rspec-rails 2.99.0 → 3.1.0

data/lib/rspec/rails/configuration.rb

@@ -0,0 +1,97 @@
+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],
+      :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]
+    }
+
+    # @private
+    def self.initialize_configuration(config)
+      config.backtrace_exclusion_patterns << /vendor\//
+      config.backtrace_exclusion_patterns << %r{ lib/rspec/rails }
+
+      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
+
+      if defined?(ActionMailer)
+        config.include RSpec::Rails::MailerExampleGroup, :type => :mailer
+      end
+
+      # controller settings
+      config.add_setting :infer_base_class_for_anonymous_controllers, :default => true
+
+      # fixture support
+      config.include RSpec::Rails::FixtureSupport
+      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
+
+      # 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
+
+      def config.render_views=(val)
+        self.rendering_views = val
+      end
+
+      def config.render_views
+        self.rendering_views = true
+      end
+
+      def config.render_views?
+        rendering_views
+      end
+
+      def config.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
+    end
+
+    initialize_configuration RSpec.configuration
+  end
+end

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

@@ -1,188 +1,202 @@
-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
-
-      # 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
-        base_class ||= root_controller
-
-        new_controller_class = Class.new(base_class) do
-          def self.name; "AnonymousController"; end
+module RSpec
+  module Rails
+    # 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 RSpec::Rails::AssertionDelegator.new(ActionDispatch::Assertions::RoutingAssertions)
+
+      # Class-level DSL for controller specs.
+      module ClassMethods
+        # @private
+        def controller_class
+          described_class
         end
-        new_controller_class.class_eval(&body)
 
-        (class << self; self; end).__send__(:define_method, :controller_class) { new_controller_class }
-        metadata[:example_group].delete(:described_class)
-        metadata[:example_group].extend DescribedClassDeprecation.new(new_controller_class)
+        # 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.to_s
+              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
 
-        before do
-          @orig_routes = self.routes
-          self.routes  = ActionDispatch::Routing::RouteSet.new.tap { |r|
-            r.draw { resources :anonymous }
-          }
+          after do
+            self.routes  = @orig_routes
+            @orig_routes = nil
+          end
         end
 
-        after do
-          self.routes  = @orig_routes
-          @orig_routes = nil
+        # 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(&blk)
+          before do
+            self.routes = blk.call
+          end
         end
       end
 
-      class DescribedClassDeprecation < Module
-        def initialize(value)
-          module_eval do
-            define_method :store_computed do |key|
-              return super(key) unless key == :described_class
-
-              RSpec.warn_deprecation(<<-EOS.gsub(/^\s+\|/,''))
-                |In RSpec 3, the `controller { }` macro no longer changes
-                |`described_class` to refer to the generated anonymous controller
-                |class. Instead of `described_class`, use `controller_class` to
-                |access the generated anonymous class.
-                |(`described_class` called from #{::RSpec::CallerFilter.first_non_rspec_line}.)
-              EOS
-              store(:described_class, value)
-            end
-          end
+      attr_reader :controller, :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,29 +1,34 @@
-module RSpec::Rails
-  module FeatureExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
+module RSpec
+  module Rails
+    # 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

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

@@ -1,39 +1,40 @@
 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
+    # 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
+        def determine_default_helper_class(_ignore)
+          described_class
+        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.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 |example|
-        controller.controller_path = _controller_path(example)
+      included do
+        before do |example|
+          controller.controller_path = _controller_path(example)
+        end
       end
     end
   end

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

@@ -1,20 +1,35 @@
-if defined?(ActionMailer)
-  module RSpec::Rails
+module RSpec
+  module Rails
+    # 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,10 @@
-module RSpec::Rails
-  module ModelExampleGroup
-    extend ActiveSupport::Concern
-    include RSpec::Rails::RailsExampleGroup
-
-    included do
-      metadata[:type] = :model
+module RSpec
+  module Rails
+    # 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,6 +4,7 @@ require 'rspec/rails/matchers'
 
 module RSpec
   module Rails
+    # Common rails example functionality.
     module RailsExampleGroup
       extend ActiveSupport::Concern
       include RSpec::Rails::SetupAndTeardownAdapter