From ee6a51b37f91c5a7345395df168eaf894812a159 Mon Sep 17 00:00:00 2001
From: Mark Tareshawty <tarebyte@github.com>
Date: Tue, 27 Feb 2018 22:01:07 -0500
Subject: [PATCH] re run rspec `rails generate rspec:install` and update config

---
 .gitignore                                    |   3 +
 .rspec                                        |   2 +-
 spec/controllers/about_controller_spec.rb     |   2 +-
 spec/controllers/community_controller_spec.rb |   2 +-
 spec/controllers/site_controller_spec.rb      |   2 +-
 spec/models/book_spec.rb                      |   2 +-
 spec/models/chapter_spec.rb                   |   2 +-
 spec/models/doc_file_spec.rb                  |   2 +-
 spec/models/doc_spec.rb                       |   2 +-
 spec/models/doc_version_spec.rb               |   2 +-
 spec/models/download_spec.rb                  |   4 +-
 spec/models/section_spec.rb                   |   2 +-
 spec/models/version_spec.rb                   |   2 +-
 spec/rails_helper.rb                          |  57 ++++++++
 spec/services/download_service_spec.rb        |   2 +-
 spec/spec_helper.rb                           | 127 +++++++++++-------
 spec/support/database_cleaners.rb             |  12 ++
 spec/support/shoulda.rb                       |   6 +
 18 files changed, 174 insertions(+), 59 deletions(-)
 create mode 100644 spec/rails_helper.rb
 create mode 100644 spec/support/database_cleaners.rb
 create mode 100644 spec/support/shoulda.rb

diff --git a/.gitignore b/.gitignore
index aaa9a074c..1b970777c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -35,3 +35,6 @@ node_modules/
 
 # Ignore byebug history
 .byebug_history
+
+# RSpec
+spec/examples.txt
diff --git a/.rspec b/.rspec
index 4e1e0d2f7..c99d2e739 100644
--- a/.rspec
+++ b/.rspec
@@ -1 +1 @@
---color
+--require spec_helper
diff --git a/spec/controllers/about_controller_spec.rb b/spec/controllers/about_controller_spec.rb
index c72080e16..c7eaa99b8 100644
--- a/spec/controllers/about_controller_spec.rb
+++ b/spec/controllers/about_controller_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe AboutController, type: :controller do
 
diff --git a/spec/controllers/community_controller_spec.rb b/spec/controllers/community_controller_spec.rb
index 522951910..935214c6e 100644
--- a/spec/controllers/community_controller_spec.rb
+++ b/spec/controllers/community_controller_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe CommunityController, type: :controller do
 
diff --git a/spec/controllers/site_controller_spec.rb b/spec/controllers/site_controller_spec.rb
index aa74c1623..47ef190fe 100644
--- a/spec/controllers/site_controller_spec.rb
+++ b/spec/controllers/site_controller_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe SiteController, type: :controller do
 
diff --git a/spec/models/book_spec.rb b/spec/models/book_spec.rb
index 7275a2990..e5c540c30 100644
--- a/spec/models/book_spec.rb
+++ b/spec/models/book_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe Book, type: :model do
 
diff --git a/spec/models/chapter_spec.rb b/spec/models/chapter_spec.rb
index d9ca59e9a..810e32ee2 100644
--- a/spec/models/chapter_spec.rb
+++ b/spec/models/chapter_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe Chapter, type: :model do
 
diff --git a/spec/models/doc_file_spec.rb b/spec/models/doc_file_spec.rb
index 04874cd11..076150cc8 100644
--- a/spec/models/doc_file_spec.rb
+++ b/spec/models/doc_file_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe DocFile, type: :model do
 
diff --git a/spec/models/doc_spec.rb b/spec/models/doc_spec.rb
index bc1de97f7..7d0c4ff3c 100644
--- a/spec/models/doc_spec.rb
+++ b/spec/models/doc_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe Doc, type: :model do
 
diff --git a/spec/models/doc_version_spec.rb b/spec/models/doc_version_spec.rb
index e8a704b4e..5842ec0c1 100644
--- a/spec/models/doc_version_spec.rb
+++ b/spec/models/doc_version_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe DocVersion, type: :model do
 
diff --git a/spec/models/download_spec.rb b/spec/models/download_spec.rb
index 20d25256e..563b017c6 100644
--- a/spec/models/download_spec.rb
+++ b/spec/models/download_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe Download, type: :model do
 
@@ -10,7 +10,7 @@ RSpec.describe Download, type: :model do
   it "should have url" do
     download.url.should == "http://git-scm.com/git.zip"
   end
-    
+
   it "should have version" do
     download.version == version
   end
diff --git a/spec/models/section_spec.rb b/spec/models/section_spec.rb
index 728f38b16..fe799bea4 100644
--- a/spec/models/section_spec.rb
+++ b/spec/models/section_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe Section, type: :model do
 
diff --git a/spec/models/version_spec.rb b/spec/models/version_spec.rb
index bd123df93..0085169cd 100644
--- a/spec/models/version_spec.rb
+++ b/spec/models/version_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe Version, type: :model do
 
diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb
new file mode 100644
index 000000000..7722cbfa5
--- /dev/null
+++ b/spec/rails_helper.rb
@@ -0,0 +1,57 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'rails_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort('The Rails environment is running in production mode!') if Rails.env.production?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+
+Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end
diff --git a/spec/services/download_service_spec.rb b/spec/services/download_service_spec.rb
index 884a892b0..e6e5459d6 100644
--- a/spec/services/download_service_spec.rb
+++ b/spec/services/download_service_spec.rb
@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'rails_helper'
 
 describe DownloadService do
   subject { DownloadService }
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index 85ab4030b..3cfb53f73 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -1,58 +1,95 @@
-# This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path("../../config/environment", __FILE__)
-
-require 'rspec/rails'
-require 'database_cleaner'
-require 'byebug'
-
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
-
-Shoulda::Matchers.configure do |config|
-  config.integrate do |with|
-    with.test_framework :rspec
-    with.library :rails
-  end
-end
-
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.before(:suite) do
-    DatabaseCleaner.strategy = :transaction
-    DatabaseCleaner.clean_with(:truncation)
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  config.around(:each) do |example|
-    DatabaseCleaner.cleaning do
-      example.run
-    end
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
   end
 
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
 
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  config.use_transactional_fixtures = true
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
 
-  # If true, the base class of anonymous controllers will be inferred
-  # automatically. This will be the default behavior in future versions of
-  # rspec-rails.
-  config.infer_base_class_for_anonymous_controllers = false
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  # config.order = "random"
-  # config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.filter_run focus: true
-  config.run_all_when_everything_filtered = true
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
 end
diff --git a/spec/support/database_cleaners.rb b/spec/support/database_cleaners.rb
new file mode 100644
index 000000000..2211979de
--- /dev/null
+++ b/spec/support/database_cleaners.rb
@@ -0,0 +1,12 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end
diff --git a/spec/support/shoulda.rb b/spec/support/shoulda.rb
new file mode 100644
index 000000000..7d045f359
--- /dev/null
+++ b/spec/support/shoulda.rb
@@ -0,0 +1,6 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end