rspec-rails 2.99.0 → 3.1.0

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

@@ -1,22 +1,24 @@
-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
+    # 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
-
-    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,55 @@
 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 RSpec
+  module Rails
+    # 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::AssertionDelegator.new(ActionDispatch::Assertions::RoutingAssertions)
+
+      # 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(&blk)
+          before do
+            self.routes = blk.call
+          end
+        end
+      end
 
-    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)
+      included do
         before do
-          self.routes = blk.call
+          self.routes = ::Rails.application.routes
         end
       end
-    end
 
-    included do
-      metadata[:type] = :routing
+      attr_reader :routes
 
-      before do
-        self.routes = ::Rails.application.routes
+      # @private
+      def routes=(routes)
+        @routes = routes
+        assertion_instance.instance_variable_set(:@routes, routes)
       end
-    end
-
-    attr_reader :routes
-
-    # @api 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/view_example_group.rb

@@ -1,169 +1,172 @@
 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
-      end
-    end
+module RSpec
+  module Rails
+    # 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 ClassMethods
+        def _default_helper
+          base = metadata[:description].split('/')[0..-2].join('/')
+          (base.camelize + 'Helper').constantize if base
+        rescue NameError
+          nil
+        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)
+        def _default_helpers
+          helpers = [_default_helper].compact
+          helpers << ApplicationHelper if Object.const_defined?('ApplicationHelper')
+          helpers
+        end
       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
+      # DSL exposed to view specs.
+      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 && options.empty?
+          super(options, local_assigns, &block)
+        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
+        # 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
 
-      # Provides access to the params hash that will be available within the
-      # view:
-      #
-      #     params[:foo] = 'bar'
-      def params
-        controller.params
-      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(ActionView::FixtureResolver.new(hash))
+        end
 
-      # @deprecated Use `view` instead.
-      def template
-        RSpec.deprecate("template", :replacement => "view")
-        view
-      end
+        # Provides access to the params hash that will be available within the
+        # view.
+        #
+        #     params[:foo] = 'bar'
+        def params
+          controller.params
+        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;
+        # @deprecated Use `view` instead.
+        def template
+          RSpec.deprecate("template", :replacement => "view")
+          view
         end
 
-        rendered
-      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
+          end
+
+          rendered
+        end
 
-    private
+      private
 
-      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
+        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
 
-          render_options = {:template => template}
-          render_options[:handlers] = [handler] if handler
-          render_options[:formats] = [format] if format
-          render_options[:locales] = [locale] if locale
+            render_options = { :template => template }
+            render_options[:handlers] = [handler] if handler
+            render_options[:formats] = [format] if format
+            render_options[:locales] = [locale] if locale
 
-          render_options
-        else
-          {:template => _default_file_to_render}
+            render_options
+          else
+            { :template => _default_file_to_render }
+          end
         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
-          view.lookup_context.prefixes << _controller_path
-        end
+        before do
+          _include_controller_helpers
+          if view.lookup_context.respond_to?(:prefixes)
+            # rails 3.1
+            view.lookup_context.prefixes << _controller_path
+          end
 
-        # fixes bug with differing formats
-        view.lookup_context.view_paths.each(&:clear_cache)
+          # fixes bug with differing formats
+          view.lookup_context.view_paths.each(&:clear_cache)
 
-        controller.controller_path = _controller_path
-        controller.request.path_parameters[:controller] = _controller_path
-        controller.request.path_parameters[:action]     = _inferred_action unless _inferred_action =~ /^_/
-      end
+          controller.controller_path = _controller_path
+          controller.request.path_parameters[:controller] = _controller_path
+          controller.request.path_parameters[:action]     = _inferred_action unless _inferred_action =~ /^_/
+        end
 
-      let(:_default_file_to_render) do |example|
-        example.example_group.top_level_description
+        let(:_default_file_to_render) do |example|
+          example.example_group.top_level_description
+        end
       end
     end
   end
 end
-

data/lib/rspec/rails/example.rb

@@ -7,36 +7,3 @@ require 'rspec/rails/example/mailer_example_group'
 require 'rspec/rails/example/routing_example_group'
 require 'rspec/rails/example/model_example_group'
 require 'rspec/rails/example/feature_example_group'
-
-RSpec::configure do |c|
-  def c.escaped_path(*parts)
-    Regexp.compile(parts.join('[\\\/]') + '[\\\/]')
-  end
-
-  c.include RSpec::Rails::ControllerExampleGroup, :type => :controller, :example_group => {
-    :file_path => c.escaped_path(%w[spec controllers])
-  }
-  c.include RSpec::Rails::HelperExampleGroup, :type => :helper, :example_group => {
-    :file_path => c.escaped_path(%w[spec helpers])
-  }
-  if defined?(RSpec::Rails::MailerExampleGroup)
-    c.include RSpec::Rails::MailerExampleGroup, :type => :mailer, :example_group => {
-      :file_path => c.escaped_path(%w[spec mailers])
-    }
-  end
-  c.include RSpec::Rails::ModelExampleGroup, :type => :model, :example_group => {
-    :file_path => c.escaped_path(%w[spec models])
-  }
-  c.include RSpec::Rails::RequestExampleGroup, :type => :request, :example_group => {
-    :file_path => c.escaped_path(%w[spec (requests|integration|api)])
-  }
-  c.include RSpec::Rails::RoutingExampleGroup, :type => :routing, :example_group => {
-    :file_path => c.escaped_path(%w[spec routing])
-  }
-  c.include RSpec::Rails::ViewExampleGroup, :type => :view, :example_group => {
-    :file_path => c.escaped_path(%w[spec views])
-  }
-  c.include RSpec::Rails::FeatureExampleGroup, :type => :feature, :example_group => {
-    :file_path => c.escaped_path(%w[spec features])
-  }
-end

data/lib/rspec/rails/extensions/active_record/proxy.rb

@@ -14,4 +14,3 @@ RSpec.configure do |rspec|
     end
   end
 end
-

data/lib/rspec/rails/extensions.rb

@@ -1,2 +1 @@
-require 'rspec/rails/extensions/active_record/base'
 require 'rspec/rails/extensions/active_record/proxy'

data/lib/rspec/rails/feature_check.rb

@@ -0,0 +1,35 @@
+# @api private
+module RSpec
+  module Rails
+    # Disable some cops until https://github.com/bbatsov/rubocop/issues/1310
+    # rubocop:disable Style/IndentationConsistency
+    module FeatureCheck
+    # rubocop:disable Style/IndentationWidth
+    module_function
+      # rubocop:enable Style/IndentationWidth
+
+      def can_check_pending_migrations?
+        has_active_record_migration? &&
+          ::ActiveRecord::Migration.respond_to?(:check_pending!)
+      end
+
+      def can_maintain_test_schema?
+        has_active_record_migration? &&
+          ::ActiveRecord::Migration.respond_to?(:maintain_test_schema!)
+      end
+
+      def has_active_job?
+        defined?(::ActiveJob)
+      end
+
+      def has_active_record?
+        defined?(::ActiveRecord)
+      end
+
+      def has_active_record_migration?
+        has_active_record? && defined?(::ActiveRecord::Migration)
+      end
+    end
+    # rubocop:enable Style/IndentationConsistency
+  end
+end

data/lib/rspec/rails/fixture_support.rb

@@ -1,7 +1,8 @@
 module RSpec
   module Rails
-    if defined?(ActiveRecord::TestFixtures)
-      module FixtureSupport
+    # @private
+    module FixtureSupport
+      if defined?(ActiveRecord::TestFixtures)
         extend ActiveSupport::Concern
         include RSpec::Rails::SetupAndTeardownAdapter
         include RSpec::Rails::MinitestLifecycleAdapter if ::ActiveRecord::VERSION::STRING > '4'
@@ -9,12 +10,12 @@ module RSpec
         include ActiveRecord::TestFixtures
 
         included do
-          # TODO (DC 2011-06-25) this is necessary because fixture_file_upload
+          # TODO: (DC 2011-06-25) this is necessary because fixture_file_upload
           # accesses fixture_path directly on ActiveSupport::TestCase. This is
           # fixed in rails by https://github.com/rails/rails/pull/1861, which
           # should be part of the 3.1 release, at which point we can include
           # these lines for rails < 3.1.
-          ActiveSupport::TestCase.class_eval do
+          ActiveSupport::TestCase.class_exec do
             include ActiveRecord::TestFixtures
             self.fixture_path = RSpec.configuration.fixture_path
           end
@@ -26,14 +27,6 @@ module RSpec
           fixtures RSpec.configuration.global_fixtures if RSpec.configuration.global_fixtures
         end
       end
-
-      RSpec.configure do |c|
-        c.include RSpec::Rails::FixtureSupport
-        c.add_setting :use_transactional_fixtures, :alias_with => :use_transactional_examples
-        c.add_setting :use_instantiated_fixtures
-        c.add_setting :global_fixtures
-        c.add_setting :fixture_path
-      end
     end
   end
 end