shoulda-matchers 3.1.0 → 5.2.0

data/lib/shoulda/matchers/action_controller/route_matcher.rb

@@ -12,8 +12,8 @@ module Shoulda
       # routing test case. For instance, given these routes:
       #
       #     My::Application.routes.draw do
-      #       get '/posts', controller: 'posts', action: 'index'
-      #       get '/posts/:id' => 'posts#show'
+      #       get '/posts', to: 'posts#index'
+      #       get '/posts/:id', to: 'posts#show'
       #     end
       #
       # You could choose to write tests for these routes alongside other tests
@@ -24,7 +24,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       it { should route(:get, '/posts').to(action: :index) }
       #       it { should route(:get, '/posts/1').to(action: :show, id: 1) }
       #     end
@@ -38,7 +38,7 @@ module Shoulda
       # Or you could place the tests along with other route tests:
       #
       #     # RSpec
-      #     describe 'Routing' do
+      #     describe 'Routing', type: :routing do
       #       it do
       #         should route(:get, '/posts').
       #           to(controller: :posts, action: :index)
@@ -64,6 +64,42 @@ module Shoulda
       # this controller. In the latter case we specify this using the
       # `controller` key passed to the `to` qualifier.
       #
+      # #### Specifying a port
+      #
+      # If the route you're testing has a constraint on it that limits the route
+      # to a particular port, you can specify it by passing a `port` option to
+      # the matcher:
+      #
+      #     class PortConstraint
+      #       def initialize(port)
+      #         @port = port
+      #       end
+      #
+      #       def matches?(request)
+      #         request.port == @port
+      #       end
+      #     end
+      #
+      #     My::Application.routes.draw do
+      #       get '/posts',
+      #         to: 'posts#index',
+      #         constraints: PortConstraint.new(12345)
+      #     end
+      #
+      #     # RSpec
+      #     describe 'Routing', type: :routing do
+      #       it do
+      #         should route(:get, '/posts', port: 12345).
+      #           to('posts#index')
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class RoutesTest < ActionController::IntegrationTest
+      #       should route(:get, '/posts', port: 12345).
+      #         to('posts#index')
+      #     end
+      #
       # #### Qualifiers
       #
       # ##### to
@@ -71,7 +107,9 @@ module Shoulda
       # Use `to` to specify the action (along with the controller, if needed)
       # that the route resolves to.
       #
-      #     # Three ways of saying the same thing (using the example above)
+      # `to` takes either keyword arguments (`controller` and `action`) or a
+      # string that represents the controller/action pair:
+      #
       #     route(:get, '/posts').to(action: index)
       #     route(:get, '/posts').to(controller: :posts, action: index)
       #     route(:get, '/posts').to('posts#index')
@@ -86,19 +124,20 @@ module Shoulda
       #
       # @return [RouteMatcher]
       #
-      def route(method, path)
-        RouteMatcher.new(method, path, self)
+      def route(method, path, port: nil)
+        RouteMatcher.new(self, method, path, port: port)
       end
 
       # @private
       class RouteMatcher
-        def initialize(method, path, context)
-          @method  = method
-          @path    = path
+        def initialize(context, method, path, port: nil)
           @context = context
+          @method = method
+          @path = add_port_to_path(normalize_path(path), port)
+          @params = {}
         end
 
-        attr_reader :failure_message, :failure_message_when_negated
+        attr_reader :failure_message
 
         def to(*args)
           @params = RouteParams.new(args).normalize
@@ -111,36 +150,56 @@ module Shoulda
         end
 
         def matches?(controller)
-          guess_controller!(controller)
+          guess_controller_if_necessary(controller)
+
           route_recognized?
         end
 
         def description
-          "route #{@method.to_s.upcase} #{@path} to/from #{@params.inspect}"
+          "route #{method.to_s.upcase} #{path} to/from #{params.inspect}"
+        end
+
+        def failure_message_when_negated
+          "Didn't expect to #{description}"
         end
 
         private
 
-        def guess_controller!(controller)
-          @params[:controller] ||= controller.controller_path
+        attr_reader :context, :method, :path, :params
+
+        def normalize_path(path)
+          if path.start_with?('/')
+            path
+          else
+            "/#{path}"
+          end
         end
 
+        def add_port_to_path(path, port)
+          if port
+            "https://example.com:#{port}" + path
+          else
+            path
+          end
+        end
 
-        def route_recognized?
-          begin
-            @context.__send__(:assert_routing,
-                          { method: @method, path: @path },
-                          @params)
+        def guess_controller_if_necessary(controller)
+          params[:controller] ||= controller.controller_path
+        end
 
-            @failure_message_when_negated = "Didn't expect to #{description}"
-            true
-          rescue ::ActionController::RoutingError => error
-            @failure_message = error.message
-            false
-          rescue Shoulda::Matchers.assertion_exception_class => error
-            @failure_message = error.message
-            false
-          end
+        def route_recognized?
+          context.send(
+            :assert_routing,
+            { method: method, path: path },
+            params,
+          )
+          true
+        rescue ::ActionController::RoutingError => e
+          @failure_message = e.message
+          false
+        rescue Shoulda::Matchers.assertion_exception_class => e
+          @failure_message = e.message
+          false
         end
       end
     end

data/lib/shoulda/matchers/action_controller/route_params.rb

@@ -3,7 +3,7 @@ module Shoulda
     module ActionController
       # @private
       class RouteParams
-        PARAMS_TO_SYMBOLIZE = %i{ format }
+        PARAMS_TO_SYMBOLIZE = %i{format}.freeze
 
         def initialize(args)
           @args = args
@@ -42,7 +42,7 @@ module Shoulda
         end
 
         def symbolize_or_stringify(key, value)
-          if key.in?(PARAMS_TO_SYMBOLIZE)
+          if PARAMS_TO_SYMBOLIZE.include?(key)
             value.to_sym
           else
             stringify(value)

data/lib/shoulda/matchers/action_controller/set_flash_matcher.rb

@@ -16,7 +16,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -58,7 +58,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -89,7 +89,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -124,7 +124,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #show' do
       #         before { get :show }
       #

data/lib/shoulda/matchers/action_controller/set_session_matcher.rb

@@ -16,7 +16,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -58,7 +58,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #
@@ -89,7 +89,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe PostsController do
+      #     RSpec.describe PostsController, type: :controller do
       #       describe 'GET #index' do
       #         before { get :index }
       #

data/lib/shoulda/matchers/action_controller/set_session_or_flash_matcher.rb

@@ -20,7 +20,9 @@ module Shoulda
         def to(expected_value = nil, &block)
           if block
             unless context_set?
-              message = "When specifying a value as a block, a context must be specified beforehand, e.g., #{store.name}.in_context(context).to { ... }"
+              message = 'When specifying a value as a block, a context must be'\
+                ' specified beforehand,'\
+                " e.g., #{store.name}.in_context(context).to { ... }"
               raise ArgumentError, message
             end
 
@@ -42,12 +44,14 @@ module Shoulda
         end
 
         def failure_message
-          "Expected #{controller.class} to #{expectation_description}, but it did not"
+          "Expected #{controller.class} to #{expectation_description},"\
+          ' but it did not'
         end
         alias_method :failure_message_for_should, :failure_message
 
         def failure_message_when_negated
-          "Expected #{controller.class} not to #{expectation_description}, but it did"
+          "Expected #{controller.class} not to #{expectation_description},"\
+          ' but it did'
         end
         alias_method :failure_message_for_should_not,
           :failure_message_when_negated
@@ -81,18 +85,20 @@ module Shoulda
         def expectation_description
           string = 'set'
 
-          if key_set?
-            string << " #{store.name}[#{key.inspect}]"
-          else
-            string << " any key in #{store.name}"
-          end
-
-          if expected_value_set?
-            if expected_value.is_a?(Regexp)
-              string << " to a value matching #{expected_value.inspect}"
+          string <<
+            if key_set?
+              " #{store.name}[#{key.inspect}]"
             else
-              string << " to #{expected_value.inspect}"
+              " any key in #{store.name}"
             end
+
+          if expected_value_set?
+            string <<
+              if expected_value.is_a?(Regexp)
+                " to a value matching #{expected_value.inspect}"
+              else
+                " to #{expected_value.inspect}"
+              end
           end
 
           string

data/lib/shoulda/matchers/action_controller.rb

@@ -16,6 +16,8 @@ require 'shoulda/matchers/action_controller/session_store'
 
 module Shoulda
   module Matchers
+    # This module provides matchers that are used to test behavior within
+    # controllers.
     module ActionController
     end
   end

data/lib/shoulda/matchers/active_model/allow_value_matcher/attribute_changed_value_error.rb

@@ -31,7 +31,7 @@ need to do something different.
 If you need help, feel free to ask a question on the shoulda-matchers
 issues list:
 
-http://github.com/thoughtbot/shoulda-matchers/issues
+https://github.com/thoughtbot/shoulda-matchers/issues
             MESSAGE
           end
 

data/lib/shoulda/matchers/active_model/allow_value_matcher/attribute_setter.rb

@@ -23,7 +23,7 @@ module Shoulda
             @value_written = args.fetch(:value)
             @ignore_interference_by_writer = args.fetch(
               :ignore_interference_by_writer,
-              Qualifiers::IgnoreInterferenceByWriter.new
+              Qualifiers::IgnoreInterferenceByWriter.new,
             )
             @after_set_callback = args.fetch(:after_set_callback, -> { })
 
@@ -36,9 +36,9 @@ module Shoulda
             description << Shoulda::Matchers::Util.inspect_value(value_written)
 
             if attribute_changed_value?
-              description << " -- which was read back as "
+              description << ' -- which was read back as '
               description << Shoulda::Matchers::Util.inspect_value(value_read)
-              description << " --"
+              description << ' --'
             end
 
             description
@@ -206,7 +206,7 @@ module Shoulda
               model: object.class,
               attribute_name: attribute_name,
               value_written: value_written,
-              value_read: value_read
+              value_read: value_read,
             )
           end
 
@@ -218,17 +218,13 @@ module Shoulda
             AttributeDoesNotExistError.create(
               model: object.class,
               attribute_name: attribute_name,
-              value: value_written
+              value: value_written,
             )
           end
 
           def active_resource_object?
             object.respond_to?(:known_attributes)
           end
-
-          def model
-            object.class
-          end
         end
       end
     end

data/lib/shoulda/matchers/active_model/allow_value_matcher/attribute_setter_and_validator.rb

@@ -34,7 +34,7 @@ module Shoulda
               attribute_name: attribute_name,
               value: value,
               ignore_interference_by_writer: ignore_interference_by_writer,
-              after_set_callback: after_setting_value_callback
+              after_set_callback: after_setting_value_callback,
             )
           end
 
@@ -48,7 +48,7 @@ module Shoulda
               attribute_to_check_message_against,
               context: context,
               expects_strict: expects_strict?,
-              expected_message: expected_message
+              expected_message: expected_message,
             )
           end
 

data/lib/shoulda/matchers/active_model/allow_value_matcher/attribute_setters.rb

@@ -11,7 +11,7 @@ module Shoulda
               AttributeSetterAndValidator.new(
                 allow_value_matcher,
                 attribute_name,
-                value
+                value,
               )
             end
           end

data/lib/shoulda/matchers/active_model/allow_value_matcher/attribute_setters_and_validators.rb

@@ -11,7 +11,7 @@ module Shoulda
               AttributeSetterAndValidator.new(
                 allow_value_matcher,
                 attribute_name,
-                value
+                value,
               )
             end
           end