shoulda-matchers 4.4.0 → 5.0.0

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

@@ -26,12 +26,7 @@ module Shoulda
 
           def join_table_name
             join_table_name =
-              if has_and_belongs_to_many_name_table_name
-                has_and_belongs_to_many_name_table_name
-              else
-                reflection.join_table
-              end
-
+              has_and_belongs_to_many_name_table_name || reflection.join_table
             join_table_name.to_s
           end
 
@@ -82,9 +77,7 @@ module Shoulda
           private
 
           def has_and_belongs_to_many_name_table_name
-            if has_and_belongs_to_many_reflection
-              has_and_belongs_to_many_reflection.table_name
-            end
+            has_and_belongs_to_many_reflection&.table_name
           end
 
           def has_and_belongs_to_many_reflection

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

@@ -12,13 +12,13 @@ module Shoulda
             :join_table_name,
             :polymorphic?,
             :validate_inverse_of_through_association!,
-            to: :reflection
+            to: :reflection,
           )
 
           delegate(
             :through?,
             to: :reflection,
-            allow_nil: true
+            allow_nil: true,
           )
 
           def initialize(subject, name)
@@ -31,7 +31,7 @@ module Shoulda
           end
 
           def reflection
-            @reflection ||= reflect_on_association(name)
+            @_reflection ||= reflect_on_association(name)
           end
 
           def reflect_on_association(name)
@@ -48,9 +48,12 @@ module Shoulda
 
           def build_relation_with_clause(name, value)
             case name
-              when :conditions then associated_class.where(value)
-              when :order      then associated_class.order(value)
-              else                  raise ArgumentError, "Unknown clause '#{name}'"
+            when :conditions
+              associated_class.where(value)
+            when :order
+              associated_class.order(value)
+            else
+              raise ArgumentError, "Unknown clause '#{name}'"
             end
           end
 
@@ -59,7 +62,9 @@ module Shoulda
             when :conditions
               relation.where_values_hash
             when :order
-              relation.order_values.map { |value| value_as_sql(value) }.join(', ')
+              relation.order_values.map do |value|
+                value_as_sql(value)
+              end.join(', ')
             else
               raise ArgumentError, "Unknown clause '#{name}'"
             end

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

@@ -6,7 +6,12 @@ module Shoulda
         class OptionVerifier
           delegate :reflection, to: :reflector
 
-          RELATION_OPTIONS = [:conditions, :order]
+          DEFAULT_VALUE_OF_OPTIONS = {
+            has_many: {
+              validate: true,
+            },
+          }.freeze
+          RELATION_OPTIONS = [:conditions, :order].freeze
 
           def initialize(reflector)
             @reflector = reflector
@@ -40,7 +45,7 @@ module Shoulda
             else
               type_cast_expected_value = type_cast(
                 type,
-                expected_value_for(type, name, expected_value)
+                expected_value_for(type, name, expected_value),
               )
               actual_value = type_cast(type, actual_value_for(name))
               type_cast_expected_value == actual_value
@@ -55,7 +60,7 @@ module Shoulda
               if respond_to?(method_name, true)
                 __send__(method_name)
               else
-                reflection.options[name]
+                actual_value_for_option(name)
               end
             end
           end
@@ -94,7 +99,7 @@ module Shoulda
 
           def expected_value_for_constant(name)
             namespace = Shoulda::Matchers::Util.deconstantize(
-              reflector.model_class.to_s
+              reflector.model_class.to_s,
             )
 
             ["#{namespace}::#{name}", name].each do |path|
@@ -107,12 +112,25 @@ module Shoulda
           end
 
           def actual_value_for_relation_clause(name)
-            reflector.extract_relation_clause_from(reflector.association_relation, name)
+            reflector.extract_relation_clause_from(
+              reflector.association_relation,
+              name,
+            )
           end
 
           def actual_value_for_class_name
             reflector.associated_class
           end
+
+          def actual_value_for_option(name)
+            option_value = reflection.options[name]
+
+            if option_value.nil?
+              DEFAULT_VALUE_OF_OPTIONS.dig(reflection.macro, name)
+            else
+              option_value
+            end
+          end
         end
       end
     end

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

@@ -32,9 +32,9 @@ module Shoulda
                 end
 
               missing_option << (
-                'fail validation if ' +
-                ":#{attribute_name} is unset; i.e., either the association " +
-                'should have been defined with `optional: ' +
+                'fail validation if '\
+                ":#{attribute_name} is unset; i.e., either the association "\
+                'should have been defined with `optional: '\
                 "#{optional.inspect}`, or there "
               )
 

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

@@ -32,7 +32,7 @@ module Shoulda
           attr_accessor :subject, :order, :name
 
           def option_verifier
-            @option_verifier ||= OptionVerifier.new(subject)
+            @_option_verifier ||= OptionVerifier.new(subject)
           end
         end
       end

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

@@ -33,9 +33,9 @@ module Shoulda
                 end
 
               missing_option << (
-                'fail validation if ' +
-                ":#{attribute_name} is unset; i.e., either the association " +
-                'should have been defined with `required: ' +
+                'fail validation if '\
+                ":#{attribute_name} is unset; i.e., either the association "\
+                'should have been defined with `required: '\
                 "#{required.inspect}`, or there "
               )
 
@@ -65,7 +65,7 @@ module Shoulda
           end
 
           def validation_message_key
-            RailsShim.validation_message_key_for_association_required_option
+            :required
           end
         end
       end

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

@@ -22,7 +22,8 @@ module Shoulda
             if option_verifier.correct_for_string?(:source, source)
               true
             else
-              self.missing_option = "#{name} should have #{source} as source option"
+              self.missing_option =
+                "#{name} should have #{source} as source option"
               false
             end
           end
@@ -32,7 +33,7 @@ module Shoulda
           attr_accessor :subject, :source, :name
 
           def option_verifier
-            @option_verifier ||= OptionVerifier.new(subject)
+            @_option_verifier ||= OptionVerifier.new(subject)
           end
         end
       end

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

@@ -29,13 +29,14 @@ module Shoulda
             if through_reflection.present?
               true
             else
-              self.missing_option = "#{name} does not have any relationship to #{through}"
+              self.missing_option =
+                "#{name} does not have any relationship to #{through}"
               false
             end
           end
 
           def through_reflection
-            @through_reflection ||= subject.reflect_on_association(through)
+            @_through_reflection ||= subject.reflect_on_association(through)
           end
 
           def through_association_correct?
@@ -43,8 +44,9 @@ module Shoulda
               true
             else
               self.missing_option =
-                "Expected #{name} to have #{name} through #{through}, " +
-                "but got it through #{option_verifier.actual_value_for(:through)}"
+                "Expected #{name} to have #{name} through #{through}, "\
+                'but got it through ' +
+                option_verifier.actual_value_for(:through).to_s
               false
             end
           end
@@ -54,7 +56,7 @@ module Shoulda
           attr_accessor :through, :name, :subject
 
           def option_verifier
-            @option_verifier ||= OptionVerifier.new(subject)
+            @_option_verifier ||= OptionVerifier.new(subject)
           end
         end
       end

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

@@ -6,16 +6,22 @@ module Shoulda
       #
       #     class Process < ActiveRecord::Base
       #       enum status: [:running, :stopped, :suspended]
+      #
+      #       alias_attribute :kind, :SomeLegacyField
+      #
+      #       enum kind: [:foo, :bar]
       #     end
       #
       #     # RSpec
       #     RSpec.describe Process, type: :model do
       #       it { should define_enum_for(:status) }
+      #       it { should define_enum_for(:kind) }
       #     end
       #
       #     # Minitest (Shoulda)
       #     class ProcessTest < ActiveSupport::TestCase
       #       should define_enum_for(:status)
+      #       should define_enum_for(:kind)
       #     end
       #
       # #### Qualifiers
@@ -237,7 +243,7 @@ module Shoulda
               "Expected #{model} to #{expectation}, but "
             end
 
-          message << failure_message_continuation + '.'
+          message << "#{failure_message_continuation}."
 
           Shoulda::Matchers.word_wrap(message)
         end
@@ -252,7 +258,7 @@ module Shoulda
         attr_reader :attribute_name, :options, :record,
           :failure_message_continuation
 
-        def expectation
+        def expectation # rubocop:disable Metrics/MethodLength
           if enum_defined?
             expectation = "#{simple_description} backed by "
             expectation << Shoulda::Matchers::Util.a_or_an(expected_column_type)
@@ -358,8 +364,8 @@ module Shoulda
             true
           else
             @failure_message_continuation =
-              "However, #{attribute_name.inspect} is " +
-              Shoulda::Matchers::Util.a_or_an(column.type) +
+              "However, #{attribute_name.inspect} is "\
+              "#{Shoulda::Matchers::Util.a_or_an(column.type)}"\
               ' column'
             false
           end
@@ -370,7 +376,10 @@ module Shoulda
         end
 
         def column
-          model.columns_hash[attribute_name.to_s]
+          key = attribute_name.to_s
+          column_name = model.attribute_alias(key) || key
+
+          model.columns_hash[column_name]
         end
 
         def model
@@ -421,9 +430,9 @@ module Shoulda
         def expected_prefix
           if options.include?(:prefix)
             if options[:prefix] == true
-              attribute_name#.to_sym
+              attribute_name
             else
-              options[:prefix]#.to_sym
+              options[:prefix]
             end
           end
         end
@@ -431,9 +440,9 @@ module Shoulda
         def expected_suffix
           if options.include?(:suffix)
             if options[:suffix] == true
-              attribute_name#.to_sym
+              attribute_name
             else
-              options[:suffix]#.to_sym
+              options[:suffix]
             end
           end
         end

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

@@ -1,10 +1,52 @@
 module Shoulda
   module Matchers
     module ActiveRecord
+      # The `have_one_attached` matcher tests usage of the
+      # `has_one_attached` macro.
+      #
+      # #### Example
+      #
+      #     class User < ApplicationRecord
+      #       has_one_attached :avatar
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe User, type: :model do
+      #       it { should have_one_attached(:avatar) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class UserTest < ActiveSupport::TestCase
+      #       should have_one_attached(:avatar)
+      #     end
+      #
+      # @return [HaveAttachedMatcher]
+      #
       def have_one_attached(name)
         HaveAttachedMatcher.new(:one, name)
       end
 
+      # The `have_many_attached` matcher tests usage of the
+      # `has_many_attached` macro.
+      #
+      # #### Example
+      #
+      #     class Message < ApplicationRecord
+      #       has_many_attached :images
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Message, type: :model do
+      #       it { should have_many_attached(:images) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class MessageTest < ActiveSupport::TestCase
+      #       should have_many_attached(:images)
+      #     end
+      #
+      # @return [HaveAttachedMatcher]
+      #
       def have_many_attached(name)
         HaveAttachedMatcher.new(:many, name)
       end
@@ -92,10 +134,8 @@ Did not expect #{expectation}, but it does.
 
         def attachments_association_name
           case macro
-          when :one then
-            "#{name}_attachment"
-          when :many then
-            "#{name}_attachments"
+          when :one then "#{name}_attachment"
+          when :many then "#{name}_attachments"
           end
         end
 
@@ -121,10 +161,8 @@ Did not expect #{expectation}, but it does.
 
         def blobs_association_name
           case macro
-          when :one then
-            "#{name}_blob"
-          when :many then
-            "#{name}_blobs"
+          when :one then "#{name}_blob"
+          when :many then "#{name}_blobs"
           end
         end
 

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

@@ -84,6 +84,8 @@ module Shoulda
 
       # @private
       class HaveDbColumnMatcher
+        OPTIONS = %i(precision limit default null scale primary).freeze
+
         def initialize(column)
           @column = column
           @options = {}
@@ -95,7 +97,8 @@ module Shoulda
         end
 
         def with_options(opts = {})
-          %w(precision limit default null scale primary).each do |attribute|
+          validate_options(opts)
+          OPTIONS.each do |attribute|
             if opts.key?(attribute.to_sym)
               @options[attribute.to_sym] = opts[attribute.to_sym]
             end
@@ -125,23 +128,38 @@ module Shoulda
 
         def description
           desc = "have db column named #{@column}"
-          desc << " of type #{@options[:column_type]}"    if @options.key?(: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)
-          desc << " of primary #{@options[:primary]}"     if @options.key?(:primary)
-          desc << " of scale #{@options[:scale]}"         if @options.key?(:scale)
+          if @options.key?(:column_type)
+            desc << " of type #{@options[:column_type]}"
+          end
+          if @options.key?(:precision)
+            desc << " of precision #{@options[:precision]}"
+          end
+          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)
+          desc << " of primary #{@options[:primary]}" if @options.key?(:primary)
+          desc << " of scale #{@options[:scale]}" if @options.key?(:scale)
           desc
         end
 
         protected
 
+        def validate_options(opts)
+          invalid_options = opts.keys.map(&:to_sym) - OPTIONS
+          if invalid_options.any?
+            raise(
+              ArgumentError,
+              "Unknown option(s): #{invalid_options.map(&:inspect).join(', ')}",
+            )
+          end
+        end
+
         def column_exists?
           if model_class.column_names.include?(@column.to_s)
             true
           else
-            @missing = "#{model_class} does not have a db column named #{@column}."
+            @missing =
+              "#{model_class} does not have a db column named #{@column}."
             false
           end
         end
@@ -152,8 +170,9 @@ module Shoulda
           if matched_column.type.to_s == @options[:column_type].to_s
             true
           else
-            @missing = "#{model_class} has a db column named #{@column} " <<
-                       "of type #{matched_column.type}, not #{@options[:column_type]}."
+            @missing =
+              "#{model_class} has a db column named #{@column} " <<
+              "of type #{matched_column.type}, not #{@options[:column_type]}."
             false
           end
         end
@@ -229,18 +248,21 @@ module Shoulda
             true
           else
             @missing = "#{model_class} has a db column named #{@column} "
-            if @options[:primary]
-              @missing << 'that is not primary, but should be'
-            else
-              @missing << 'that is primary, but should not be'
-            end
+            @missing <<
+              if @options[:primary]
+                'that is not primary, but should be'
+              else
+                'that is primary, but should not be'
+              end
             false
           end
         end
 
         def matched_column
           @_matched_column ||= begin
-            column = model_class.columns.detect { |each| each.name == @column.to_s }
+            column = model_class.columns.detect do |each|
+              each.name == @column.to_s
+            end
             DecoratedColumn.new(model_class, column)
           end
         end