shoulda-matchers 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 319b0cb3944a37309b11169bd71ffddde2d6af35b262795e7c16466d6d2c497c
-  data.tar.gz: 22ac49d578766e24a18826bcde86443a09afa41c1cfc9ee7932f94f214623a36
+  metadata.gz: 97aebe50b9fb389687c99bc5dc1229a27abc5255f15e2330c9d1409d957fb689
+  data.tar.gz: 7cd8151aae87feb29121f4b4c152f963e5cc1c7a136e0a2115344af225fb1dcd
 SHA512:
-  metadata.gz: 05a067ef5aa288661855f6257a55ce887bdf19f6684cd965c145669815a3d432a236cd7fb88e21647d0251e4e971b6c45b03af04def19b5cefbef26279276d81
-  data.tar.gz: f06e9c331d39d82fd450332cb0b81e108852c7fac2a28927ada2fbccc11b31226206023f69eb6ecccd7dceaaca4c9b3410b818ed86babd3f7f37bb4c778013df
+  metadata.gz: 351c2bc9565abf151db5eeef3d17280989cdc8ec1841b0a099de8be8533767324494b04bfcc4464290852f5b022f6595fb5759e79c4534f50b6e464c94e44679
+  data.tar.gz: 529b6d0815299c10c0f52664371e37b948ec4b8403c0096065f11649fb1849851454634f736e747820f06e27fc4d48a0616d9adfbc34b560f14a8dad364e4268

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2021 Tammer Saleh and thoughtbot, inc.
+Copyright (c) 2006-2022 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

@@ -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
@@ -117,7 +117,7 @@ Otherwise, add `shoulda-matchers` to your Gemfile:
 
 ```ruby
 group :test do
-  gem 'shoulda-matchers', '~> 4.0'
+  gem 'shoulda-matchers', '~> 5.0'
 end
 ```
 
@@ -492,7 +492,7 @@ Albuk][guialbuk].
 
 ## Copyright/License
 
-Shoulda Matchers is copyright © 2006-2021 Tammer Saleh and [thoughtbot,
+Shoulda Matchers is copyright © 2006-2022 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.
 

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'

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

@@ -109,6 +109,8 @@ module Shoulda
             end
           elsif array_column?
             ['an arbitary value']
+          elsif enum_column?
+            enum_values.first
           else
             case column_type
             when :integer, :float then 1
@@ -145,6 +147,15 @@ module Shoulda
             @subject.class.columns_hash[@attribute.to_s].respond_to?(:array) &&
             @subject.class.columns_hash[@attribute.to_s].array
         end
+
+        def enum_column?
+          @subject.class.respond_to?(:defined_enums) &&
+            @subject.class.defined_enums.key?(@attribute.to_s)
+        end
+
+        def enum_values
+          @subject.class.defined_enums[@attribute.to_s].values
+        end
       end
     end
   end

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

@@ -355,7 +355,7 @@ EOT
             description = "validate that :#{@attribute}"
 
             description <<
-              if @array.many?
+              if @array.count > 1
                 " is either #{inspected_array}"
               else
                 " is #{inspected_array}"

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

@@ -239,7 +239,7 @@ module Shoulda
       #
       # @return [ValidateLengthOfMatcher]
       #
-      # # ##### allow_blank
+      # ##### allow_blank
       #
       # Use `allow_blank` to assert that the attribute allows blank.
       #

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
 

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

@@ -116,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
@@ -163,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)
@@ -173,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
@@ -226,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
@@ -294,6 +324,10 @@ module Shoulda
               expectation << "_#{expected_suffix}".inspect
             end
 
+            if exclude_scopes?
+              expectation << ' with no scopes'
+            end
+
             expectation
           else
             simple_description
@@ -387,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].
@@ -427,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
@@ -447,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

@@ -19,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_gte_7?
+          Gem::Requirement.new('>= 7').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,

data/lib/shoulda/matchers/version.rb

@@ -1,6 +1,6 @@
 module Shoulda
   module Matchers
     # @private
-    VERSION = '5.0.0'.freeze
+    VERSION = '5.2.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',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shoulda-matchers
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Tammer Saleh
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-10 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,7 @@ files:
 - lib/shoulda/matchers/active_model/numericality_matchers/odd_number_matcher.rb
 - lib/shoulda/matchers/active_model/numericality_matchers/only_integer_matcher.rb
 - lib/shoulda/matchers/active_model/qualifiers.rb
+- lib/shoulda/matchers/active_model/qualifiers/allow_blank.rb
 - lib/shoulda/matchers/active_model/qualifiers/allow_nil.rb
 - lib/shoulda/matchers/active_model/qualifiers/ignore_interference_by_writer.rb
 - lib/shoulda/matchers/active_model/qualifiers/ignoring_interference_by_writer.rb
@@ -173,7 +174,7 @@ licenses:
 - MIT
 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
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Simple one-liner tests for common Rails functionality