shoulda-matchers 5.1.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 188abbfbc6cac3e26997733b3d88b34ea74e9747e25f137738190bf15d033751
-  data.tar.gz: 73136b35573cffac784cadd7e3193e8e9a0934f0e69fa751f536ed589db01024
+  metadata.gz: 0a3a788cc37a73b615004a4e88dacb051413e00f9a752b78f00cfa8b529e4149
+  data.tar.gz: 99e5319049435d5ae107d068cecacd547bbd5135e1f1966bf8e15c40e5cde84f
 SHA512:
-  metadata.gz: 55f3ccad9ce3d4affcb6ccc38020872bc000710f887765d7b78962bcdd339d79a2a1316e3a9d2cb33c62887e66bab9e54801d79c872f6cab7a2459a32ddce4bf
-  data.tar.gz: e5a862e62f25dfe284f0325f20600bbc4a3567ef78a0b7742685d1a9af9d03147ab650a259be287bd4566719444c7d998c0106874b7c3ac43efbd79996191838
+  metadata.gz: 5f2b4708f133c2e0a790c99de4608d976d8dfe8704436adeea539e816a18bc6bca7612e7ff669bc4830f8f617550a0db7a70574f611a791dc27879d66f6ed09c
+  data.tar.gz: 460ac28a8c3833b30ec3171f62a5d5225712132837caeb1c620df49cdcc1fc2d92614a8a652ac93f7707b06d4fe24c5c9ee70fc9759b8b34a3929f845931a2b5

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2021 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
@@ -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', '~> 5.0'
+  gem 'shoulda-matchers', '~> 6.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', '~> 6.0'
 end
 ```
 
@@ -167,9 +167,9 @@ end
 Most of the matchers provided by this gem are useful in a Rails context, and as
 such, can be used for different parts of a Rails app:
 
-* [database models backed by ActiveRecord](#activemodel-matchers)
+* [database models backed by ActiveRecord](#activerecord-matchers)
 * [non-database models, form objects, etc. backed by
-  ActiveModel](#activerecord-matchers)
+  ActiveModel](#activemodel-matchers)
 * [controllers](#actioncontroller-matchers)
 * [routes](#routing-matchers) (RSpec only)
 * [Rails-specific features like `delegate`](#independent-matchers)
@@ -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
 
@@ -383,8 +385,10 @@ 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#L827)**
+* **[have_and_belong_to_many](lib/shoulda/matchers/active_record/association_matcher.rb)**
   tests your `has_and_belongs_to_many` associations.
+* **[have_delegated_type](lib/shoulda/matchers/active_record/association_matcher.rb#L687)**
+  tests usage of the `delegated_type` macro.
 * **[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.
 * **[have_db_index](lib/shoulda/matchers/active_record/have_db_index_matcher.rb)**
@@ -407,6 +411,10 @@ 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
+* **[encrypt](lib/shoulda/matchers/active_record/encrypt_matcher.rb)**
+  tests usage of the `encrypts` macro.
 
 ### ActionController matchers
 
@@ -468,8 +476,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,30 +492,45 @@ 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-2021 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.
 
 [thoughtbot-website]: https://thoughtbot.com
 
+<!-- START /templates/footer.md -->
 ## About thoughtbot
 
-![thoughtbot][thoughtbot-logo]
-
-[thoughtbot-logo]: https://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg
+![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)
 
+This repo is maintained and funded by thoughtbot, inc.
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
-We are passionate about open source software. See [our other
-projects][community]. We are [available for hire][hire].
+We love open source software!
+See [our other projects][community].
+We are [available for hire][hire].
 
 [community]: https://thoughtbot.com/community?utm_source=github
-[hire]: https://thoughtbot.com?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github
+
+
+<!-- END /templates/footer.md -->

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:
@@ -276,16 +276,14 @@ module Shoulda
           :context, :subparameter_name, :parameters_double_registry
 
         def expectation
-          message = 'restrict parameters '
+          String.new('restrict parameters ').tap do |message|
+            if subparameter_name
+              message << "on #{subparameter_name.inspect} "
+            end
 
-          if subparameter_name
-            message << "on #{subparameter_name.inspect} "
+            message << 'to '\
+              "#{format_parameter_names(expected_permitted_parameter_names)}"
           end
-
-          message << 'to '\
-            "#{format_parameter_names(expected_permitted_parameter_names)}"
-
-          message
         end
 
         def reality

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

@@ -133,7 +133,7 @@ module Shoulda
           when :missing  then 404
           when :error    then 500..599
           when Symbol
-            ::Rack::Utils::SYMBOL_TO_STATUS_CODE[potential_symbol]
+            ::Rack::Utils.status_code(potential_symbol)
           else
             potential_symbol
           end

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

@@ -83,25 +83,23 @@ module Shoulda
         end
 
         def expectation_description
-          string = 'set'
-
-          string <<
-            if key_set?
-              " #{store.name}[#{key.inspect}]"
-            else
-              " any key in #{store.name}"
-            end
-
-          if expected_value_set?
+          String.new('set').tap do |string|
             string <<
-              if expected_value.is_a?(Regexp)
-                " to a value matching #{expected_value.inspect}"
+              if key_set?
+                " #{store.name}[#{key.inspect}]"
               else
-                " to #{expected_value.inspect}"
+                " any key in #{store.name}"
               end
-          end
 
-          string
+            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
+          end
         end
       end
     end

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

@@ -169,6 +169,36 @@ module Shoulda
       #         on(:create)
       #     end
       #
+      # ##### against
+      #
+      # Use `against` if the validation is on an attribute
+      # other than the attribute being validated:
+      #
+      #     class UserProfile
+      #       include ActiveModel::Model
+      #       attr_accessor :website_url
+      #
+      #       alias_attribute :url, :website_url
+      #
+      #       validates_format_of :url, with: URI.regexp
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe UserProfile, type: :model do
+      #       it do
+      #         should allow_value('https://foo.com').
+      #           for(:website_url).
+      #           against(:url)
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class UserProfileTest < ActiveSupport::TestCase
+      #       should allow_value('https://foo.com').
+      #         for(:website_url).
+      #         against(:url)
+      #     end
+      #
       # ##### with_message
       #
       # Use `with_message` if you are using a custom validation message.
@@ -349,6 +379,12 @@ module Shoulda
           self
         end
 
+        def against(attribute)
+          @attribute_to_check_message_against = attribute if attribute.present?
+
+          self
+        end
+
         def with_message(message, given_options = {})
           if message.present?
             @expects_custom_validation_message = true
@@ -402,6 +438,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 +520,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
@@ -541,7 +586,7 @@ module Shoulda
         end
 
         def default_failure_message_preface
-          ''.tap do |preface|
+          String.new.tap do |preface|
             if descriptions_for_preset_values.any?
               preface << 'After setting '
               preface << descriptions_for_preset_values.to_sentence

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

@@ -0,0 +1,157 @@
+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 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/have_secure_password_matcher.rb

@@ -47,6 +47,8 @@ module Shoulda
           did_not_authenticate_correct_password: 'expected %{subject} to'\
             ' authenticate the correct %{attribute}',
           method_not_found: 'expected %{subject} to respond to %{methods}',
+          should_not_have_secure_password: 'expected %{subject} to'\
+            ' not %{description}!',
         }.freeze
 
         def initialize(attribute)
@@ -69,6 +71,11 @@ module Shoulda
           failure.nil?
         end
 
+        def failure_message_when_negated
+          MESSAGES[:should_not_have_secure_password] %
+            { subject: @subject.class, description: description }
+        end
+
         protected
 
         attr_reader :subject

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,53 @@
+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
+            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/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'