rspec-rails 2.14.2 → 3.9.1

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

@@ -0,0 +1,23 @@
+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
+      # This blank module is only necessary for YARD processing. It doesn't
+      # handle the conditional `defined?` check below very well.
+    end
+  end
+end
+
+if defined?(ActiveJob)
+  module RSpec
+    module Rails
+      # Container module for job spec functionality.
+      module JobExampleGroup
+        extend ActiveSupport::Concern
+        include RSpec::Rails::RailsExampleGroup
+      end
+    end
+  end
+end

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

@@ -1,20 +1,36 @@
-if defined?(ActionMailer)
-  module RSpec::Rails
+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
-      extend ActiveSupport::Concern
-      include RSpec::Rails::RailsExampleGroup
-      include ActionMailer::TestCase::Behavior
+      # This blank module is only necessary for YARD processing. It doesn't
+      # handle the conditional `defined?` check below very well.
+    end
+  end
+end
 
-      included do
-        metadata[:type] = :mailer
-        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
-      end
+if defined?(ActionMailer)
+  module RSpec
+    module Rails
+      # Container module for mailer spec functionality.
+      module MailerExampleGroup
+        extend ActiveSupport::Concern
+        include RSpec::Rails::RailsExampleGroup
+        include ActionMailer::TestCase::Behavior
+
+        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
+        end
 
-      module ClassMethods
-        def mailer_class
-          described_class
+        # Class-level DSL for mailer specs.
+        module ClassMethods
+          # Alias for `described_class`.
+          def mailer_class
+            described_class
+          end
         end
       end
     end

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

@@ -1,10 +1,11 @@
-module RSpec::Rails
-  module ModelExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
-
-    included do
-      metadata[:type] = :model
+module RSpec
+  module Rails
+    # @api public
+    # Container class for model spec functionality. Does not provide anything
+    # special over the common RailsExampleGroup currently.
+    module ModelExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
     end
   end
 end

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

@@ -4,12 +4,14 @@ require 'rspec/rails/matchers'
 
 module RSpec
   module Rails
+    # @api public
+    # Common rails example functionality.
     module RailsExampleGroup
       extend ActiveSupport::Concern
       include RSpec::Rails::SetupAndTeardownAdapter
       include RSpec::Rails::MinitestLifecycleAdapter if ::Rails::VERSION::STRING >= '4'
       include RSpec::Rails::MinitestAssertionAdapter
-      include RSpec::Rails::Matchers
+      include RSpec::Rails::FixtureSupport
     end
   end
 end

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

@@ -1,22 +1,29 @@
-module RSpec::Rails
-  module RequestExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
-    include ActionDispatch::Integration::Runner
-    include ActionDispatch::Assertions
-    include RSpec::Rails::Matchers::RedirectTo
-    include RSpec::Rails::Matchers::RenderTemplate
-    include ActionController::TemplateAssertions
+module RSpec
+  module Rails
+    # @api public
+    # Container class for request spec functionality.
+    module RequestExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include ActionDispatch::Integration::Runner
+      include ActionDispatch::Assertions
+      include RSpec::Rails::Matchers::RedirectTo
+      include RSpec::Rails::Matchers::RenderTemplate
+      include ActionController::TemplateAssertions
 
-    def app
-      ::Rails.application
-    end
+      if ActionPack::VERSION::MAJOR >= 5
+        include ActionDispatch::IntegrationTest::Behavior
+      end
 
-    included do
-      metadata[:type] = :request
+      # Delegates to `Rails.application`.
+      def app
+        ::Rails.application
+      end
 
-      before do
-        @routes = ::Rails.application.routes
+      included do
+        before do
+          @routes = ::Rails.application.routes
+        end
       end
     end
   end

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

@@ -1,54 +1,63 @@
 require "action_dispatch/testing/assertions/routing"
 
-module RSpec::Rails
-  module RoutingExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
-    include RSpec::Rails::Matchers::RoutingMatchers
-    include RSpec::Rails::Matchers::RoutingMatchers::RouteHelpers
-    include RSpec::Rails::AssertionDelegator.new(ActionDispatch::Assertions::RoutingAssertions)
-
-    module ClassMethods
-      # Specifies the routeset that will be used for the example group. This
-      # is most useful when testing Rails engines.
-      #
-      # @example
-      #
-      #     describe MyEngine::PostsController do
-      #       routes { MyEngine::Engine.routes }
-      #
-      #       it "routes posts#index" do
-      #         expect(:get => "/posts").to
-      #           route_to(:controller => "my_engine/posts", :action => "index")
-      #       end
-      #     end
-      def routes(&blk)
-        before do
-          self.routes = blk.call
+module RSpec
+  module Rails
+    # @private
+    RoutingAssertionDelegator =  RSpec::Rails::AssertionDelegator.new(
+      ActionDispatch::Assertions::RoutingAssertions
+    )
+
+    # @api public
+    # Container module for routing spec functionality.
+    module RoutingExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include RSpec::Rails::Matchers::RoutingMatchers
+      include RSpec::Rails::Matchers::RoutingMatchers::RouteHelpers
+      include RSpec::Rails::RoutingAssertionDelegator
+
+      # Class-level DSL for route specs.
+      module ClassMethods
+        # Specifies the routeset that will be used for the example group. This
+        # is most useful when testing Rails engines.
+        #
+        # @example
+        #     describe MyEngine::PostsController do
+        #       routes { MyEngine::Engine.routes }
+        #
+        #       it "routes posts#index" do
+        #         expect(:get => "/posts").to
+        #           route_to(:controller => "my_engine/posts", :action => "index")
+        #       end
+        #     end
+        def routes
+          before do
+            self.routes = yield
+          end
         end
       end
-    end
-
-    included do
-      metadata[:type] = :routing
 
-      before do
-        self.routes = ::Rails.application.routes
+      included do
+        before do
+          self.routes = ::Rails.application.routes
+        end
       end
-    end
 
-    attr_reader :routes
+      # @!attribute [r]
+      # @private
+      attr_reader :routes
 
-    # @api private
-    def routes=(routes)
-      @routes = routes
-      assertion_instance.instance_variable_set(:@routes, routes)
-    end
+      # @private
+      def routes=(routes)
+        @routes = routes
+        assertion_instance.instance_variable_set(:@routes, routes)
+      end
 
     private
 
-    def method_missing(m, *args, &block)
-      routes.url_helpers.respond_to?(m) ? routes.url_helpers.send(m, *args) : super
+      def method_missing(m, *args, &block)
+        routes.url_helpers.respond_to?(m) ? routes.url_helpers.send(m, *args) : super
+      end
     end
   end
 end

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

@@ -0,0 +1,108 @@
+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 BlowAwayAfterTeardownHook
+        # @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|
+        begin
+          require 'capybara'
+          require 'action_dispatch/system_test_case'
+        # rubocop:disable Lint/HandleExceptions
+        rescue LoadError => e
+          # rubocop:enable Lint/HandleExceptions
+          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
+
+        original_after_teardown =
+          ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown.instance_method(:after_teardown)
+
+        other.include ActionDispatch::IntegrationTest::Behavior
+        other.include ::ActionDispatch::SystemTesting::TestHelpers::SetupAndTeardown
+        other.include ::ActionDispatch::SystemTesting::TestHelpers::ScreenshotHelper
+        other.include BlowAwayAfterTeardownHook
+
+        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
+        end
+
+        def driven_by(*args, &blk)
+          @driver = ::ActionDispatch::SystemTestCase.driven_by(*args, &blk).tap(&:use)
+        end
+
+        before do
+          # A user may have already set the driver, so only default if driver
+          # is not set
+          driven_by(:selenium) unless @driver
+          @routes = ::Rails.application.routes
+        end
+
+        after do
+          orig_stdout = $stdout
+          $stdout = StringIO.new
+          begin
+            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