rspec-rails 4.0.0.beta4 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51903b359e44b4d8c3323a4af3caa9de3495e02009b61da605af24d7ae588b0b
-  data.tar.gz: 11e9ff4ad45a88a32e9f0a4294cd6c8f7c75febd5ba07c1382fed86ebdcd64aa
+  metadata.gz: 4cfb82b177fd4c881bb331fe78d7c0c7e974d8e886050b67db824aa4e4a93ab2
+  data.tar.gz: 1c55d80deaeab9a57af17b7b4c219490be2141c55d04fef428daa4a09fc3fd4f
 SHA512:
-  metadata.gz: 8e9b40e1404bb29508e00c460db05b7d499ca86daa332cbe3e517dfd922ec860302023e6f71e15e7445f07c7eb39979306cd98ef296b7794ae2c87e3d5865b59
-  data.tar.gz: bb8b7f0411f6d1eff0550b952117bbd58aa59ca082c54d2a145e808fc14a400de0885bb8a8b5503b04baef787527b50a08054e471444123e433d3138c8b45fe1
+  metadata.gz: 346b1d7428910e9b79881fa6a5ad616521fe6615c058ba559aa11136929e9f3ec7601d76e8a200123c74708f147d49c665b0fc649cf76a10f8b4ae55e734c6c0
+  data.tar.gz: 10478159e4622f40869d46fb36ab8a4472d469b2547bb54238164244511326393a3b66f7568787d0419aeac70fcb24942352f1f3fcdaede273070aa609b12cfc

data/Capybara.md

@@ -1,58 +1,19 @@
 rspec-rails supports integration with Capybara out of the box by adding
 its Capybara::DSL (visit/page) and Capybara::RSpecMatchers to the
-examples in the applicable directories, which differ slightly between
-Capybara 1.x and Capybara >= 2.x.
+examples in the applicable directories.
 
 ## Capybara::DSL
 
 Adds the `visit` and `page` methods, which work together to simulate a
 GET request and provide access to the result (via `page`).
 
-## Capybara::RSpecMatchers
-
-Exposes matchers used to specify expected HTML content (e.g. `should_not have_selector` will work correctly).
-
-## Capybara 1.x
-
-Capybara::DSL is added to examples in:
-
-* spec/requests    # included by Capybara
-* spec/controllers
-
-Capybara::RSpecMatchers is added to examples in:
-
-* spec/requests    # included by Capybara
-* spec/controllers
-* spec/views
-* spec/helpers
-* spec/mailers
-
-## Capybara 2.0
-
-To use Capybara 2.0, you need rspec-rails-2.11.1 or greater.
-
 Capybara::DSL is added to examples in:
 
 * spec/features
 
-Capybara::RSpecMatchers is added to examples in:
-
-* spec/features
-* spec/controllers
-* spec/views
-* spec/helpers
-* spec/mailers
-
-## Upgrading to Capybara-2.0
-
-Many users have been confused by the co-existence of the the
-Capybara::DSL (visit/page) alongside the rack-test DSL
-(get|post|put|delete|head/response.body) in examples in spec/requests
-and spec/controllers. As of rspec-rails-2.11.1 and capybara-2.0.0.beta2, these
-are separated as follows:
+## Capybara::RSpecMatchers
 
-* Capybara::DSL is included `spec/features`
-* rack-test DSL is included in `spec/requests` and `spec/controllers`
+Exposes matchers used to specify expected HTML content (e.g. `should_not have_selector` will work correctly).
 
 Capybara::RSpecMatchers is added to examples in:
 
@@ -62,16 +23,6 @@ Capybara::RSpecMatchers is added to examples in:
 * spec/helpers
 * spec/mailers
 
-If you're upgrading to Capybara-2.0 and you used visit/page in
-spec/requests you'll want to move those examples to spec/features and
-they should just work.
-
-If you want to leave those examples in spec/requests, you can include
-Capybara::DSL in those examples yourself as follows, but this is
-absolutely not recommended as you will be overriding the intended
-behavior and accepting the risks associated with doing so:
+## Upgrading to Capybara-3.x
 
-    # not recommended!
-    RSpec.configure do |c|
-      c.include Capybara::DSL, file_path: "spec/requests"
-    end
+Consult the official [Upgrading from Capybara 2.x to 3.x](https://github.com/teamcapybara/capybara/blob/master/UPGRADING.md#upgrading-from-capybara-2x-to-3x) guide.

data/Changelog.md

@@ -1,28 +1,50 @@
-### 4.0.0.beta4
-[Full Changelog](https://github.com/rspec/rspec-rails/compare/v4.0.0.beta3...v4.0.0.beta4)
+### 4.1.0 / 2021-03-06
+[Full Changelog](https://github.com/rspec/rspec-rails/compare/v4.0.2...v4.1.0)
 
 Enhancements:
 
-* Add argument matcher support to `have_enqueued_*` matchers. (Phil Pirozhkov, #2206)
-* Switch generated templates to use ruby 1.9 hash keys. (Tanbir Hasan, #2224)
-* Add `have_been_performed`/`have_performed_job`/`perform_job` ActiveJob
-  matchers (Isaac Seymour, #1785)
-* Default to generating request specs rather than controller specs when
-  generating a controller (Luka Lüdicke, #2222)
+* Issue a warning when using job matchers with `#at` mis-match on `usec` precision.
+  (Jon Rowe, #2350)
+* Generated request specs now have a bare `_spec` suffix instead of `request_spec`.
+  (Eloy Espinaco, Luka Lüdicke, #2355, #2356, #2378)
+* Generated scaffold now includes engine route helpers when inside a mountable engine.
+  (Andrew W. Lee, #2372)
+* Improve request spec "controller" scafold when no action is specified.
+  (Thomas Hareau, #2399)
+* Introduce testing snippets concept (Phil Pirozhkov, Benoit Tigeot, #2423)
+* Prevent collisions with `let(:name)` for Rails 6.1 and `let(:method_name)` on older
+  Rails. (Benoit Tigeot, #2461)
+
+### 4.0.2 / 2020-12-26
+[Full Changelog](https://github.com/rspec/rspec-rails/compare/v4.0.1...v4.0.2)
 
 Bug Fixes:
 
-* Prevent `driven_by(:selenium)` being called due to hook precedence.
-  (Takumi Shotoku, #2188)
-* Prevent a `WrongScopeError` being thrown during loading fixtures on Rails
-  6.1 development version. (Edouard Chin, #2215)
-* Fix Mocha mocking support with `should`. (Phil Pirozhkov, #2256)
+* Indent all extra failure lines output from system specs. (Alex Robbin, #2321)
+* Generated request spec for update now uses the correct let. (Paul Hanyzewski, #2344)
+* Return `true`/`false` from predicate methods in config rather than raw values.
+  (Phil Pirozhkov, Jon Rowe, #2353, #2354)
+* Remove old #fixture_path feature detection code which broke under newer Rails.
+  (Koen Punt, Jon Rowe, #2370)
+
+### 4.0.1 / 2020-05-16
+[Full Changelog](https://github.com/rspec/rspec-rails/compare/v4.0.0...v4.0.1)
+
+Bug Fixes:
+
+* Remove warning when calling `driven_by` in system specs. (Aubin Lorieux, #2302)
+* Fix comparison of times for `#at` in job matchers. (Jon Rowe, Markus Doits, #2304)
+* Allow `have_enqueued_mail` to match when a sub class of `ActionMailer::DeliveryJob`
+  is set using `<Class>.delivery_job=`. (Atsushi Yoshida #2305)
+* Restore Ruby 2.2.x compatibility. (Jon Rowe, #2332)
+* Add `required_ruby_version` to gem spec. (Marc-André Lafortune, #2319, #2338)
 
-### 4.0.0.beta3
-[Full Changelog](https://github.com/rspec/rspec-rails/compare/v4.0.0.beta2...v4.0.0.beta3)
+### 4.0.0 / 2020-03-24
+[Full Changelog](https://github.com/rspec/rspec-rails/compare/v3.9.1...v4.0.0)
 
 Enhancements:
 
+* Adds support for Rails 6. (Penelope Phippen, Benoit Tigeot, Jon Rowe, #2071)
 * Adds support for JRuby on Rails 5.2 and 6
 * Add support for parameterised mailers (Ignatius Reza, #2125)
 * Add ActionMailbox spec helpers and test type (James Dabbs, #2119)
@@ -33,28 +55,18 @@ Enhancements:
 * Improve path parsing in view specs render options. (John Hawthorn, #2115)
 * Add routing spec template as an option for generating controller specs.
   (David Revelo, #2134)
-
-Bug Fixes:
-
-* Replace `before_teardown` as well as `after_teardown` to ensure screenshots
-  are generated correctly. (Jon Rowe, #2164)
-* `ActionView::FixtureResolver#hash` has been renamed to `ActionView::FixtureResolver#data`.
-  (Penelope Phippen, #2076)
-* Add missing require for `have_enqueued_mail` matcher.  (Ignatius Reza, #2117)
-
-### 4.0.0.beta2
-[Full Changelog](https://github.com/rspec/rspec-rails/compare/v4.0.0.beta1...v4.0.0.beta2)
-
-Bug Fixes:
-
-* Fix version dependencies in gemspec.
-
-### 4.0.0.beta1
-[Full Changelog](https://github.com/rspec/rspec-rails/compare/v3.9.0...v4.0.0.beta1)
-
-Enhancements:
-
-* Adds support for Rails 6. (Penelope Phippen, Benoit Tigeot, Jon Rowe, #2071)
+* Add argument matcher support to `have_enqueued_*` matchers. (Phil Pirozhkov, #2206)
+* Switch generated templates to use ruby 1.9 hash keys. (Tanbir Hasan, #2224)
+* Add `have_been_performed`/`have_performed_job`/`perform_job` ActiveJob
+  matchers (Isaac Seymour, #1785)
+* Default to generating request specs rather than controller specs when
+  generating a controller (Luka Lüdicke, #2222)
+* Allow `ActiveJob` matchers `#on_queue` modifier to take symbolic queue names. (Nils Sommer, #2283)
+* The scaffold generator now generates request specs in preference to controller specs.
+  (Luka Lüdicke, #2288)
+* Add configuration option to disable ActiveRecord. (Jon Rowe, Phil Pirozhkov, Hermann Mayer, #2266)
+*  Set `ActionDispatch::SystemTesting::Server.silence_puma = true` when running system specs.
+  (ta1kt0me, Benoit Tigeot, #2289)
 
 Bug Fixes:
 
@@ -64,12 +76,35 @@ Bug Fixes:
   deprecated. (Pavel Rosický, #2092)
 * `ActionView::Template#formats` has been deprecated and replaced by
   `ActionView::Template#format`(Seb Jacobs, #2100)
+* Replace `before_teardown` as well as `after_teardown` to ensure screenshots
+  are generated correctly. (Jon Rowe, #2164)
+* `ActionView::FixtureResolver#hash` has been renamed to `ActionView::FixtureResolver#data`.
+  (Penelope Phippen, #2076)
+* Prevent `driven_by(:selenium)` being called due to hook precedence.
+  (Takumi Shotoku, #2188)
+* Prevent a `WrongScopeError` being thrown during loading fixtures on Rails
+  6.1 development version. (Edouard Chin, #2215)
+* Fix Mocha mocking support with `should`. (Phil Pirozhkov, #2256)
+* Restore previous conditional check for setting `default_url_options` in feature
+  specs, prevents a `NoMethodError` in some scenarios. (Eugene Kenny, #2277)
+* Allow changing `ActiveJob::Base.queue_adapter` inside a system spec.
+  (Jonathan Rochkind, #2242)
+* `rails generate generator` command now creates related spec file (Joel Azemar, #2217)
+* Relax upper `capybara` version constraint to allow for Capybara 3.x (Phil Pirozhkov, #2281)
+* Clear ActionMailer test mailbox after each example (Benoit Tigeot, #2293)
 
 Breaking Changes:
 
 * Drops support for Rails below 5.0
 * Drops support for Ruby below 2.3
 
+### 3.9.1 / 2020-03-10
+[Full Changelog](http://github.com/rspec/rspec-rails/compare/v3.9.0...v3.9.1)
+
+Bug Fixes:
+
+* Add missing require for have_enqueued_mail matcher. (Ignatius Reza, #2117)
+
 ### 3.9.0 / 2019-10-08
 [Full Changelog](https://github.com/rspec/rspec-rails/compare/v3.8.3...v3.9.0)
 

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,10 @@ 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` 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 +20,27 @@ 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
 
 ## Installation
 
+**IMPORTANT** This README / branch refers to the `4.1.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
    group :development, :test do
-     gem 'rspec-rails', '~> 4.0'
+     gem 'rspec-rails', '~> 4.1.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
    ```
@@ -182,17 +187,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.
 
@@ -361,7 +366,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/controller/controller_generator.rb

@@ -16,7 +16,7 @@ module Rspec
         return unless options[:request_specs]
 
         template 'request_spec.rb',
-                 File.join('spec/requests', class_path, "#{file_name}_request_spec.rb")
+                 File.join('spec/requests', class_path, "#{file_name}_spec.rb")
       end
 
       def generate_controller_spec

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

@@ -1,7 +1,12 @@
 require 'rails_helper'
 
 RSpec.describe "<%= class_name.pluralize %>", <%= type_metatag(:request) %> do
-<% namespaced_path = regular_class_path.join('/') %>
+<% 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

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/install/templates/spec/rails_helper.rb

@@ -20,7 +20,7 @@ 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.has_active_record_migration? -%>
 # Checks for pending migrations and applies them before tests are run.
@@ -42,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

data/lib/generators/rspec/scaffold/scaffold_generator.rb

@@ -14,7 +14,8 @@ module Rspec
       class_option :singleton, type: :boolean, desc: "Supply to create a singleton controller"
       class_option :api, type: :boolean, desc: "Skip specs unnecessary for API-only apps"
 
-      class_option :controller_specs, type: :boolean, default: true,  desc: "Generate controller specs"
+      class_option :controller_specs, type: :boolean, default: false, desc: "Generate controller specs"
+      class_option :request_specs,    type: :boolean, default: true,  desc: "Generate request specs"
       class_option :view_specs,       type: :boolean, default: true,  desc: "Generate view specs"
       class_option :helper_specs,     type: :boolean, default: true,  desc: "Generate helper specs"
       class_option :routing_specs,    type: :boolean, default: true,  desc: "Generate routing specs"
@@ -27,15 +28,20 @@ module Rspec
       def generate_controller_spec
         return unless options[:controller_specs]
 
-        template_file = File.join(
-          'spec/controllers',
-          controller_class_path,
-          "#{controller_file_name}_controller_spec.rb"
-        )
         if options[:api]
-          template 'api_controller_spec.rb', template_file
+          template 'api_controller_spec.rb', template_file(folder: 'controllers', suffix: '_controller')
+        else
+          template 'controller_spec.rb', template_file(folder: 'controllers', suffix: '_controller')
+        end
+      end
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        if options[:api]
+          template 'api_request_spec.rb', template_file(folder: 'requests')
         else
-          template 'controller_spec.rb', template_file
+          template 'request_spec.rb', template_file(folder: 'requests')
         end
       end
 
@@ -60,8 +66,6 @@ module Rspec
         template 'routing_spec.rb', template_file
       end
 
-      hook_for :integration_tool, as: :integration
-
     protected
 
       attr_reader :generator_args
@@ -116,6 +120,10 @@ module Rspec
         end
       end
 
+      def template_file(folder:, suffix: '')
+        File.join('spec', folder, controller_class_path, "#{controller_file_name}#{suffix}_spec.rb")
+      end
+
       def banner
         self.class.banner
       end