rspec-rails 3.9.0 → 5.0.1

data/README.md

@@ -1,4 +1,4 @@
-# rspec-rails [![Build Status][]][travis-ci] [![Code Climate][]][code-climate] [![Gem Version][]](gem-version)
+# rspec-rails [![Code Climate][]][code-climate] [![Gem Version][]][gem-version]
 
 `rspec-rails` brings the [RSpec][] testing framework to [Ruby on Rails][]
 as a drop-in alternative to its default testing framework, Minitest.
@@ -8,9 +8,11 @@ They’re also specifications (or _specs,_ for short):
 detailed explanations of how the application is supposed to behave,
 expressed in plain English.
 
+Use **[`rspec-rails` 4.x][]** for Rails from 5.0 to 6.0.
+Use **[`rspec-rails` 3.x][]** for Rails earlier than 5.0.
 Use **[`rspec-rails` 1.x][]** for Rails 2.x.
 
-[Build Status]: https://secure.travis-ci.org/rspec/rspec-rails.svg?branch=master
+[Build Status]: https://secure.travis-ci.org/rspec/rspec-rails.svg?branch=main
 [travis-ci]: https://travis-ci.org/rspec/rspec-rails
 [Code Climate]: https://codeclimate.com/github/rspec/rspec-rails.svg
 [code-climate]: https://codeclimate.com/github/rspec/rspec-rails
@@ -19,23 +21,28 @@ Use **[`rspec-rails` 1.x][]** for Rails 2.x.
 [RSpec]: https://rspec.info/
 [Ruby on Rails]: https://rubyonrails.org/
 [`rspec-rails` 1.x]: https://github.com/dchelimsky/rspec-rails
+[`rspec-rails` 3.x]: https://github.com/rspec/rspec-rails/tree/3-9-maintenance
+[`rspec-rails` 4.x]: https://github.com/rspec/rspec-rails/tree/4-1-maintenance
 
 ## Installation
 
+**IMPORTANT** This README / branch refers to the 5.0.x series of releases.
+See the [`main` branch on Github](https://github.com/rspec/rspec-rails/tree/main) for more up to date releases.
+
 1. Add `rspec-rails` to **both** the `:development` and `:test` groups
    of your app’s `Gemfile`:
 
    ```ruby
-   # Run against the latest stable release
+   # Run against this stable release
    group :development, :test do
-     gem 'rspec-rails', '~> 3.8'
+     gem 'rspec-rails', '~> 5.0.0'
    end
 
-   # Or, run against the master branch
-   # (requires master-branch versions of all related RSpec libraries)
+   # Or, run against the main branch
+   # (requires main-branch versions of all related RSpec libraries)
    group :development, :test do
      %w[rspec-core rspec-expectations rspec-mocks rspec-rails rspec-support].each do |lib|
-       gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'master'
+       gem lib, git: "https://github.com/rspec/#{lib}.git", branch: 'main'
      end
    end
    ```
@@ -119,8 +126,7 @@ $ bundle exec rspec --help
 ```
 
 **Optional:** If `bundle exec rspec` is too verbose for you,
-you can generate a binstub at `bin/rspec`
-and use that instead (Rails 4+ only):
+you can generate a binstub at `bin/rspec` and use that instead:
 
  ```sh
  $ bundle binstubs rspec-core
@@ -183,17 +189,17 @@ In addition to [the matchers that come standard in RSpec][],
 here are some extras that make it easier
 to test the various parts of a Rails system:
 
-| RSpec matcher            | Delegates to      | Available in                    | Notes                                                    |
-| ------------------------ | ----------------- | ------------------------------- | -------------------------------------------------------- |
-| [`be_a_new`][]           |                   | all                             | primarily intended for controller specs                  |
-| [`render_template`][]    | `assert_template` | request / controller / view     | use with `expect(response).to`                           |
-| [`redirect_to`][]        | `assert_redirect` | request / controller            | use with `expect(response).to`                           |
-| [`route_to`]             | `assert_routing`  | routing / controller            | replaces `route_for` from version 1.x                    |
-| [`be_routable`]          |                   | routing / controller            | usu. for `expect(...).not_to be_routable`                |
-| [`have_http_status`][]   |                   | request / controller / feature  |                                                          |
-| [`match_array`][]        |                   | all                             | for comparing arrays of ActiveRecord objects             |
-| [`have_been_enqueued`][] |                   | all                             | requires config: `ActiveJob::Base.queue_adapter = :test` |
-| [`have_enqueued_job`][]  |                   | all                             | requires config: `ActiveJob::Base.queue_adapter = :test` |
+| RSpec matcher            | Delegates to        | Available in                    | Notes                                                    |
+| ------------------------ | ------------------- | ------------------------------- | -------------------------------------------------------- |
+| [`be_a_new`][]           |                     | all                             | primarily intended for controller specs                  |
+| [`render_template`][]    | `assert_template`   | request / controller / view     | use with `expect(response).to`                           |
+| [`redirect_to`][]        | `assert_redirect`   | request / controller            | use with `expect(response).to`                           |
+| [`route_to`]             | `assert_recognizes` | routing / controller            | use with `expect(...).to route_to`                       |
+| [`be_routable`]          |                     | routing / controller            | use with `expect(...).not_to be_routable`                |
+| [`have_http_status`][]   |                     | request / controller / feature  |                                                          |
+| [`match_array`][]        |                     | all                             | for comparing arrays of ActiveRecord objects             |
+| [`have_been_enqueued`][] |                     | all                             | requires config: `ActiveJob::Base.queue_adapter = :test` |
+| [`have_enqueued_job`][]  |                     | all                             | requires config: `ActiveJob::Base.queue_adapter = :test` |
 
 Follow the links above for examples of how each matcher is used.
 
@@ -362,7 +368,7 @@ you can run the specs and Cucumber features, or submit a pull request.
 ### Recommended third-party extensions
 
 * [FactoryBot](https://github.com/thoughtbot/factory_bot)
-* [Capybara](https://github.com/jnicklas/capybara)
+* [Capybara](https://github.com/teamcapybara/capybara)
   (Included by default in Rails 5.1+.
   Note that [additional configuration is required][] to use the Capybara DSL
   anywhere other than system specs and feature specs.)

data/lib/generators/rspec.rb

@@ -18,12 +18,6 @@ module Rspec
           @_rspec_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'rspec', generator_name, 'templates'))
         end
       end
-
-      if ::Rails::VERSION::STRING < '3.1'
-        def module_namespacing
-          yield if block_given?
-        end
-      end
     end
   end
 end

data/lib/generators/rspec/channel/channel_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class ChannelGenerator < Base
+      def create_channel_spec
+        template 'channel_spec.rb.erb', File.join('spec/channels', class_path, "#{file_name}_channel_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/{observer/templates/observer_spec.rb → channel/templates/channel_spec.rb.erb}

@@ -1,7 +1,7 @@
 require 'rails_helper'
 
 <% module_namespacing do -%>
-RSpec.describe <%= class_name %>Observer, <%= type_metatag(:observer) %> do
+RSpec.describe <%= class_name %>Channel, <%= type_metatag(:channel) %> do
   pending "add some examples to (or delete) #{__FILE__}"
 end
 <% end -%>

data/lib/generators/rspec/controller/controller_generator.rb

@@ -4,11 +4,20 @@ module Rspec
   module Generators
     # @private
     class ControllerGenerator < Base
-      argument :actions, :type => :array, :default => [], :banner => "action action"
+      argument :actions, type: :array, default: [], banner: "action action"
 
-      class_option :template_engine, :desc => "Template engine to generate view files"
-      class_option :controller_specs, :type => :boolean, :default => true
-      class_option :view_specs,       :type => :boolean, :default => true
+      class_option :template_engine,  desc: "Template engine to generate view files"
+      class_option :request_specs,    type: :boolean, default: true, desc: "Generate request specs"
+      class_option :controller_specs, type: :boolean, default: false, desc: "Generate controller specs"
+      class_option :view_specs,       type: :boolean, default: true, desc: "Generate view specs"
+      class_option :routing_specs,    type: :boolean, default: false, desc: "Generate routing specs"
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        template 'request_spec.rb',
+                 File.join('spec/requests', class_path, "#{file_name}_spec.rb")
+      end
 
       def generate_controller_spec
         return unless options[:controller_specs]
@@ -18,7 +27,7 @@ module Rspec
       end
 
       def generate_view_specs
-        return if actions.empty?
+        return if actions.empty? && behavior == :invoke
         return unless options[:view_specs] && options[:template_engine]
 
         empty_directory File.join("spec", "views", file_path)
@@ -29,6 +38,14 @@ module Rspec
                    File.join("spec", "views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
         end
       end
+
+      def generate_routing_spec
+        return if actions.empty?
+        return unless options[:routing_specs]
+
+        template 'routing_spec.rb',
+                 File.join('spec/routing', class_path, "#{file_name}_routing_spec.rb")
+      end
     end
   end
 end

data/lib/generators/rspec/controller/templates/request_spec.rb

@@ -0,0 +1,19 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name.pluralize %>", <%= type_metatag(:request) %> do
+<% namespaced_path = regular_class_path.join('/') -%>
+<% if actions.empty? -%>
+  describe "GET /index" do
+    pending "add some examples (or delete) #{__FILE__}"
+  end
+<% end -%>
+<% for action in actions -%>
+  describe "GET /<%= action %>" do
+    it "returns http success" do
+      get "<%= "/#{namespaced_path}" if namespaced_path != '' %>/<%= file_name %>/<%= action %>"
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+<% end -%>
+end

data/lib/generators/rspec/controller/templates/routing_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe '<%= class_name %>Controller', <%= type_metatag(:routing) %> do
+  describe 'routing' do
+<% for action in actions -%>
+    it 'routes to #<%= action %>' do
+      expect(get: "/<%= class_name.underscore %>/<%= action %>").to route_to("<%= class_name.underscore %>#<%= action  %>")
+    end
+<% end -%>
+  end
+end
+<% end -%>

data/lib/generators/rspec/feature/feature_generator.rb

@@ -4,8 +4,8 @@ module Rspec
   module Generators
     # @private
     class FeatureGenerator < Base
-      class_option :feature_specs, :type => :boolean, :default => true,  :desc => "Generate feature specs"
-      class_option :singularize,   :type => :boolean, :default => false, :desc => "Singularize the generated feature"
+      class_option :feature_specs, type: :boolean, default: true,  desc: "Generate feature specs"
+      class_option :singularize,   type: :boolean, default: false, desc: "Singularize the generated feature"
 
       def generate_feature_spec
         return unless options[:feature_specs]

data/lib/generators/rspec/{generators → generator}/generator_generator.rb

@@ -3,8 +3,8 @@ require 'generators/rspec'
 module Rspec
   module Generators
     # @private
-    class GeneratorsGenerator < Base
-      class_option :generator_specs, :type => :boolean, :default => false,  :desc => "Generate generator specs"
+    class GeneratorGenerator < Base
+      class_option :generator_specs, type: :boolean, default: true,  desc: "Generate generator specs"
 
       def generate_generator_spec
         return unless options[:generator_specs]

data/lib/generators/rspec/helper/helper_generator.rb

@@ -4,7 +4,7 @@ module Rspec
   module Generators
     # @private
     class HelperGenerator < Base
-      class_option :helper_specs, :type => :boolean, :default => true
+      class_option :helper_specs, type: :boolean, default: true
 
       def generate_helper_spec
         return unless options[:helper_specs]

data/lib/generators/rspec/install/install_generator.rb

@@ -32,8 +32,8 @@ DESC
 
       def generate_rspec_init(tmpdir)
         initializer = ::RSpec::Core::ProjectInitializer.new(
-          :destination => tmpdir,
-          :report_stream => StringIO.new
+          destination: tmpdir,
+          report_stream: StringIO.new
         )
         initializer.run
 
@@ -47,7 +47,7 @@ DESC
         gsub_file spec_helper_path,
                   'rspec --init',
                   'rails generate rspec:install',
-                  :verbose => false
+                  verbose: false
       end
 
       def remove_warnings_configuration(spec_helper_path)
@@ -56,7 +56,7 @@ DESC
         gsub_file spec_helper_path,
                   /#{empty_line}(#{comment_line})+\s+config\.warnings = true\n/,
                   '',
-                  :verbose => false
+                  verbose: false
       end
     end
   end

data/lib/generators/rspec/install/templates/spec/rails_helper.rb

@@ -1,11 +1,7 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 require 'spec_helper'
 ENV['RAILS_ENV'] ||= 'test'
-<% if RUBY_VERSION >= '2.0.0' %>
 require File.expand_path('../config/environment', __dir__)
-<% else %>
-require File.expand_path('../../config/environment', __FILE__)
-<% end %>
 # Prevent database truncation if the environment is production
 abort("The Rails environment is running in production mode!") if Rails.env.production?
 require 'rspec/rails'
@@ -24,9 +20,9 @@ require 'rspec/rails'
 # 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 }
+# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
 
-<% if RSpec::Rails::FeatureCheck.can_maintain_test_schema? -%>
+<% if RSpec::Rails::FeatureCheck.has_active_record_migration? -%>
 # Checks for pending migrations and applies them before tests are run.
 # If you are not using ActiveRecord, you can remove these lines.
 begin
@@ -35,15 +31,6 @@ rescue ActiveRecord::PendingMigrationError => e
   puts e.to_s.strip
   exit 1
 end
-<% elsif RSpec::Rails::FeatureCheck.can_check_pending_migrations? -%>
-# Checks for pending migrations before tests are run.
-# If you are not using ActiveRecord, you can remove these lines.
-begin
-  ActiveRecord::Migration.check_pending!
-rescue ActiveRecord::PendingMigrationError => e
-  puts e.to_s.strip
-  exit 1
-end
 <% end -%>
 RSpec.configure do |config|
 <% if RSpec::Rails::FeatureCheck.has_active_record? -%>
@@ -55,6 +42,20 @@ RSpec.configure do |config|
   # instead of true.
   config.use_transactional_fixtures = true
 
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+<% else -%>
+  # Remove this line to enable support for ActiveRecord
+  config.use_active_record = false
+
+  # If you enable ActiveRecord support you should unncomment these lines,
+  # note if you'd prefer not to run each example within a transaction, you
+  # should set use_transactional_fixtures to false.
+  #
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  # config.use_transactional_fixtures = true
+
 <% end -%>
   # RSpec Rails can automatically mix in different behaviours to your tests
   # based on their file location, for example enabling you to call `get` and
@@ -63,7 +64,7 @@ RSpec.configure do |config|
   # 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
+  #     RSpec.describe UsersController, type: :controller do
   #       # ...
   #     end
   #

data/lib/generators/rspec/integration/integration_generator.rb

@@ -7,9 +7,9 @@ module Rspec
       # Add a deprecation for this class, before rspec-rails 4, to use the
       # `RequestGenerator` instead
       class_option :request_specs,
-                   :type => :boolean,
-                   :default => true,
-                   :desc => "Generate request specs"
+                   type: :boolean,
+                   default: true,
+                   desc: "Generate request specs"
 
       def generate_request_spec
         return unless options[:request_specs]

data/lib/generators/rspec/mailbox/mailbox_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class MailboxGenerator < Base
+      def create_mailbox_spec
+        template('mailbox_spec.rb.erb',
+                 File.join('spec/mailboxes', class_path, "#{file_name}_mailbox_spec.rb")
+        )
+      end
+    end
+  end
+end

data/lib/generators/rspec/mailbox/templates/mailbox_spec.rb.erb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Mailbox, <%= type_metatag(:mailbox) %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/generators/rspec/mailer/mailer_generator.rb

@@ -5,7 +5,7 @@ module Rspec
   module Generators
     # @private
     class MailerGenerator < Base
-      argument :actions, :type => :array, :default => [], :banner => "method method"
+      argument :actions, type: :array, default: [], banner: "method method"
 
       def generate_mailer_spec
         template "mailer_spec.rb", File.join('spec/mailers', class_path, "#{file_name}_spec.rb")
@@ -20,6 +20,7 @@ module Rspec
 
       def generate_preview_files
         return unless RSpec::Rails::FeatureCheck.has_action_mailer_preview?
+
         template "preview.rb", File.join("spec/mailers/previews", class_path, "#{file_name}_preview.rb")
       end
     end

data/lib/generators/rspec/mailer/templates/mailer_spec.rb

@@ -1,10 +1,10 @@
 require "rails_helper"
 
 <% module_namespacing do -%>
-RSpec.describe <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : class_name %>, <%= type_metatag(:mailer) %> do
+RSpec.describe <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>, <%= type_metatag(:mailer) %> do
 <% for action in actions -%>
   describe "<%= action %>" do
-    let(:mail) { <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : class_name %>.<%= action %> }
+    let(:mail) { <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>.<%= action %> }
 
     it "renders the headers" do
       expect(mail.subject).to eq(<%= action.to_s.humanize.inspect %>)

data/lib/generators/rspec/mailer/templates/preview.rb

@@ -5,7 +5,7 @@ class <%= class_name %>Preview < ActionMailer::Preview
 
   # Preview this email at http://localhost:3000/rails/mailers/<%= file_path %>/<%= action %>
   def <%= action %>
-    <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : class_name %>.<%= action %>
+    <%= class_name.sub(/(Mailer)?$/, 'Mailer') %>.<%= action %>
   end
 <% end -%>
 

data/lib/generators/rspec/model/model_generator.rb

@@ -5,10 +5,10 @@ module Rspec
     # @private
     class ModelGenerator < Base
       argument :attributes,
-               :type => :array,
-               :default => [],
-               :banner => "field:type field:type"
-      class_option :fixture, :type => :boolean
+               type: :array,
+               default: [],
+               banner: "field:type field:type"
+      class_option :fixture, type: :boolean
 
       def create_model_spec
         template_file = File.join(
@@ -23,6 +23,7 @@ module Rspec
 
       def create_fixture_file
         return unless missing_fixture_replacement?
+
         template 'fixtures.yml', File.join('spec/fixtures', class_path, "#{(pluralize_table_names? ? plural_file_name : file_name)}.yml")
       end