shoulda-matchers 5.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97aebe50b9fb389687c99bc5dc1229a27abc5255f15e2330c9d1409d957fb689
-  data.tar.gz: 7cd8151aae87feb29121f4b4c152f963e5cc1c7a136e0a2115344af225fb1dcd
+  metadata.gz: '00039d1c47436bb88b431784a2b956713382face294b6bbe5c7599378ce03a55'
+  data.tar.gz: 27640030d1ada19757e5da4d9c10465f422234f8dde9242a54bcb002585c71d5
 SHA512:
-  metadata.gz: 351c2bc9565abf151db5eeef3d17280989cdc8ec1841b0a099de8be8533767324494b04bfcc4464290852f5b022f6595fb5759e79c4534f50b6e464c94e44679
-  data.tar.gz: 529b6d0815299c10c0f52664371e37b948ec4b8403c0096065f11649fb1849851454634f736e747820f06e27fc4d48a0616d9adfbc34b560f14a8dad364e4268
+  metadata.gz: 51aff6ac4ab386f8df5dec81dfca4f197604d206263b29b711146820dda54ef5f9a9aa723aa6ce14084364eccdcbfbb8c3b1c38f2a4cdcbfc5d3ae8e8c965806
+  data.tar.gz: 476b055e38257cc8d6841a96779a012ef68cd01239c26c15b170c251a4f7655bab6344a7c163361e9ef283142994bc04ed69f8c6bbccf1bae3acfafc5fd62176

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2022 Tammer Saleh and thoughtbot, inc.
+Copyright (c) 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

@@ -2,7 +2,7 @@
 
 [version-badge]: https://img.shields.io/gem/v/shoulda-matchers.svg
 [rubygems]: https://rubygems.org/gems/shoulda-matchers
-[github-actions-badge]: https://img.shields.io/github/workflow/status/thoughtbot/shoulda-matchers/Test
+[github-actions-badge]: https://img.shields.io/github/actions/workflow/status/thoughtbot/shoulda-matchers/ci.yml?branch=main
 [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
@@ -374,6 +374,8 @@ about any of them, make sure to [consult the documentation][rubydocs]!
   tests usage of `validates_numericality_of`.
 * **[validate_presence_of](lib/shoulda/matchers/active_model/validate_presence_of_matcher.rb)**
   tests usage of `validates_presence_of`.
+* **[validate_comparison_of](lib/shoulda/matchers/active_model/validate_comparison_of_matcher.rb)**
+  tests usage of `validates_comparison_of`.
 
 ### ActiveRecord matchers
 
@@ -407,6 +409,8 @@ about any of them, make sure to [consult the documentation][rubydocs]!
   usage of the `serialize` macro.
 * **[validate_uniqueness_of](lib/shoulda/matchers/active_record/validate_uniqueness_of_matcher.rb)**
   tests usage of `validates_uniqueness_of`.
+* **[normalize](lib/shoulda/matchers/active_record/normalize_matcher.rb)** tests
+  usage of the `normalize` macro
 
 ### ActionController matchers
 
@@ -468,8 +472,8 @@ machine, understanding the codebase, and creating a good pull request.
 
 ## Compatibility
 
-Shoulda Matchers is tested and supported against Ruby 2.6+, Rails
-5.2+, RSpec 3.x, and Minitest 5.x.
+Shoulda Matchers is tested and supported against Ruby 3.0+, Rails
+6.1+, 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 < 3.0 and Rails < 6.1 compatibility, please use [v4.5.1][v4.5.1].
@@ -484,15 +488,26 @@ Shoulda Matchers follows Semantic Versioning 2.0 as defined at
 
 ## Team
 
-Shoulda Matchers is maintained by [Elliot Winkler][mcmire] and [Gui
-Albuk][guialbuk].
+Shoulda Matchers is currently maintained by [Pedro Paiva][VSPPedro] and [Matheus
+Sales][matsales28]. Previous maintainers include [Elliot Winkler][mcmire],
+[Gui Albuk][guialbuk], [Jason Draper][drapergeek], [Melissa Xie][mxie],
+[Gabe Berke-Williams][gabebw], [Ryan McGeary][rmm5t], [Joe Ferris][jferris], and
+[Tammer Saleh][tammersaleh].
 
+[VSPPedro]: https://github.com/VSPPedro
+[matsales28]: https://github.com/matsales28
 [mcmire]: https://github.com/mcmire
 [guialbuk]: https://github.com/guialbuk
+[drapergeek]: https://github.com/drapergeek
+[mxie]: https://github.com/mxie
+[gabebw]: https://github.com/gabebw
+[rmm5t]: https://github.com/rmm5t
+[jferris]: https://github.com/jferris
+[tammersaleh]: https://github.com/tammersaleh
 
 ## Copyright/License
 
-Shoulda Matchers is copyright © 2006-2022 Tammer Saleh and [thoughtbot,
+Shoulda Matchers is copyright © 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.
 
@@ -502,7 +517,7 @@ redistributed under the terms specified in the [LICENSE](LICENSE) file.
 
 ![thoughtbot][thoughtbot-logo]
 
-[thoughtbot-logo]: https://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg
+[thoughtbot-logo]: https://thoughtbot.com/brand_assets/93:44.svg
 
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 

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

@@ -11,7 +11,7 @@ module Shoulda
   module Matchers
     module ActionController
       # The `permit` matcher tests that an action in your controller receives a
-      # whitelist of parameters using Rails' Strong Parameters feature
+      # allowlist of parameters using Rails' Strong Parameters feature
       # (specifically that `permit` was called with the correct arguments).
       #
       # Here's an example:

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

@@ -402,6 +402,10 @@ module Shoulda
           @result.nil?
         end
 
+        def has_any_errors?
+          validator.record.errors.any?
+        end
+
         def failure_message
           attribute_setter = result.attribute_setter
 
@@ -480,6 +484,11 @@ module Shoulda
                   message << " it produced these validation errors instead:\n\n"
                   message << validator.all_formatted_validation_error_messages
                 end
+              elsif validator.has_any_errors?
+                message << ", placing a validation error on :#{attribute_setter.attribute_name}"
+                message << '. The Example was invalid,'
+                message << " but it had errors involving other attributes:\n\n"
+                message << validator.all_formatted_validation_error_messages
               else
                 message << ', but it was valid instead.'
               end

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

@@ -0,0 +1,162 @@
+require 'active_support/core_ext/module/delegation'
+
+module Shoulda
+  module Matchers
+    module ActiveModel
+      # @private
+      class ComparisonMatcher < ValidationMatcher
+        ERROR_MESSAGES = {
+          :> => {
+            label: :greater_than,
+            assertions: [false, false, true],
+          },
+          :>= => {
+            label: :greater_than_or_equal_to,
+            assertions: [false, true, true],
+          },
+          :< => {
+            label: :less_than,
+            assertions: [true, false, false],
+          },
+          :<= => {
+            label: :less_than_or_equal_to,
+            assertions: [true, true, false],
+          },
+          :== => {
+            label: :equal_to,
+            assertions: [false, true, false],
+          },
+          :!= => {
+            label: :other_than,
+            assertions: [true, false, true],
+          },
+        }.freeze
+
+        delegate :failure_message, :failure_message_when_negated, to: :comparison_submatchers
+
+        def initialize(matcher, value, operator)
+          super(nil)
+          unless matcher.respond_to? :diff_to_compare
+            raise ArgumentError, 'matcher is invalid'
+          end
+
+          @matcher = matcher
+          @value = value
+          @operator = operator
+          @message = ERROR_MESSAGES[operator][:label]
+        end
+
+        def simple_description
+          description = ''
+
+          if expects_strict?
+            description << ' strictly'
+          end
+
+          description +
+            "disallow :#{attribute} from being a number that is not " +
+            "#{comparison_expectation} #{@value}"
+        end
+
+        def for(attribute)
+          @attribute = attribute
+          self
+        end
+
+        def with_message(message)
+          @expects_custom_validation_message = true
+          @message = message
+          self
+        end
+
+        def expects_custom_validation_message?
+          @expects_custom_validation_message
+        end
+
+        def matches?(subject)
+          @subject = subject
+          comparison_submatchers.matches?(subject)
+        end
+
+        def does_not_match?(subject)
+          @subject = subject
+          comparison_submatchers.does_not_match?(subject)
+        end
+
+        def comparison_description
+          "#{comparison_expectation} #{@value}"
+        end
+
+        def comparison_submatchers
+          @_comparison_submatchers ||=
+            NumericalityMatchers::Submatchers.new(build_comparison_submatchers)
+        end
+
+        private
+
+        def build_comparison_submatchers
+          comparison_combos.map do |diff, submatcher_method_name|
+            matcher = __send__(submatcher_method_name, diff, nil)
+            matcher.with_message(@message, values: { count: option_value })
+            matcher
+          end
+        end
+
+        def comparison_combos
+          diffs_to_compare.zip(submatcher_method_names)
+        end
+
+        def submatcher_method_names
+          assertions.map do |value|
+            if value
+              :allow_value_matcher
+            else
+              :disallow_value_matcher
+            end
+          end
+        end
+
+        def assertions
+          ERROR_MESSAGES[@operator][:assertions]
+        end
+
+        def option_value
+          if defined?(@_option_value)
+            @_option_value
+          else
+            @_option_value =
+              case @value
+              when Proc then @value.call(@subject)
+              when Symbol then @subject.send(@value)
+              else @value
+              end
+          end
+        end
+
+        def diffs_to_compare
+          diff_to_compare = @matcher.diff_to_compare
+          values = case option_value
+                   when String then diffs_when_string(diff_to_compare)
+                   else [-1, 0, 1].map { |sign| option_value + (diff_to_compare * sign) }
+                   end
+
+          if @matcher.given_numeric_column?
+            values
+          else
+            values.map(&:to_s)
+          end
+        end
+
+        def diffs_when_string(diff_to_compare)
+          [-1, 0, 1].map do |sign|
+            option_value[0..-2] + (option_value[-1].ord + diff_to_compare * sign).chr
+          end
+        end
+
+        def comparison_expectation
+          ERROR_MESSAGES[@operator][:label].to_s.tr('_', ' ')
+        end
+      end
+    end
+  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)
+            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,58 @@
+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 does_not_match?(subject)
+            @subject = subject
+            non_failing_submatchers.empty?
+          end
+
+          def failure_message
+            failing_submatcher.failure_message
+          end
+
+          def failure_message_when_negated
+            non_failing_submatcher.failure_message_when_negated
+          end
+
+          def add(submatcher)
+            @submatchers << submatcher
+          end
+
+          private
+
+          def failing_submatchers
+            @_failing_submatchers ||= @submatchers.reject do |submatcher|
+              submatcher.matches?(@subject)
+            end
+          end
+
+          def non_failing_submatchers
+            @_non_failing_submatchers ||= @submatchers.reject do |submatcher|
+              submatcher.does_not_match?(@subject)
+            end
+          end
+
+          def failing_submatcher
+            failing_submatchers.last
+          end
+
+          def non_failing_submatcher
+            non_failing_submatchers.last
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -108,7 +108,7 @@ module Shoulda
               obj
             end
           elsif array_column?
-            ['an arbitary value']
+            ['an arbitrary value']
           elsif enum_column?
             enum_values.first
           else
@@ -118,6 +118,7 @@ module Shoulda
             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