shoulda-matchers 4.4.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50d63f547edcfe3f040aff155386def4cf30b3b17befc2e24a3b29f9933d6aba
-  data.tar.gz: dc7066ab2357ddda9efe73ab7bfd547dae0a2b6c3180a4d68d3fb715708af500
+  metadata.gz: 319b0cb3944a37309b11169bd71ffddde2d6af35b262795e7c16466d6d2c497c
+  data.tar.gz: 22ac49d578766e24a18826bcde86443a09afa41c1cfc9ee7932f94f214623a36
 SHA512:
-  metadata.gz: a112316adba7fa8458cc8b4aa404152cf3618705f232002dddc7b1004f99f69a9717961d4893cfaff50e7d802ae30ea7837e70104bc4a497c9b560982ab80831
-  data.tar.gz: a732f1d0039ad911f35ee9f1d05a4cac8683232b253b42a59a8d6409ed285e292213bca8680e4c627f9fbd7ff27ba85dcc5d67a42885d571462456c385ec635a
+  metadata.gz: 05a067ef5aa288661855f6257a55ce887bdf19f6684cd965c145669815a3d432a236cd7fb88e21647d0251e4e971b6c45b03af04def19b5cefbef26279276d81
+  data.tar.gz: f06e9c331d39d82fd450332cb0b81e108852c7fac2a28927ada2fbccc11b31226206023f69eb6ecccd7dceaaca4c9b3410b818ed86babd3f7f37bb4c778013df

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2006-2021 Tammer Saleh and thoughtbot, inc.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,14 +1,12 @@
-# Shoulda Matchers [![Gem Version][version-badge]][rubygems] [![Build Status][travis-badge]][travis] [![Total Downloads][downloads-total]][rubygems] [![Downloads][downloads-badge]][rubygems] [![Hound][hound-badge]][hound]
+# Shoulda Matchers [![Gem Version][version-badge]][rubygems] [![Build Status][github-actions-badge]][github-actions] [![Total Downloads][downloads-total]][rubygems] [![Downloads][downloads-badge]][rubygems]
 
 [version-badge]: https://img.shields.io/gem/v/shoulda-matchers.svg
 [rubygems]: https://rubygems.org/gems/shoulda-matchers
-[travis-badge]: https://img.shields.io/travis/thoughtbot/shoulda-matchers/master.svg
-[travis]: https://travis-ci.org/thoughtbot/shoulda-matchers
+[github-actions-badge]: https://img.shields.io/github/workflow/status/thoughtbot/shoulda-matchers/Test
+[github-actions]: https://github.com/thoughtbot/shoulda-matchers/actions
 [downloads-total]: https://img.shields.io/gem/dt/shoulda-matchers.svg
 [downloads-badge]: https://img.shields.io/gem/dtv/shoulda-matchers.svg
 [downloads-badge]: https://img.shields.io/gem/dtv/shoulda-matchers.svg
-[hound-badge]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
-[hound]: https://houndci.com
 
 [![shoulda-matchers][logo]][website]
 
@@ -24,7 +22,7 @@ complex, and error-prone.
 📖 **[Read the documentation for the latest version][rubydocs].**  
 📢 **[See what's changed in recent versions][changelog].**
 
-[rubydocs]: http://matchers.shoulda.io/docs
+[rubydocs]: https://matchers.shoulda.io/docs
 [changelog]: CHANGELOG.md
 
 ## Table of contents
@@ -57,7 +55,7 @@ Start by including `shoulda-matchers` in your Gemfile:
 
 ```ruby
 group :test do
-  gem 'shoulda-matchers', '~> 4.0'
+  gem 'shoulda-matchers', '~> 5.0'
 end
 ```
 
@@ -385,7 +383,7 @@ about any of them, make sure to [consult the documentation][rubydocs]!
   tests your `belongs_to` associations.
 * **[define_enum_for](lib/shoulda/matchers/active_record/define_enum_for_matcher.rb)**
   tests usage of the `enum` macro.
-* **[have_and_belong_to_many](lib/shoulda/matchers/active_record/association_matcher.rb)**
+* **[have_and_belong_to_many](lib/shoulda/matchers/active_record/association_matcher.rb#L827)**
   tests your `has_and_belongs_to_many` associations.
 * **[have_db_column](lib/shoulda/matchers/active_record/have_db_column_matcher.rb)**
   tests that the table that backs your model has a specific column.
@@ -393,11 +391,11 @@ about any of them, make sure to [consult the documentation][rubydocs]!
   tests that the table that backs your model has an index on a specific column.
 * **[have_implicit_order_column](lib/shoulda/matchers/active_record/have_implicit_order_column.rb)**
   tests usage of `implicit_order_column`.
-* **[have_many](lib/shoulda/matchers/active_record/association_matcher.rb)**
+* **[have_many](lib/shoulda/matchers/active_record/association_matcher.rb#L328)**
   tests your `has_many` associations.
 * **[have_many_attached](lib/shoulda/matchers/active_record/have_attached_matcher.rb)**
   tests your `has_many_attached` associations.
-* **[have_one](lib/shoulda/matchers/active_record/association_matcher.rb)**
+* **[have_one](lib/shoulda/matchers/active_record/association_matcher.rb#L598)**
   tests your `has_one` associations.
 * **[have_one_attached](lib/shoulda/matchers/active_record/have_attached_matcher.rb)**
   tests your `has_one_attached` associations.
@@ -432,11 +430,11 @@ about any of them, make sure to [consult the documentation][rubydocs]!
   makes assertions on the `session` hash.
 * **[set_flash](lib/shoulda/matchers/action_controller/set_flash_matcher.rb)**
   makes assertions on the `flash` hash.
-* **[use_after_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L79)**
+* **[use_after_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L29)**
   tests that an `after_action` callback is defined in your controller.
-* **[use_around_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L129)**
+* **[use_around_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L75)**
   tests that an `around_action` callback is defined in your controller.
-* **[use_before_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L54)**
+* **[use_before_action](lib/shoulda/matchers/action_controller/callback_matcher.rb#L4)**
   tests that a `before_action` callback is defined in your controller.
 
 ### Routing matchers
@@ -470,17 +468,19 @@ machine, understanding the codebase, and creating a good pull request.
 
 ## Compatibility
 
-Shoulda Matchers is [tested][travis] and supported against Ruby 2.4+, Rails
-4.2+, RSpec 3.x, and Minitest 5.x.
+Shoulda Matchers is tested and supported against Ruby 2.6+, Rails
+5.2+, RSpec 3.x, and Minitest 5.x.
 
-For Ruby < 2.4 and Rails < 4.1 compatibility, please use [v3.1.3][v3.1.3].
+- For Ruby < 2.4 and Rails < 4.1 compatibility, please use [v3.1.3][v3.1.3].
+- For Ruby < 3.0 and Rails < 6.1 compatibility, please use [v4.5.1][v4.5.1].
 
 [v3.1.3]: https://github.com/thoughtbot/shoulda-matchers/tree/v3.1.3
+[v4.5.1]: https://github.com/thoughtbot/shoulda-matchers/tree/v4.5.1
 
 ## Versioning
 
 Shoulda Matchers follows Semantic Versioning 2.0 as defined at
-<http://semver.org>.
+<https://semver.org>.
 
 ## Team
 
@@ -492,7 +492,7 @@ Albuk][guialbuk].
 
 ## Copyright/License
 
-Shoulda Matchers is copyright © 2006-2020 Tammer Saleh and [thoughtbot,
+Shoulda Matchers is copyright © 2006-2021 Tammer Saleh and [thoughtbot,
 inc][thoughtbot-website]. It is free and opensource software and may be
 redistributed under the terms specified in the [LICENSE](LICENSE) file.
 

data/lib/shoulda/matchers.rb

@@ -1,22 +1,21 @@
 require 'shoulda/matchers/configuration'
+require 'shoulda/matchers/doublespeak'
+require 'shoulda/matchers/error'
+require 'shoulda/matchers/independent'
+require 'shoulda/matchers/integrations'
+require 'shoulda/matchers/matcher_context'
+require 'shoulda/matchers/rails_shim'
+require 'shoulda/matchers/util'
 require 'shoulda/matchers/version'
 require 'shoulda/matchers/warn'
 
+require 'shoulda/matchers/action_controller'
+require 'shoulda/matchers/active_model'
+require 'shoulda/matchers/active_record'
+require 'shoulda/matchers/routing'
+
 module Shoulda
   module Matchers
-    autoload :ActionController, 'shoulda/matchers/action_controller'
-    autoload :ActiveModel, 'shoulda/matchers/active_model'
-    autoload :ActiveRecord, 'shoulda/matchers/active_record'
-    autoload :Doublespeak, 'shoulda/matchers/doublespeak'
-    autoload :Error, 'shoulda/matchers/error'
-    autoload :Independent, 'shoulda/matchers/independent'
-    autoload :Integrations, 'shoulda/matchers/integrations'
-    autoload :MatcherContext, 'shoulda/matchers/matcher_context'
-    autoload :RailsShim, 'shoulda/matchers/rails_shim'
-    autoload :Routing, 'shoulda/matchers/routing'
-    autoload :Util, 'shoulda/matchers/util'
-    autoload :WordWrap, 'shoulda/matchers/util/word_wrap'
-
     class << self
       # @private
       attr_accessor :assertion_exception_class

data/lib/shoulda/matchers/action_controller.rb

@@ -1,24 +1,24 @@
+require 'shoulda/matchers/action_controller/filter_param_matcher'
+require 'shoulda/matchers/action_controller/route_params'
+require 'shoulda/matchers/action_controller/set_flash_matcher'
+require 'shoulda/matchers/action_controller/render_with_layout_matcher'
 require 'shoulda/matchers/action_controller/respond_with_matcher'
+require 'shoulda/matchers/action_controller/set_session_matcher'
 require 'shoulda/matchers/action_controller/route_matcher'
+require 'shoulda/matchers/action_controller/redirect_to_matcher'
+require 'shoulda/matchers/action_controller/render_template_matcher'
+require 'shoulda/matchers/action_controller/rescue_from_matcher'
+require 'shoulda/matchers/action_controller/callback_matcher'
+require 'shoulda/matchers/action_controller/permit_matcher'
+require 'shoulda/matchers/action_controller/set_session_or_flash_matcher'
+require 'shoulda/matchers/action_controller/flash_store'
+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
-      autoload :CallbackMatcher, 'shoulda/matchers/action_controller/callback_matcher'
-      autoload :FlashStore, 'shoulda/matchers/action_controller/flash_store'
-      autoload :FilterParamMatcher, 'shoulda/matchers/action_controller/filter_param_matcher'
-      autoload :PermitMatcher, 'shoulda/matchers/action_controller/permit_matcher'
-      autoload :RedirectToMatcher, 'shoulda/matchers/action_controller/redirect_to_matcher'
-      autoload :RenderTemplateMatcher, 'shoulda/matchers/action_controller/render_template_matcher'
-      autoload :RenderWithLayoutMatcher, 'shoulda/matchers/action_controller/render_with_layout_matcher'
-      autoload :RescueFromMatcher, 'shoulda/matchers/action_controller/rescue_from_matcher'
-      autoload :RouteParams, 'shoulda/matchers/action_controller/route_params'
-      autoload :SessionStore, 'shoulda/matchers/action_controller/session_store'
-      autoload :SetFlashMatcher, 'shoulda/matchers/action_controller/set_flash_matcher'
-      autoload :SetSessionMatcher, 'shoulda/matchers/action_controller/set_session_matcher'
-      autoload :SetSessionOrFlashMatcher, 'shoulda/matchers/action_controller/set_session_or_flash_matcher'
     end
   end
 end

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

@@ -1,64 +1,6 @@
 module Shoulda
   module Matchers
     module ActionController
-      # The `use_before_filter` matcher is used to test that a before_filter
-      # callback is defined within your controller.
-      #
-      #     class UsersController < ApplicationController
-      #       before_filter :authenticate_user!
-      #     end
-      #
-      #     # RSpec
-      #     RSpec.describe UsersController, type: :controller do
-      #       it { should use_before_filter(:authenticate_user!) }
-      #       it { should_not use_before_filter(:prevent_ssl) }
-      #     end
-      #
-      #     # Minitest (Shoulda)
-      #     class UsersControllerTest < ActionController::TestCase
-      #       should use_before_filter(:authenticate_user!)
-      #       should_not use_before_filter(:prevent_ssl)
-      #     end
-      #
-      # @note This method is only available when using shoulda-matchers under
-      # Rails 4.x.
-      # @return [CallbackMatcher]
-      #
-      if RailsShim.action_pack_lt_5?
-        def use_before_filter(callback)
-          CallbackMatcher.new(callback, :before, :filter)
-        end
-      end
-
-      # The `use_after_filter` matcher is used to test that an after_filter
-      # callback is defined within your controller.
-      #
-      #     class IssuesController < ApplicationController
-      #       after_filter :log_activity
-      #     end
-      #
-      #     # RSpec
-      #     RSpec.describe IssuesController, type: :controller do
-      #       it { should use_after_filter(:log_activity) }
-      #       it { should_not use_after_filter(:destroy_user) }
-      #     end
-      #
-      #     # Minitest (Shoulda)
-      #     class IssuesControllerTest < ActionController::TestCase
-      #       should use_after_filter(:log_activity)
-      #       should_not use_after_filter(:destroy_user)
-      #     end
-      #
-      # @note This method is only available when using shoulda-matchers under
-      # Rails 4.x.
-      # @return [CallbackMatcher]
-      #
-      if RailsShim.action_pack_lt_5?
-        def use_after_filter(callback)
-          CallbackMatcher.new(callback, :after, :filter)
-        end
-      end
-
       # The `use_before_action` matcher is used to test that a before_action
       # callback is defined within your controller.
       #
@@ -109,35 +51,6 @@ module Shoulda
         CallbackMatcher.new(callback, :after, :action)
       end
 
-      # The `use_around_filter` matcher is used to test that an around_filter
-      # callback is defined within your controller.
-      #
-      #     class ChangesController < ApplicationController
-      #       around_filter :wrap_in_transaction
-      #     end
-      #
-      #     # RSpec
-      #     RSpec.describe ChangesController, type: :controller do
-      #       it { should use_around_filter(:wrap_in_transaction) }
-      #       it { should_not use_around_filter(:save_view_context) }
-      #     end
-      #
-      #     # Minitest (Shoulda)
-      #     class ChangesControllerTest < ActionController::TestCase
-      #       should use_around_filter(:wrap_in_transaction)
-      #       should_not use_around_filter(:save_view_context)
-      #     end
-      #
-      # @note This method is only available when using shoulda-matchers under
-      # Rails 4.x.
-      # @return [CallbackMatcher]
-      #
-      if RailsShim.action_pack_lt_5?
-        def use_around_filter(callback)
-          CallbackMatcher.new(callback, :around, :filter)
-        end
-      end
-
       # The `use_around_action` matcher is used to test that an around_action
       # callback is defined within your controller.
       #
@@ -179,11 +92,13 @@ module Shoulda
         end
 
         def failure_message
-          "Expected that #{controller_class.name} would have :#{method_name} as a #{kind}_#{callback_type}"
+          "Expected that #{controller_class.name} would have :#{method_name}"\
+            " as a #{kind}_#{callback_type}"
         end
 
         def failure_message_when_negated
-          "Expected that #{controller_class.name} would not have :#{method_name} as a #{kind}_#{callback_type}"
+          "Expected that #{controller_class.name} would not have"\
+            " :#{method_name} as a #{kind}_#{callback_type}"
         end
 
         def description

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

@@ -31,12 +31,13 @@ module Shoulda
           @key = key
         end
 
-        def matches?(controller)
+        def matches?(_controller)
           filters_key?
         end
 
         def failure_message
-          "Expected #{@key} to be filtered; filtered keys: #{filtered_keys.join(', ')}"
+          "Expected #{@key} to be filtered; filtered keys:"\
+            " #{filtered_keys.join(', ')}"
         end
 
         def failure_message_when_negated

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

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/module/delegation'
 module Shoulda
   module Matchers
     module ActionController
@@ -34,10 +35,7 @@ module Shoulda
             expected_value === actual_value
           end
         end
-
-        def empty?
-          flash.empty?
-        end
+        delegate :empty?, to: :flash
 
         def use_now!
           @use_now = true

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

@@ -209,7 +209,8 @@ module Shoulda
         attr_writer :stubbed_params
 
         def initialize(expected_permitted_parameter_names)
-          @expected_permitted_parameter_names = expected_permitted_parameter_names
+          @expected_permitted_parameter_names =
+            expected_permitted_parameter_names
           @action = nil
           @verb = nil
           @request_params = {}
@@ -250,30 +251,29 @@ module Shoulda
           parameters_double_registry.register
 
           Doublespeak.with_doubles_activated do
-            Shoulda::Matchers::RailsShim.make_controller_request(
-              context,
-              verb,
-              action,
-              request_params,
-            )
+            params = { params: request_params }
+
+            context.__send__(verb, action, **params)
           end
 
           unpermitted_parameter_names.empty?
         end
 
         def failure_message
-          "Expected #{verb.upcase} ##{action} to #{expectation},\nbut #{reality}."
+          "Expected #{verb.upcase} ##{action} to #{expectation},"\
+          "\nbut #{reality}."
         end
 
         def failure_message_when_negated
-          "Expected #{verb.upcase} ##{action} not to #{expectation},\nbut it did."
+          "Expected #{verb.upcase} ##{action} not to #{expectation},"\
+          "\nbut it did."
         end
 
         protected
 
-        attr_reader :controller, :double_collections_by_parameter_name, :action, :verb,
-          :request_params, :expected_permitted_parameter_names, :context, :subparameter_name,
-          :parameters_double_registry
+        attr_reader :controller, :double_collections_by_parameter_name, :action,
+          :verb, :request_params, :expected_permitted_parameter_names,
+          :context, :subparameter_name, :parameters_double_registry
 
         def expectation
           message = 'restrict parameters '
@@ -282,7 +282,8 @@ module Shoulda
             message << "on #{subparameter_name.inspect} "
           end
 
-          message << 'to ' + format_parameter_names(expected_permitted_parameter_names)
+          message << 'to '\
+            "#{format_parameter_names(expected_permitted_parameter_names)}"
 
           message
         end
@@ -291,9 +292,9 @@ module Shoulda
           if actual_permitted_parameter_names.empty?
             'it did not restrict any parameters'
           else
-            'the restricted parameters were ' +
-              format_parameter_names(actual_permitted_parameter_names) +
-              ' instead'
+            'the restricted parameters were '\
+            "#{format_parameter_names(actual_permitted_parameter_names)}"\
+            ' instead'
           end
         end
 
@@ -303,12 +304,12 @@ module Shoulda
 
         def actual_permitted_parameter_names
           @_actual_permitted_parameter_names ||= begin
-            if subparameter_name
-              options = { for: subparameter_name }
-            else
-              options = {}
-            end
-
+            options =
+              if subparameter_name
+                { for: subparameter_name }
+              else
+                {}
+              end
             parameters_double_registry.permitted_parameter_names(options)
           end
         end
@@ -329,8 +330,8 @@ module Shoulda
 
         def default_verb
           case action
-            when :create then :post
-            when :update then RailsShim.verb_for_update
+          when :create then :post
+          when :update then RailsShim.verb_for_update
           end
         end
 
@@ -346,7 +347,7 @@ module Shoulda
 
           def register
             double_collection = Doublespeak.double_collection_for(
-              ::ActionController::Parameters.singleton_class
+              ::ActionController::Parameters.singleton_class,
             )
             double_collection.register_proxy(:new).to_return do |call|
               params = call.return_value
@@ -389,7 +390,7 @@ module Shoulda
 
             if double_collections_by_parameter_name.key?(subparameter_name)
               self.class.permitted_parameter_names_within(
-                double_collections_by_parameter_name[subparameter_name]
+                double_collections_by_parameter_name[subparameter_name],
               )
             else
               []
@@ -436,7 +437,8 @@ module Shoulda
         # @private
         class VerbNotDefinedError < StandardError
           def message
-            'You must specify an HTTP verb when using a non-RESTful action. For example: for(:authorize, verb: :post)'
+            'You must specify an HTTP verb when using a non-RESTful action.'\
+            ' For example: for(:authorize, verb: :post)'
           end
         end
       end