rspec-rails 3.7.2 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7adb1e867de1a32aa2321c7d214157d1624d4b95
-  data.tar.gz: cc75e1a431ac8dd3d91e515394b759aa4eb2de08
+  metadata.gz: ea2d87e6ff8e297370262b9b24149098c96ce7e1
+  data.tar.gz: 628aaf29946b0d609e2f7312a0135a11e20a54bf
 SHA512:
-  metadata.gz: 77043a4efa1f5df35358d1531605b611ec55c2ac383f3f6c496fcc4afae68122f2cf37a5442061107c55357a29d621fb64913fe23d9e16acec0f468e645758be
-  data.tar.gz: d58a7c5f801e96d26399eedca46faca78d8dfb398b90b0ba1539780d35bf607b359c473e7acfc1daf1dbb4a0080be4474675dbf418bb99bf663f855709ebff9f
+  metadata.gz: dfb6ef6e01a98df778f5d44e165a1222e3ba7edc9b00ca095f11efe3d17336e6f9fa2ee73b3587527bb51453efafb480372acbfdac4b031f186fb0106aa39218
+  data.tar.gz: 43a37b04ca888383a5a648597b0daade6b456b4e10a2a69838eaf9fedfb535934853020945a1df54d785e1e478fbd1eb7423a2168f3bb76b37c49c9fa02c351a

data/Changelog.md

@@ -1,5 +1,28 @@
-### Development
-[Full Changelog](http://github.com/rspec/rspec-rails/compare/v3.7.2...master)
+### 3.8.0 / 2018-08-04
+[Full Changelog](http://github.com/rspec/rspec-rails/compare/v3.7.2...v3.8.0)
+
+Enhancements:
+
+* Improved message when migrations are pending in the default `rails_helper.rb`
+  (Koichi ITO, #1924)
+* `have_http_status` matcher now supports Rails 5.2 style response symbols
+  (Douglas Lovell, #1951)
+* Change generated Rails helper to match Rails standards for Rails.root
+  (Alessandro Rodi, #1960)
+* At support for asserting enqueued jobs have no wait period attached.
+  (Brad Charna, #1977)
+* Cache instances of `ActionView::Template` used in `stub_template` resulting
+  in increased performance due to less allocations and setup. (Simon Coffey, #1979)
+* Rails scaffold generator now respects longer namespaces (e.g. api/v1/\<thing\>).
+  (Laura Paakkinen, #1958)
+
+Bug Fixes:
+
+* Escape quotation characters when producing method names for system spec
+  screenshots. (Shane Cavanaugh, #1955)
+* Use relative path for resolving fixtures when `fixture_path` is not set.
+  (Laurent Cobos, #1943)
+* Allow custom template resolvers in view specs. (@ahorek, #1941)
 
 ### 3.7.2 / 2017-11-20
 [Full Changelog](http://github.com/rspec/rspec-rails/compare/v3.7.1...v3.7.2)

data/README.md

@@ -1,5 +1,5 @@
 # rspec-rails [![Build Status](https://secure.travis-ci.org/rspec/rspec-rails.svg?branch=master)](http://travis-ci.org/rspec/rspec-rails) [![Code Climate](https://img.shields.io/codeclimate/github/rspec/rspec-rails.svg)](https://codeclimate.com/github/rspec/rspec-rails)
-**rspec-rails** is a testing framework for Rails 3.x, 4.x and 5.0.
+**rspec-rails** is a testing framework for Rails 3.x, 4.x and 5.x.
 
 Use **[rspec-rails 1.x](http://github.com/dchelimsky/rspec-rails)** for Rails
 2.x.
@@ -11,7 +11,7 @@ Add `rspec-rails` to **both** the `:development` and `:test` groups in the
 
 ```ruby
 group :development, :test do
-  gem 'rspec-rails', '~> 3.6'
+  gem 'rspec-rails', '~> 3.7'
 end
 ```
 
@@ -70,7 +70,7 @@ bundle exec rspec spec/controllers/accounts_controller_spec.rb:8
 Specs can also be run via `rake spec`, though this command may be slower to
 start than the `rspec` command.
 
-In Rails 4, you may want to create a binstub for the `rspec` command so it can
+In Rails 4/5+, you may want to create a binstub for the `rspec` command so it can
 be run via `bin/rspec`:
 
 ```
@@ -147,12 +147,14 @@ For example:
 ```ruby
 require "rails_helper"
 
-RSpec.describe User, :type => :model do
-  it "orders by last name" do
-    lindeman = User.create!(first_name: "Andy", last_name: "Lindeman")
-    chelimsky = User.create!(first_name: "David", last_name: "Chelimsky")
-
-    expect(User.ordered_by_last_name).to eq([chelimsky, lindeman])
+RSpec.describe Post, :type => :model do
+  context "with 2 or more comments" do
+    it "orders them in reverse chronologically" do
+      post = Post.create!
+      comment1 = post.comments.create!(:body => "first comment")
+      comment2 = post.comments.create!(:body => "second comment")
+      expect(post.reload.comments).to eq([comment2, comment1])
+    end
   end
 end
 ```

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

@@ -20,18 +20,26 @@ 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')].each { |f| require f }
 
 <% if RSpec::Rails::FeatureCheck.can_maintain_test_schema? -%>
 # 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!
-
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+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 this line.
-ActiveRecord::Migration.check_pending!
-
+# 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? -%>

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

@@ -73,21 +73,31 @@ module Rspec
 
       # support for namespaced-resources
       def ns_file_name
-        ns_parts.empty? ? file_name : "#{ns_parts[0].underscore}_#{ns_parts[1].singularize.underscore}"
+        return file_name if ns_parts.empty?
+        "#{ns_prefix.map(&:underscore).join('/')}_#{ns_suffix.singularize.underscore}"
       end
 
       # support for namespaced-resources
       def ns_table_name
-        ns_parts.empty? ? table_name : "#{ns_parts[0].underscore}/#{ns_parts[1].tableize}"
+        return table_name if ns_parts.empty?
+        "#{ns_prefix.map(&:underscore).join('/')}/#{ns_suffix.tableize}"
       end
 
       def ns_parts
         @ns_parts ||= begin
-                        matches = generator_args[0].to_s.match(/\A(\w+)(?:\/|::)(\w+)/)
-                        matches ? [matches[1], matches[2]] : []
+                        parts = generator_args[0].split(/\/|::/)
+                        parts.size > 1 ? parts : []
                       end
       end
 
+      def ns_prefix
+        @ns_prefix ||= ns_parts[0..-2]
+      end
+
+      def ns_suffix
+        @ns_suffix ||= ns_parts[-1]
+      end
+
       def value_for(attribute)
         raw_value_for(attribute).inspect
       end

data/lib/generators/rspec/scaffold/templates/api_controller_spec.rb

@@ -51,7 +51,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 <% else -%>
       get :index, params: {}, session: valid_session
 <% end -%>
-      expect(response).to be_success
+      expect(response).to be_successful
     end
   end
 
@@ -64,7 +64,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 <% else -%>
       get :show, params: {id: <%= file_name %>.to_param}, session: valid_session
 <% end -%>
-      expect(response).to be_success
+      expect(response).to be_successful
     end
   end
 

data/lib/generators/rspec/scaffold/templates/controller_spec.rb

@@ -45,13 +45,13 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 <% unless options[:singleton] -%>
   describe "GET #index" do
     it "returns a success response" do
-      <%= file_name %> = <%= class_name %>.create! valid_attributes
+      <%= class_name %>.create! valid_attributes
 <% if Rails::VERSION::STRING < '5.0' -%>
       get :index, {}, valid_session
 <% else -%>
       get :index, params: {}, session: valid_session
 <% end -%>
-      expect(response).to be_success
+      expect(response).to be_successful
     end
   end
 
@@ -64,7 +64,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 <% else -%>
       get :show, params: {id: <%= file_name %>.to_param}, session: valid_session
 <% end -%>
-      expect(response).to be_success
+      expect(response).to be_successful
     end
   end
 
@@ -75,7 +75,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 <% else -%>
       get :new, params: {}, session: valid_session
 <% end -%>
-      expect(response).to be_success
+      expect(response).to be_successful
     end
   end
 
@@ -87,7 +87,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 <% else -%>
       get :edit, params: {id: <%= file_name %>.to_param}, session: valid_session
 <% end -%>
-      expect(response).to be_success
+      expect(response).to be_successful
     end
   end
 
@@ -120,7 +120,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 <% else -%>
         post :create, params: {<%= ns_file_name %>: invalid_attributes}, session: valid_session
 <% end -%>
-        expect(response).to be_success
+        expect(response).to be_successful
       end
     end
   end
@@ -161,7 +161,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:control
 <% else -%>
         put :update, params: {id: <%= file_name %>.to_param, <%= ns_file_name %>: invalid_attributes}, session: valid_session
 <% end -%>
-        expect(response).to be_success
+        expect(response).to be_successful
       end
     end
   end

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

@@ -3,7 +3,6 @@ require "rails_helper"
 <% module_namespacing do -%>
 RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:routing) %> do
   describe "routing" do
-
 <% unless options[:singleton] -%>
     it "routes to #index" do
       expect(:get => "/<%= ns_table_name %>").to route_to("<%= ns_table_name %>#index")
@@ -14,8 +13,8 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:routing
     it "routes to #new" do
       expect(:get => "/<%= ns_table_name %>/new").to route_to("<%= ns_table_name %>#new")
     end
-<% end -%>
 
+<% end -%>
     it "routes to #show" do
       expect(:get => "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#show", :id => "1")
     end
@@ -24,6 +23,7 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:routing
     it "routes to #edit" do
       expect(:get => "/<%= ns_table_name %>/1/edit").to route_to("<%= ns_table_name %>#edit", :id => "1")
     end
+
 <% end -%>
 
     it "routes to #create" do
@@ -43,7 +43,6 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:routing
     it "routes to #destroy" do
       expect(:delete => "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#destroy", :id => "1")
     end
-
   end
 end
 <% end -%>

data/lib/rspec-rails.rb

@@ -9,7 +9,11 @@ module RSpec
       # As of Rails 5.1.0 you can register directories to work with `rake notes`
       if ::Rails::VERSION::STRING >= '5.1'
         require 'rails/source_annotation_extractor'
-        SourceAnnotationExtractor::Annotation.register_directories("spec")
+        if ::Rails::VERSION::STRING >= '6.0'
+          ::Rails::SourceAnnotationExtractor::Annotation.register_directories("spec")
+        else
+          SourceAnnotationExtractor::Annotation.register_directories("spec")
+        end
       end
       # Rails-3.0.1 requires config.app_generators instead of 3.0.0's config.generators
       generators = config.respond_to?(:app_generators) ? config.app_generators : config.generators

data/lib/rspec/rails/example/system_example_group.rb

@@ -11,6 +11,9 @@ module RSpec
       include ActionDispatch::Assertions
       include ActionController::TemplateAssertions
 
+      # Special characters to translate into underscores for #method_name
+      CHARS_TO_TRANSLATE = ['/', '.', ':', ',', "'", '"', " "].freeze
+
       # @private
       module BlowAwayAfterTeardownHook
         # @private
@@ -33,9 +36,8 @@ module RSpec
       def method_name
         @method_name ||= [
           self.class.name.underscore,
-          RSpec.current_example.description.underscore,
-          rand(1000)
-        ].join("_").gsub(/[\/\.:, ]/, "_")
+          RSpec.current_example.description.underscore
+        ].join("_").tr(CHARS_TO_TRANSLATE.join, "_")[0...251] + "_#{rand(1000)}"
       end
 
       # Delegates to `Rails.application`.
@@ -48,9 +50,10 @@ module RSpec
           require 'capybara'
           require 'action_dispatch/system_test_case'
         # rubocop:disable Lint/HandleExceptions
-        rescue LoadError
+        rescue LoadError => e
           # rubocop:enable Lint/HandleExceptions
           abort """
+            LoadError: #{e.message}
             System test integration requires Rails >= 5.1 and has a hard
             dependency on a webserver and `capybara`, please add capybara to
             your Gemfile and configure a webserver (e.g. `Capybara.server =

data/lib/rspec/rails/example/view_example_group.rb

@@ -13,6 +13,14 @@ module RSpec
       include RSpec::Rails::ViewAssigns
       include RSpec::Rails::Matchers::RenderTemplate
 
+      # @private
+      module StubResolverCache
+        def self.resolver_for(hash)
+          @resolvers ||= {}
+          @resolvers[hash] ||= ActionView::FixtureResolver.new(hash)
+        end
+      end
+
       # @private
       module ClassMethods
         def _default_helper
@@ -84,7 +92,7 @@ module RSpec
         #
         #     stub_template("widgets/_widget.html.erb" => "This content.")
         def stub_template(hash)
-          view.view_paths.unshift(ActionView::FixtureResolver.new(hash))
+          view.view_paths.unshift(StubResolverCache.resolver_for(hash))
         end
 
         # Provides access to the params hash that will be available within the

data/lib/rspec/rails/fixture_file_upload_support.rb

@@ -7,8 +7,9 @@ module RSpec
     private
 
       def rails_fixture_file_wrapper
+        RailsFixtureFileWrapper.fixture_path = nil
         resolved_fixture_path = (fixture_path || RSpec.configuration.fixture_path || '')
-        RailsFixtureFileWrapper.fixture_path = File.join(resolved_fixture_path, '')
+        RailsFixtureFileWrapper.fixture_path = File.join(resolved_fixture_path, '') unless resolved_fixture_path.strip.empty?
         RailsFixtureFileWrapper.instance
       end
 
@@ -18,7 +19,7 @@ module RSpec
         class << self
           attr_reader :fixture_path
 
-          # Get the instance of wrapper
+          # Get instance of wrapper
           def instance
             @instance ||= new
           end

data/lib/rspec/rails/matchers/active_job.rb

@@ -118,7 +118,7 @@ module RSpec
             "#{message_expectation_modifier} #{@expected_number} jobs,".tap do |msg|
               msg << " with #{@args}," if @args.any?
               msg << " on queue #{@queue}," if @queue
-              msg << " at #{@at}," if @at
+              msg << " at #{@at.inspect}," if @at
               msg << " but enqueued #{@matching_jobs_count}"
             end
           end
@@ -149,12 +149,16 @@ module RSpec
 
           def serialized_attributes
             {}.tap do |attributes|
-              attributes[:at]    = @at.to_f if @at
+              attributes[:at]    = serialized_at if @at
               attributes[:queue] = @queue if @queue
               attributes[:job]   = @job if @job
             end
           end
 
+          def serialized_at
+            @at == :no_wait ? nil : @at.to_f
+          end
+
           def set_expected_number(relativity, count)
             @expectation_type = relativity
             @expected_number = case count
@@ -232,6 +236,17 @@ module RSpec
       #     expect {
       #       HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
       #     }.to have_enqueued_job.with(42).on_queue("low").at(Date.tomorrow.noon)
+      #
+      #     expect {
+      #       HelloJob.set(queue: "low").perform_later(42)
+      #     }.to have_enqueued_job.with(42).on_queue("low").at(:no_wait)
+      #
+      #     expect {
+      #       HelloJob.perform_later('rspec_rails', 'rails', 42)
+      #     }.to have_enqueued_job.with { |from, to, times|
+      #       # Perform more complex argument matching using dynamic arguments
+      #       expect(from).to include "_#{to}"
+      #     }
       def have_enqueued_job(job = nil)
         check_active_job_adapter
         ActiveJob::HaveEnqueuedJob.new(job)
@@ -264,6 +279,9 @@ module RSpec
       #
       #     HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
       #     expect(HelloJob).to have_been_enqueued.with(42).on_queue("low").at(Date.tomorrow.noon)
+      #
+      #     HelloJob.set(queue: "low").perform_later(42)
+      #     expect(HelloJob).to have_been_enqueued.with(42).on_queue("low").at(:no_wait)
       def have_been_enqueued
         check_active_job_adapter
         ActiveJob::HaveBeenEnqueued.new

data/lib/rspec/rails/matchers/have_http_status.rb

@@ -243,7 +243,11 @@ module RSpec
           #   code "group"
           # @see https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/testing/test_response.rb `ActionDispatch::TestResponse`
           def self.valid_statuses
-            [:error, :success, :missing, :redirect]
+            [
+              :error, :success, :missing,
+              :server_error, :successful, :not_found,
+              :redirect
+            ]
           end
 
           def initialize(type)
@@ -256,11 +260,11 @@ module RSpec
           end
 
           # @return [Boolean] `true` if Rack's associated numeric HTTP code matched
-          #   the `response` code
+          #   the `response` code or the named response status
           def matches?(response)
             test_response = as_test_response(response)
             @actual = test_response.response_code
-            test_response.send("#{expected}?")
+            check_expected_status(test_response, expected)
           rescue TypeError => _ignored
             @invalid_response = response
             false
@@ -283,6 +287,28 @@ module RSpec
             "expected the response not to have #{type_message} but it was #{actual}"
           end
 
+        protected
+
+          if 5 < ::Rails::VERSION::MAJOR ||
+             (::Rails::VERSION::MAJOR == 5 && 2 <= ::Rails::VERSION::MINOR)
+            RESPONSE_METHODS = {
+              :success => 'successful',
+              :error => 'server_error',
+              :missing => 'not_found'
+            }.freeze
+          else
+            RESPONSE_METHODS = {
+              :successful => 'success',
+              :server_error => 'error',
+              :not_found => 'missing'
+            }.freeze
+          end
+
+          def check_expected_status(test_response, expected)
+            test_response.send(
+              "#{RESPONSE_METHODS.fetch(expected, expected)}?")
+          end
+
         private
 
           # @return [String] formating the expected status and associated code(s)
@@ -316,11 +342,11 @@ module RSpec
             # @see https://github.com/rails/rails/blob/ca200378/actionpack/lib/action_dispatch/http/response.rb#L74
             # @see https://github.com/rack/rack/blob/ce4a3959/lib/rack/response.rb#L119-L122
             @type_codes ||= case expected
-                            when :error
+                            when :error, :server_error
                               "5xx"
-                            when :success
+                            when :success, :successful
                               "2xx"
-                            when :missing
+                            when :missing, :not_found
                               "404"
                             when :redirect
                               "3xx"

data/lib/rspec/rails/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec Rails.
     module Version
       # Current version of RSpec Rails, in semantic versioning format.
-      STRING = '3.7.2'
+      STRING = '3.8.0'
     end
   end
 end

data/lib/rspec/rails/view_rendering.rb

@@ -137,7 +137,7 @@ module RSpec
         before do
           unless render_views?
             @_original_path_set = controller.class.view_paths
-            path_set = @_original_path_set.map { |resolver| RESOLVER_CACHE[resolver.to_s] }
+            path_set = @_original_path_set.map { |resolver| RESOLVER_CACHE[resolver] }
 
             controller.class.view_paths = path_set
             controller.extend(EmptyTemplates)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.8.0
 platform: ruby
 authors:
 - David Chelimsky
@@ -44,7 +44,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2018-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,56 +94,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rspec-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -294,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: RSpec for Rails