rspec-rails 4.0.0.beta3 → 4.0.0

data/lib/rspec/rails/fixture_support.rb

@@ -5,52 +5,58 @@ module RSpec
       if defined?(ActiveRecord::TestFixtures)
         extend ActiveSupport::Concern
         include RSpec::Rails::SetupAndTeardownAdapter
-        include RSpec::Rails::MinitestLifecycleAdapter if ::ActiveRecord::VERSION::STRING > '4'
+        include RSpec::Rails::MinitestLifecycleAdapter
         include RSpec::Rails::MinitestAssertionAdapter
         include ActiveRecord::TestFixtures
 
         included do
-          # TODO: (DC 2011-06-25) this is necessary because fixture_file_upload
-          # accesses fixture_path directly on ActiveSupport::TestCase. This is
-          # fixed in rails by https://github.com/rails/rails/pull/1861, which
-          # should be part of the 3.1 release, at which point we can include
-          # these lines for rails < 3.1.
-          ActiveSupport::TestCase.class_exec do
-            include ActiveRecord::TestFixtures
+          if RSpec.configuration.use_active_record?
+            include Fixtures
+
             self.fixture_path = RSpec.configuration.fixture_path
-          end
-          # /TODO
+            if ::Rails::VERSION::STRING > '5'
+              self.use_transactional_tests = RSpec.configuration.use_transactional_fixtures
+            else
+              self.use_transactional_fixtures = RSpec.configuration.use_transactional_fixtures
+            end
+            self.use_instantiated_fixtures = RSpec.configuration.use_instantiated_fixtures
 
-          self.fixture_path = RSpec.configuration.fixture_path
-          if ::Rails::VERSION::STRING > '5'
-            self.use_transactional_tests = RSpec.configuration.use_transactional_fixtures
-          else
-            self.use_transactional_fixtures = RSpec.configuration.use_transactional_fixtures
+            fixtures RSpec.configuration.global_fixtures if RSpec.configuration.global_fixtures
           end
-          self.use_instantiated_fixtures  = RSpec.configuration.use_instantiated_fixtures
+        end
 
-          def self.fixtures(*args)
-            orig_methods = private_instance_methods
-            super.tap do
-              new_methods = private_instance_methods - orig_methods
-              new_methods.each do |method_name|
-                proxy_method_warning_if_called_in_before_context_scope(method_name)
+        module Fixtures
+          extend ActiveSupport::Concern
+
+          class_methods do
+            def fixtures(*args)
+              orig_methods = private_instance_methods
+              super.tap do
+                new_methods = private_instance_methods - orig_methods
+                new_methods.each do |method_name|
+                  proxy_method_warning_if_called_in_before_context_scope(method_name)
+                end
               end
             end
-          end
 
-          def self.proxy_method_warning_if_called_in_before_context_scope(method_name)
-            orig_implementation = instance_method(method_name)
-            define_method(method_name) do |*args, &blk|
-              if inspect.include?("before(:context)")
-                RSpec.warn_with("Calling fixture method in before :context ")
-              else
-                orig_implementation.bind(self).call(*args, &blk)
+            def proxy_method_warning_if_called_in_before_context_scope(method_name)
+              orig_implementation = instance_method(method_name)
+              define_method(method_name) do |*args, &blk|
+                if inspect.include?("before(:context)")
+                  RSpec.warn_with("Calling fixture method in before :context ")
+                else
+                  orig_implementation.bind(self).call(*args, &blk)
+                end
               end
             end
           end
 
-          fixtures RSpec.configuration.global_fixtures if RSpec.configuration.global_fixtures
+          if ::Rails.version.to_f >= 6.1
+            # @private return the example name for TestFixtures
+            def name
+              @example
+            end
+          end
         end
       end
     end

data/lib/rspec/rails/matchers/action_cable/have_broadcasted_to.rb

@@ -8,15 +8,15 @@ module RSpec
           def initialize(target, channel:)
             @target = target
             @channel = channel
-            @block = Proc.new {}
+            @block = proc { }
             @data = nil
             set_expected_number(:exactly, 1)
           end
 
-          def with(data = nil)
+          def with(data = nil, &block)
             @data = data
             @data = @data.with_indifferent_access if @data.is_a?(Hash)
-            @block = Proc.new if block_given?
+            @block = block if block
             self
           end
 

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

@@ -48,7 +48,7 @@ module RSpec
       def have_broadcasted_to(target = nil)
         check_action_cable_adapter
 
-        ActionCable::HaveBroadcastedTo.new(target, :channel => described_class)
+        ActionCable::HaveBroadcastedTo.new(target, channel: described_class)
       end
       alias_method :broadcast_to, :have_broadcasted_to
 

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

@@ -15,7 +15,7 @@ module RSpec
             @args = []
             @queue = nil
             @at = nil
-            @block = Proc.new {}
+            @block = proc { }
             set_expected_number(:exactly, 1)
           end
 
@@ -26,7 +26,7 @@ module RSpec
           end
 
           def on_queue(queue)
-            @queue = queue
+            @queue = queue.to_s
             self
           end
 
@@ -67,7 +67,7 @@ module RSpec
           end
 
           def failure_message
-            "expected to enqueue #{base_message}".tap do |msg|
+            "expected to #{self.class::FAILURE_MESSAGE_EXPECTATION_ACTION} #{base_message}".tap do |msg|
               if @unmatching_jobs.any?
                 msg << "\nQueued jobs:"
                 @unmatching_jobs.each do |job|
@@ -78,7 +78,7 @@ module RSpec
           end
 
           def failure_message_when_negated
-            "expected not to enqueue #{base_message}"
+            "expected not to #{self.class::FAILURE_MESSAGE_EXPECTATION_ACTION} #{base_message}"
           end
 
           def message_expectation_modifier
@@ -97,7 +97,7 @@ module RSpec
 
           def check(jobs)
             @matching_jobs, @unmatching_jobs = jobs.partition do |job|
-              if job_match?(job) && arguments_match?(job) && other_attributes_match?(job)
+              if job_match?(job) && arguments_match?(job) && queue_match?(job) && at_match?(job)
                 args = deserialize_arguments(job)
                 @block.call(*args)
                 true
@@ -119,7 +119,7 @@ module RSpec
               msg << " with #{@args}," if @args.any?
               msg << " on queue #{@queue}," if @queue
               msg << " at #{@at.inspect}," if @at
-              msg << " but enqueued #{@matching_jobs_count}"
+              msg << " but #{self.class::MESSAGE_EXPECTATION_ACTION} #{@matching_jobs_count}"
             end
           end
 
@@ -148,19 +148,18 @@ module RSpec
             end
           end
 
-          def other_attributes_match?(job)
-            serialized_attributes.all? { |key, value| value == job[key] }
-          end
+          def queue_match?(job)
+            return true unless @queue
 
-          def serialized_attributes
-            {}.tap do |attributes|
-              attributes[:at]    = serialized_at if @at
-              attributes[:queue] = @queue if @queue
-            end
+            @queue == job[:queue]
           end
 
-          def serialized_at
-            @at == :no_wait ? nil : @at.to_f
+          def at_match?(job)
+            return true unless @at
+            return job[:at].nil? if @at == :no_wait
+            return false unless job[:at]
+
+            values_match?(@at, Time.at(job[:at]))
           end
 
           def set_expected_number(relativity, count)
@@ -194,6 +193,9 @@ module RSpec
 
         # @private
         class HaveEnqueuedJob < Base
+          FAILURE_MESSAGE_EXPECTATION_ACTION = 'enqueue'.freeze
+          MESSAGE_EXPECTATION_ACTION = 'enqueued'.freeze
+
           def initialize(job)
             super()
             @job = job
@@ -218,6 +220,9 @@ module RSpec
 
         # @private
         class HaveBeenEnqueued < Base
+          FAILURE_MESSAGE_EXPECTATION_ACTION = 'enqueue'.freeze
+          MESSAGE_EXPECTATION_ACTION = 'enqueued'.freeze
+
           def matches?(job)
             @job = job
             check(queue_adapter.enqueued_jobs)
@@ -229,6 +234,38 @@ module RSpec
             !matches?(proc)
           end
         end
+
+        # @private
+        class HavePerformedJob < Base
+          FAILURE_MESSAGE_EXPECTATION_ACTION = 'perform'.freeze
+          MESSAGE_EXPECTATION_ACTION = 'performed'.freeze
+
+          def initialize(job)
+            super()
+            @job = job
+          end
+
+          def matches?(proc)
+            raise ArgumentError, "have_performed_job only supports block expectations" unless Proc === proc
+
+            original_performed_jobs_count = queue_adapter.performed_jobs.count
+            proc.call
+            in_block_jobs = queue_adapter.performed_jobs.drop(original_performed_jobs_count)
+
+            check(in_block_jobs)
+          end
+        end
+
+        # @private
+        class HaveBeenPerformed < Base
+          FAILURE_MESSAGE_EXPECTATION_ACTION = 'perform'.freeze
+          MESSAGE_EXPECTATION_ACTION = 'performed'.freeze
+
+          def matches?(job)
+            @job = job
+            check(queue_adapter.performed_jobs)
+          end
+        end
       end
 
       # @api public
@@ -316,6 +353,79 @@ module RSpec
         ActiveJob::HaveBeenEnqueued.new
       end
 
+      # @api public
+      # Passes if a job has been performed inside block. May chain at_least, at_most or exactly to specify a number of times.
+      #
+      # @example
+      #     expect {
+      #       perform_jobs { HeavyLiftingJob.perform_later }
+      #     }.to have_performed_job
+      #
+      #     expect {
+      #       perform_jobs {
+      #         HelloJob.perform_later
+      #         HeavyLiftingJob.perform_later
+      #       }
+      #     }.to have_performed_job(HelloJob).exactly(:once)
+      #
+      #     expect {
+      #       perform_jobs { 3.times { HelloJob.perform_later } }
+      #     }.to have_performed_job(HelloJob).at_least(2).times
+      #
+      #     expect {
+      #       perform_jobs { HelloJob.perform_later }
+      #     }.to have_performed_job(HelloJob).at_most(:twice)
+      #
+      #     expect {
+      #       perform_jobs {
+      #         HelloJob.perform_later
+      #         HeavyLiftingJob.perform_later
+      #       }
+      #     }.to have_performed_job(HelloJob).and have_performed_job(HeavyLiftingJob)
+      #
+      #     expect {
+      #       perform_jobs {
+      #         HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
+      #       }
+      #     }.to have_performed_job.with(42).on_queue("low").at(Date.tomorrow.noon)
+      def have_performed_job(job = nil)
+        check_active_job_adapter
+        ActiveJob::HavePerformedJob.new(job)
+      end
+      alias_method :perform_job, :have_performed_job
+
+      # @api public
+      # Passes if a job has been performed. May chain at_least, at_most or exactly to specify a number of times.
+      #
+      # @example
+      #     before do
+      #       ActiveJob::Base.queue_adapter.performed_jobs.clear
+      #       ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
+      #       ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
+      #     end
+      #
+      #     HeavyLiftingJob.perform_later
+      #     expect(HeavyLiftingJob).to have_been_performed
+      #
+      #     HelloJob.perform_later
+      #     HeavyLiftingJob.perform_later
+      #     expect(HeavyLiftingJob).to have_been_performed.exactly(:once)
+      #
+      #     3.times { HelloJob.perform_later }
+      #     expect(HelloJob).to have_been_performed.at_least(2).times
+      #
+      #     HelloJob.perform_later
+      #     HeavyLiftingJob.perform_later
+      #     expect(HelloJob).to have_been_performed
+      #     expect(HeavyLiftingJob).to have_been_performed
+      #
+      #     HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
+      #     expect(HelloJob).to have_been_performed.with(42).on_queue("low").at(Date.tomorrow.noon)
+      def have_been_performed
+        check_active_job_adapter
+        ActiveJob::HaveBeenPerformed.new
+      end
+
     private
 
       # @private

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

@@ -1,7 +1,9 @@
 module RSpec
   module Rails
     module Matchers
-      # @ api private
+      # @api private
+      #
+      # Base class to build matchers. Should not be instantiated directly.
       class BaseMatcher
         include RSpec::Matchers::Composable
 
@@ -119,15 +121,7 @@ module RSpec
           raise "#{self.class.name} needs to supply#{ivar_list}"
         end
 
-        if RUBY_VERSION.to_f < 1.9
-          # :nocov:
-          def present_ivars
-            instance_variables.map(&:to_sym)
-          end
-          # :nocov:
-        else
-          alias present_ivars instance_variables
-        end
+        alias present_ivars instance_variables
 
         # @private
         module HashFormatting

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

@@ -1,4 +1,7 @@
-require "rspec/mocks"
+# We require the minimum amount of rspec-mocks possible to avoid
+# conflicts with other mocking frameworks.
+# See: https://github.com/rspec/rspec-rails/issues/2252
+require "rspec/mocks/argument_matchers"
 require "rspec/rails/matchers/active_job"
 
 module RSpec
@@ -11,7 +14,7 @@ module RSpec
       class HaveEnqueuedMail < ActiveJob::HaveEnqueuedJob
         MAILER_JOB_METHOD = 'deliver_now'.freeze
 
-        include RSpec::Mocks::ExampleMethods
+        include RSpec::Mocks::ArgumentMatchers
 
         def initialize(mailer_class, method_name)
           super(nil)
@@ -90,7 +93,7 @@ module RSpec
         end
 
         def yield_mail_args(block)
-          Proc.new { |*job_args| block.call(*(job_args - base_mailer_args)) }
+          proc { |*job_args| block.call(*(job_args - base_mailer_args)) }
         end
 
         def check_active_job_adapter

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

@@ -73,7 +73,7 @@ module RSpec
         # @example
         #   expect(response).to have_http_status(404)
         #
-        # @see RSpec::Rails::Matchers.have_http_status
+        # @see RSpec::Rails::Matchers#have_http_status
         class NumericCode < RSpec::Rails::Matchers::BaseMatcher
           include HaveHttpStatus
 
@@ -123,7 +123,7 @@ module RSpec
         # @example
         #   expect(response).to have_http_status(:created)
         #
-        # @see RSpec::Rails::Matchers.have_http_status
+        # @see RSpec::Rails::Matchers#have_http_status
         # @see https://github.com/rack/rack/blob/master/lib/rack/utils.rb `Rack::Utils::SYMBOL_TO_STATUS_CODE`
         class SymbolicStatus < RSpec::Rails::Matchers::BaseMatcher
           include HaveHttpStatus
@@ -236,8 +236,8 @@ module RSpec
         #   expect(response).to have_http_status(:missing)
         #   expect(response).to have_http_status(:redirect)
         #
-        # @see RSpec::Rails::Matchers.have_http_status
-        # @see ActionDispatch::TestResponse
+        # @see RSpec::Rails::Matchers#have_http_status
+        # @see https://github.com/rails/rails/blob/6-0-stable/actionpack/lib/action_dispatch/testing/test_response.rb `ActionDispatch::TestResponse`
         class GenericStatus < RSpec::Rails::Matchers::BaseMatcher
           include HaveHttpStatus
 
@@ -293,9 +293,9 @@ module RSpec
         protected
 
           RESPONSE_METHODS = {
-            :success => 'successful',
-            :error => 'server_error',
-            :missing => 'not_found'
+            success: 'successful',
+            error: 'server_error',
+            missing: 'not_found'
           }.freeze
 
           def check_expected_status(test_response, expected)

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

@@ -14,7 +14,7 @@ module RSpec
               @expected.merge!(expected[0])
             else
               controller, action = expected[0].split('#')
-              @expected.merge!(:controller => controller, :action => action)
+              @expected.merge!(controller: controller, action: action)
             end
           end
 
@@ -26,7 +26,7 @@ module RSpec
               path, query = *verb_to_path_map.values.first.split('?')
               @scope.assert_recognizes(
                 @expected,
-                { :method => verb_to_path_map.keys.first, :path => path },
+                {method: verb_to_path_map.keys.first, path: path},
                 Rack::Utils.parse_nested_query(query)
               )
             end
@@ -50,12 +50,12 @@ module RSpec
         #
         # @example
         #
-        #     expect(:get => "/things/special").to route_to(
-        #       :controller => "things",
-        #       :action     => "special"
+        #     expect(get: "/things/special").to route_to(
+        #       controller: "things",
+        #       action:     "special"
         #     )
         #
-        #     expect(:get => "/things/special").to route_to("things#special")
+        #     expect(get: "/things/special").to route_to("things#special")
         #
         # @see https://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes
         def route_to(*expected)
@@ -72,7 +72,7 @@ module RSpec
             @actual = path
             match_unless_raises ActionController::RoutingError do
               @routing_options = @scope.routes.recognize_path(
-                path.values.first, :method => path.keys.first
+                path.values.first, method: path.keys.first
               )
             end
           end
@@ -95,9 +95,9 @@ module RSpec
         # `RouteSet#recognize_path`.
         #
         # @example You can use route helpers provided by rspec-rails.
-        #     expect(:get  => "/a/path").to be_routable
-        #     expect(:post => "/another/path").to be_routable
-        #     expect(:put  => "/yet/another/path").to be_routable
+        #     expect(get:  "/a/path").to be_routable
+        #     expect(post: "/another/path").to be_routable
+        #     expect(put:  "/yet/another/path").to be_routable
         def be_routable
           BeRoutableMatcher.new(self)
         end
@@ -115,7 +115,7 @@ module RSpec
           # Shorthand method for matching this type of route.
           %w[get post put patch delete options head].each do |method|
             define_method method do |path|
-              { method.to_sym => path }
+              {method.to_sym => path}
             end
           end
         end

data/lib/rspec/rails/tasks/rspec.rake

@@ -3,19 +3,19 @@ if default = Rake.application.instance_variable_get('@tasks')['default']
   default.prerequisites.delete('test')
 end
 
-task :default => :spec
+task default: :spec
 
-task :stats => "spec:statsetup"
+task stats: "spec:statsetup"
 
 desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => "spec:prepare")
+RSpec::Core::RakeTask.new(spec: "spec:prepare")
 
 namespace :spec do
   types = begin
-            dirs = Dir['./spec/**/*_spec.rb'].
-              map { |f| f.sub(/^\.\/(spec\/\w+)\/.*/, '\\1') }.
-              uniq.
-              select { |f| File.directory?(f) }
+            dirs = Dir['./spec/**/*_spec.rb']
+              .map { |f| f.sub(/^\.\/(spec\/\w+)\/.*/, '\\1') }
+              .uniq
+              .select { |f| File.directory?(f) }
             Hash[dirs.map { |d| [d.split('/').last, d] }]
           end
 
@@ -35,16 +35,6 @@ namespace :spec do
     end
   end
 
-  # RCov task only enabled for Ruby 1.8
-  if RUBY_VERSION < '1.9'
-    desc "Run all specs with rcov"
-    RSpec::Core::RakeTask.new(:rcov => "spec:prepare") do |t|
-      t.rcov = true
-      t.pattern = "./spec/**/*_spec.rb"
-      t.rcov_opts = '--exclude /gems/,/Library/,/usr/,lib/tasks,.bundle,config,/lib/rspec/,/lib/rspec-,spec'
-    end
-  end
-
   task :statsetup do
     require 'rails/code_statistics'
     types.each do |type, dir|

data/lib/rspec/rails/vendor/capybara.rb

@@ -9,31 +9,26 @@ rescue LoadError
 end
 
 if defined?(Capybara)
-  require 'rspec/support/comparable_version'
-  unless RSpec::Support::ComparableVersion.new(Capybara::VERSION) >= '2.2.0'
-    raise "You are using capybara #{Capybara::VERSION}. RSpec requires >= 2.2.0."
-  end
-
   RSpec.configure do |c|
     if defined?(Capybara::DSL)
-      c.include Capybara::DSL, :type => :feature
+      c.include Capybara::DSL, type: :feature
       if defined?(ActionPack) && ActionPack::VERSION::STRING >= "5.1"
-        c.include Capybara::DSL, :type => :system
+        c.include Capybara::DSL, type: :system
       end
     end
 
     if defined?(Capybara::RSpecMatchers)
-      c.include Capybara::RSpecMatchers, :type => :view
-      c.include Capybara::RSpecMatchers, :type => :helper
-      c.include Capybara::RSpecMatchers, :type => :mailer
-      c.include Capybara::RSpecMatchers, :type => :controller
-      c.include Capybara::RSpecMatchers, :type => :feature
-      c.include Capybara::RSpecMatchers, :type => :system
+      c.include Capybara::RSpecMatchers, type: :view
+      c.include Capybara::RSpecMatchers, type: :helper
+      c.include Capybara::RSpecMatchers, type: :mailer
+      c.include Capybara::RSpecMatchers, type: :controller
+      c.include Capybara::RSpecMatchers, type: :feature
+      c.include Capybara::RSpecMatchers, type: :system
     end
 
     unless defined?(Capybara::RSpecMatchers) || defined?(Capybara::DSL)
-      c.include Capybara, :type => :request
-      c.include Capybara, :type => :controller
+      c.include Capybara, type: :request
+      c.include Capybara, type: :controller
     end
   end
 end

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 = '4.0.0.beta3'
+      STRING = '4.0.0'
     end
   end
 end

data/lib/rspec/rails/view_path_builder.rb

@@ -20,7 +20,7 @@ module RSpec
       #     view_path_builder.path_for({ :controller => 'posts', :action => 'delete' })
       #     # => ActionController::UrlGenerationError: No route matches {:action=>"delete", :controller=>"posts"}
       def path_for(path_params)
-        url_for(path_params.merge(:only_path => true))
+        url_for(path_params.merge(only_path: true))
       rescue => e
         e.message
       end

data/lib/rspec/rails/view_rendering.rb

@@ -55,9 +55,9 @@ module RSpec
               "",
               template.identifier,
               EmptyTemplateHandler,
-              :virtual_path => template.virtual_path,
-              :format => template_format(template),
-              :locals => []
+              virtual_path: template.virtual_path,
+              format: template_format(template),
+              locals: []
             )
           end
         end

data/lib/rspec-rails.rb

@@ -15,8 +15,7 @@ module RSpec
           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
+      generators = config.app_generators
       generators.integration_tool :rspec
       generators.test_framework :rspec
 
@@ -31,9 +30,9 @@ module RSpec
       # This is called after the environment has been loaded but before Rails
       # sets the default for the `preview_path`
       initializer "rspec_rails.action_mailer",
-                  :before => "action_mailer.set_configs" do |app|
-        setup_preview_path(app)
-      end
+                  before: "action_mailer.set_configs" do |app|
+                    setup_preview_path(app)
+                  end
 
     private
 
@@ -47,9 +46,7 @@ module RSpec
       def config_preview_path?(options)
         # We cannot use `respond_to?(:show_previews)` here as it will always
         # return `true`.
-        if ::Rails::VERSION::STRING < '4.2'
-          ::Rails.env.development?
-        elsif options.show_previews.nil?
+        if options.show_previews.nil?
           options.show_previews = ::Rails.env.development?
         else
           options.show_previews
@@ -74,7 +71,7 @@ module RSpec
         # not respond to the method. However, we cannot use
         # `config.action_mailer.respond_to?(:preview_path)` here as it will
         # always return `true`.
-        config.respond_to?(:action_mailer) && ::Rails::VERSION::STRING > '4.1'
+        config.respond_to?(:action_mailer)
       end
     end
   end