rspec-rails 3.8.2 → 7.0.1

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

@@ -5,43 +5,41 @@ RSpec.describe <%= controller_class_name %>Controller, <%= type_metatag(:routing
   describe "routing" do
 <% unless options[:singleton] -%>
     it "routes to #index" do
-      expect(:get => "/<%= ns_table_name %>").to route_to("<%= ns_table_name %>#index")
+      expect(get: "/<%= ns_table_name %>").to route_to("<%= ns_table_name %>#index")
     end
 
 <% end -%>
 <% unless options[:api] -%>
     it "routes to #new" do
-      expect(:get => "/<%= ns_table_name %>/new").to route_to("<%= ns_table_name %>#new")
+      expect(get: "/<%= ns_table_name %>/new").to route_to("<%= ns_table_name %>#new")
     end
 
 <% end -%>
     it "routes to #show" do
-      expect(:get => "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#show", :id => "1")
+      expect(get: "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#show", id: "1")
     end
 
 <% unless options[:api] -%>
     it "routes to #edit" do
-      expect(:get => "/<%= ns_table_name %>/1/edit").to route_to("<%= ns_table_name %>#edit", :id => "1")
+      expect(get: "/<%= ns_table_name %>/1/edit").to route_to("<%= ns_table_name %>#edit", id: "1")
     end
 
 <% end -%>
 
     it "routes to #create" do
-      expect(:post => "/<%= ns_table_name %>").to route_to("<%= ns_table_name %>#create")
+      expect(post: "/<%= ns_table_name %>").to route_to("<%= ns_table_name %>#create")
     end
 
     it "routes to #update via PUT" do
-      expect(:put => "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#update", :id => "1")
+      expect(put: "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#update", id: "1")
     end
 
-<% if Rails::VERSION::STRING > '4' -%>
     it "routes to #update via PATCH" do
-      expect(:patch => "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#update", :id => "1")
+      expect(patch: "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#update", id: "1")
     end
 
-<% end -%>
     it "routes to #destroy" do
-      expect(:delete => "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#destroy", :id => "1")
+      expect(delete: "/<%= ns_table_name %>/1").to route_to("<%= ns_table_name %>#destroy", id: "1")
     end
   end
 end

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

@@ -3,9 +3,9 @@ require 'rails_helper'
 <% output_attributes = attributes.reject{|attribute| [:datetime, :timestamp, :time, :date].index(attribute.type) } -%>
 RSpec.describe "<%= ns_table_name %>/show", <%= type_metatag(:view) %> do
   before(:each) do
-    @<%= ns_file_name %> = assign(:<%= ns_file_name %>, <%= class_name %>.create!(<%= '))' if output_attributes.empty? %>
+    assign(:<%= singular_table_name %>, <%= class_name %>.create!(<%= '))' if output_attributes.empty? %>
 <% output_attributes.each_with_index do |attribute, attribute_index| -%>
-      :<%= attribute.name %> => <%= value_for(attribute) %><%= attribute_index == output_attributes.length - 1 ? '' : ','%>
+      <%= attribute.name %>: <%= value_for(attribute) %><%= attribute_index == output_attributes.length - 1 ? '' : ','%>
 <% end -%>
 <% if !output_attributes.empty? -%>
     ))

data/lib/generators/rspec/system/system_generator.rb

@@ -0,0 +1,24 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class SystemGenerator < Base
+      class_option :system_specs, type: :boolean, default: true,  desc: "Generate system specs"
+
+      def generate_system_spec
+        return unless options[:system_specs]
+
+        template template_name, target_path('system', class_path, filename)
+      end
+
+      def template_name
+        'system_spec.rb'
+      end
+
+      def filename
+        "#{table_name}_spec.rb"
+      end
+    end
+  end
+end

data/lib/generators/rspec/system/templates/system_spec.rb

@@ -0,0 +1,9 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name.pluralize %>", <%= type_metatag(:system) %> do
+  before do
+    driven_by(:rack_test)
+  end
+
+  pending "add some scenarios (or delete) #{__FILE__}"
+end

data/lib/generators/rspec/view/view_generator.rb

@@ -4,17 +4,17 @@ module Rspec
   module Generators
     # @private
     class ViewGenerator < Base
-      argument :actions, :type => :array, :default => [], :banner => "action action"
+      argument :actions, type: :array, default: [], banner: "action action"
 
-      class_option :template_engine, :desc => "Template engine to generate view files"
+      class_option :template_engine, desc: "Template engine to generate view files"
 
       def create_view_specs
-        empty_directory File.join("spec", "views", file_path)
+        empty_directory target_path("views", file_path)
 
         actions.each do |action|
           @action = action
           template 'view_spec.rb',
-                   File.join("spec", "views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
+                   target_path("views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
         end
       end
     end

data/lib/generators/rspec.rb

@@ -1,8 +1,9 @@
 require 'rails/generators/named_base'
+require 'rspec/core'
 require 'rspec/rails/feature_check'
 
 # @private
-# Weirdly named generators namespace (should be `RSpec`) for compatability with
+# Weirdly named generators namespace (should be `RSpec`) for compatibility with
 # rails loading.
 module Rspec
   # @private
@@ -19,10 +20,20 @@ module Rspec
         end
       end
 
-      if ::Rails::VERSION::STRING < '3.1'
-        def module_namespacing
-          yield if block_given?
-        end
+      # @private
+      # Load configuration from RSpec to ensure `--default-path` is set
+      def self.configuration
+        @configuration ||=
+          begin
+            configuration = RSpec.configuration
+            options = RSpec::Core::ConfigurationOptions.new({})
+            options.configure(configuration)
+            configuration
+          end
+      end
+
+      def target_path(*paths)
+        File.join(self.class.configuration.default_path, *paths)
       end
     end
   end

data/lib/rspec/rails/adapters.rb

@@ -19,68 +19,15 @@ module RSpec
     end
     private_class_method :disable_testunit_autorun
 
-    if ::Rails::VERSION::STRING >= '4.1.0'
-      if defined?(Kernel.gem)
-        gem 'minitest'
-      else
-        require 'minitest'
-      end
-      require 'minitest/assertions'
-      # Constant aliased to either Minitest or TestUnit, depending on what is
-      # loaded.
-      Assertions = Minitest::Assertions
-    elsif RUBY_VERSION >= '2.2.0'
-      # Minitest / TestUnit has been removed from ruby core. However, we are
-      # on an old Rails version and must load the appropriate gem
-      if ::Rails::VERSION::STRING >= '4.0.0'
-        # ActiveSupport 4.0.x has the minitest '~> 4.2' gem as a dependency
-        # This gem has no `lib/minitest.rb` file.
-        gem 'minitest' if defined?(Kernel.gem)
-        require 'minitest/unit'
-        Assertions = MiniTest::Assertions
-      elsif ::Rails::VERSION::STRING >= '3.2.21'
-        # TODO: Change the above check to >= '3.2.22' once it's released
-        begin
-          # Test::Unit "helpfully" sets up autoload for its `AutoRunner`.
-          # While we do not reference it directly, when we load the `TestCase`
-          # classes from AS (ActiveSupport), AS kindly references `AutoRunner`
-          # for everyone.
-          #
-          # To handle this we need to pre-emptively load 'test/unit' and make
-          # sure the version installed has `AutoRunner` (the 3.x line does to
-          # date). If so, we turn the auto runner off.
-          require 'test/unit'
-          require 'test/unit/assertions'
-          disable_testunit_autorun
-        rescue LoadError => e
-          raise LoadError, <<-ERR.squish, e.backtrace
-            Ruby 2.2+ has removed test/unit from the core library. Rails
-            requires this as a dependency. Please add test-unit gem to your
-            Gemfile: `gem 'test-unit', '~> 3.0'` (#{e.message})"
-          ERR
-        end
-        Assertions = Test::Unit::Assertions
-      else
-        abort <<-MSG.squish
-          Ruby 2.2+ is not supported on Rails #{::Rails::VERSION::STRING}.
-          Check the Rails release notes for the appropriate update with
-          support.
-        MSG
-      end
+    if defined?(Kernel.gem)
+      gem 'minitest'
     else
-      begin
-        require 'test/unit/assertions'
-      rescue LoadError
-        # work around for Rubinius not having a std std-lib
-        require 'rubysl-test-unit' if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
-        require 'test/unit/assertions'
-      end
-      # Turn off test unit's auto runner for those using the gem
-      disable_testunit_autorun
-      # Constant aliased to either Minitest or TestUnit, depending on what is
-      # loaded.
-      Assertions = Test::Unit::Assertions
+      require 'minitest'
     end
+    require 'minitest/assertions'
+    # Constant aliased to either Minitest or TestUnit, depending on what is
+    # loaded.
+    Assertions = Minitest::Assertions
 
     # @private
     class AssertionDelegator < Module
@@ -103,6 +50,7 @@ module RSpec
           assertion_modules.each do |mod|
             mod.public_instance_methods.each do |method|
               next if method == :method_missing || method == "method_missing"
+
               define_method(method.to_sym) do |*args, &block|
                 assertion_instance.send(method.to_sym, *args, &block)
               end
@@ -198,12 +146,11 @@ module RSpec
         # examples without exposing non-assertion methods in Test::Unit or
         # Minitest.
         def assertion_method_names
-          methods = ::RSpec::Rails::Assertions.
-            public_instance_methods.
-            select do |m|
+          ::RSpec::Rails::Assertions
+            .public_instance_methods
+            .select do |m|
               m.to_s =~ /^(assert|flunk|refute)/
             end
-          methods + test_unit_specific_methods
         end
 
         def define_assertion_delegators
@@ -213,18 +160,6 @@ module RSpec
             end
           end
         end
-
-        # Starting on Rails 4, Minitest is the default testing framework so no
-        # need to add TestUnit specific methods.
-        if ::Rails::VERSION::STRING >= '4.0.0'
-          def test_unit_specific_methods
-            []
-          end
-        else
-          def test_unit_specific_methods
-            [:build_message]
-          end
-        end
       end
 
       class AssertionDelegator
@@ -246,5 +181,16 @@ module RSpec
     #
     # @private
     TestUnitAssertionAdapter = MinitestAssertionAdapter
+
+    # @private
+    module TaggedLoggingAdapter
+      private
+      # Vendored from activesupport/lib/active_support/testing/tagged_logging.rb
+      # This implements the tagged_logger method where it is expected, but
+      # doesn't call `name` or set it up like Rails does.
+      def tagged_logger
+        @tagged_logger ||= (defined?(Rails.logger) && Rails.logger)
+      end
+    end
   end
 end

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,47 +26,56 @@ 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],
+      generator: %w[spec generator],
+      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,Metrics/AbcSize,Metrics/PerceivedComplexity
       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
+
+      if ::Rails::VERSION::STRING < "7.1.0"
+        config.add_setting :fixture_path
+      else
+        config.add_setting :fixture_paths
+      end
+
       config.include RSpec::Rails::FixtureSupport, :use_fixtures
 
       # We'll need to create a deprecated module in order to properly report to
@@ -77,10 +87,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 +99,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 +111,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
@@ -121,28 +163,60 @@ module RSpec
           filter_gems_from_backtrace "activemodel", "activerecord",
                                      "activesupport", "activejob"
         end
+
+        # @deprecated TestFixtures#fixture_path is deprecated and will be removed in Rails 7.2
+        if ::Rails::VERSION::STRING >= "7.1.0"
+          def fixture_path
+            RSpec.deprecate(
+              "config.fixture_path",
+              replacement: "config.fixture_paths",
+              message: "Rails 7.1 has deprecated the singular fixture_path in favour of an array." \
+              "You should migrate to plural:"
+            )
+            fixture_paths&.first
+          end
+
+          def fixture_path=(path)
+            RSpec.deprecate(
+              "config.fixture_path = #{path.inspect}",
+              replacement: "config.fixture_paths = [#{path.inspect}]",
+              message: "Rails 7.1 has deprecated the singular fixture_path in favour of an array." \
+              "You should migrate to plural:"
+            )
+            self.fixture_paths = Array(path)
+          end
+        end
       end
 
       add_test_type_configurations(config)
 
       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/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
@@ -176,6 +176,7 @@ module RSpec
           super
         end
       end
+      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 
       included do
         subject { controller }