rspec-rails 2.99.0 → 3.1.0

data/lib/rspec/rails/matchers/have_rendered.rb

@@ -1,40 +1,44 @@
-module RSpec::Rails::Matchers
-  module RenderTemplate
-    class RenderTemplateMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+module RSpec
+  module Rails
+    module Matchers
+      # Matcher for template rendering.
+      module RenderTemplate
+        # @private
+        class RenderTemplateMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(scope, expected, message = nil)
+            @expected = Symbol === expected ? expected.to_s : expected
+            @message = message
+            @scope = scope
+          end
 
-      def initialize(scope, expected, message=nil)
-        @expected = Symbol === expected ? expected.to_s : expected
-        @message = message
-        @scope = scope
-      end
+          # @api private
+          def matches?(*)
+            match_unless_raises ActiveSupport::TestCase::Assertion do
+              @scope.assert_template expected, @message
+            end
+          end
+
+          # @api private
+          def failure_message
+            rescued_exception.message
+          end
 
-      # @api private
-      def matches?(*)
-        match_unless_raises ActiveSupport::TestCase::Assertion do
-          @scope.assert_template expected, @message
+          # @api private
+          def failure_message_when_negated
+            "expected not to render #{expected.inspect}, but did"
+          end
         end
-      end
 
-      # @api private
-      def failure_message_for_should
-        rescued_exception.message
-      end
+        # Delegates to `assert_template`.
+        #
+        # @example
+        #     expect(response).to have_rendered("new")
+        def have_rendered(options, message = nil)
+          RenderTemplateMatcher.new(self, options, message)
+        end
 
-      # @api private
-      def failure_message_for_should_not
-        "expected not to render #{expected.inspect}, but did"
+        alias_method :render_template, :have_rendered
       end
     end
-
-    # Delegates to `assert_template`
-    #
-    # @example
-    #
-    #     response.should have_rendered("new")
-    def have_rendered(options, message=nil)
-      RenderTemplateMatcher.new(self, options, message)
-    end
-
-    alias_method :render_template, :have_rendered
   end
 end

data/lib/rspec/rails/matchers/redirect_to.rb

@@ -1,37 +1,38 @@
-module RSpec::Rails::Matchers
-  module RedirectTo
-    class RedirectTo < RSpec::Matchers::BuiltIn::BaseMatcher
+module RSpec
+  module Rails
+    module Matchers
+      # Matcher for redirects.
+      module RedirectTo
+        # @private
+        class RedirectTo < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(scope, expected)
+            @expected = expected
+            @scope = scope
+          end
 
-      def initialize(scope, expected)
-        @expected = expected
-        @scope = scope
-      end
+          def matches?(_)
+            match_unless_raises ActiveSupport::TestCase::Assertion do
+              @scope.assert_redirected_to(@expected)
+            end
+          end
 
-      # @api private
-      def matches?(_)
-        match_unless_raises ActiveSupport::TestCase::Assertion do
-          @scope.assert_redirected_to(@expected)
-        end
-      end
+          def failure_message
+            rescued_exception.message
+          end
 
-      # @api private
-      def failure_message_for_should
-        rescued_exception.message
-      end
+          def failure_message_when_negated
+            "expected not to redirect to #{@expected.inspect}, but did"
+          end
+        end
 
-      # @api private
-      def failure_message_for_should_not
-        "expected not to redirect to #{@expected.inspect}, but did"
+        # Delegates to `assert_redirected_to`.
+        #
+        # @example
+        #     expect(response).to redirect_to(:action => "new")
+        def redirect_to(target)
+          RedirectTo.new(self, target)
+        end
       end
     end
-
-    # Delegates to `assert_redirected_to`
-    #
-    # @example
-    #
-    #     response.should redirect_to(:action => "new")
-    def redirect_to(target)
-      RedirectTo.new(self, target)
-    end
   end
 end

data/lib/rspec/rails/matchers/relation_match_array.rb

@@ -1,3 +1,3 @@
 if defined?(ActiveRecord::Relation)
-  RSpec::Matchers::BuiltIn::OperatorMatcher.register(ActiveRecord::Relation, '=~', RSpec::Matchers::BuiltIn::MatchArray)
+  RSpec::Matchers::BuiltIn::OperatorMatcher.register(ActiveRecord::Relation, '=~', RSpec::Matchers::BuiltIn::ContainExactly)
 end

data/lib/rspec/rails/matchers/routing_matchers.rb

@@ -1,109 +1,119 @@
-module RSpec::Rails::Matchers
-  module RoutingMatchers
-    extend RSpec::Matchers::DSL
+module RSpec
+  module Rails
+    module Matchers
+      # Matchers to help with specs for routing code.
+      module RoutingMatchers
+        extend RSpec::Matchers::DSL
 
-    class RouteToMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+        # @private
+        class RouteToMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(scope, *expected)
+            @scope = scope
+            @expected = expected[1] || {}
+            if Hash === expected[0]
+              @expected.merge!(expected[0])
+            else
+              controller, action = expected[0].split('#')
+              @expected.merge!(:controller => controller, :action => action)
+            end
+          end
 
-      def initialize(scope, *expected)
-        @scope = scope
-        @expected = expected[1] || {}
-        if Hash === expected[0]
-          @expected.merge!(expected[0])
-        else
-          controller, action = expected[0].split('#')
-          @expected.merge!(:controller => controller, :action => action)
-        end
-      end
-      
-      # @api private
-      def matches?(verb_to_path_map)
-        @actual = @verb_to_path_map = verb_to_path_map
-        # assert_recognizes does not consider ActionController::RoutingError an
-        # assertion failure, so we have to capture that and Assertion here.
-        match_unless_raises ActiveSupport::TestCase::Assertion, ActionController::RoutingError do
-          path, query = *verb_to_path_map.values.first.split('?')
-          @scope.assert_recognizes(
-            @expected,
-            {:method => verb_to_path_map.keys.first, :path => path},
-            Rack::Utils::parse_query(query)
-          )
-        end
-      end
+          def matches?(verb_to_path_map)
+            @actual = @verb_to_path_map = verb_to_path_map
+            # assert_recognizes does not consider ActionController::RoutingError an
+            # assertion failure, so we have to capture that and Assertion here.
+            match_unless_raises ActiveSupport::TestCase::Assertion, ActionController::RoutingError do
+              path, query = *verb_to_path_map.values.first.split('?')
+              @scope.assert_recognizes(
+                @expected,
+                { :method => verb_to_path_map.keys.first, :path => path },
+                Rack::Utils.parse_nested_query(query)
+              )
+            end
+          end
 
-      # @api private
-      def failure_message_for_should
-        rescued_exception.message
-      end
+          def failure_message
+            rescued_exception.message
+          end
 
-      def failure_message_for_should_not
-        "expected #{@actual.inspect} not to route to #{@expected.inspect}"
-      end
+          def failure_message_when_negated
+            "expected #{@actual.inspect} not to route to #{@expected.inspect}"
+          end
 
-      def description
-        "route #{@actual.inspect} to #{@expected.inspect}"
-      end
-    end
-
-    # Delegates to `assert_recognizes`. Supports short-hand controller/action
-    # declarations (e.g. `"controller#action"`).
-    #
-    # @example
-    #
-    #     { :get => "/things/special" }.should route_to(
-    #       :controller => "things",
-    #       :action     => "special"
-    #     )
-    #
-    #     { :get => "/things/special" }.should route_to("things#special")
-    #
-    # @see http://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes
-    def route_to(*expected)
-      RouteToMatcher.new(self, *expected)
-    end
+          def description
+            "route #{@actual.inspect} to #{@expected.inspect}"
+          end
+        end
 
-    class BeRoutableMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+        # Delegates to `assert_recognizes`. Supports short-hand controller/action
+        # declarations (e.g. `"controller#action"`).
+        #
+        # @example
+        #
+        #     expect(:get => "/things/special").to route_to(
+        #       :controller => "things",
+        #       :action     => "special"
+        #     )
+        #
+        #     expect(:get => "/things/special").to route_to("things#special")
+        #
+        # @see http://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes
+        def route_to(*expected)
+          RouteToMatcher.new(self, *expected)
+        end
 
-      def initialize(scope)
-        @scope = scope
-      end
+        # @private
+        class BeRoutableMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(scope)
+            @scope = scope
+          end
 
-      # @api private
-      def matches?(path)
-        @actual = path
-        match_unless_raises ActionController::RoutingError do
-          @routing_options = @scope.routes.recognize_path(
-            path.values.first, :method => path.keys.first
-          )
-        end
-      end
+          def matches?(path)
+            @actual = path
+            match_unless_raises ActionController::RoutingError do
+              @routing_options = @scope.routes.recognize_path(
+                path.values.first, :method => path.keys.first
+              )
+            end
+          end
 
-      def failure_message_for_should
-        "expected #{@actual.inspect} to be routable"
-      end
+          def failure_message
+            "expected #{@actual.inspect} to be routable"
+          end
 
-      def failure_message_for_should_not
-        "expected #{@actual.inspect} not to be routable, but it routes to #{@routing_options.inspect}"
-      end
-    end
+          def failure_message_when_negated
+            "expected #{@actual.inspect} not to be routable, but it routes to #{@routing_options.inspect}"
+          end
+        end
 
-    # Passes if the route expression is recognized by the Rails router based on
-    # the declarations in `config/routes.rb`. Delegates to
-    # `RouteSet#recognize_path`.
-    #
-    # @example
-    #
-    # You can use route helpers provided by rspec-rails.
-    #     {:get =>  "/a/path"}.should be_routable
-    #     {:post => "/another/path"}.should be_routable
-    #     {:put => "/yet/another/path"}.should_not be_routable
-    def be_routable
-      BeRoutableMatcher.new(self)
-    end
+        # Passes if the route expression is recognized by the Rails router based on
+        # the declarations in `config/routes.rb`. Delegates to
+        # `RouteSet#recognize_path`.
+        #
+        # @example You can use route helpers provided by rspec-rails.
+        #     expect(:get  => "/a/path").to be_routable
+        #     expect(:post => "/another/path").to be_routable
+        #     expect(:put  => "/yet/another/path").to be_routable
+        def be_routable
+          BeRoutableMatcher.new(self)
+        end
 
-    module RouteHelpers
-      %w(get post put patch delete options head).each do |method|
-        define_method method do |path|
-          { method.to_sym => path }
+        # Helpers for matching different route types.
+        module RouteHelpers
+          # @!method get
+          # @!method post
+          # @!method put
+          # @!method patch
+          # @!method delete
+          # @!method options
+          # @!method head
+          #
+          # Shorthand method for matching this type of route.
+          %w[get post put patch delete options head].each do |method|
+            define_method method do |path|
+              { method.to_sym => path }
+            end
+          end
         end
       end
     end

data/lib/rspec/rails/matchers.rb

@@ -1,8 +1,11 @@
-require 'rspec/core/deprecation'
+require 'rspec/core/warnings'
 require 'rspec/expectations'
 
-module RSpec::Rails
-  module Matchers
+module RSpec
+  module Rails
+    # Container module for Rails specific matchers.
+    module Matchers
+    end
   end
 end
 
@@ -22,6 +25,6 @@ require 'rspec/rails/matchers/redirect_to'
 require 'rspec/rails/matchers/routing_matchers'
 require 'rspec/rails/matchers/be_new_record'
 require 'rspec/rails/matchers/be_a_new'
-require 'rspec/rails/matchers/have_extension'
 require 'rspec/rails/matchers/relation_match_array'
 require 'rspec/rails/matchers/be_valid'
+require 'rspec/rails/matchers/have_http_status'

data/lib/rspec/rails/tasks/rspec.rake

@@ -22,7 +22,7 @@ namespace :spec do
   task :prepare do
     ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'test'
     if Rails.configuration.generators.options[:rails][:orm] == :active_record
-      if ::Rails::VERSION::STRING.to_f < 4.1
+      if Rake::Task.task_defined?("test:prepare")
         Rake::Task["test:prepare"].invoke
       end
     end

data/lib/rspec/rails/vendor/capybara.rb

@@ -9,42 +9,11 @@ rescue LoadError
 end
 
 if defined?(Capybara)
-  module RSpec::Rails::DeprecatedCapybaraDSL
-    include ::Capybara::DSL
-
-    def self.included(mod)
-      mod.extend(ClassMethods)
-      super
-    end
-
-    module ClassMethods
-      def include(mod)
-        if mod == ::Capybara::DSL
-          class_variable_set(:@@_rspec_capybara_included_explicitly, true)
-        end
-
-        super
-      end
-    end
-
-    ::Capybara::DSL.instance_methods(false).each do |method|
-      # capybara internally calls `page`, skip to avoid a duplicate
-      # deprecation warning
-      next if method.to_s == 'page'
-
-      define_method method do |*args, &blk|
-        unless self.class.class_variable_defined?(:@@_rspec_capybara_included_explicitly)
-          RSpec.deprecate "Using the capybara method `#{method}` in controller specs",
-            :replacement => "feature specs (spec/features)"
-        end
-        super(*args, &blk)
-      end
-    end
-  end
+  require 'rspec/support/version_checker'
+  RSpec::Support::VersionChecker.new('capybara', Capybara::VERSION, '2.2.0').check_version!
 
   RSpec.configure do |c|
     if defined?(Capybara::DSL)
-      c.include ::RSpec::Rails::DeprecatedCapybaraDSL, :type => :controller
       c.include Capybara::DSL, :type => :feature
     end
 

data/lib/rspec/rails/version.rb

@@ -1,7 +1,9 @@
 module RSpec
   module Rails
+    # Version information for RSpec Rails.
     module Version
-      STRING = '2.99.0'
+      # Current version of RSpec Rails, in semantic versioning format.
+      STRING = '3.1.0'
     end
   end
 end

data/lib/rspec/rails/view_assigns.rb

@@ -1,5 +1,6 @@
 module RSpec
   module Rails
+    # Helpers for making instance variables available to views.
     module ViewAssigns
       # Assigns a value to an instance variable in the scope of the
       # view being rendered.
@@ -11,35 +12,34 @@ module RSpec
         _encapsulated_assigns[key] = value
       end
 
+      # Compat-shim for AbstractController::Rendering#view_assigns
+      #
+      # _assigns was deprecated in favor of view_assigns after
+      # Rails-3.0.0 was released. Since we are not able to predict when
+      # the _assigns/view_assigns patch will be released (I thought it
+      # would have been in 3.0.1, but 3.0.1 bypassed this change for a
+      # security fix), this bit ensures that we do the right thing without
+      # knowing anything about the Rails version we are dealing with.
+      #
+      # Once that change _is_ released, this can be changed to something
+      # that checks for the Rails version when the module is being
+      # interpreted, as it was before commit dd0095.
       def view_assigns
-        begin
-          # TODO: _assigns was deprecated in favor of view_assigns after
-          # Rails-3.0.0 was released. Since we are not able to predict when
-          # the _assigns/view_assigns patch will be released (I thought it
-          # would have been in 3.0.1, but 3.0.1 bypassed this change for a
-          # security fix), this bit ensures that we do the right thing without
-          # knowing anything about the Rails version we are dealing with.
-          #
-          # Once that change _is_ released, this can be changed to something
-          # that checks for the Rails version when the module is being
-          # interpreted, as it was before commit dd0095.
-          super.merge(_encapsulated_assigns)
-        rescue
-          _assigns
-        end
+        super.merge(_encapsulated_assigns)
+      rescue
+        _assigns
       end
 
-      # @api private
+      # @private
       def _assigns
         super.merge(_encapsulated_assigns)
       end
 
-      private
+    private
 
       def _encapsulated_assigns
         @_encapsulated_assigns ||= {}
       end
-
     end
   end
 end

data/lib/rspec/rails/view_rendering.rb

@@ -1,53 +1,27 @@
 require 'action_view/testing/resolvers'
 
-RSpec.configure do |config|
-  # 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
-end
-
 module RSpec
   module Rails
+    # Helpers for optionally rendering views in controller specs.
     module ViewRendering
       extend ActiveSupport::Concern
 
       attr_accessor :controller
 
+      # DSL methods
       module ClassMethods
-        def metadata_for_rspec_rails
-          metadata[:rspec_rails] = metadata[:rspec_rails] ? metadata[:rspec_rails].dup : {}
-        end
-
         # @see RSpec::Rails::ControllerExampleGroup
-        def render_views(true_or_false=true)
-          metadata_for_rspec_rails[:render_views] = true_or_false
-        end
-
-        # @deprecated Use `render_views` instead.
-        def integrate_views
-          RSpec.deprecate("integrate_views", :replacement => "render_views")
-          render_views
+        def render_views(true_or_false = true)
+          @render_views = true_or_false
         end
 
         # @api private
         def render_views?
-          metadata_for_rspec_rails.fetch(:render_views) do
+          return @render_views if defined?(@render_views)
+
+          if superclass.respond_to?(:render_views?)
+            superclass.render_views?
+          else
             RSpec.configuration.render_views?
           end
         end
@@ -60,6 +34,8 @@ module RSpec
 
       # Delegates find_all to the submitted path set and then returns templates
       # with modified source
+      #
+      # @private
       class EmptyTemplatePathSetDecorator < ::ActionView::Resolver
         attr_reader :original_path_set
 
@@ -67,40 +43,39 @@ module RSpec
           @original_path_set = original_path_set
         end
 
-        # @api private
         def find_all(*args)
-          original_path_set.find_all(*args).collect do |template|
+          original_path_set.find_all(*args).map do |template|
             ::ActionView::Template.new(
               "",
               template.identifier,
               EmptyTemplateHandler,
-              {
-                :virtual_path => template.virtual_path,
-                :format => template.formats
-              }
+              :virtual_path => template.virtual_path,
+              :format => template.formats
             )
           end
         end
       end
 
+      # @private
       class EmptyTemplateHandler
-        def self.call(template)
+        def self.call(_template)
           %("")
         end
       end
 
+      # Used to null out view rendering in controller specs.
+      #
+      # @private
       module EmptyTemplates
-        # @api private
         def prepend_view_path(new_path)
           lookup_context.view_paths.unshift(*_path_decorator(new_path))
         end
 
-        # @api private
         def append_view_path(new_path)
           lookup_context.view_paths.push(*_path_decorator(new_path))
         end
 
-        private
+      private
 
         def _path_decorator(path)
           EmptyTemplatePathSetDecorator.new(ActionView::PathSet.new(Array.wrap(path)))

data/lib/rspec/rails.rb

@@ -1,22 +1,11 @@
 require 'rspec/core'
-
-RSpec::configure do |c|
-  c.backtrace_exclusion_patterns << /vendor\//
-  c.backtrace_exclusion_patterns << /lib\/rspec\/rails/
-end
-
 require 'rails/version'
 require 'rspec/rails/extensions'
 require 'rspec/rails/view_rendering'
 require 'rspec/rails/adapters'
 require 'rspec/rails/matchers'
 require 'rspec/rails/fixture_support'
-
-# Load rspec-activemodel-mocks if available; otherwise fall back
-# to the deprecated mock methods
-require 'rspec/rails/mocks'
-require 'rspec/rails/module_inclusion'
 require 'rspec/rails/example'
-require 'rspec/rails/infer_type_configuration'
 require 'rspec/rails/vendor/capybara'
-require 'rspec/rails/vendor/webrat'
+require 'rspec/rails/configuration'
+require 'rspec/rails/feature_check'