rspec-rails 3.9.1 → 5.0.1

data/lib/rspec/rails/configuration.rb

@@ -1,3 +1,4 @@
+# rubocop: disable Metrics/ModuleLength
 module RSpec
   module Rails
     # Fake class to document RSpec Rails configuration options. In practice,
@@ -25,44 +26,46 @@ module RSpec
     #
     # @api private
     DIRECTORY_MAPPINGS = {
-      :controller => %w[spec controllers],
-      :helper     => %w[spec helpers],
-      :job        => %w[spec jobs],
-      :mailer     => %w[spec mailers],
-      :model      => %w[spec models],
-      :request    => %w[spec (requests|integration|api)],
-      :routing    => %w[spec routing],
-      :view       => %w[spec views],
-      :feature    => %w[spec features],
-      :system     => %w[spec system]
+      channel:    %w[spec channels],
+      controller: %w[spec controllers],
+      helper:     %w[spec helpers],
+      job:        %w[spec jobs],
+      mailer:     %w[spec mailers],
+      model:      %w[spec models],
+      request:    %w[spec (requests|integration|api)],
+      routing:    %w[spec routing],
+      view:       %w[spec views],
+      feature:    %w[spec features],
+      system:     %w[spec system],
+      mailbox:    %w[spec mailboxes]
     }
 
     # Sets up the different example group modules for the different spec types
     #
     # @api private
     def self.add_test_type_configurations(config)
-      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
+      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
       config.include RSpec::Rails::Matchers
-      config.include RSpec::Rails::SystemExampleGroup, :type => :system
+      config.include RSpec::Rails::SystemExampleGroup, type: :system
     end
 
     # @private
-    # rubocop:disable Style/MethodLength
-    def self.initialize_configuration(config)
+    def self.initialize_configuration(config) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity
       config.backtrace_exclusion_patterns << /vendor\//
       config.backtrace_exclusion_patterns << %r{lib/rspec/rails}
 
       # controller settings
-      config.add_setting :infer_base_class_for_anonymous_controllers, :default => true
+      config.add_setting :infer_base_class_for_anonymous_controllers, default: true
 
       # fixture support
-      config.add_setting :use_transactional_fixtures, :alias_with => :use_transactional_examples
+      config.add_setting :use_active_record, default: true
+      config.add_setting :use_transactional_fixtures, alias_with: :use_transactional_examples
       config.add_setting :use_instantiated_fixtures
       config.add_setting :global_fixtures
       config.add_setting :fixture_path
@@ -77,10 +80,8 @@ module RSpec
       #   `RSpec::Rails::FixtureSupport` directly instead
       config.include RSpec::Rails::FixtureSupport
 
-      if ::Rails::VERSION::STRING > '5'
-        config.add_setting :file_fixture_path, :default => 'spec/fixtures/files'
-        config.include RSpec::Rails::FileFixtureSupport
-      end
+      config.add_setting :file_fixture_path, default: 'spec/fixtures/files'
+      config.include RSpec::Rails::FileFixtureSupport
 
       # Add support for fixture_path on fixture_file_upload
       config.include RSpec::Rails::FixtureFileUploadSupport
@@ -91,7 +92,7 @@ module RSpec
       # as a getter. This makes it easier for rspec-rails users because we use
       # `render_views` directly in example groups, so this aligns the two APIs,
       # but requires this workaround:
-      config.add_setting :rendering_views, :default => false
+      config.add_setting :rendering_views, default: false
 
       config.instance_exec do
         def render_views=(val)
@@ -103,13 +104,47 @@ module RSpec
         end
 
         def render_views?
-          rendering_views
+          rendering_views?
+        end
+
+        undef :rendering_views? if respond_to?(:rendering_views?)
+        def rendering_views?
+          !!rendering_views
+        end
+
+        # Define boolean predicates rather than relying on rspec-core due
+        # to the bug fix in rspec/rspec-core#2736, note some of these
+        # predicates are a bit nonsensical, but they exist for backwards
+        # compatibility, we can tidy these up in `rspec-rails` 5.
+        undef :fixture_path? if respond_to?(:fixture_path?)
+        def fixture_path?
+          !!fixture_path
+        end
+
+        undef :global_fixtures? if respond_to?(:global_fixtures?)
+        def global_fixtures?
+          !!global_fixtures
+        end
+
+        undef :infer_base_class_for_anonymous_controllers? if respond_to?(:infer_base_class_for_anonymous_controllers?)
+        def infer_base_class_for_anonymous_controllers?
+          !!infer_base_class_for_anonymous_controllers
+        end
+
+        undef :use_instantiated_fixtures? if respond_to?(:use_instantiated_fixtures?)
+        def use_instantiated_fixtures?
+          !!use_instantiated_fixtures
+        end
+
+        undef :use_transactional_fixtures? if respond_to?(:use_transactional_fixtures?)
+        def use_transactional_fixtures?
+          !!use_transactional_fixtures
         end
 
         def infer_spec_type_from_file_location!
           DIRECTORY_MAPPINGS.each do |type, dir_parts|
             escaped_path = Regexp.compile(dir_parts.join('[\\\/]') + '[\\\/]')
-            define_derived_metadata(:file_path => escaped_path) do |metadata|
+            define_derived_metadata(file_path: escaped_path) do |metadata|
               metadata[:type] ||= type
             end
           end
@@ -127,22 +162,31 @@ module RSpec
 
       if defined?(::Rails::Controller::Testing)
         [:controller, :view, :request].each do |type|
-          config.include ::Rails::Controller::Testing::TestProcess, :type => type
-          config.include ::Rails::Controller::Testing::TemplateAssertions, :type => type
-          config.include ::Rails::Controller::Testing::Integration, :type => type
+          config.include ::Rails::Controller::Testing::TestProcess, type: type
+          config.include ::Rails::Controller::Testing::TemplateAssertions, type: type
+          config.include ::Rails::Controller::Testing::Integration, type: type
         end
       end
 
-      if defined?(ActionMailer)
-        config.include RSpec::Rails::MailerExampleGroup, :type => :mailer
+      if RSpec::Rails::FeatureCheck.has_action_mailer?
+        config.include RSpec::Rails::MailerExampleGroup, type: :mailer
+        config.after { ActionMailer::Base.deliveries.clear }
+      end
+
+      if RSpec::Rails::FeatureCheck.has_active_job?
+        config.include RSpec::Rails::JobExampleGroup, type: :job
+      end
+
+      if RSpec::Rails::FeatureCheck.has_action_cable_testing?
+        config.include RSpec::Rails::ChannelExampleGroup, type: :channel
       end
 
-      if defined?(ActiveJob)
-        config.include RSpec::Rails::JobExampleGroup, :type => :job
+      if RSpec::Rails::FeatureCheck.has_action_mailbox?
+        config.include RSpec::Rails::MailboxExampleGroup, type: :mailbox
       end
     end
-    # rubocop:enable Style/MethodLength
 
     initialize_configuration RSpec.configuration
   end
 end
+# rubocop: enable Metrics/ModuleLength

data/lib/rspec/rails/example.rb

@@ -9,3 +9,5 @@ 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/example/channel_example_group.rb

@@ -0,0 +1,93 @@
+require "rspec/rails/matchers/action_cable/have_streams"
+
+module RSpec
+  module Rails
+    # @api public
+    # Container module for channel spec functionality. It is only available if
+    # ActionCable has been loaded before it.
+    module ChannelExampleGroup
+      # @private
+      module ClassMethods
+        # These blank modules are only necessary for YARD processing. It doesn't
+        # handle the conditional check below very well and reports undocumented objects.
+      end
+    end
+  end
+end
+
+if RSpec::Rails::FeatureCheck.has_action_cable_testing?
+  module RSpec
+    module Rails
+      # @api public
+      # Container module for channel spec functionality.
+      module ChannelExampleGroup
+        extend ActiveSupport::Concern
+        include RSpec::Rails::RailsExampleGroup
+        include ActionCable::Connection::TestCase::Behavior
+        include ActionCable::Channel::TestCase::Behavior
+
+        # Class-level DSL for channel specs.
+        module ClassMethods
+          # @private
+          def channel_class
+            (_channel_class || described_class).tap do |klass|
+              next if klass <= ::ActionCable::Channel::Base
+
+              raise "Described class is not a channel class.\n" \
+                    "Specify the channel class in the `describe` statement " \
+                    "or set it manually using `tests MyChannelClass`"
+            end
+          end
+
+          # @private
+          def connection_class
+            (_connection_class || described_class).tap do |klass|
+              next if klass <= ::ActionCable::Connection::Base
+
+              raise "Described class is not a connection class.\n" \
+                    "Specify the connection class in the `describe` statement " \
+                    "or set it manually using `tests MyConnectionClass`"
+            end
+          end
+        end
+
+        # Checks that the connection attempt has been rejected.
+        #
+        # @example
+        #     expect { connect }.to have_rejected_connection
+        def have_rejected_connection
+          raise_error(::ActionCable::Connection::Authorization::UnauthorizedError)
+        end
+
+        # Checks that the subscription is subscribed to at least one stream.
+        #
+        # @example
+        #     expect(subscription).to have_streams
+        def have_streams
+          check_subscribed!
+
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new
+        end
+
+        # Checks that the channel has been subscribed to the given stream
+        #
+        # @example
+        #     expect(subscription).to have_stream_from("chat_1")
+        def have_stream_from(stream)
+          check_subscribed!
+
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new(stream)
+        end
+
+        # Checks that the channel has been subscribed to a stream for the given model
+        #
+        # @example
+        #     expect(subscription).to have_stream_for(user)
+        def have_stream_for(object)
+          check_subscribed!
+          RSpec::Rails::Matchers::ActionCable::HaveStream.new(broadcasting_for(object))
+        end
+      end
+    end
+  end
+end

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

@@ -94,9 +94,9 @@ module RSpec
             self.routes = ActionDispatch::Routing::RouteSet.new.tap do |r|
               r.draw do
                 resources resource_name,
-                          :as => resource_as,
-                          :module => resource_module,
-                          :path => resource_path
+                          as: resource_as,
+                          module: resource_module,
+                          path: resource_path
               end
             end
           end
@@ -159,7 +159,7 @@ module RSpec
       #
       #         expect do
       #           bypass_rescue
-      #           get :show, :id => profile.id + 1
+      #           get :show, id: profile.id + 1
       #         end.to raise_error(/403 Forbidden/)
       #       end
       #     end

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, :skip => 'Temporarily skipped with 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