shoulda-matchers 6.0.0 → 6.2.0

data/lib/shoulda/matchers/active_record/association_matchers/model_reflection.rb

@@ -13,7 +13,11 @@ module Shoulda
           end
 
           def associated_class
-            reflection.klass
+            if polymorphic?
+              subject
+            else
+              reflection.klass
+            end
           end
 
           def polymorphic?
@@ -70,6 +74,10 @@ module Shoulda
             reflection.options[:through]
           end
 
+          def strict_loading?
+            reflection.options.fetch(:strict_loading, subject.strict_loading_by_default)
+          end
+
           protected
 
           attr_reader :reflection, :subject

data/lib/shoulda/matchers/active_record/association_matchers/model_reflector.rb

@@ -8,6 +8,7 @@ module Shoulda
             :associated_class,
             :association_foreign_key,
             :foreign_key,
+            :foreign_type,
             :has_and_belongs_to_many_name,
             :join_table_name,
             :polymorphic?,

data/lib/shoulda/matchers/active_record/association_matchers/option_verifier.rb

@@ -122,6 +122,10 @@ module Shoulda
             reflector.associated_class
           end
 
+          def actual_value_for_strict_loading
+            reflection.strict_loading?
+          end
+
           def actual_value_for_option(name)
             option_value = reflection.options[name]
 

data/lib/shoulda/matchers/active_record/association_matchers/optional_matcher.rb

@@ -22,44 +22,48 @@ module Shoulda
             if submatcher_passes?(subject)
               true
             else
-              @missing_option = 'and for the record '
+              @missing_option = build_missing_option
 
-              missing_option <<
+              false
+            end
+          end
+
+          private
+
+          attr_reader :attribute_name, :optional, :submatcher
+
+          def submatcher_passes?(subject)
+            if optional
+              submatcher.matches?(subject)
+            else
+              submatcher.does_not_match?(subject)
+            end
+          end
+
+          def build_missing_option
+            String.new('and for the record ').tap do |missing_option_string|
+              missing_option_string <<
                 if optional
                   'not to '
                 else
                   'to '
                 end
 
-              missing_option << (
+              missing_option_string << (
                 'fail validation if '\
                 ":#{attribute_name} is unset; i.e., either the association "\
                 'should have been defined with `optional: '\
                 "#{optional.inspect}`, or there "
               )
 
-              missing_option <<
+              missing_option_string <<
                 if optional
                   'should not '
                 else
                   'should '
                 end
 
-              missing_option << "be a presence validation on :#{attribute_name}"
-
-              false
-            end
-          end
-
-          private
-
-          attr_reader :attribute_name, :optional, :submatcher
-
-          def submatcher_passes?(subject)
-            if optional
-              submatcher.matches?(subject)
-            else
-              submatcher.does_not_match?(subject)
+              missing_option_string << "be a presence validation on :#{attribute_name}"
             end
           end
         end

data/lib/shoulda/matchers/active_record/association_matchers/required_matcher.rb

@@ -23,50 +23,54 @@ module Shoulda
             if submatcher_passes?(subject)
               true
             else
-              @missing_option = 'and for the record '
+              @missing_option = build_missing_option
 
-              missing_option <<
+              false
+            end
+          end
+
+          private
+
+          attr_reader :attribute_name, :required, :submatcher
+
+          def submatcher_passes?(subject)
+            if required
+              submatcher.matches?(subject)
+            else
+              submatcher.does_not_match?(subject)
+            end
+          end
+
+          def validation_message_key
+            :required
+          end
+
+          def build_missing_option
+            String.new('and for the record ').tap do |missing_option_string|
+              missing_option_string <<
                 if required
                   'to '
                 else
                   'not to '
                 end
 
-              missing_option << (
+              missing_option_string << (
                 'fail validation if '\
                 ":#{attribute_name} is unset; i.e., either the association "\
                 'should have been defined with `required: '\
                 "#{required.inspect}`, or there "
               )
 
-              missing_option <<
+              missing_option_string <<
                 if required
                   'should '
                 else
                   'should not '
                 end
 
-              missing_option << "be a presence validation on :#{attribute_name}"
-
-              false
+              missing_option_string << "be a presence validation on :#{attribute_name}"
             end
           end
-
-          private
-
-          attr_reader :attribute_name, :required, :submatcher
-
-          def submatcher_passes?(subject)
-            if required
-              submatcher.matches?(subject)
-            else
-              submatcher.does_not_match?(subject)
-            end
-          end
-
-          def validation_message_key
-            :required
-          end
         end
       end
     end

data/lib/shoulda/matchers/active_record/encrypt_matcher.rb

@@ -0,0 +1,174 @@
+module Shoulda
+  module Matchers
+    module ActiveRecord
+      # The `encrypt` matcher tests usage of the
+      # `encrypts` macro (Rails 7+ only).
+      #
+      #     class Survey < ActiveRecord::Base
+      #       encrypts :access_code
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Survey, type: :model do
+      #       it { should encrypt(:access_code) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class SurveyTest < ActiveSupport::TestCase
+      #       should encrypt(:access_code)
+      #     end
+      #
+      # #### Qualifiers
+      #
+      # ##### deterministic
+      #
+      #     class Survey < ActiveRecord::Base
+      #       encrypts :access_code, deterministic: true
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Survey, type: :model do
+      #       it { should encrypt(:access_code).deterministic(true) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class SurveyTest < ActiveSupport::TestCase
+      #       should encrypt(:access_code).deterministic(true)
+      #     end
+      #
+      # ##### downcase
+      #
+      #     class Survey < ActiveRecord::Base
+      #       encrypts :access_code, downcase: true
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Survey, type: :model do
+      #       it { should encrypt(:access_code).downcase(true) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class SurveyTest < ActiveSupport::TestCase
+      #       should encrypt(:access_code).downcase(true)
+      #     end
+      #
+      # ##### ignore_case
+      #
+      #     class Survey < ActiveRecord::Base
+      #       encrypts :access_code, deterministic: true, ignore_case: true
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Survey, type: :model do
+      #       it { should encrypt(:access_code).ignore_case(true) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class SurveyTest < ActiveSupport::TestCase
+      #       should encrypt(:access_code).ignore_case(true)
+      #     end
+      #
+      # @return [EncryptMatcher]
+      #
+      def encrypt(value)
+        EncryptMatcher.new(value)
+      end
+
+      # @private
+      class EncryptMatcher
+        def initialize(attribute)
+          @attribute = attribute.to_sym
+          @options = {}
+        end
+
+        attr_reader :failure_message, :failure_message_when_negated
+
+        def deterministic(deterministic)
+          with_option(:deterministic, deterministic)
+        end
+
+        def downcase(downcase)
+          with_option(:downcase, downcase)
+        end
+
+        def ignore_case(ignore_case)
+          with_option(:ignore_case, ignore_case)
+        end
+
+        def matches?(subject)
+          @subject = subject
+          result = encrypted_attributes_included? &&
+                   options_correct?(
+                     :deterministic,
+                     :downcase,
+                     :ignore_case,
+                   )
+
+          if result
+            @failure_message_when_negated = "Did not expect to #{description} of #{class_name}"
+            if @options.present?
+              @failure_message_when_negated += "
+using "
+              @failure_message_when_negated += @options.map { |opt, expected|
+                ":#{opt} option as ‹#{expected}›"
+              }.join(' and
+')
+            end
+
+            @failure_message_when_negated += ",
+but it did"
+          end
+
+          result
+        end
+
+        def description
+          "encrypt :#{@attribute}"
+        end
+
+        private
+
+        def encrypted_attributes_included?
+          if encrypted_attributes.include?(@attribute)
+            true
+          else
+            @failure_message = "Expected to #{description} of #{class_name}, but it did not"
+            false
+          end
+        end
+
+        def with_option(option_name, value)
+          @options[option_name] = value
+          self
+        end
+
+        def options_correct?(*opts)
+          opts.all? do |opt|
+            next true unless @options.key?(opt)
+
+            expected = @options[opt]
+            actual = encrypted_attribute_scheme.send("#{opt}?")
+            next true if expected == actual
+
+            @failure_message = "Expected to #{description} of #{class_name} using :#{opt} option
+as ‹#{expected}›, but got ‹#{actual}›"
+
+            false
+          end
+        end
+
+        def encrypted_attributes
+          @_encrypted_attributes ||= @subject.class.encrypted_attributes || []
+        end
+
+        def encrypted_attribute_scheme
+          @subject.class.type_for_attribute(@attribute).scheme
+        end
+
+        def class_name
+          @subject.class.name
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/active_record/have_db_index_matcher.rb

@@ -152,18 +152,18 @@ module Shoulda
         end
 
         def description
-          description = 'have '
-
-          description <<
-            if qualifiers.include?(:unique)
-              "#{Shoulda::Matchers::Util.a_or_an(index_type)} "
-            else
-              'an '
-            end
+          String.new('have ').tap do |description|
+            description <<
+              if qualifiers.include?(:unique)
+                "#{Shoulda::Matchers::Util.a_or_an(index_type)} "
+              else
+                'an '
+              end
 
-          description << 'index on '
+            description << 'index on '
 
-          description << inspected_expected_columns
+            description << inspected_expected_columns
+          end
         end
 
         private

data/lib/shoulda/matchers/active_record/have_readonly_attribute_matcher.rb

@@ -59,7 +59,7 @@ module Shoulda
         private
 
         def readonly_attributes
-          @_readonly_attributes ||= (@subject.class.readonly_attributes || [])
+          @_readonly_attributes ||= @subject.class.readonly_attributes || []
         end
 
         def class_name

data/lib/shoulda/matchers/active_record/normalize_matcher.rb

@@ -40,7 +40,7 @@ module Shoulda
       #
       #     # Minitest (Shoulda)
       #     class User < ActiveSupport::TestCase
-      #       should normalize(:email, handle).from(" Example\n").to("example")
+      #       should normalize(:email, :handle).from(" Example\n").to("example")
       #     end
       #
       # If the normalization accepts nil values with the `apply_to_nil` option,

data/lib/shoulda/matchers/active_record/uniqueness/model.rb

@@ -29,7 +29,7 @@ module Shoulda
           end
 
           def symlink_to(parent)
-            namespace.set(name, parent.dup)
+            namespace.set(name, Class.new(parent))
           end
 
           def to_s

data/lib/shoulda/matchers/active_record/validate_uniqueness_of_matcher.rb

@@ -411,9 +411,29 @@ module Shoulda
           if scopes_match?
             true
           else
-            @failure_reason = 'Expected the validation '
+            @failure_reason = String.new('Expected the validation ').tap do |failure_reason_string|
+              failure_reason_string <<
+                if expected_scopes.empty?
+                  'not to be scoped to anything, '
+                else
+                  "to be scoped to #{inspected_expected_scopes}, "
+                end
+
+              if actual_sets_of_scopes.any?
+                failure_reason_string << 'but it was scoped to '
+                failure_reason_string << "#{inspected_actual_scopes} instead."
+              else
+                failure_reason_string << 'but it was not scoped to anything.'
+              end
+            end
 
-            @failure_reason <<
+            false
+          end
+        end
+
+        def build_failure_reason
+          String.new('Expected the validation ').tap do |failure_reason_string|
+            failure_reason_string <<
               if expected_scopes.empty?
                 'not to be scoped to anything, '
               else
@@ -421,27 +441,25 @@ module Shoulda
               end
 
             if actual_sets_of_scopes.any?
-              @failure_reason << 'but it was scoped to '
-              @failure_reason << "#{inspected_actual_scopes} instead."
+              failure_reason_string << 'but it was scoped to '
+              failure_reason_string << "#{inspected_actual_scopes} instead."
             else
-              @failure_reason << 'but it was not scoped to anything.'
+              failure_reason_string << 'but it was not scoped to anything.'
             end
-
-            false
           end
         end
 
         def does_not_match_scopes_configuration?
           if scopes_match?
-            @failure_reason = 'Expected the validation '
-
-            if expected_scopes.empty?
-              @failure_reason << 'to be scoped to nothing, '
-              @failure_reason << 'but it was scoped to '
-              @failure_reason << "#{inspected_actual_scopes} instead."
-            else
-              @failure_reason << 'not to be scoped to '
-              @failure_reason << inspected_expected_scopes
+            @failure_reason = String.new('Expected the validation ').tap do |failure_reason|
+              if expected_scopes.empty?
+                failure_reason << 'to be scoped to nothing, '
+                failure_reason << 'but it was scoped to '
+                failure_reason << "#{inspected_actual_scopes} instead."
+              else
+                failure_reason << 'not to be scoped to '
+                failure_reason << inspected_expected_scopes
+              end
             end
 
             false
@@ -618,20 +636,18 @@ module Shoulda
           else
             inspected_scopes = scopes_missing_on_model.map(&:inspect)
 
-            reason = ''
-
-            reason << inspected_scopes.to_sentence
-
-            reason <<
-              if inspected_scopes.many?
-                ' do not seem to be attributes'
-              else
-                ' does not seem to be an attribute'
-              end
+            @failure_reason = String.new.tap do |reason|
+              reason << inspected_scopes.to_sentence
 
-            reason << " on #{model.name}."
+              reason <<
+                if inspected_scopes.many?
+                  ' do not seem to be attributes'
+                else
+                  ' does not seem to be an attribute'
+                end
 
-            @failure_reason = reason
+              reason << " on #{model.name}."
+            end
 
             false
           end
@@ -643,20 +659,18 @@ module Shoulda
           else
             inspected_scopes = scopes_present_on_model.map(&:inspect)
 
-            reason = ''
-
-            reason << inspected_scopes.to_sentence
-
-            reason <<
-              if inspected_scopes.many?
-                ' seem to be attributes'
-              else
-                ' seems to be an attribute'
-              end
+            @failure_reason = String.new.tap do |reason|
+              reason << inspected_scopes.to_sentence
 
-            reason << " on #{model.name}."
+              reason <<
+                if inspected_scopes.many?
+                  ' seem to be attributes'
+                else
+                  ' seems to be an attribute'
+                end
 
-            @failure_reason = reason
+              reason << " on #{model.name}."
+            end
 
             false
           end
@@ -936,45 +950,43 @@ module Shoulda
         end
 
         def failure_message_preface # rubocop:disable Metrics/MethodLength
-          prefix = ''
-
-          if @existing_record_created
-            prefix << "After taking the given #{model.name}"
+          String.new.tap do |prefix|
+            if @existing_record_created
+              prefix << "After taking the given #{model.name}"
+
+              if attribute_setter_for_existing_record
+                prefix << ', setting '
+                prefix << description_for_attribute_setter(
+                  attribute_setter_for_existing_record,
+                )
+              else
+                prefix << ", whose :#{attribute} is "
+                prefix << "‹#{existing_value_read.inspect}›"
+              end
 
-            if attribute_setter_for_existing_record
-              prefix << ', setting '
+              prefix << ', and saving it as the existing record, then'
+            elsif attribute_setter_for_existing_record
+              prefix << "Given an existing #{model.name},"
+              prefix << ' after setting '
               prefix << description_for_attribute_setter(
                 attribute_setter_for_existing_record,
               )
+              prefix << ', then'
             else
-              prefix << ", whose :#{attribute} is "
-              prefix << "‹#{existing_value_read.inspect}›"
+              prefix << "Given an existing #{model.name} whose :#{attribute}"
+              prefix << ' is '
+              prefix << Shoulda::Matchers::Util.inspect_value(
+                existing_value_read,
+              )
+              prefix << ', after'
             end
 
-            prefix << ', and saving it as the existing record, then'
-          elsif attribute_setter_for_existing_record
-            prefix << "Given an existing #{model.name},"
-            prefix << ' after setting '
-            prefix << description_for_attribute_setter(
-              attribute_setter_for_existing_record,
-            )
-            prefix << ', then'
-          else
-            prefix << "Given an existing #{model.name} whose :#{attribute}"
-            prefix << ' is '
-            prefix << Shoulda::Matchers::Util.inspect_value(
-              existing_value_read,
-            )
-            prefix << ', after'
-          end
-
-          prefix << " making a new #{model.name} and setting "
+            prefix << " making a new #{model.name} and setting "
 
-          prefix << descriptions_for_attribute_setters_for_new_record
+            prefix << descriptions_for_attribute_setters_for_new_record
 
-          prefix << ", the matcher expected the new #{model.name} to be"
-
-          prefix
+            prefix << ", the matcher expected the new #{model.name} to be"
+          end
         end
 
         def attribute_changed_value_message

data/lib/shoulda/matchers/active_record.rb

@@ -25,6 +25,7 @@ require 'shoulda/matchers/active_record/uniqueness'
 require 'shoulda/matchers/active_record/validate_uniqueness_of_matcher'
 require 'shoulda/matchers/active_record/have_attached_matcher'
 require 'shoulda/matchers/active_record/normalize_matcher'
+require 'shoulda/matchers/active_record/encrypt_matcher'
 
 module Shoulda
   module Matchers

data/lib/shoulda/matchers/doublespeak/double_collection.rb

@@ -18,15 +18,11 @@ module Shoulda
         end
 
         def activate
-          doubles_by_method_name.each do |_method_name, double|
-            double.activate
-          end
+          doubles_by_method_name.each_value(&:activate)
         end
 
         def deactivate
-          doubles_by_method_name.each do |_method_name, double|
-            double.deactivate
-          end
+          doubles_by_method_name.each_value(&:deactivate)
         end
 
         def calls_by_method_name

data/lib/shoulda/matchers/doublespeak/world.rb

@@ -39,15 +39,11 @@ module Shoulda
         private
 
         def activate
-          double_collections_by_class.each do |_klass, double_collection|
-            double_collection.activate
-          end
+          double_collections_by_class.each_value(&:activate)
         end
 
         def deactivate
-          double_collections_by_class.each do |_klass, double_collection|
-            double_collection.deactivate
-          end
+          double_collections_by_class.each_value(&:deactivate)
         end
 
         def double_collections_by_class