shoulda-matchers 5.1.0 → 6.4.0

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

@@ -48,6 +48,30 @@ module Shoulda
       #       should have_db_column(:camera_aperture).of_type(:decimal)
       #     end
       #
+      # ##### of_sql_type
+      #
+      # Use `of_sql_type` to assert that a column is defined as a certain sql_type.
+      #
+      #     class CreatePhones < ActiveRecord::Migration
+      #       def change
+      #         create_table :phones do |t|
+      #           t.string :camera_aperture, limit: 36
+      #         end
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Phone, type: :model do
+      #       it do
+      #         should have_db_column(:camera_aperture).of_sql_type('varchar(36)')
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class PhoneTest < ActiveSupport::TestCase
+      #       should have_db_column(:camera_aperture).of_sql_type('varchar(36)')
+      #     end
+      #
       # ##### with_options
       #
       # Use `with_options` to assert that a column has been defined with
@@ -96,6 +120,11 @@ module Shoulda
           self
         end
 
+        def of_sql_type(sql_column_type)
+          @options[:sql_column_type] = sql_column_type
+          self
+        end
+
         def with_options(opts = {})
           validate_options(opts)
           OPTIONS.each do |attribute|
@@ -110,6 +139,7 @@ module Shoulda
           @subject = subject
           column_exists? &&
             correct_column_type? &&
+            correct_sql_column_type? &&
             correct_precision? &&
             correct_limit? &&
             correct_default? &&
@@ -129,12 +159,9 @@ module Shoulda
 
         def description
           desc = "have db column named #{@column}"
-          if @options.key?(:column_type)
-            desc << " of type #{@options[:column_type]}"
-          end
-          if @options.key?(:precision)
-            desc << " of precision #{@options[:precision]}"
-          end
+          desc << " of type #{@options[:column_type]}" if @options.key?(:column_type)
+          desc << " of sql_type #{@options[:sql_column_type]}" if @options.key?(:sql_column_type)
+          desc << " of precision #{@options[:precision]}" if @options.key?(:precision)
           desc << " of limit #{@options[:limit]}" if @options.key?(:limit)
           desc << " of default #{@options[:default]}" if @options.key?(:default)
           desc << " of null #{@options[:null]}" if @options.key?(:null)
@@ -178,6 +205,19 @@ module Shoulda
           end
         end
 
+        def correct_sql_column_type?
+          return true unless @options.key?(:sql_column_type)
+
+          if matched_column.sql_type.to_s == @options[:sql_column_type].to_s
+            true
+          else
+            @missing =
+              "#{model_class} has a db column named #{@column} " <<
+              "of sql type #{matched_column.sql_type}, not #{@options[:sql_column_type]}."
+            false
+          end
+        end
+
         def correct_precision?
           return true unless @options.key?(:precision)
 

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
@@ -197,17 +197,28 @@ module Shoulda
         def matched_index
           @_matched_index ||=
             if expected_columns.one?
-              actual_indexes.detect do |index|
+              sorted_indexes.detect do |index|
                 Array.wrap(index.columns) == expected_columns
               end
             else
-              actual_indexes.detect do |index|
+              sorted_indexes.detect do |index|
                 index.columns == expected_columns
               end
             end
         end
 
-        def actual_indexes
+        def sorted_indexes
+          if qualifiers.include?(:unique)
+            # return indexes with unique matching the qualifier first
+            unsorted_indexes.sort_by do |index|
+              index.unique == qualifiers[:unique] ? 0 : 1
+            end
+          else
+            unsorted_indexes
+          end
+        end
+
+        def unsorted_indexes
           model.connection.indexes(table_name)
         end
 

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

@@ -2,7 +2,7 @@ module Shoulda
   module Matchers
     module ActiveRecord
       # The `have_implicit_order_column` matcher tests that the model has `implicit_order_column`
-      # assigned to one of the table columns. (Rails 6+ only)
+      # assigned to one of the table columns.
       #
       #     class Product < ApplicationRecord
       #       self.implicit_order_column = :created_at
@@ -20,10 +20,8 @@ module Shoulda
       #
       # @return [HaveImplicitOrderColumnMatcher]
       #
-      if RailsShim.active_record_gte_6?
-        def have_implicit_order_column(column_name)
-          HaveImplicitOrderColumnMatcher.new(column_name)
-        end
+      def have_implicit_order_column(column_name)
+        HaveImplicitOrderColumnMatcher.new(column_name)
       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

@@ -0,0 +1,151 @@
+module Shoulda
+  module Matchers
+    module ActiveRecord
+      # The `normalize` matcher is used to ensure attribute normalizations
+      # are transforming attribute values as expected.
+      #
+      # Take this model for example:
+      #
+      #     class User < ActiveRecord::Base
+      #       normalizes :email, with: -> email { email.strip.downcase }
+      #     end
+      #
+      # You can use `normalize` providing an input and defining the expected
+      # normalization output:
+      #
+      #     # RSpec
+      #     RSpec.describe User, type: :model do
+      #       it do
+      #         should normalize(:email).from(" ME@XYZ.COM\n").to("me@xyz.com")
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class User < ActiveSupport::TestCase
+      #       should normalize(:email).from(" ME@XYZ.COM\n").to("me@xyz.com")
+      #     end
+      #
+      # You can use `normalize` to test multiple attributes at once:
+      #
+      #     class User < ActiveRecord::Base
+      #       normalizes :email, :handle, with: -> value { value.strip.downcase }
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe User, type: :model do
+      #       it do
+      #         should normalize(:email, :handle).from(" Example\n").to("example")
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class User < ActiveSupport::TestCase
+      #       should normalize(:email, :handle).from(" Example\n").to("example")
+      #     end
+      #
+      # If the normalization accepts nil values with the `apply_to_nil` option,
+      # you just need to use `.from(nil).to("Your expected value here")`.
+      #
+      #     class User < ActiveRecord::Base
+      #       normalizes :name, with: -> name { name&.titleize || 'Untitled' },
+      #         apply_to_nil: true
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe User, type: :model do
+      #       it { should normalize(:name).from("jane doe").to("Jane Doe") }
+      #       it { should normalize(:name).from(nil).to("Untitled") }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class User < ActiveSupport::TestCase
+      #       should normalize(:name).from("jane doe").to("Jane Doe")
+      #       should normalize(:name).from(nil).to("Untitled")
+      #     end
+      #
+      # @return [NormalizeMatcher]
+      #
+      def normalize(*attributes)
+        if attributes.empty?
+          raise ArgumentError, 'need at least one attribute'
+        else
+          NormalizeMatcher.new(*attributes)
+        end
+      end
+
+      # @private
+      class NormalizeMatcher
+        attr_reader :attributes, :from_value, :to_value, :failure_message,
+          :failure_message_when_negated
+
+        def initialize(*attributes)
+          @attributes = attributes
+        end
+
+        def description
+          %(
+            normalize #{attributes.to_sentence(last_word_connector: ' and ')} from
+            ‹#{from_value.inspect}› to ‹#{to_value.inspect}›
+          ).squish
+        end
+
+        def from(value)
+          @from_value = value
+
+          self
+        end
+
+        def to(value)
+          @to_value = value
+
+          self
+        end
+
+        def matches?(subject)
+          attributes.all? { |attribute| attribute_matches?(subject, attribute) }
+        end
+
+        def does_not_match?(subject)
+          attributes.all? { |attribute| attribute_does_not_match?(subject, attribute) }
+        end
+
+        private
+
+        def attribute_matches?(subject, attribute)
+          return true if normalize_attribute?(subject, attribute)
+
+          @failure_message = build_failure_message(
+            attribute,
+            subject.class.normalize_value_for(attribute, from_value),
+          )
+          false
+        end
+
+        def attribute_does_not_match?(subject, attribute)
+          return true unless normalize_attribute?(subject, attribute)
+
+          @failure_message_when_negated = build_failure_message_when_negated(attribute)
+          false
+        end
+
+        def normalize_attribute?(subject, attribute)
+          subject.class.normalize_value_for(attribute, from_value) == to_value
+        end
+
+        def build_failure_message(attribute, attribute_value)
+          %(
+            Expected to normalize #{attribute.inspect} from ‹#{from_value.inspect}› to
+            ‹#{to_value.inspect}› but it was normalized to ‹#{attribute_value.inspect}›
+          ).squish
+        end
+
+        def build_failure_message_when_negated(attribute)
+          %(
+            Expected to not normalize #{attribute.inspect} from ‹#{from_value.inspect}› to
+            ‹#{to_value.inspect}› but it was normalized
+          ).squish
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,19 @@ module Shoulda
           end
 
           def symlink_to(parent)
-            namespace.set(name, parent.dup)
+            table_name = parent.table_name
+
+            new_class = Class.new(parent) do
+              define_singleton_method :table_name do
+                table_name
+              end
+
+              define_singleton_method :base_class do
+                self
+              end
+            end
+
+            namespace.set(name, new_class)
           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

@@ -24,6 +24,8 @@ require 'shoulda/matchers/active_record/define_enum_for_matcher'
 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

data/lib/shoulda/matchers/doublespeak.rb

@@ -1,5 +1,4 @@
 require 'forwardable'
-require 'logger'
 
 module Shoulda
   module Matchers

data/lib/shoulda/matchers/independent/delegate_method_matcher.rb

@@ -400,7 +400,7 @@ module Shoulda
                 false
               rescue NoMethodError => e
                 if e.message =~
-                   /undefined method `#{delegate_method}' for nil:NilClass/
+                   /undefined method `#{delegate_method}' for nil/
                   false
                 else
                   raise e
@@ -440,22 +440,20 @@ module Shoulda
         end
 
         def formatted_calls_on_delegate_object
-          string = ''
-
-          if calls_on_delegate_object.any?
-            string << "\n\n"
-            calls_on_delegate_object.each_with_index do |call, i|
-              name = call.method_name
-              args = call.args.map(&:inspect).join(', ')
-              string << "#{i + 1}) #{name}(#{args})\n"
+          String.new.tap do |string|
+            if calls_on_delegate_object.any?
+              string << "\n\n"
+              calls_on_delegate_object.each_with_index do |call, i|
+                name = call.method_name
+                args = call.args.map(&:inspect).join(', ')
+                string << "#{i + 1}) #{name}(#{args})\n"
+              end
+            else
+              string << ' (none)'
             end
-          else
-            string << ' (none)'
-          end
 
-          string.rstrip!
-
-          string
+            string.rstrip!
+          end
         end
       end
     end