rspec-rails 2.14.2 → 4.1.2

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::MinitestLifecycleAdapter
       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,125 @@
+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(driver, **driver_options, &blk)
+          @driver = ::ActionDispatch::SystemTestCase.driven_by(driver, **driver_options, &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
+            myio.rewind
+            RSpec.current_example.metadata[:extra_failure_lines] = myio.readlines
+            $stdout = orig_stdout
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,169 +1,213 @@
 require 'rspec/rails/view_assigns'
-
-module RSpec::Rails
-  module ViewExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
-    include ActionView::TestCase::Behavior
-    include RSpec::Rails::ViewAssigns
-    include RSpec::Rails::Matchers::RenderTemplate
-
-    module ClassMethods
-      def _default_helper
-        base = metadata[:example_group][:description].split('/')[0..-2].join('/')
-        (base.camelize + 'Helper').constantize if base
-      rescue NameError
-        nil
-      end
-
-      def _default_helpers
-        helpers = [_default_helper].compact
-        helpers << ApplicationHelper if Object.const_defined?('ApplicationHelper')
-        helpers
+require 'rspec/rails/view_spec_methods'
+require 'rspec/rails/view_path_builder'
+
+module RSpec
+  module Rails
+    # @api public
+    # Container class for view spec functionality.
+    module ViewExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include ActionView::TestCase::Behavior
+      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
-    end
 
-    module ExampleMethods
-      # @overload render
-      # @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.
-      #
-      # The only addition is that you can call render with no arguments, and RSpec
-      # will pass the top level description to render:
-      #
-      #     describe "widgets/new.html.erb" do
-      #       it "shows all the widgets" do
-      #         render # => view.render(:file => "widgets/new.html.erb")
-      #         # ...
-      #       end
-      #     end
-      def render(options={}, local_assigns={}, &block)
-        options = _default_render_options if Hash === options and options.empty?
-        super(options, local_assigns, &block)
-      end
+      # @private
+      module ClassMethods
+        def _default_helper
+          base = metadata[:description].split('/')[0..-2].join('/')
+          (base.camelize + 'Helper').constantize unless base.to_s.empty?
+        rescue NameError
+          nil
+        end
 
-      # The instance of `ActionView::Base` that is used to render the template.
-      # Use this to stub methods _before_ calling `render`.
-      #
-      #     describe "widgets/new.html.erb" do
-      #       it "shows all the widgets" do
-      #         view.stub(:foo) { "foo" }
-      #         render
-      #         # ...
-      #       end
-      #     end
-      def view
-        _view
+        def _default_helpers
+          helpers = [_default_helper].compact
+          helpers << ApplicationHelper if Object.const_defined?('ApplicationHelper')
+          helpers
+        end
       end
 
-      # Simulates the presence of a template on the file system by adding a
-      # Rails' FixtureResolver to the front of the view_paths list. Designed to
-      # help isolate view examples from partials rendered by the view template
-      # that is the subject of the example.
-      #
-      # @example
-      #
-      #     stub_template("widgets/_widget.html.erb" => "This content.")
-      def stub_template(hash)
-        view.view_paths.unshift(ActionView::FixtureResolver.new(hash))
-      end
+      # DSL exposed to view specs.
+      module ExampleMethods
+        extend ActiveSupport::Concern
 
-      # Provides access to the params hash that will be available within the
-      # view:
-      #
-      #     params[:foo] = 'bar'
-      def params
-        controller.params
-      end
+        included do
+          include ::Rails.application.routes.url_helpers
+          include ::Rails.application.routes.mounted_helpers
+        end
 
-      # @deprecated Use `view` instead.
-      def template
-        RSpec.deprecate("template", :replacement => "view")
-        view
-      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
+        #
+        # Delegates to ActionView::Base#render, so see documentation on that
+        # for more info.
+        #
+        # The only addition is that you can call render with no arguments, and
+        # RSpec will pass the top level description to render:
+        #
+        #     describe "widgets/new.html.erb" do
+        #       it "shows all the widgets" do
+        #         render # => view.render(file: "widgets/new.html.erb")
+        #         # ...
+        #       end
+        #     end
+        def render(options = {}, local_assigns = {}, &block)
+          options = _default_render_options if Hash === options && options.empty?
+          super(options, local_assigns, &block)
+        end
 
-      # @deprecated Use `rendered` instead.
-      def response
-        # `assert_template` expects `response` to implement a #body method
-        # like an `ActionDispatch::Response` does to force the view to render.
-        # For backwards compatibility, we use #response as an alias for
-        # #rendered, but it needs to implement #body to avoid `assert_template`
-        # raising a `NoMethodError`.
-        unless rendered.respond_to?(:body)
-          def rendered.body; self; end;
+        # The instance of `ActionView::Base` that is used to render the template.
+        # Use this to stub methods _before_ calling `render`.
+        #
+        #     describe "widgets/new.html.erb" do
+        #       it "shows all the widgets" do
+        #         view.stub(:foo) { "foo" }
+        #         render
+        #         # ...
+        #       end
+        #     end
+        def view
+          _view
         end
 
-        rendered
-      end
+        # Simulates the presence of a template on the file system by adding a
+        # Rails' FixtureResolver to the front of the view_paths list. Designed to
+        # help isolate view examples from partials rendered by the view template
+        # that is the subject of the example.
+        #
+        #     stub_template("widgets/_widget.html.erb" => "This content.")
+        def stub_template(hash)
+          view.view_paths.unshift(StubResolverCache.resolver_for(hash))
+        end
 
-    private
+        # Provides access to the params hash that will be available within the
+        # view.
+        #
+        #     params[:foo] = 'bar'
+        def params
+          controller.params
+        end
 
-      def _default_file_to_render
-        example.example_group.top_level_description
-      end
+        # @deprecated Use `view` instead.
+        def template
+          RSpec.deprecate("template", replacement: "view")
+          view
+        end
 
-      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
+        # @deprecated Use `rendered` instead.
+        def response
+          # `assert_template` expects `response` to implement a #body method
+          # like an `ActionDispatch::Response` does to force the view to
+          # render. For backwards compatibility, we use #response as an alias
+          # for #rendered, but it needs to implement #body to avoid
+          # `assert_template` raising a `NoMethodError`.
+          unless rendered.respond_to?(:body)
+            def rendered.body
+              self
+            end
+          end
+
+          rendered
+        end
 
-          render_options = {:template => template}
-          render_options[:handlers] = [handler] if handler
-          render_options[:formats] = [format] if format
-          render_options[:locales] = [locale] if locale
+      private
+
+        def _default_render_options
+          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
-        else
-          {:template => _default_file_to_render}
         end
-      end
 
-      def _path_parts
-        _default_file_to_render.split("/")
-      end
+        def _path_parts
+          _default_file_to_render.split("/")
+        end
 
-      def _controller_path
-        _path_parts[0..-2].join("/")
-      end
+        def _controller_path
+          _path_parts[0..-2].join("/")
+        end
 
-      def _inferred_action
-        _path_parts.last.split(".").first
-      end
+        def _inferred_action
+          _path_parts.last.split(".").first
+        end
 
-      def _include_controller_helpers
-        helpers = controller._helpers
-        view.singleton_class.class_eval do
-          include helpers unless included_modules.include?(helpers)
+        def _include_controller_helpers
+          helpers = controller._helpers
+          view.singleton_class.class_exec do
+            include helpers unless included_modules.include?(helpers)
+          end
         end
       end
-    end
 
-    included do
-      include ExampleMethods
+      included do
+        include ExampleMethods
 
-      metadata[:type] = :view
-      helper(*_default_helpers)
+        helper(*_default_helpers)
 
-      before do
-        _include_controller_helpers
-        if view.lookup_context.respond_to?(:prefixes)
-          # rails 3.1
+        before do
+          _include_controller_helpers
           view.lookup_context.prefixes << _controller_path
+
+          controller.controller_path = _controller_path
+
+          path_params_to_merge = {}
+          path_params_to_merge[:controller] = _controller_path
+          path_params_to_merge[:action] = _inferred_action unless _inferred_action =~ /^_/
+
+          path_params = controller.request.path_parameters
+
+          controller.request.path_parameters = path_params.reverse_merge(path_params_to_merge)
+          controller.request.path = ViewPathBuilder.new(::Rails.application.routes).path_for(controller.request.path_parameters)
+          ViewSpecMethods.add_to(::ActionView::TestCase::TestController)
         end
 
-        # fixes bug with differing formats
-        view.lookup_context.view_paths.each(&:clear_cache)
+        after do
+          ViewSpecMethods.remove_from(::ActionView::TestCase::TestController)
+        end
 
-        controller.controller_path = _controller_path
-        controller.request.path_parameters[:controller] = _controller_path
-        controller.request.path_parameters[:action]     = _inferred_action unless _inferred_action =~ /^_/
+        let(:_default_file_to_render) do |example|
+          example.example_group.top_level_description
+        end
       end
     end
   end
 end
-