rspec-rails 2.14.2 → 4.1.2

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

@@ -1,109 +1,123 @@
-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::Rails::Matchers::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
+            # 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
+          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
+        # 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 https://api.rubyonrails.org/classes/ActionDispatch/Assertions/RoutingAssertions.html#method-i-assert_recognizes
+        def route_to(*expected)
+          RouteToMatcher.new(self, *expected)
+        end
 
-    class BeRoutableMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+        # @private
+        class BeRoutableMatcher < RSpec::Rails::Matchers::BaseMatcher
+          def initialize(scope)
+            @scope = scope
+          end
 
-      def initialize(scope)
-        @scope = scope
-      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
 
-      # @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 failure_message
+            "expected #{@actual.inspect} to be routable"
+          end
 
-      def failure_message_for_should
-        "expected #{@actual.inspect} to be routable"
-      end
+          def failure_message_when_negated
+            "expected #{@actual.inspect} not to be routable, but it routes to #{@routing_options.inspect}"
+          end
 
-      def failure_message_for_should_not
-        "expected #{@actual.inspect} not to be routable, but it routes to #{@routing_options.inspect}"
-      end
-    end
+          def description
+            "be routable"
+          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,27 +1,35 @@
-require 'rspec/core/deprecation'
+require 'rspec/core/warnings'
 require 'rspec/expectations'
+require 'rspec/rails/feature_check'
 
-module RSpec::Rails
-  module Matchers
-  end
-end
-
-begin
-  require 'test/unit/assertionfailederror'
-rescue LoadError
-  module Test
-    module Unit
-      class AssertionFailedError < StandardError
-      end
+module RSpec
+  module Rails
+    # @api public
+    # Container module for Rails specific matchers.
+    module Matchers
     end
   end
 end
 
+require 'rspec/rails/matchers/base_matcher'
 require 'rspec/rails/matchers/have_rendered'
 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'
+
+if RSpec::Rails::FeatureCheck.has_active_job?
+  require 'rspec/rails/matchers/active_job'
+  require 'rspec/rails/matchers/have_enqueued_mail'
+end
+
+if RSpec::Rails::FeatureCheck.has_action_cable_testing?
+  require 'rspec/rails/matchers/action_cable'
+end
+
+if RSpec::Rails::FeatureCheck.has_action_mailbox?
+  require 'rspec/rails/matchers/action_mailbox'
+end

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

@@ -3,26 +3,26 @@ if default = Rake.application.instance_variable_get('@tasks')['default']
   default.prerequisites.delete('test')
 end
 
-task :default => :spec
+task default: :spec
 
-task :stats => "spec:statsetup"
+task stats: "spec:statsetup"
 
 desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => "spec:prepare")
+RSpec::Core::RakeTask.new(spec: "spec:prepare")
 
 namespace :spec do
   types = begin
-            dirs = Dir['./spec/**/*_spec.rb'].
-              map { |f| f.sub(/^\.\/(spec\/\w+)\/.*/, '\\1') }.
-              uniq.
-              select { |f| File.directory?(f) }
+            dirs = Dir['./spec/**/*_spec.rb']
+              .map { |f| f.sub(/^\.\/(spec\/\w+)\/.*/, '\\1') }
+              .uniq
+              .select { |f| File.directory?(f) }
             Hash[dirs.map { |d| [d.split('/').last, d] }]
           end
 
   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
@@ -35,16 +35,6 @@ namespace :spec do
     end
   end
 
-  # RCov task only enabled for Ruby 1.8
-  if RUBY_VERSION < '1.9'
-    desc "Run all specs with rcov"
-    RSpec::Core::RakeTask.new(:rcov => "spec:prepare") do |t|
-      t.rcov = true
-      t.pattern = "./spec/**/*_spec.rb"
-      t.rcov_opts = '--exclude /gems/,/Library/,/usr/,lib/tasks,.bundle,config,/lib/rspec/,/lib/rspec-,spec'
-    end
-  end
-
   task :statsetup do
     require 'rails/code_statistics'
     types.each do |type, dir|

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

@@ -11,23 +11,24 @@ end
 if defined?(Capybara)
   RSpec.configure do |c|
     if defined?(Capybara::DSL)
-      c.include Capybara::DSL, :type => :controller
-      c.include Capybara::DSL, :type => :feature
+      c.include Capybara::DSL, type: :feature
+      if defined?(ActionPack) && ActionPack::VERSION::STRING >= "5.1"
+        c.include Capybara::DSL, type: :system
+      end
     end
 
     if defined?(Capybara::RSpecMatchers)
-      c.include Capybara::RSpecMatchers, :type => :view
-      c.include Capybara::RSpecMatchers, :type => :helper
-      c.include Capybara::RSpecMatchers, :type => :mailer
-      c.include Capybara::RSpecMatchers, :type => :controller
-      c.include Capybara::RSpecMatchers, :example_group => {
-        :file_path => c.escaped_path(%w[spec features])
-      }
+      c.include Capybara::RSpecMatchers, type: :view
+      c.include Capybara::RSpecMatchers, type: :helper
+      c.include Capybara::RSpecMatchers, type: :mailer
+      c.include Capybara::RSpecMatchers, type: :controller
+      c.include Capybara::RSpecMatchers, type: :feature
+      c.include Capybara::RSpecMatchers, type: :system
     end
 
     unless defined?(Capybara::RSpecMatchers) || defined?(Capybara::DSL)
-      c.include Capybara, :type => :request
-      c.include Capybara, :type => :controller
+      c.include Capybara, type: :request
+      c.include Capybara, type: :controller
     end
   end
 end

data/lib/rspec/rails/version.rb

@@ -1,7 +1,9 @@
 module RSpec
   module Rails
+    # Version information for RSpec Rails.
     module Version
-      STRING = '2.14.2'
+      # Current version of RSpec Rails, in semantic versioning format.
+      STRING = '4.1.2'
     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_path_builder.rb

@@ -0,0 +1,29 @@
+module RSpec
+  module Rails
+    # Builds paths for view specs using a particular route set.
+    class ViewPathBuilder
+      def initialize(route_set)
+        self.class.send(:include, route_set.url_helpers)
+      end
+
+      # Given a hash of parameters, build a view path, if possible.
+      # Returns nil if no path can be built from the given params.
+      #
+      # @example
+      #     # path can be built because all required params are present in the hash
+      #     view_path_builder = ViewPathBuilder.new(::Rails.application.routes)
+      #     view_path_builder.path_for({ :controller => 'posts', :action => 'show', :id => '54' })
+      #     # => "/post/54"
+      #
+      # @example
+      #     # path cannot be built because the params are missing a required element (:id)
+      #     view_path_builder.path_for({ :controller => 'posts', :action => 'delete' })
+      #     # => ActionController::UrlGenerationError: No route matches {:action=>"delete", :controller=>"posts"}
+      def path_for(path_params)
+        url_for(path_params.merge(only_path: true))
+      rescue => e
+        e.message
+      end
+    end
+  end
+end