rspec-rails 3.5.0 → 4.0.0

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

@@ -37,37 +37,17 @@ end
 
 unless RSpec.respond_to?(:feature)
   opts = {
-    :capybara_feature => true,
-    :type => :feature,
-    :skip => <<-EOT.squish
-      Feature specs require the Capybara (http://github.com/jnicklas/capybara)
-      gem, version 2.2.0 or later. We recommend version 2.4.0 or later to avoid
-      some deprecation warnings and have support for
-      `config.expose_dsl_globally = false`.
+    capybara_feature: true,
+    type: :feature,
+    skip: <<-EOT.squish
+      Feature specs require the Capybara (https://github.com/teamcapybara/capybara)
+      gem, version 2.13.0 or later.
     EOT
   }
 
-  # Capybara's monkey patching causes us to have to jump through some hoops
-  top_level = self
-  main_feature = nil
-  if defined?(Capybara) && ::Capybara::VERSION.to_f < 2.4
-    # Capybara 2.2 and 2.3 do not use `alias_example_xyz`
-    opts[:skip] = <<-EOT.squish
-      Capybara < 2.4.0 does not support RSpec's namespace or
-      `config.expose_dsl_globally = false`. Upgrade to Capybara >= 2.4.0.
-    EOT
-    main_feature = top_level.method(:feature) if top_level.respond_to?(:feature)
-  end
-
   RSpec.configure do |c|
-    main_feature = nil unless c.expose_dsl_globally?
     c.alias_example_group_to :feature, opts
     c.alias_example_to :scenario
-    c.alias_example_to :xscenario
+    c.alias_example_to :xscenario, skip: 'Temporarily skipped with xscenario'
   end
-
-  # Due to load order issues and `config.expose_dsl_globally?` defaulting to
-  # `true` we need to put Capybara's monkey patch method back. Otherwise,
-  # app upgrades have a high likelyhood of having all feature specs skipped.
-  top_level.define_singleton_method(:feature, &main_feature) if main_feature
 end

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

@@ -12,15 +12,8 @@ module RSpec
 
       # @private
       module ClassMethods
-        if ::Rails::VERSION::MAJOR > 3
-          def determine_constant_from_test_name(_ignore)
-            described_class if yield(described_class)
-          end
-        else
-          def determine_default_helper_class(_ignore)
-            return unless Module === described_class && !(Class === described_class)
-            described_class
-          end
+        def determine_constant_from_test_name(_ignore)
+          described_class if yield(described_class)
         end
       end
 

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

@@ -0,0 +1,80 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container module for mailbox spec functionality.
+    module MailboxExampleGroup
+      extend ActiveSupport::Concern
+
+      if RSpec::Rails::FeatureCheck.has_action_mailbox?
+        require 'action_mailbox/test_helper'
+        extend ::ActionMailbox::TestHelper
+
+        # @private
+        def self.create_inbound_email(arg)
+          case arg
+          when Hash
+            create_inbound_email_from_mail(arg)
+          else
+            create_inbound_email_from_source(arg.to_s)
+          end
+        end
+      else
+        def self.create_inbound_email(_arg)
+          raise "Could not load ActionMailer::TestHelper"
+        end
+      end
+
+      class_methods do
+        # @private
+        def mailbox_class
+          described_class
+        end
+      end
+
+      included do
+        subject { described_class }
+      end
+
+      # @api public
+      # Passes if the inbound email was delivered
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_been_delivered
+      def have_been_delivered
+        satisfy('have been delivered', &:delivered?)
+      end
+
+      # @api public
+      # Passes if the inbound email bounced during processing
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_bounced
+      def have_bounced
+        satisfy('have bounced', &:bounced?)
+      end
+
+      # @api public
+      # Passes if the inbound email failed to process
+      #
+      # @example
+      #       inbound_email = process(args)
+      #       expect(inbound_email).to have_failed
+      def have_failed
+        satisfy('have failed', &:failed?)
+      end
+
+      # Process an inbound email message directly, bypassing routing.
+      #
+      # @param message [Hash, Mail::Message] a mail message or hash of
+      #   attributes used to build one
+      # @return [ActionMaibox::InboundMessage]
+      def process(message)
+        MailboxExampleGroup.create_inbound_email(message).tap do |mail|
+          self.class.mailbox_class.receive(mail)
+        end
+      end
+    end
+  end
+end

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

@@ -22,7 +22,7 @@ if defined?(ActionMailer)
         included do
           include ::Rails.application.routes.url_helpers
           options = ::Rails.configuration.action_mailer.default_url_options
-          options.each { |key, value| default_url_options[key] = value } if options
+          options&.each { |key, value| default_url_options[key] = value }
         end
 
         # Class-level DSL for mailer specs.

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

@@ -9,9 +9,8 @@ module RSpec
     module RailsExampleGroup
       extend ActiveSupport::Concern
       include RSpec::Rails::SetupAndTeardownAdapter
-      include RSpec::Rails::MinitestLifecycleAdapter if ::Rails::VERSION::STRING >= '4'
+      include RSpec::Rails::MinitestLifecycleAdapter
       include RSpec::Rails::MinitestAssertionAdapter
-      include RSpec::Rails::Matchers
       include RSpec::Rails::FixtureSupport
     end
   end

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

@@ -11,10 +11,8 @@ module RSpec
       include RSpec::Rails::Matchers::RenderTemplate
       include ActionController::TemplateAssertions
 
-      begin
+      if ActionPack::VERSION::MAJOR >= 5
         include ActionDispatch::IntegrationTest::Behavior
-      rescue NameError # rubocop:disable Lint/HandleExceptions
-        # rails is too old to provide integration test helpers
       end
 
       # Delegates to `Rails.application`.

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

@@ -0,0 +1,124 @@
+module RSpec
+  module Rails
+    # @api public
+    # Container class for system tests
+    module SystemExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include RSpec::Rails::Matchers::RedirectTo
+      include RSpec::Rails::Matchers::RenderTemplate
+      include ActionDispatch::Integration::Runner
+      include ActionDispatch::Assertions
+      include ActionController::TemplateAssertions
+
+      # Special characters to translate into underscores for #method_name
+      CHARS_TO_TRANSLATE = ['/', '.', ':', ',', "'", '"', " "].freeze
+
+      # @private
+      module BlowAwayTeardownHooks
+        # @private
+        def before_teardown
+        end
+
+        # @private
+        def after_teardown
+        end
+      end
+
+      # for the SystemTesting Screenshot situation
+      def passed?
+        return false if RSpec.current_example.exception
+        return true unless defined?(::RSpec::Expectations::FailureAggregator)
+
+        failure_notifier = ::RSpec::Support.failure_notifier
+        return true unless failure_notifier.is_a?(::RSpec::Expectations::FailureAggregator)
+
+        failure_notifier.failures.empty? && failure_notifier.other_errors.empty?
+      end
+
+      # @private
+      def method_name
+        @method_name ||= [
+          self.class.name.underscore,
+          RSpec.current_example.description.underscore
+        ].join("_").tr(CHARS_TO_TRANSLATE.join, "_")[0...200] + "_#{rand(1000)}"
+      end
+
+      # Delegates to `Rails.application`.
+      def app
+        ::Rails.application
+      end
+
+      included do |other|
+        ActiveSupport.on_load(:action_dispatch_system_test_case) do
+          ActionDispatch::SystemTesting::Server.silence_puma = true
+        end
+
+        begin
+          require 'capybara'
+          require 'action_dispatch/system_test_case'
+        rescue LoadError => e
+          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 =
+            :webrick`) before attempting to use system specs.
+          """.gsub(/\s+/, ' ').strip
+        end
+
+        if ::Rails::VERSION::STRING >= '6.0'
+          original_before_teardown =
+            ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:before_teardown)
+        end
+
+        original_after_teardown =
+          ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:after_teardown)
+
+        other.include ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown
+        other.include ::ActionDispatch::SystemTesting::TestHelpers::ScreenshotHelper
+        other.include BlowAwayTeardownHooks
+
+        attr_reader :driver
+
+        if ActionDispatch::SystemTesting::Server.respond_to?(:silence_puma=)
+          ActionDispatch::SystemTesting::Server.silence_puma = true
+        end
+
+        def initialize(*args, &blk)
+          super(*args, &blk)
+          @driver = nil
+
+          self.class.before do
+            # A user may have already set the driver, so only default if driver
+            # is not set
+            driven_by(:selenium) unless @driver
+          end
+        end
+
+        def driven_by(*args, &blk)
+          @driver = ::ActionDispatch::SystemTestCase.driven_by(*args, &blk).tap(&:use)
+        end
+
+        before do
+          @routes = ::Rails.application.routes
+        end
+
+        after do
+          orig_stdout = $stdout
+          $stdout = StringIO.new
+          begin
+            if ::Rails::VERSION::STRING >= '6.0'
+              original_before_teardown.bind(self).call
+            end
+            original_after_teardown.bind(self).call
+          ensure
+            myio = $stdout
+            RSpec.current_example.metadata[:extra_failure_lines] = myio.string
+            $stdout = orig_stdout
+          end
+        end
+      end
+    end
+  end
+end

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
@@ -35,16 +43,13 @@ module RSpec
 
         included do
           include ::Rails.application.routes.url_helpers
-
-          if ::Rails.application.routes.respond_to?(:mounted_helpers)
-            include ::Rails.application.routes.mounted_helpers
-          end
+          include ::Rails.application.routes.mounted_helpers
         end
 
         # @overload render
-        # @overload render({:partial => path_to_file})
-        # @overload render({:partial => path_to_file}, {... locals ...})
-        # @overload render({:partial => path_to_file}, {... locals ...}) do ... end
+        # @overload render({partial: path_to_file})
+        # @overload render({partial: path_to_file}, {... locals ...})
+        # @overload render({partial: path_to_file}, {... locals ...}) do ... end
         #
         # Delegates to ActionView::Base#render, so see documentation on that
         # for more info.
@@ -54,7 +59,7 @@ module RSpec
         #
         #     describe "widgets/new.html.erb" do
         #       it "shows all the widgets" do
-        #         render # => view.render(:file => "widgets/new.html.erb")
+        #         render # => view.render(file: "widgets/new.html.erb")
         #         # ...
         #       end
         #     end
@@ -84,7 +89,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
@@ -97,7 +102,7 @@ module RSpec
 
         # @deprecated Use `view` instead.
         def template
-          RSpec.deprecate("template", :replacement => "view")
+          RSpec.deprecate("template", replacement: "view")
           view
         end
 
@@ -120,20 +125,37 @@ module RSpec
       private
 
         def _default_render_options
-          if ::Rails::VERSION::STRING >= '3.2'
-            # pluck the handler, format, and locale out of, eg, posts/index.de.html.haml
-            template, *components   = _default_file_to_render.split('.')
-            handler, format, locale = *components.reverse
-
-            render_options = { :template => template }
-            render_options[:handlers] = [handler] if handler
-            render_options[:formats] = [format.to_sym] if format
-            render_options[:locales] = [locale] if locale
-
-            render_options
-          else
-            { :template => _default_file_to_render }
-          end
+          formats = if ActionView::Template::Types.respond_to?(:symbols)
+                      ActionView::Template::Types.symbols
+                    else
+                      [:html, :text, :js, :css, :xml, :json].map(&:to_s)
+                    end.map { |x| Regexp.escape(x) }.join("|")
+
+          handlers = ActionView::Template::Handlers.extensions.map { |x| Regexp.escape(x) }.join("|")
+          locales = "[a-z]{2}(?:-[A-Z]{2})?"
+          variants = "[^.]*"
+          path_regex = %r{
+          \A
+          (?<template>.*?)
+          (?:\.(?<locale>#{locales}))??
+            (?:\.(?<format>#{formats}))??
+            (?:\+(?<variant>#{variants}))??
+            (?:\.(?<handler>#{handlers}))?
+            \z
+          }x
+
+          # This regex should always find a match.
+          # Worst case, everything will be nil, and :template will just be
+          # the original string.
+          match = path_regex.match(_default_file_to_render)
+
+          render_options = {template: match[:template]}
+          render_options[:handlers] = [match[:handler]] if match[:handler]
+          render_options[:formats] = [match[:format].to_sym] if match[:format]
+          render_options[:locales] = [match[:locale]] if match[:locale]
+          render_options[:variants] = [match[:variant]] if match[:variant]
+
+          render_options
         end
 
         def _path_parts
@@ -163,10 +185,7 @@ module RSpec
 
         before do
           _include_controller_helpers
-          if view.lookup_context.respond_to?(:prefixes)
-            # rails 3.1
-            view.lookup_context.prefixes << _controller_path
-          end
+          view.lookup_context.prefixes << _controller_path
 
           controller.controller_path = _controller_path
 

data/lib/rspec/rails/example.rb

@@ -8,3 +8,6 @@ require 'rspec/rails/example/routing_example_group'
 require 'rspec/rails/example/model_example_group'
 require 'rspec/rails/example/job_example_group'
 require 'rspec/rails/example/feature_example_group'
+require 'rspec/rails/example/system_example_group'
+require 'rspec/rails/example/channel_example_group'
+require 'rspec/rails/example/mailbox_example_group'

data/lib/rspec/rails/extensions/active_record/proxy.rb

@@ -2,15 +2,7 @@ RSpec.configure do |rspec|
   # Delay this in order to give users a chance to configure `expect_with`...
   rspec.before(:suite) do
     if defined?(RSpec::Matchers) && RSpec::Matchers.configuration.syntax.include?(:should) && defined?(ActiveRecord::Associations)
-      # In Rails 3.0, it was AssociationProxy.
-      # In 3.1+, it's CollectionProxy.
-      const_name = [:CollectionProxy, :AssociationProxy].find do |const|
-        ActiveRecord::Associations.const_defined?(const)
-      end
-
-      proxy_class = ActiveRecord::Associations.const_get(const_name)
-
-      RSpec::Matchers.configuration.add_should_and_should_not_to proxy_class
+      RSpec::Matchers.configuration.add_should_and_should_not_to ActiveRecord::Associations::CollectionProxy
     end
   end
 end

data/lib/rspec/rails/feature_check.rb

@@ -1,23 +1,8 @@
 module RSpec
   module Rails
     # @private
-    # Disable some cops until https://github.com/bbatsov/rubocop/issues/1310
-    # rubocop:disable Style/IndentationConsistency
     module FeatureCheck
-    # rubocop:disable Style/IndentationWidth
-    module_function
-      # rubocop:enable Style/IndentationWidth
-
-      def can_check_pending_migrations?
-        has_active_record_migration? &&
-          ::ActiveRecord::Migration.respond_to?(:check_pending!)
-      end
-
-      def can_maintain_test_schema?
-        has_active_record_migration? &&
-          ::ActiveRecord::Migration.respond_to?(:maintain_test_schema!)
-      end
-
+      module_function
       def has_active_job?
         defined?(::ActiveJob)
       end
@@ -38,27 +23,25 @@ module RSpec
         has_action_mailer? && defined?(::ActionMailer::Preview)
       end
 
-      def has_action_mailer_show_preview?
-        has_action_mailer_preview? &&
-          ::ActionMailer::Base.respond_to?(:show_previews=)
+      def has_action_cable_testing?
+        defined?(::ActionCable) && ActionCable::VERSION::MAJOR >= 6
+      end
+
+      def has_action_mailer_parameterized?
+        has_action_mailer? && defined?(::ActionMailer::Parameterized)
       end
 
-      def has_1_9_hash_syntax?
-        ::Rails::VERSION::STRING > '4.0'
+      def has_action_mailer_unified_delivery?
+        has_action_mailer? && defined?(::ActionMailer::MailDeliveryJob)
       end
 
-      def has_file_fixture?
-        ::Rails::VERSION::STRING > '5.0'
+      def has_action_mailbox?
+        defined?(::ActionMailbox)
       end
 
       def type_metatag(type)
-        if has_1_9_hash_syntax?
-          "type: :#{type}"
-        else
-          ":type => :#{type}"
-        end
+        "type: :#{type}"
       end
     end
-    # rubocop:enable Style/IndentationConsistency
   end
 end

data/lib/rspec/rails/fixture_file_upload_support.rb

@@ -0,0 +1,40 @@
+module RSpec
+  module Rails
+    # @private
+    module FixtureFileUploadSupport
+      delegate :fixture_file_upload, to: :rails_fixture_file_wrapper
+
+    private
+
+      def rails_fixture_file_wrapper
+        RailsFixtureFileWrapper.fixture_path = nil
+        resolved_fixture_path = (fixture_path || RSpec.configuration.fixture_path || '').to_s
+        RailsFixtureFileWrapper.fixture_path = File.join(resolved_fixture_path, '') unless resolved_fixture_path.strip.empty?
+        RailsFixtureFileWrapper.instance
+      end
+
+      class RailsFixtureFileWrapper
+        include ActionDispatch::TestProcess if defined?(ActionDispatch::TestProcess)
+
+        class << self
+          attr_reader :fixture_path
+
+          # Get instance of wrapper
+          def instance
+            @instance ||= new
+          end
+
+          # Override fixture_path set
+          # to support Rails 3.0->3.1 using ActionController::TestCase class to resolve fixture_path
+          # see https://apidock.com/rails/v3.0.0/ActionDispatch/TestProcess/fixture_file_upload
+          def fixture_path=(value)
+            if ActionController::TestCase.respond_to?(:fixture_path)
+              ActionController::TestCase.fixture_path = value
+            end
+            @fixture_path = value
+          end
+        end
+      end
+    end
+  end
+end

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