shoulda-matchers 4.5.1 → 5.3.0

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

@@ -78,6 +78,27 @@ module Shoulda
       #     should validate_presence_of(:nickname).allow_nil
       #   end
       #
+      # #### allow_blank
+      #
+      # Use `allow_blank` to assert that the attribute allows blank.
+      #
+      #   class Robot
+      #     include ActiveModel::Model
+      #     attr_accessor :nickname
+      #
+      #     validates_presence_of :nickname, allow_blank: true
+      #   end
+      #
+      #   # RSpec
+      #   RSpec.describe Robot, type: :model do
+      #     it { should validate_presence_of(:nickname).allow_blank }
+      #   end
+      #
+      #   # Minitest (Shoulda)
+      #   class RobotTest < ActiveSupport::TestCase
+      #     should validate_presence_of(:nickname).allow_blank
+      #   end
+      #
       # ##### on
       #
       # Use `on` if your validation applies only under a certain context.
@@ -133,6 +154,7 @@ module Shoulda
       # @private
       class ValidatePresenceOfMatcher < ValidationMatcher
         include Qualifiers::AllowNil
+        include Qualifiers::AllowBlank
 
         def initialize(attribute)
           super
@@ -144,7 +166,8 @@ module Shoulda
 
           possibly_ignore_interference_by_writer
 
-          if secure_password_being_validated?
+          if secure_password_being_validated? &&
+             Shoulda::Matchers::RailsShim.active_model_lt_7?
             ignore_interference_by_writer.default_to(when: :blank?)
 
             disallowed_values.all? do |value|
@@ -152,6 +175,7 @@ module Shoulda
             end
           else
             (!expects_to_allow_nil? || allows_value_of(nil)) &&
+              (!expects_to_allow_blank? || allows_value_of('')) &&
               disallowed_values.all? do |value|
                 disallows_original_or_typecast_value?(value)
               end
@@ -171,6 +195,7 @@ module Shoulda
             end
           else
             (expects_to_allow_nil? && disallows_value_of(nil)) ||
+              (expects_to_allow_blank? && disallows_value_of('')) ||
               disallowed_values.any? do |value|
                 allows_original_or_typecast_value?(value)
               end
@@ -208,7 +233,7 @@ validation for you? Instead of using `validate_presence_of`, try
         end
 
         def possibly_ignore_interference_by_writer
-          if secure_password_being_validated?
+          if secure_password_being_validated? && RailsShim.active_model_lt_7?
             ignore_interference_by_writer.default_to(when: :blank?)
           end
         end
@@ -241,11 +266,11 @@ validation for you? Instead of using `validate_presence_of`, try
           else
             values = []
 
-            if attribute_accepts_string_values?
+            if attribute_accepts_string_values? && !expects_to_allow_blank?
               values << ''
             end
 
-            if !expects_to_allow_nil?
+            if !expects_to_allow_nil? && !expects_to_allow_blank?
               values << nil
             end
 
@@ -327,8 +352,8 @@ validation for you? Instead of using `validate_presence_of`, try
         end
 
         def collection_association?
-          association? && association_reflection.macro.in?(
-            [:has_many, :has_and_belongs_to_many],
+          association? && [:has_many, :has_and_belongs_to_many].include?(
+            association_reflection.macro,
           )
         end
 

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

@@ -98,12 +98,7 @@ module Shoulda
 
           all_validation_errors = record.errors.dup
 
-          validation_error_messages =
-            if record.errors.respond_to?(:[])
-              record.errors[attribute]
-            else
-              record.errors.on(attribute)
-            end
+          validation_error_messages = record.errors[attribute]
 
           {
             all_validation_errors: all_validation_errors,

data/lib/shoulda/matchers/active_model.rb

@@ -26,7 +26,8 @@ require 'shoulda/matchers/active_model/numericality_matchers/comparison_matcher'
 require 'shoulda/matchers/active_model/numericality_matchers/odd_number_matcher'
 require 'shoulda/matchers/active_model/numericality_matchers/even_number_matcher'
 require 'shoulda/matchers/active_model/numericality_matchers/only_integer_matcher'
-require 'shoulda/matchers/active_model/allow_mass_assignment_of_matcher'
+require 'shoulda/matchers/active_model/numericality_matchers/range_matcher'
+require 'shoulda/matchers/active_model/numericality_matchers/submatchers'
 require 'shoulda/matchers/active_model/errors'
 require 'shoulda/matchers/active_model/have_secure_password_matcher'
 

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

@@ -1004,7 +1004,7 @@ module Shoulda
           @submatchers = []
           @missing = ''
 
-          if macro == :belongs_to && RailsShim.active_record_gte_5?
+          if macro == :belongs_to
             required(belongs_to_required_by_default?)
           end
         end
@@ -1394,23 +1394,25 @@ module Shoulda
         end
 
         def class_has_foreign_key?(klass)
+          @missing = validate_foreign_key(klass)
+
+          @missing.nil?
+        end
+
+        def validate_foreign_key(klass)
           if options.key?(:foreign_key) && !foreign_key_correct?
-            @missing = foreign_key_failure_message(klass, options[:foreign_key])
-            false
-          elsif !has_column?(klass, foreign_key)
-            @missing = foreign_key_failure_message(klass, foreign_key)
-            false
-          else
-            true
+            foreign_key_failure_message(klass, options[:foreign_key])
+          elsif !has_column?(klass, actual_foreign_key)
+            foreign_key_failure_message(klass, actual_foreign_key)
           end
         end
 
         def has_column?(klass, column)
           case column
           when Array
-            column.all? { |c| has_column?(klass, c) }
+            column.all? { |c| has_column?(klass, c.to_s) }
           else
-            column_names_for(klass).include?(column)
+            column_names_for(klass).include?(column.to_s)
           end
         end
 
@@ -1442,19 +1444,15 @@ module Shoulda
           end
         end
 
-        def foreign_key
-          key = if foreign_key_reflection
-                  if foreign_key_reflection.respond_to?(:foreign_key)
-                    foreign_key_reflection.foreign_key
-                  else
-                    foreign_key_reflection.primary_key_name
-                  end
-                end
-
-          if key.is_a?(Array)
-            key.map(&:to_s)
+        def actual_foreign_key
+          return unless foreign_key_reflection
+
+          if foreign_key_reflection.options[:foreign_key]
+            foreign_key_reflection.options[:foreign_key]
+          elsif foreign_key_reflection.respond_to?(:foreign_key)
+            foreign_key_reflection.foreign_key
           else
-            key.to_s
+            foreign_key_reflection.primary_key_name
           end
         end
 

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

@@ -42,7 +42,7 @@ module Shoulda
           end
 
           def join_table_exists?
-            if RailsShim.tables_and_views(connection).
+            if connection.data_sources.
                 include?(join_table_name.to_s)
               true
             else

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

@@ -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/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
@@ -110,7 +116,7 @@ module Shoulda
       ## ##### with_prefix
       #
       # Use `with_prefix` to test that the enum is defined with a `_prefix`
-      # option (Rails 5 only). Can take either a boolean or a symbol:
+      # option (Rails 6+ only). Can take either a boolean or a symbol:
       #
       #     class Issue < ActiveRecord::Base
       #       enum status: [:open, :closed], _prefix: :old
@@ -157,6 +163,30 @@ module Shoulda
       #         with_suffix
       #     end
       #
+      # ##### without_scopes
+      #
+      # Use `without_scopes` to test that the enum is defined with
+      # '_scopes: false' option (Rails 5 only). Can take either a boolean or a
+      # symbol:
+      #
+      #     class Issue < ActiveRecord::Base
+      #       enum status: [:open, :closed], _scopes: false
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Issue, type: :model do
+      #       it do
+      #         should define_enum_for(:status).
+      #           without_scopes
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class ProcessTest < ActiveSupport::TestCase
+      #       should define_enum_for(:status).
+      #         without_scopes
+      #     end
+      #
       # @return [DefineEnumForMatcher]
       #
       def define_enum_for(attribute_name)
@@ -167,7 +197,7 @@ module Shoulda
       class DefineEnumForMatcher
         def initialize(attribute_name)
           @attribute_name = attribute_name
-          @options = { expected_enum_values: [] }
+          @options = { expected_enum_values: [], scopes: true }
         end
 
         def description
@@ -220,13 +250,19 @@ module Shoulda
           self
         end
 
+        def without_scopes
+          options[:scopes] = false
+          self
+        end
+
         def matches?(subject)
           @record = subject
 
           enum_defined? &&
             enum_values_match? &&
             column_type_matches? &&
-            enum_value_methods_exist?
+            enum_value_methods_exist? &&
+            scope_presence_matches?
         end
 
         def failure_message
@@ -288,6 +324,10 @@ module Shoulda
               expectation << "_#{expected_suffix}".inspect
             end
 
+            if exclude_scopes?
+              expectation << ' with no scopes'
+            end
+
             expectation
           else
             simple_description
@@ -370,7 +410,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
@@ -378,37 +421,81 @@ module Shoulda
         end
 
         def enum_value_methods_exist?
-          passed = expected_singleton_methods.all? do |method|
-            model.singleton_methods.include?(method)
+          if instance_methods_exist?
+            true
+          else
+            message = missing_methods_message
+
+            message << " (we can't tell which)"
+
+            @failure_message_continuation = message
+
+            false
           end
+        end
 
-          if passed
+        def scope_presence_matches?
+          if exclude_scopes?
+            if singleton_methods_exist?
+              message = "#{attribute_name.inspect} does map to these values "
+              message << 'but class scope methods were present'
+
+              @failure_message_continuation = message
+
+              false
+            else
+              true
+            end
+          elsif singleton_methods_exist?
             true
           else
-            message = "#{attribute_name.inspect} does map to these "
-            message << 'values, but the enum is '
+            if enum_defined?
+              message = 'But the class scope methods are not present'
+            else
+              message = missing_methods_message
 
-            if expected_prefix
-              if expected_suffix
-                message << 'configured with either a different prefix or '
-                message << 'suffix, or no prefix or suffix at all'
-              else
-                message << 'configured with either a different prefix or no '
-                message << 'prefix at all'
-              end
-            elsif expected_suffix
-              message << 'configured with either a different suffix or no '
-              message << 'suffix at all'
+              message << 'or the class scope methods are not present'
+              message << " (we can't tell which)"
             end
 
-            message << " (we can't tell which)"
-
             @failure_message_continuation = message
 
             false
           end
         end
 
+        def missing_methods_message
+          message = "#{attribute_name.inspect} does map to these "
+          message << 'values, but the enum is '
+
+          if expected_prefix
+            if expected_suffix
+              message << 'configured with either a different prefix or '
+              message << 'suffix, or no prefix or suffix at all'
+            else
+              message << 'configured with either a different prefix or no '
+              message << 'prefix at all'
+            end
+          elsif expected_suffix
+            message << 'configured with either a different suffix or no '
+            message << 'suffix at all'
+          else
+            ''
+          end
+        end
+
+        def singleton_methods_exist?
+          expected_singleton_methods.all? do |method|
+            model.singleton_methods.include?(method)
+          end
+        end
+
+        def instance_methods_exist?
+          expected_instance_methods.all? do |method|
+            record.methods.include?(method)
+          end
+        end
+
         def expected_singleton_methods
           expected_enum_value_names.map do |name|
             [expected_prefix, name, expected_suffix].
@@ -418,6 +505,18 @@ module Shoulda
           end
         end
 
+        def expected_instance_methods
+          methods = expected_enum_value_names.map do |name|
+            [expected_prefix, name, expected_suffix].
+              select(&:present?).
+              join('_')
+          end
+
+          methods.flat_map do |m|
+            ["#{m}?".to_sym, "#{m}!".to_sym]
+          end
+        end
+
         def expected_prefix
           if options.include?(:prefix)
             if options[:prefix] == true
@@ -438,6 +537,10 @@ module Shoulda
           end
         end
 
+        def exclude_scopes?
+          !options[:scopes]
+        end
+
         def to_hash(value)
           if value.is_a?(Array)
             value.each_with_index.inject({}) do |hash, (item, index)|

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

@@ -52,7 +52,7 @@ module Shoulda
       #
       # Use `with_options` to assert that a column has been defined with
       # certain options (`:precision`, `:limit`, `:default`, `:null`, `:scale`,
-      # or `:primary`).
+      # `:primary` or `:array`).
       #
       #     class CreatePhones < ActiveRecord::Migration
       #       def change
@@ -84,7 +84,7 @@ module Shoulda
 
       # @private
       class HaveDbColumnMatcher
-        OPTIONS = %i(precision limit default null scale primary).freeze
+        OPTIONS = %i(precision limit default null scale primary array).freeze
 
         def initialize(column)
           @column = column
@@ -115,7 +115,8 @@ module Shoulda
             correct_default? &&
             correct_null? &&
             correct_scale? &&
-            correct_primary?
+            correct_primary? &&
+            correct_array?
         end
 
         def failure_message
@@ -258,6 +259,23 @@ module Shoulda
           end
         end
 
+        def correct_array?
+          return true unless @options.key?(:array)
+
+          if matched_column.array? == @options[:array]
+            true
+          else
+            @missing = "#{model_class} has a db column named #{@column} "
+            @missing <<
+              if @options[:primary]
+                'that is not array, but should be'
+              else
+                'that is array, but should not be'
+              end
+            false
+          end
+        end
+
         def matched_column
           @_matched_column ||= begin
             column = model_class.columns.detect do |each|

data/lib/shoulda/matchers/rails_shim.rb

@@ -3,24 +3,12 @@ module Shoulda
     # @private
     module RailsShim # rubocop:disable Metrics/ModuleLength
       class << self
-        def action_pack_gte_5?
-          Gem::Requirement.new('>= 5').satisfied_by?(action_pack_version)
-        end
-
-        def action_pack_lt_5?
-          Gem::Requirement.new('< 5').satisfied_by?(action_pack_version)
-        end
-
         def action_pack_version
           Gem::Version.new(::ActionPack::VERSION::STRING)
         rescue NameError
           Gem::Version.new('0')
         end
 
-        def active_record_gte_5?
-          Gem::Requirement.new('>= 5').satisfied_by?(active_record_version)
-        end
-
         def active_record_gte_6?
           Gem::Requirement.new('>= 6').satisfied_by?(active_record_version)
         end
@@ -31,6 +19,20 @@ module Shoulda
           Gem::Version.new('0')
         end
 
+        def active_model_version
+          Gem::Version.new(::ActiveModel::VERSION::STRING)
+        rescue NameError
+          Gem::Version.new('0')
+        end
+
+        def active_model_st_6_1?
+          Gem::Requirement.new('< 6.1').satisfied_by?(active_model_version)
+        end
+
+        def active_model_lt_7?
+          Gem::Requirement.new('< 7').satisfied_by?(active_model_version)
+        end
+
         def generate_validation_message(
           record,
           attribute,
@@ -57,17 +59,6 @@ module Shoulda
           )
         end
 
-        def make_controller_request(context, verb, action, request_params)
-          params =
-            if action_pack_gte_5?
-              { params: request_params }
-            else
-              request_params
-            end
-
-          context.__send__(verb, action, params)
-        end
-
         def serialized_attributes_for(model)
           attribute_types_for(model).
             inject({}) do |hash, (attribute_name, attribute_type)|
@@ -85,26 +76,10 @@ module Shoulda
           serialized_attributes_for(model)[attribute_name.to_s]
         end
 
-        def tables_and_views(connection)
-          if active_record_gte_5?
-            connection.data_sources
-          else
-            connection.tables
-          end
-        end
-
         def verb_for_update
           :patch
         end
 
-        def validation_message_key_for_association_required_option
-          if active_record_gte_5?
-            :required
-          else
-            :blank
-          end
-        end
-
         def parent_of(mod)
           if mod.respond_to?(:module_parent)
             mod.module_parent

data/lib/shoulda/matchers/util/word_wrap.rb

@@ -92,7 +92,7 @@ module Shoulda
           if line.list_item?
             combined_lines << line
           else
-            combined_lines.last << (" #{line}").squeeze(' ')
+            combined_lines.last << " #{line}".squeeze(' ')
           end
 
           combined_lines
@@ -185,7 +185,7 @@ module Shoulda
           leftover = ''
         else
           fitted_line = line[0..index].rstrip
-          leftover = line[index + 1..-1]
+          leftover = line[index + 1..]
         end
 
         { fitted_line: fitted_line, leftover: leftover }

data/lib/shoulda/matchers/version.rb

@@ -1,6 +1,6 @@
 module Shoulda
   module Matchers
     # @private
-    VERSION = '4.5.1'.freeze
+    VERSION = '5.3.0'.freeze
   end
 end

data/shoulda-matchers.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
 
   s.metadata = {
     'bug_tracker_uri' => 'https://github.com/thoughtbot/shoulda-matchers/issues',
-    'changelog_uri' => 'https://github.com/thoughtbot/shoulda-matchers/blob/master/CHANGELOG.md',
+    'changelog_uri' => 'https://github.com/thoughtbot/shoulda-matchers/blob/main/CHANGELOG.md',
     'documentation_uri' => 'https://matchers.shoulda.io/docs',
     'homepage_uri' => 'https://matchers.shoulda.io',
     'source_code_uri' => 'https://github.com/thoughtbot/shoulda-matchers',
@@ -36,6 +36,6 @@ Gem::Specification.new do |s|
     'shoulda-matchers.gemspec']
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.4.0'
-  s.add_dependency('activesupport', '>= 4.2.0')
+  s.required_ruby_version = '>= 2.6.0'
+  s.add_dependency('activesupport', '>= 5.2.0')
 end