rspec-rails 2.14.2 → 3.9.1

data/lib/rspec/rails/configuration.rb

@@ -0,0 +1,148 @@
+module RSpec
+  module Rails
+    # Fake class to document RSpec Rails configuration options. In practice,
+    # these are dynamically added to the normal RSpec configuration object.
+    class Configuration
+      # @!method infer_spec_type_from_file_location!
+      # Automatically tag specs in conventional directories with matching `type`
+      # metadata so that they have relevant helpers available to them. See
+      # `RSpec::Rails::DIRECTORY_MAPPINGS` for details on which metadata is
+      # applied to each directory.
+
+      # @!method render_views=(val)
+      #
+      # When set to `true`, controller specs will render the relevant view as
+      # well. Defaults to `false`.
+
+      # @!method render_views(val)
+      # Enables view rendering for controllers specs.
+
+      # @!method render_views?
+      # Reader for currently value of `render_views` setting.
+    end
+
+    # Mappings used by `infer_spec_type_from_file_location!`.
+    #
+    # @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]
+    }
+
+    # 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::Matchers
+      config.include RSpec::Rails::SystemExampleGroup, :type => :system
+    end
+
+    # @private
+    # rubocop:disable Style/MethodLength
+    def self.initialize_configuration(config)
+      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
+
+      # fixture support
+      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
+      config.include RSpec::Rails::FixtureSupport, :use_fixtures
+
+      # We'll need to create a deprecated module in order to properly report to
+      # gems / projects which are relying on this being loaded globally.
+      #
+      # See rspec/rspec-rails#1355 for history
+      #
+      # @deprecated Include `RSpec::Rails::RailsExampleGroup` or
+      #   `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
+
+      # Add support for fixture_path on fixture_file_upload
+      config.include RSpec::Rails::FixtureFileUploadSupport
+
+      # This allows us to expose `render_views` as a config option even though it
+      # breaks the convention of other options by using `render_views` as a
+      # command (i.e. `render_views = true`), where it would normally be used
+      # 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.instance_exec do
+        def render_views=(val)
+          self.rendering_views = val
+        end
+
+        def render_views
+          self.rendering_views = true
+        end
+
+        def render_views?
+          rendering_views
+        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|
+              metadata[:type] ||= type
+            end
+          end
+        end
+
+        # Adds exclusion filters for gems included with Rails
+        def filter_rails_from_backtrace!
+          filter_gems_from_backtrace "actionmailer", "actionpack", "actionview"
+          filter_gems_from_backtrace "activemodel", "activerecord",
+                                     "activesupport", "activejob"
+        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
+        end
+      end
+
+      if defined?(ActionMailer)
+        config.include RSpec::Rails::MailerExampleGroup, :type => :mailer
+      end
+
+      if defined?(ActiveJob)
+        config.include RSpec::Rails::JobExampleGroup, :type => :job
+      end
+    end
+    # rubocop:enable Style/MethodLength
+
+    initialize_configuration RSpec.configuration
+  end
+end

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

@@ -1,164 +1,214 @@
-RSpec.configure do |config|
-  config.add_setting :infer_base_class_for_anonymous_controllers, :default => false
-end
-
-module RSpec::Rails
-  module ControllerExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
-    include ActionController::TestCase::Behavior
-    include RSpec::Rails::ViewRendering
-    include RSpec::Rails::Matchers::RedirectTo
-    include RSpec::Rails::Matchers::RenderTemplate
-    include RSpec::Rails::Matchers::RoutingMatchers
-    include RSpec::Rails::AssertionDelegator.new(ActionDispatch::Assertions::RoutingAssertions)
-
-    module ClassMethods
-      # @private
-      def controller_class
-        described_class
-      end
+module RSpec
+  module Rails
+    # @private
+    ControllerAssertionDelegator = RSpec::Rails::AssertionDelegator.new(
+      ActionDispatch::Assertions::RoutingAssertions
+    )
+
+    # @api public
+    # Container module for controller spec functionality.
+    module ControllerExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include ActionController::TestCase::Behavior
+      include RSpec::Rails::ViewRendering
+      include RSpec::Rails::Matchers::RedirectTo
+      include RSpec::Rails::Matchers::RenderTemplate
+      include RSpec::Rails::Matchers::RoutingMatchers
+      include ControllerAssertionDelegator
+
+      # Class-level DSL for controller specs.
+      module ClassMethods
+        # @private
+        def controller_class
+          described_class
+        end
 
-      # Supports a simple DSL for specifying behavior of ApplicationController.
-      # Creates an anonymous subclass of ApplicationController and evals the
-      # `body` in that context. Also sets up implicit routes for this
-      # controller, that are separate from those defined in "config/routes.rb".
-      #
-      # @note Due to Ruby 1.8 scoping rules in anoymous subclasses, constants
-      #   defined in `ApplicationController` must be fully qualified (e.g.
-      #   `ApplicationController::AccessDenied`) in the block passed to the
-      #   `controller` method. Any instance methods, filters, etc, that are
-      #   defined in `ApplicationController`, however, are accessible from
-      #   within the block.
-      #
-      # @example
-      #
-      #     describe ApplicationController do
-      #       controller do
-      #         def index
-      #           raise ApplicationController::AccessDenied
-      #         end
-      #       end
-      #
-      #       describe "handling AccessDenied exceptions" do
-      #         it "redirects to the /401.html page" do
-      #           get :index
-      #           response.should redirect_to("/401.html")
-      #         end
-      #       end
-      #     end
-      #
-      # If you would like to spec a subclass of ApplicationController, call
-      # controller like so:
-      #
-      #     controller(ApplicationControllerSubclass) do
-      #       # ....
-      #     end
-      def controller(base_class = nil, &body)
-        root_controller = defined?(ApplicationController) ? ApplicationController : ActionController::Base
-        base_class ||= RSpec.configuration.infer_base_class_for_anonymous_controllers? ?
-                         controller_class :
-                         root_controller
-
-        metadata[:example_group][:described_class] = Class.new(base_class) do
-          def self.name; "AnonymousController"; end
+        # Supports a simple DSL for specifying behavior of ApplicationController.
+        # Creates an anonymous subclass of ApplicationController and evals the
+        # `body` in that context. Also sets up implicit routes for this
+        # controller, that are separate from those defined in "config/routes.rb".
+        #
+        # @note Due to Ruby 1.8 scoping rules in anonymous subclasses, constants
+        #   defined in `ApplicationController` must be fully qualified (e.g.
+        #   `ApplicationController::AccessDenied`) in the block passed to the
+        #   `controller` method. Any instance methods, filters, etc, that are
+        #   defined in `ApplicationController`, however, are accessible from
+        #   within the block.
+        #
+        # @example
+        #     describe ApplicationController do
+        #       controller do
+        #         def index
+        #           raise ApplicationController::AccessDenied
+        #         end
+        #       end
+        #
+        #       describe "handling AccessDenied exceptions" do
+        #         it "redirects to the /401.html page" do
+        #           get :index
+        #           response.should redirect_to("/401.html")
+        #         end
+        #       end
+        #     end
+        #
+        # If you would like to spec a subclass of ApplicationController, call
+        # controller like so:
+        #
+        #     controller(ApplicationControllerSubclass) do
+        #       # ....
+        #     end
+        def controller(base_class = nil, &body)
+          if RSpec.configuration.infer_base_class_for_anonymous_controllers?
+            base_class ||= controller_class
+          end
+          base_class ||= defined?(ApplicationController) ? ApplicationController : ActionController::Base
+
+          new_controller_class = Class.new(base_class) do
+            def self.name
+              root_controller = defined?(ApplicationController) ? ApplicationController : ActionController::Base
+              if superclass == root_controller || superclass.abstract?
+                "AnonymousController"
+              else
+                superclass.name
+              end
+            end
+          end
+          new_controller_class.class_exec(&body)
+          (class << self; self; end).__send__(:define_method, :controller_class) { new_controller_class }
+
+          before do
+            @orig_routes = routes
+            resource_name = if @controller.respond_to?(:controller_name)
+                              @controller.controller_name.to_sym
+                            else
+                              :anonymous
+                            end
+            resource_path = if @controller.respond_to?(:controller_path)
+                              @controller.controller_path
+                            else
+                              resource_name.to_s
+                            end
+            resource_module = resource_path.rpartition('/').first.presence
+            resource_as = 'anonymous_' + resource_path.tr('/', '_')
+            self.routes = ActionDispatch::Routing::RouteSet.new.tap do |r|
+              r.draw do
+                resources resource_name,
+                          :as => resource_as,
+                          :module => resource_module,
+                          :path => resource_path
+              end
+            end
+          end
+
+          after do
+            self.routes  = @orig_routes
+            @orig_routes = nil
+          end
         end
-        metadata[:example_group][:described_class].class_eval(&body)
 
-        before do
-          @orig_routes = self.routes
-          self.routes  = ActionDispatch::Routing::RouteSet.new.tap { |r|
-            r.draw { resources :anonymous }
-          }
+        # 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 }
+        #
+        #       # ...
+        #     end
+        def routes
+          before do
+            self.routes = yield
+          end
         end
+      end
+
+      # @!attribute [r]
+      # Returns the controller object instance under test.
+      attr_reader :controller
 
-        after do
-          self.routes  = @orig_routes
-          @orig_routes = nil
+      # @!attribute [r]
+      # Returns the Rails routes used for the spec.
+      attr_reader :routes
+
+      # @private
+      #
+      # RSpec Rails uses this to make Rails routes easily available to specs.
+      def routes=(routes)
+        @routes = routes
+        assertion_instance.instance_variable_set(:@routes, routes)
+      end
+
+      # @private
+      module BypassRescue
+        def rescue_with_handler(exception)
+          raise exception
         end
       end
 
-      # Specifies the routeset that will be used for the example group. This
-      # is most useful when testing Rails engines.
+      # Extends the controller with a module that overrides
+      # `rescue_with_handler` to raise the exception passed to it. Use this to
+      # specify that an action _should_ raise an exception given appropriate
+      # conditions.
       #
       # @example
+      #     describe ProfilesController do
+      #       it "raises a 403 when a non-admin user tries to view another user's profile" do
+      #         profile = create_profile
+      #         login_as profile.user
       #
-      #     describe MyEngine::PostsController do
-      #       routes { MyEngine::Engine.routes }
-      #
-      #       # ...
+      #         expect do
+      #           bypass_rescue
+      #           get :show, :id => profile.id + 1
+      #         end.to raise_error(/403 Forbidden/)
+      #       end
       #     end
-      def routes(&blk)
-        before do
-          self.routes = blk.call
+      def bypass_rescue
+        controller.extend(BypassRescue)
+      end
+
+      # If method is a named_route, delegates to the RouteSet associated with
+      # this controller.
+      def method_missing(method, *args, &block)
+        if route_available?(method)
+          controller.send(method, *args, &block)
+        else
+          super
         end
       end
-    end
 
-    attr_reader :controller, :routes
+      included do
+        subject { controller }
 
-    # @api private
-    def routes=(routes)
-      @routes = routes
-      assertion_instance.instance_variable_set(:@routes, routes)
-    end
+        before do
+          self.routes = ::Rails.application.routes
+        end
 
-    module BypassRescue
-      def rescue_with_handler(exception)
-        raise exception
+        around do |ex|
+          previous_allow_forgery_protection_value = ActionController::Base.allow_forgery_protection
+          begin
+            ActionController::Base.allow_forgery_protection = false
+            ex.call
+          ensure
+            ActionController::Base.allow_forgery_protection = previous_allow_forgery_protection_value
+          end
+        end
       end
-    end
 
-    # Extends the controller with a module that overrides
-    # `rescue_with_handler` to raise the exception passed to it.  Use this to
-    # specify that an action _should_ raise an exception given appropriate
-    # conditions.
-    #
-    # @example
-    #
-    #     describe ProfilesController do
-    #       it "raises a 403 when a non-admin user tries to view another user's profile" do
-    #         profile = create_profile
-    #         login_as profile.user
-    #
-    #         expect do
-    #           bypass_rescue
-    #           get :show, :id => profile.id + 1
-    #         end.to raise_error(/403 Forbidden/)
-    #       end
-    #     end
-    def bypass_rescue
-      controller.extend(BypassRescue)
-    end
+    private
 
-    # If method is a named_route, delegates to the RouteSet associated with
-    # this controller.
-    def method_missing(method, *args, &block)
-      if @routes && @routes.named_routes.helpers.include?(method)
-        controller.send(method, *args, &block)
-      elsif defined?(@orig_routes) && @orig_routes && @orig_routes.named_routes.helpers.include?(method)
-        controller.send(method, *args, &block)
-      else
-        super
+      def route_available?(method)
+        (defined?(@routes) && route_defined?(routes, method)) ||
+          (defined?(@orig_routes) && route_defined?(@orig_routes, method))
       end
-    end
-
-    included do
-      subject { controller }
 
-      metadata[:type] = :controller
-
-      before do
-        self.routes = ::Rails.application.routes
-      end
+      def route_defined?(routes, method)
+        return false if routes.nil?
 
-      around do |ex|
-        previous_allow_forgery_protection_value = ActionController::Base.allow_forgery_protection
-        begin
-          ActionController::Base.allow_forgery_protection = false
-          ex.call
-        ensure
-          ActionController::Base.allow_forgery_protection = previous_allow_forgery_protection_value
+        if routes.named_routes.respond_to?(:route_defined?)
+          routes.named_routes.route_defined?(method)
+        else
+          routes.named_routes.helpers.include?(method)
         end
       end
     end

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

@@ -1,30 +1,73 @@
-module RSpec::Rails
-  module FeatureExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
+module RSpec
+  module Rails
+    # @api public
+    # Container module for routing spec functionality.
+    module FeatureExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
 
-    DEFAULT_HOST = "www.example.com"
+      # Default host to be used in Rails route helpers if none is specified.
+      DEFAULT_HOST = "www.example.com"
 
-    included do
-      metadata[:type] = :feature
+      included do
+        app = ::Rails.application
+        if app.respond_to?(:routes)
+          include app.routes.url_helpers     if app.routes.respond_to?(:url_helpers)
+          include app.routes.mounted_helpers if app.routes.respond_to?(:mounted_helpers)
 
-      app = ::Rails.application
-      if app.respond_to?(:routes)
-        include app.routes.url_helpers     if app.routes.respond_to?(:url_helpers)
-        include app.routes.mounted_helpers if app.routes.respond_to?(:mounted_helpers)
-
-        if respond_to?(:default_url_options)
-          default_url_options[:host] ||= ::RSpec::Rails::FeatureExampleGroup::DEFAULT_HOST
+          if respond_to?(:default_url_options)
+            default_url_options[:host] ||= ::RSpec::Rails::FeatureExampleGroup::DEFAULT_HOST
+          end
         end
       end
-    end
 
-    def visit(*)
-      if defined?(super)
-        super
-      else
-        raise "Capybara not loaded, please add it to your Gemfile:\n\ngem \"capybara\""
+      # Shim to check for presence of Capybara. Will delegate if present, raise
+      # if not. We assume here that in most cases `visit` will be the first
+      # Capybara method called in a spec.
+      def visit(*)
+        if defined?(super)
+          super
+        else
+          raise "Capybara not loaded, please add it to your Gemfile:\n\ngem \"capybara\""
+        end
       end
     end
   end
 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`.
+    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'
+  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

@@ -1,39 +1,48 @@
 require 'rspec/rails/view_assigns'
 
-module RSpec::Rails
-  module HelperExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
-    include ActionView::TestCase::Behavior
-    include RSpec::Rails::ViewAssigns
+module RSpec
+  module Rails
+    # @api public
+    # Container module for helper specs.
+    module HelperExampleGroup
+      extend ActiveSupport::Concern
+      include RSpec::Rails::RailsExampleGroup
+      include ActionView::TestCase::Behavior
+      include RSpec::Rails::ViewAssigns
 
-    module ClassMethods
-      # @api private
-      def determine_default_helper_class(ignore)
-        described_class
+      # @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
+        end
       end
-    end
 
-    # Returns an instance of ActionView::Base with the helper being specified
-    # mixed in, along with any of the built-in rails helpers.
-    def helper
-      _view.tap do |v|
-        v.extend(ApplicationHelper) if defined?(ApplicationHelper)
-        v.assign(view_assigns)
+      # Returns an instance of ActionView::Base with the helper being specified
+      # mixed in, along with any of the built-in rails helpers.
+      def helper
+        _view.tap do |v|
+          v.extend(ApplicationHelper) if defined?(ApplicationHelper)
+          v.assign(view_assigns)
+        end
       end
-    end
 
     private
 
-    def _controller_path
-      example.example_group.described_class.to_s.sub(/Helper/,'').underscore
-    end
-
-    included do
-      metadata[:type] = :helper
+      def _controller_path(example)
+        example.example_group.described_class.to_s.sub(/Helper/, '').underscore
+      end
 
-      before do
-        controller.controller_path = _controller_path
+      included do
+        before do |example|
+          controller.controller_path = _controller_path(example)
+        end
       end
     end
   end