shoulda-matchers 5.1.0 → 6.4.0

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,8 +163,119 @@ module Shoulda
       #         with_suffix
       #     end
       #
-      # @return [DefineEnumForMatcher]
+      # ##### 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
+      #
+      # ##### with_default
+      #
+      # Use `with_default` to test that the enum is defined with a
+      # default value. A proc can also be passed, and will be called once each
+      # time a new value is needed. (If using Time or Date, it's recommended to
+      # freeze time or date to avoid flaky tests):
+      #
+      #     class Issue < ActiveRecord::Base
+      #       enum status: [:open, :closed], default: :closed
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Issue, type: :model do
+      #       it do
+      #         should define_enum_for(:status).
+      #           with_default(:closed)
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class ProcessTest < ActiveSupport::TestCase
+      #       should define_enum_for(:status).
+      #         with_default(:closed)
+      #     end
+      #
+      # ##### validating
+      #
+      # Use `validating` to test that the enum is being validated.
+      # Can take a boolean value and an allowing_nil keyword argument:
+      #
+      #     class Issue < ActiveRecord::Base
+      #       enum status: [:open, :closed], validate: true
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Issue, type: :model do
+      #       it do
+      #         should define_enum_for(:status).
+      #           validating
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class ProcessTest < ActiveSupport::TestCase
+      #       should define_enum_for(:status).
+      #         validating
+      #     end
+      #
+      #     class Issue < ActiveRecord::Base
+      #       enum status: [:open, :closed], validate: { allow_nil: true }
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Issue, type: :model do
+      #       it do
+      #         should define_enum_for(:status).
+      #           validating(allowing_nil: true)
+      #       end
+      #     end
       #
+      #     # Minitest (Shoulda)
+      #     class ProcessTest < ActiveSupport::TestCase
+      #       should define_enum_for(:status).
+      #         validating(allowing_nil: true)
+      #     end
+      #
+      # ##### without_instance_methods
+      #
+      # Use `without_instance_methods` to exclude the check for instance methods.
+      #
+      #     class Issue < ActiveRecord::Base
+      #       enum status: [:open, :closed], instance_methods: false
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Issue, type: :model do
+      #       it do
+      #         should define_enum_for(:status).
+      #           without_instance_methods
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class ProcessTest < ActiveSupport::TestCase
+      #       should define_enum_for(:status).
+      #         without_instance_methods
+      #     end
+      #
+      # @return [DefineEnumForMatcher]
       def define_enum_for(attribute_name)
         DefineEnumForMatcher.new(attribute_name)
       end
@@ -173,7 +284,7 @@ module Shoulda
       class DefineEnumForMatcher
         def initialize(attribute_name)
           @attribute_name = attribute_name
-          @options = { expected_enum_values: [] }
+          @options = { expected_enum_values: [], scopes: true, instance_methods: true }
         end
 
         def description
@@ -198,17 +309,15 @@ module Shoulda
           description
         end
 
-        def with_values(expected_enum_values)
-          options[:expected_enum_values] = expected_enum_values
+        def validating(value = true, allowing_nil: false)
+          options[:validating] = value
+          options[:allowing_nil] = allowing_nil
           self
         end
 
-        def with(expected_enum_values)
-          Shoulda::Matchers.warn_about_deprecated_method(
-            'The `with` qualifier on `define_enum_for`',
-            '`with_values`',
-          )
-          with_values(expected_enum_values)
+        def with_values(expected_enum_values)
+          options[:expected_enum_values] = expected_enum_values
+          self
         end
 
         def with_prefix(expected_prefix = true)
@@ -226,13 +335,31 @@ module Shoulda
           self
         end
 
+        def without_scopes
+          options[:scopes] = false
+          self
+        end
+
+        def without_instance_methods
+          options[:instance_methods] = false
+          self
+        end
+
+        def with_default(default_value)
+          options[:default] = default_value
+          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? &&
+            default_value_matches? &&
+            validating_matches?
         end
 
         def failure_message
@@ -255,6 +382,30 @@ module Shoulda
 
         private
 
+        def validating_matches?
+          return true if options[:validating].nil?
+
+          validator = find_enum_validator
+
+          if expected_validating? == !!validator
+            if validator&.options&.dig(:allow_nil).present? == expected_allowing_nil?
+              true
+            else
+              @failure_message_continuation =
+                "However, #{attribute_name.inspect} is allowing nil values"
+              false
+            end
+          else
+            @failure_message_continuation =
+              if expected_validating?
+                "However, #{attribute_name.inspect} is not being validated"
+              else
+                "However, #{attribute_name.inspect} is being validated"
+              end
+            false
+          end
+        end
+
         attr_reader :attribute_name, :options, :record,
           :failure_message_continuation
 
@@ -270,6 +421,21 @@ module Shoulda
               )
             end
 
+            if options[:default].present?
+              expectation << ', with a default value of '
+              expectation << Shoulda::Matchers::Util.inspect_value(expected_default_value)
+            end
+
+            if expected_validating?
+              expectation << ', and being validated '
+              expectation <<
+                if expected_allowing_nil?
+                  'allowing nil values'
+                else
+                  'not allowing nil values'
+                end
+            end
+
             if expected_prefix
               expectation <<
                 if expected_suffix
@@ -294,6 +460,10 @@ module Shoulda
               expectation << "_#{expected_suffix}".inspect
             end
 
+            if exclude_scopes?
+              expectation << ' with no scopes'
+            end
+
             expectation
           else
             simple_description
@@ -387,37 +557,139 @@ module Shoulda
         end
 
         def enum_value_methods_exist?
-          passed = expected_singleton_methods.all? do |method|
-            model.singleton_methods.include?(method)
+          if options[:instance_methods]
+            return true if instance_methods_exist?
+
+            message = missing_methods_message
+            message << " (we can't tell which)" if [expected_prefix, expected_suffix].any?
+
+            @failure_message_continuation = message
+
+            false
+          elsif instance_methods_exist?
+            message = "#{attribute_name.inspect} does map to these values"
+            message << ' with instance methods, but expected no instance methods'
+
+            @failure_message_continuation = message
+
+            false
+          else
+            true
           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'
+          elsif expected_instance_methods?
+            message << 'configured with no instance methods'
+          else
+            ''
+          end
+        end
+
+        def default_value_matches?
+          return true if options[:default].blank?
+
+          if actual_default_value.nil?
+            @failure_message_continuation = 'However, no default value was set'
+            return false
+          end
+
+          if actual_default_value == expected_default_value
+            true
+          else
+            String.new.tap do |message|
+              message << 'However, the default value is '
+              message << Shoulda::Matchers::Util.inspect_value(actual_default_value)
+              @failure_message_continuation = message
+            end
+            false
+          end
+        end
+
+        def expected_default_value
+          options[:default].respond_to?(:call) ? options[:default].call : options[:default]
+        end
+
+        def actual_default_value
+          attribute_schema = if model.respond_to?(:_default_attributes)
+                               model._default_attributes[attribute_name.to_s]
+                             else
+                               model.attributes_to_define_after_schema_loads[attribute_name.to_s]
+                             end
+
+          if Kernel.const_defined?('ActiveModel::Attribute::UserProvidedDefault') &&
+             attribute_schema.is_a?(::ActiveModel::Attribute::UserProvidedDefault)
+            attribute_schema = attribute_schema.marshal_dump
+          end
+
+          value = case attribute_schema
+                  in [_, { default: default_value } ]
+                    default_value
+                  in [_, default_value, *]
+                    default_value
+                  in [_, default_value]
+                    default_value
+                  end
+
+          value.respond_to?(:call) ? value.call : value
+        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 +699,22 @@ 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_instance_methods?
+          options[:instance_methods]
+        end
+
         def expected_prefix
           if options.include?(:prefix)
             if options[:prefix] == true
@@ -447,6 +735,26 @@ module Shoulda
           end
         end
 
+        def expected_validating?
+          options[:validating].present?
+        end
+
+        def expected_allowing_nil?
+          options[:allowing_nil].present?
+        end
+
+        def find_enum_validator
+          record.class.validators.detect do |validator|
+            validator.kind == :inclusion &&
+              validator.attributes.include?(attribute_name.to_s) &&
+              validator.options[:in] == expected_enum_value_names
+          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/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