rspec-rails 3.3.3 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de09692dd4022b2aacb0256360abec30bdb763d7
-  data.tar.gz: 1de8362305e49f4d154567baee5e20f8fffecd44
+  metadata.gz: 01a00f10eee52408429aac920152745edbb5fbe6
+  data.tar.gz: 9f0fb99df0c8eb32b823dff0496dca286bd2a36a
 SHA512:
-  metadata.gz: fae9f7f42ac82a740bdcda1f2b1afc2f13bb820632418868ef25167982edd6ff9235d7f2e0d73cfbf982381cd6fd5bd84d97a50c67c97227710657e4af28858a
-  data.tar.gz: da319d09ca3fdebf3bfcc60e837232815d3a7edb55fac9cfea5b75a3c1e523e6b9244434401aadf71cc65fb772cfed8f804ac46a16547081f3c1b4cf5e5b8d6b
+  metadata.gz: ebc16491b83addf8ada3e9ea5f030da43bf01e6bb39c6d1a5920f0c4acbc2f482fa55dd8c23c16b4f2419d5d74e1005cfc1c5b44ff5cda7dcd8584dfe610d1fa
+  data.tar.gz: 1648b996f98c9232dee112034ae12e569a9105cccb30dca95140727d5b8f0df4c8fd5945592fc0a5608cfa128f4e195568010a43874737250689ee55b6862ed1

data/.document

@@ -1,5 +1,5 @@
 lib/**/*.rb
 -
 README.md
-License.txt
+LICENSE.md
 Changelog.md

data/.yardopts

@@ -7,5 +7,5 @@
 --template-path yard/template/
 -
 Changelog.md
-License.txt
+LICENSE.md
 Capybara.md

data/Changelog.md

@@ -1,3 +1,24 @@
+### 3.4.0 / 2015-11-11
+[Full Changelog](http://github.com/rspec/rspec-rails/compare/v3.3.3...v3.4.0)
+
+Enhancements:
+
+* Improved the failure message for `have_rendered` matcher on a redirect
+  response. (Alex Egan, #1440)
+* Add configuration option to filter out Rails gems from backtraces.
+  (Bradley Schaefer, #1458)
+* Enable resolver cache for view specs for a large speed improvement
+  (Chris Zetter, #1452)
+* Add `have_enqueued_job` matcher for checking if a block has queued jobs.
+  (Wojciech Wnętrzak, #1464)
+
+Bug Fixes:
+
+* Fix another load order issued which causes an undefined method `fixture_path` error
+  when loading rspec-rails after a spec has been created. (Nikki Murray, #1430)
+* Removed incorrect surrounding whitespace in the rspec-rails backtrace
+  exclusion pattern for its own `lib` code. (Jam Black, #1439)
+
 ### 3.3.3 / 2015-07-15
 [Full Changelog](http://github.com/rspec/rspec-rails/compare/v3.3.2...v3.3.3)
 

data/{License.txt → License.md}

@@ -1,7 +1,9 @@
-(The MIT License)
+The MIT License (MIT)
+=====================
 
-Copyright (c) 2012 David Chelimsky, Andy Lindeman
-Copyright (c) 2006 David Chelimsky, The RSpec Development Team
+* Copyright © 2015 David Chelimsky, Aaron Kromer
+* Copyright © 2012 David Chelimsky, Andy Lindeman
+* Copyright © 2006 David Chelimsky, The RSpec Development Team
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -105,6 +105,24 @@ running `rails generate rspec:model` will generate a model spec. For more
 information, see [list of all
 generators](https://www.relishapp.com/rspec/rspec-rails/docs/generators).
 
+## Contributing
+
+Once you've set up the environment, you'll need to cd into the working
+directory of whichever repo you want to work in. From there you can run the
+specs and cucumber features, and make patches.
+
+NOTE: You do not need to use rspec-dev to work on a specific RSpec repo. You
+can treat each RSpec repo as an independent project.
+Please see the following files:
+
+For `rspec-rails`-specific development information, see
+
+- [Build details](BUILD_DETAIL.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Detailed contributing guide](CONTRIBUTING.md)
+- [Development setup guide](DEVELOPMENT.md)
+
+
 ## Model Specs
 
 Use model specs to describe behavior of models (usually ActiveRecord-based) in
@@ -536,19 +554,13 @@ However, you must first clear the task that rspec-rails defined:
 task("spec").clear
 ```
 
-## Contribute
-
-See [http://github.com/rspec/rspec-dev](http://github.com/rspec/rspec-dev).
-
-For `rspec-rails`-specific development information, see
-[README_DEV](https://github.com/rspec/rspec-rails/blob/master/README_DEV.md).
 
 ## Also see
 
-* [http://github.com/rspec/rspec](http://github.com/rspec/rspec)
-* [http://github.com/rspec/rspec-core](http://github.com/rspec/rspec-core)
-* [http://github.com/rspec/rspec-expectations](http://github.com/rspec/rspec-expectations)
-* [http://github.com/rspec/rspec-mocks](http://github.com/rspec/rspec-mocks)
+* [https://github.com/rspec/rspec](https://github.com/rspec/rspec)
+* [https://github.com/rspec/rspec-core](https://github.com/rspec/rspec-core)
+* [https://github.com/rspec/rspec-expectations](https://github.com/rspec/rspec-expectations)
+* [https://github.com/rspec/rspec-mocks](https://github.com/rspec/rspec-mocks)
 
 ## Feature Requests & Bugs
 

data/lib/generators/rspec.rb

@@ -1,6 +1,7 @@
 require 'rails/generators/named_base'
 require 'rspec/rails/feature_check'
 
+# @private
 # Weirdly named generators namespace (should be `RSpec`) for compatability with
 # rails loading.
 module Rspec

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

@@ -23,7 +23,7 @@ require 'rspec/rails'
 # Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
 
 <% if RSpec::Rails::FeatureCheck.can_maintain_test_schema? -%>
-# Checks for pending migrations before tests are run.
+# Checks for pending migration and applies them before tests are run.
 # If you are not using ActiveRecord, you can remove this line.
 ActiveRecord::Migration.maintain_test_schema!
 
@@ -58,4 +58,9 @@ RSpec.configure do |config|
   # 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

data/lib/rspec/rails/configuration.rb

@@ -39,23 +39,7 @@ module RSpec
     # @private
     def self.initialize_configuration(config)
       config.backtrace_exclusion_patterns << /vendor\//
-      config.backtrace_exclusion_patterns << %r{ lib/rspec/rails }
-
-      config.include RSpec::Rails::ControllerExampleGroup, :type => :controller
-      config.include RSpec::Rails::HelperExampleGroup,     :type => :helper
-      config.include RSpec::Rails::ModelExampleGroup,      :type => :model
-      config.include RSpec::Rails::RequestExampleGroup,    :type => :request
-      config.include RSpec::Rails::RoutingExampleGroup,    :type => :routing
-      config.include RSpec::Rails::ViewExampleGroup,       :type => :view
-      config.include RSpec::Rails::FeatureExampleGroup,    :type => :feature
-
-      if defined?(ActionMailer)
-        config.include RSpec::Rails::MailerExampleGroup, :type => :mailer
-      end
-
-      if defined?(ActiveJob)
-        config.include RSpec::Rails::JobExampleGroup, :type => :job
-      end
+      config.backtrace_exclusion_patterns << %r{lib/rspec/rails}
 
       # controller settings
       config.add_setting :infer_base_class_for_anonymous_controllers, :default => true
@@ -105,6 +89,29 @@ module RSpec
             end
           end
         end
+
+        # Adds exclusion filters for gems included with Rails
+        def filter_rails_from_backtrace!
+          filter_gems_from_backtrace "actionmailer", "actionpack", "actionview"
+          filter_gems_from_backtrace "activemodel", "activerecord",
+                                     "activesupport", "activejob"
+        end
+      end
+
+      config.include RSpec::Rails::ControllerExampleGroup, :type => :controller
+      config.include RSpec::Rails::HelperExampleGroup,     :type => :helper
+      config.include RSpec::Rails::ModelExampleGroup,      :type => :model
+      config.include RSpec::Rails::RequestExampleGroup,    :type => :request
+      config.include RSpec::Rails::RoutingExampleGroup,    :type => :routing
+      config.include RSpec::Rails::ViewExampleGroup,       :type => :view
+      config.include RSpec::Rails::FeatureExampleGroup,    :type => :feature
+
+      if defined?(ActionMailer)
+        config.include RSpec::Rails::MailerExampleGroup, :type => :mailer
+      end
+
+      if defined?(ActiveJob)
+        config.include RSpec::Rails::JobExampleGroup, :type => :job
       end
     end
 

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

@@ -5,6 +5,7 @@ module RSpec
       ActionDispatch::Assertions::RoutingAssertions
     )
 
+    # @api public
     # Container module for controller spec functionality.
     module ControllerExampleGroup
       extend ActiveSupport::Concern

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

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container module for routing spec functionality.
     module FeatureExampleGroup
       extend ActiveSupport::Concern

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

@@ -2,6 +2,7 @@ require 'rspec/rails/view_assigns'
 
 module RSpec
   module Rails
+    # @api public
     # Container module for helper specs.
     module HelperExampleGroup
       extend ActiveSupport::Concern

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

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container module for job spec functionality. It is only available if
     # ActiveJob has been loaded before it.
     module JobExampleGroup

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

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container module for mailer spec functionality. It is only available if
     # ActionMailer has been loaded before it.
     module MailerExampleGroup

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

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container class for model spec functionality. Does not provide anything
     # special over the common RailsExampleGroup currently.
     module ModelExampleGroup

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

@@ -4,6 +4,7 @@ require 'rspec/rails/matchers'
 
 module RSpec
   module Rails
+    # @api public
     # Common rails example functionality.
     module RailsExampleGroup
       extend ActiveSupport::Concern

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

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # @api public
     # Container class for request spec functionality.
     module RequestExampleGroup
       extend ActiveSupport::Concern

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

@@ -7,6 +7,7 @@ module RSpec
       ActionDispatch::Assertions::RoutingAssertions
     )
 
+    # @api public
     # Container module for routing spec functionality.
     module RoutingExampleGroup
       extend ActiveSupport::Concern

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

@@ -2,6 +2,7 @@ require 'rspec/rails/view_assigns'
 
 module RSpec
   module Rails
+    # @api public
     # Container class for view spec functionality.
     module ViewExampleGroup
       extend ActiveSupport::Concern
@@ -114,7 +115,7 @@ module RSpec
 
             render_options = { :template => template }
             render_options[:handlers] = [handler] if handler
-            render_options[:formats] = [format] if format
+            render_options[:formats] = [format.to_sym] if format
             render_options[:locales] = [locale] if locale
 
             render_options
@@ -155,9 +156,6 @@ module RSpec
             view.lookup_context.prefixes << _controller_path
           end
 
-          # fixes bug with differing formats
-          view.lookup_context.view_paths.each(&:clear_cache)
-
           controller.controller_path = _controller_path
           controller.request.path_parameters[:controller] = _controller_path
           controller.request.path_parameters[:action]     = _inferred_action unless _inferred_action =~ /^_/

data/lib/rspec/rails/feature_check.rb

@@ -1,4 +1,3 @@
-# @api private
 module RSpec
   module Rails
     # @private

data/lib/rspec/rails/matchers.rb

@@ -1,8 +1,10 @@
 require 'rspec/core/warnings'
 require 'rspec/expectations'
+require 'rspec/rails/feature_check'
 
 module RSpec
   module Rails
+    # @api public
     # Container module for Rails specific matchers.
     module Matchers
     end
@@ -17,3 +19,6 @@ require 'rspec/rails/matchers/be_a_new'
 require 'rspec/rails/matchers/relation_match_array'
 require 'rspec/rails/matchers/be_valid'
 require 'rspec/rails/matchers/have_http_status'
+if RSpec::Rails::FeatureCheck.has_active_job?
+  require 'rspec/rails/matchers/active_job'
+end

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

@@ -0,0 +1,165 @@
+require "active_job/base"
+require "active_job/arguments"
+
+module RSpec
+  module Rails
+    module Matchers
+      # Namespace for various implementations of ActiveJob features
+      #
+      # @api private
+      module ActiveJob
+        # @private
+        class HaveEnqueuedJob < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(job)
+            @job = job
+            @args = []
+            @queue = nil
+            @at = nil
+            set_expected_number(:exactly, 1)
+          end
+
+          def matches?(proc)
+            raise ArgumentError, "have_enqueued_jobs only supports block expectations" unless Proc === proc
+
+            original_enqueued_jobs_count = queue_adapter.enqueued_jobs.count
+            proc.call
+            in_block_jobs = queue_adapter.enqueued_jobs.drop(original_enqueued_jobs_count)
+
+            @matching_jobs_count = in_block_jobs.count do |job|
+              serialized_attributes.all? { |key, value| value == job[key] }
+            end
+
+            case @expectation_type
+            when :exactly then @expected_number == @matching_jobs_count
+            when :at_most then @expected_number >= @matching_jobs_count
+            when :at_least then @expected_number <= @matching_jobs_count
+            end
+          end
+
+          def with(*args)
+            @args = args
+            self
+          end
+
+          def on_queue(queue)
+            @queue = queue
+            self
+          end
+
+          def at(date)
+            @at = date
+            self
+          end
+
+          def exactly(count)
+            set_expected_number(:exactly, count)
+            self
+          end
+
+          def at_least(count)
+            set_expected_number(:at_least, count)
+            self
+          end
+
+          def at_most(count)
+            set_expected_number(:at_most, count)
+            self
+          end
+
+          def times
+            self
+          end
+
+          def failure_message
+            "expected to enqueue #{base_message}"
+          end
+
+          def failure_message_when_negated
+            "expected not to enqueue #{base_message}"
+          end
+
+          def message_expectation_modifier
+            case @expectation_type
+            when :exactly then "exactly"
+            when :at_most then "at most"
+            when :at_least then "at least"
+            end
+          end
+
+          def supports_block_expectations?
+            true
+          end
+
+        private
+
+          def base_message
+            "#{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 << " but enqueued #{@matching_jobs_count}"
+            end
+          end
+
+          def serialized_attributes
+            {}.tap do |attributes|
+              attributes[:args]  = ::ActiveJob::Arguments.serialize(@args) if @args.any?
+              attributes[:at]    = @at.to_f if @at
+              attributes[:queue] = @queue if @queue
+              attributes[:job]   = @job if @job
+            end
+          end
+
+          def set_expected_number(relativity, count)
+            @expectation_type = relativity
+            @expected_number = case count
+                               when :once then 1
+                               when :twice then 2
+                               when :thrice then 3
+                               else Integer(count)
+                               end
+          end
+
+          def queue_adapter
+            ::ActiveJob::Base.queue_adapter
+          end
+        end
+      end
+
+      # @api public
+      # Passess if `count` of jobs were enqueued inside block
+      #
+      # @example
+      #     expect {
+      #       HeavyLiftingJob.perform_later
+      #     }.to have_enqueued_job
+      #
+      #     expect {
+      #       HelloJob.perform_later
+      #       HeavyLiftingJob.perform_later
+      #     }.to have_enqueued_job(HelloJob).exactly(:once)
+      #
+      #     expect {
+      #       HelloJob.perform_later
+      #       HelloJob.perform_later
+      #       HelloJob.perform_later
+      #     }.to have_enqueued_job(HelloJob).at_least(2).times
+      #
+      #     expect {
+      #       HelloJob.perform_later
+      #     }.to have_enqueued_job(HelloJob).at_most(:twice)
+      #
+      #     expect {
+      #       HelloJob.perform_later
+      #       HeavyLiftingJob.perform_later
+      #     }.to have_enqueued_job(HelloJob).and have_enqueued_job(HeavyLiftingJob)
+      #
+      #     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)
+      def have_enqueued_job(job = nil)
+        ActiveJob::HaveEnqueuedJob.new(job)
+      end
+    end
+  end
+end

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

@@ -60,6 +60,7 @@ module RSpec
         end
       end
 
+      # @api public
       # Passes if actual is an instance of `model_class` and returns `false` for
       # `persisted?`. Typically used to specify instance variables assigned to
       # views by controller actions

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

@@ -16,6 +16,7 @@ module RSpec
         end
       end
 
+      # @api public
       # Passes if actual returns `false` for `persisted?`.
       #
       # @example

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

@@ -33,6 +33,7 @@ module RSpec
         end
       end
 
+      # @api public
       # Passes if the given model instance's `valid?` method is true, meaning
       # all of the `ActiveModel::Validations` passed and no errors exist. If a
       # message is not given, a default message is shown listing each error.

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

@@ -9,18 +9,37 @@ module RSpec
             @expected = Symbol === expected ? expected.to_s : expected
             @message = message
             @scope = scope
+            @redirect_is = nil
           end
 
           # @api private
           def matches?(*)
-            match_unless_raises ActiveSupport::TestCase::Assertion do
+            match_check = match_unless_raises ActiveSupport::TestCase::Assertion do
               @scope.assert_template expected, @message
             end
+            check_redirect unless match_check
+            match_check
+          end
+
+          # Uses normalize_argument_to_redirection to find and format
+          # the redirect location. normalize_argument_to_redirection is private
+          # in ActionDispatch::Assertions::ResponseAssertions so we call it
+          # here using #send. This will keep the error message format consistent
+          # @api private
+          def check_redirect
+            response = @scope.response
+            return unless response.respond_to?(:redirect?) && response.redirect?
+            @redirect_is = @scope.send(:normalize_argument_to_redirection, response.location)
           end
 
           # @api private
           def failure_message
-            rescued_exception.message
+            if @redirect_is
+              rescued_exception.message[/.* but /] +
+                "was a redirect to <#{@redirect_is}>"
+            else
+              rescued_exception.message
+            end
           end
 
           # @api private

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.3.3'
+      STRING = '3.4.0'
     end
   end
 end

data/lib/rspec/rails/view_rendering.rb

@@ -2,6 +2,7 @@ require 'action_view/testing/resolvers'
 
 module RSpec
   module Rails
+    # @api public
     # Helpers for optionally rendering views in controller specs.
     module ViewRendering
       extend ActiveSupport::Concern

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.4.0
 platform: ruby
 authors:
 - David Chelimsky
@@ -44,7 +44,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,56 +112,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rspec-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -228,7 +228,7 @@ files:
 - ".yardopts"
 - Capybara.md
 - Changelog.md
-- License.txt
+- License.md
 - README.md
 - lib/generators/rspec.rb
 - lib/generators/rspec/controller/controller_generator.rb
@@ -284,6 +284,7 @@ files:
 - lib/rspec/rails/feature_check.rb
 - lib/rspec/rails/fixture_support.rb
 - lib/rspec/rails/matchers.rb
+- lib/rspec/rails/matchers/active_job.rb
 - lib/rspec/rails/matchers/be_a_new.rb
 - lib/rspec/rails/matchers/be_new_record.rb
 - lib/rspec/rails/matchers/be_valid.rb