shoulda-matchers 4.5.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a62f760706ab97ba90edd181dbdf330ce6e8203c8ec3ec37a258022e202a53a6
-  data.tar.gz: 68f333b57646a8a437b73ff43f617efa9231674fb92f68de73365eb1408932f0
+  metadata.gz: d083d22f49f99bf60d6c6bdfed7ea08ea1f838a90b4aed439d84108ebc814af9
+  data.tar.gz: 90cc8440d8c63da1c338306b3d9f129cc9af8dc1a80277d9e7f5b233f2bbe115
 SHA512:
-  metadata.gz: ea01851ee8521ff08ab6b1caea192c161e34286e5fd361cbceb6b84404813fa952acb73c70481c3140b2c5116ffce8bb386bf1feea70754f827a3918292b1bfb
-  data.tar.gz: 286ac5e78d534651889c5e3ed3843e1afa50d0fd77ed896c4ca3cf3622596cb7e1f47d2ae053e38100ce443dbfd80fbf1a8d099ecdfbbcf8d70912dbe3f42ad3
+  metadata.gz: '09b1dcf7e19179b50992d34cf73a86e72727cf27a1db911f2adb98fe291dc4d3d711da962d3efdbec60d2b1f280dcecd441e725a7e6a701a152ff60fdd8e340c'
+  data.tar.gz: 8ba54626246e133cfd86b84aba3d3b05487166d6359b2ba97256af242a057b5ff6cd40d5eae35bd35f619c9a9b0f39cc2c8b6508e299b44e2605e3cdf4f64078

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2021 Tammer Saleh and thoughtbot, inc.
+Copyright (c) 2006-2022 Tammer Saleh and thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,9 +1,9 @@
-# Shoulda Matchers [![Gem Version][version-badge]][rubygems] [![Build Status][travis-badge]][travis] [![Total Downloads][downloads-total]][rubygems] [![Downloads][downloads-badge]][rubygems]
+# 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
@@ -19,7 +19,7 @@ complex, and error-prone.
 
 ## Quick links
 
-📖 **[Read the documentation for the latest version][rubydocs].**  
+📖 **[Read the documentation for the latest version][rubydocs].**
 📢 **[See what's changed in recent versions][changelog].**
 
 [rubydocs]: https://matchers.shoulda.io/docs
@@ -55,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
 ```
 
@@ -117,7 +117,7 @@ Otherwise, add `shoulda-matchers` to your Gemfile:
 
 ```ruby
 group :test do
-  gem 'shoulda-matchers', '~> 4.0'
+  gem 'shoulda-matchers', '~> 5.0'
 end
 ```
 
@@ -430,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
@@ -468,12 +468,14 @@ 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
 
@@ -490,7 +492,7 @@ Albuk][guialbuk].
 
 ## Copyright/License
 
-Shoulda Matchers is copyright © 2006-2021 Tammer Saleh and [thoughtbot,
+Shoulda Matchers is copyright © 2006-2022 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/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.
       #

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

@@ -251,12 +251,9 @@ 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?

data/lib/shoulda/matchers/active_model/helpers.rb

@@ -8,7 +8,7 @@ module Shoulda
         end
 
         def format_validation_errors(errors)
-          list_items = errors.keys.map do |attribute|
+          list_items = errors.to_hash.keys.map do |attribute|
             messages = errors[attribute]
             "* #{attribute}: #{messages}"
           end

data/lib/shoulda/matchers/active_model/numericality_matchers/comparison_matcher.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/module/delegation'
+
 module Shoulda
   module Matchers
     module ActiveModel
@@ -31,6 +33,8 @@ module Shoulda
             },
           }.freeze
 
+          delegate :failure_message, :failure_message_when_negated, to: :submatchers
+
           def initialize(numericality_matcher, value, operator)
             super(nil)
             unless numericality_matcher.respond_to? :diff_to_compare
@@ -72,49 +76,24 @@ module Shoulda
 
           def matches?(subject)
             @subject = subject
-            all_bounds_correct?
-          end
-
-          def failure_message
-            last_failing_submatcher.failure_message
-          end
-
-          def failure_message_when_negated
-            last_failing_submatcher.failure_message_when_negated
+            submatchers.matches?(subject)
           end
 
           def comparison_description
             "#{comparison_expectation} #{@value}"
           end
 
-          private
-
-          def all_bounds_correct?
-            failing_submatchers.empty?
-          end
-
-          def failing_submatchers
-            submatchers_and_results.
-              select { |x| !x[:matched] }.
-              map { |x| x[:matcher] }
-          end
-
-          def last_failing_submatcher
-            failing_submatchers.last
-          end
-
           def submatchers
-            @_submatchers ||=
-              comparison_combos.map do |diff, submatcher_method_name|
-                matcher = __send__(submatcher_method_name, diff, nil)
-                matcher.with_message(@message, values: { count: @value })
-                matcher
-              end
+            @_submatchers ||= NumericalityMatchers::Submatchers.new(build_submatchers)
           end
 
-          def submatchers_and_results
-            @_submatchers_and_results ||= submatchers.map do |matcher|
-              { matcher: matcher, matched: matcher.matches?(@subject) }
+          private
+
+          def build_submatchers
+            comparison_combos.map do |diff, submatcher_method_name|
+              matcher = __send__(submatcher_method_name, diff, nil)
+              matcher.with_message(@message, values: { count: @value })
+              matcher
             end
           end
 

data/lib/shoulda/matchers/active_model/numericality_matchers/numeric_type_matcher.rb

@@ -55,11 +55,9 @@ module Shoulda
           private
 
           def disallow_value_matcher
-            @_disallow_value_matcher ||= begin
-              DisallowValueMatcher.new(disallowed_value).tap do |matcher|
-                matcher.for(attribute)
-                wrap_disallow_value_matcher(matcher)
-              end
+            @_disallow_value_matcher ||= DisallowValueMatcher.new(disallowed_value).tap do |matcher|
+              matcher.for(attribute)
+              wrap_disallow_value_matcher(matcher)
             end
           end
         end

data/lib/shoulda/matchers/active_model/numericality_matchers/range_matcher.rb

@@ -0,0 +1,71 @@
+require 'active_support/core_ext/module/delegation'
+
+module Shoulda
+  module Matchers
+    module ActiveModel
+      module NumericalityMatchers
+        # @private
+        class RangeMatcher < ValidationMatcher
+          OPERATORS = [:>=, :<=].freeze
+
+          delegate :failure_message, to: :submatchers
+
+          def initialize(numericality_matcher, attribute, range)
+            super(attribute)
+            unless numericality_matcher.respond_to? :diff_to_compare
+              raise ArgumentError, 'numericality_matcher is invalid'
+            end
+
+            @numericality_matcher = numericality_matcher
+            @range = range
+            @attribute = attribute
+          end
+
+          def matches?(subject)
+            @subject = subject
+            submatchers.matches?(subject)
+          end
+
+          def simple_description
+            description = ''
+
+            if expects_strict?
+              description << ' strictly'
+            end
+
+            description +
+              "disallow :#{attribute} from being a number that is not " +
+              range_description
+          end
+
+          def range_description
+            "from #{Shoulda::Matchers::Util.inspect_range(@range)}"
+          end
+
+          def submatchers
+            @_submatchers ||= NumericalityMatchers::Submatchers.new(build_submatchers)
+          end
+
+          private
+
+          def build_submatchers
+            submatcher_combos.map do |value, operator|
+              build_comparison_submatcher(value, operator)
+            end
+          end
+
+          def submatcher_combos
+            @range.minmax.zip(OPERATORS)
+          end
+
+          def build_comparison_submatcher(value, operator)
+            NumericalityMatchers::ComparisonMatcher.new(@numericality_matcher, value, operator).
+              for(@attribute).
+              with_message(@message).
+              on(@context)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/active_model/numericality_matchers/submatchers.rb

@@ -0,0 +1,43 @@
+module Shoulda
+  module Matchers
+    module ActiveModel
+      module NumericalityMatchers
+        # @private
+        class Submatchers
+          def initialize(submatchers)
+            @submatchers = submatchers
+          end
+
+          def matches?(subject)
+            @subject = subject
+            failing_submatchers.empty?
+          end
+
+          def failure_message
+            last_failing_submatcher.failure_message
+          end
+
+          def failure_message_when_negated
+            last_failing_submatcher.failure_message_when_negated
+          end
+
+          def add(submatcher)
+            @submatchers << submatcher
+          end
+
+          def last_failing_submatcher
+            failing_submatchers.last
+          end
+
+          private
+
+          def failing_submatchers
+            @_failing_submatchers ||= @submatchers.reject do |submatcher|
+              submatcher.matches?(@subject)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/active_model/qualifiers/allow_blank.rb

@@ -0,0 +1,26 @@
+module Shoulda
+  module Matchers
+    module ActiveModel
+      module Qualifiers
+        # @private
+        module AllowBlank
+          def initialize(*args)
+            super
+            @expects_to_allow_blank = false
+          end
+
+          def allow_blank
+            @expects_to_allow_blank = true
+            self
+          end
+
+          protected
+
+          def expects_to_allow_blank?
+            @expects_to_allow_blank
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/active_model/qualifiers.rb

@@ -9,5 +9,6 @@ module Shoulda
 end
 
 require_relative 'qualifiers/allow_nil'
+require_relative 'qualifiers/allow_blank'
 require_relative 'qualifiers/ignore_interference_by_writer'
 require_relative 'qualifiers/ignoring_interference_by_writer'

data/lib/shoulda/matchers/active_model/validate_absence_of_matcher.rb

@@ -108,14 +108,17 @@ module Shoulda
               obj
             end
           elsif array_column?
-            ['an arbitary value']
+            ['an arbitrary value']
+          elsif enum_column?
+            enum_values.first
           else
             case column_type
             when :integer, :float then 1
             when :decimal then BigDecimal(1, 0)
-            when :datetime, :time, :timestamp then Time.now
+            when :datetime, :time, :timestamp then Time.current
             when :date then Date.new
             when :binary then '0'
+            when :uuid then SecureRandom.uuid
             else 'an arbitrary value'
             end
           end
@@ -145,6 +148,15 @@ module Shoulda
             @subject.class.columns_hash[@attribute.to_s].respond_to?(:array) &&
             @subject.class.columns_hash[@attribute.to_s].array
         end
+
+        def enum_column?
+          @subject.class.respond_to?(:defined_enums) &&
+            @subject.class.defined_enums.key?(@attribute.to_s)
+        end
+
+        def enum_values
+          @subject.class.defined_enums[@attribute.to_s].values
+        end
       end
     end
   end

data/lib/shoulda/matchers/active_model/validate_exclusion_of_matcher.rb

@@ -33,9 +33,9 @@ module Shoulda
       #
       #     class Game
       #       include ActiveModel::Model
-      #       attr_accessor :supported_os
+      #       attr_accessor :floors_with_enemies
       #
-      #       validates_exclusion_of :supported_os, in: 5..8
+      #       validates_exclusion_of :floors_with_enemies, in: 5..8
       #     end
       #
       #     # RSpec

data/lib/shoulda/matchers/active_model/validate_inclusion_of_matcher.rb

@@ -3,6 +3,8 @@ require 'date'
 
 module Shoulda
   module Matchers
+    class ExampleClass; end
+
     module ActiveModel
       # The `validate_inclusion_of` matcher tests usage of the
       # `validates_inclusion_of` validation, asserting that an attribute can
@@ -43,12 +45,12 @@ module Shoulda
       #
       #     # RSpec
       #     RSpec.describe Issue, type: :model do
-      #       it { should validate_inclusion_of(:state).in_range(1..5) }
+      #       it { should validate_inclusion_of(:priority).in_range(1..5) }
       #     end
       #
       #     # Minitest (Shoulda)
       #     class IssueTest < ActiveSupport::TestCase
-      #       should validate_inclusion_of(:state).in_range(1..5)
+      #       should validate_inclusion_of(:priority).in_range(1..5)
       #     end
       #
       # #### Caveats
@@ -269,7 +271,7 @@ module Shoulda
       # @private
       class ValidateInclusionOfMatcher < ValidationMatcher
         BLANK_VALUES = ['', ' ', "\n", "\r", "\t", "\f"].freeze
-        ARBITRARY_OUTSIDE_STRING = 'shoulda-matchers test string'.freeze
+        ARBITRARY_OUTSIDE_STRING = Shoulda::Matchers::ExampleClass.name
         ARBITRARY_OUTSIDE_INTEGER = 123456789
         ARBITRARY_OUTSIDE_DECIMAL = BigDecimal('0.123456789')
         ARBITRARY_OUTSIDE_DATE = Date.jd(9999999)
@@ -355,7 +357,7 @@ EOT
             description = "validate that :#{@attribute}"
 
             description <<
-              if @array.many?
+              if @array.count > 1
                 " is either #{inspected_array}"
               else
                 " is #{inspected_array}"

data/lib/shoulda/matchers/active_model/validate_length_of_matcher.rb

@@ -239,7 +239,7 @@ module Shoulda
       #
       # @return [ValidateLengthOfMatcher]
       #
-      # # ##### allow_blank
+      # ##### allow_blank
       #
       # Use `allow_blank` to assert that the attribute allows blank.
       #

data/lib/shoulda/matchers/active_model/validate_numericality_of_matcher.rb

@@ -276,6 +276,33 @@ module Shoulda
       #       should validate_numericality_of(:birth_day).odd
       #     end
       #
+      # ##### is_in
+      #
+      # Use `is_in` to test usage of the `:in` option.
+      # This asserts that the attribute can take a number which is contained
+      # in the given range.
+      #
+      #     class Person
+      #       include ActiveModel::Model
+      #       attr_accessor :legal_age
+      #
+      #       validates_numericality_of :birth_month, in: 1..12
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Person, type: :model do
+      #       it do
+      #         should validate_numericality_of(:birth_month).
+      #           is_in(1..12)
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class PersonTest < ActiveSupport::TestCase
+      #       should validate_numericality_of(:birth_month).
+      #         is_in(1..12)
+      #     end
+      #
       # ##### with_message
       #
       # Use `with_message` if you are using a custom validation message.
@@ -426,6 +453,13 @@ module Shoulda
           self
         end
 
+        def is_in(range)
+          prepare_submatcher(
+            NumericalityMatchers::RangeMatcher.new(self, @attribute, range),
+          )
+          self
+        end
+
         def with_message(message)
           @expects_custom_validation_message = true
           @expected_message = message
@@ -457,6 +491,10 @@ module Shoulda
           description << "validate that :#{@attribute} looks like "
           description << Shoulda::Matchers::Util.a_or_an(full_allowed_type)
 
+          if range_description.present?
+            description << " #{range_description}"
+          end
+
           if comparison_descriptions.present?
             description << " #{comparison_descriptions}"
           end
@@ -643,7 +681,7 @@ module Shoulda
             if number_of_submatchers_for_failure_message > 1
               "In checking that #{model.name} #{submatcher_description}, " +
                 failure_message[0].downcase +
-                failure_message[1..-1]
+                failure_message[1..]
             else
               failure_message
             end
@@ -673,6 +711,14 @@ module Shoulda
           end
         end
 
+        def range_description
+          range_submatcher = @submatchers.detect do |submatcher|
+            submatcher.respond_to? :range_description
+          end
+
+          range_submatcher&.range_description
+        end
+
         def model
           @subject.class
         end