shoulda-matchers 3.1.0 → 5.2.0

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

@@ -17,7 +17,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it do
       #         should validate_length_of(:password).
       #           is_at_least(10).
@@ -47,7 +47,7 @@ module Shoulda
       #
       #     # RSpec
       #
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it { should validate_length_of(:bio).is_at_least(15) }
       #     end
       #
@@ -71,7 +71,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it { should validate_length_of(:status_update).is_at_most(140) }
       #     end
       #
@@ -94,7 +94,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it { should validate_length_of(:favorite_superhero).is_equal_to(6) }
       #     end
       #
@@ -116,7 +116,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it do
       #         should validate_length_of(:password).
       #           is_at_least(5).is_at_most(30)
@@ -143,7 +143,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it do
       #         should validate_length_of(:password).
       #           is_at_least(10).
@@ -172,7 +172,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it do
       #         should validate_length_of(:secret_key).
       #           is_at_least(15).
@@ -201,7 +201,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe User do
+      #     RSpec.describe User, type: :model do
       #       it do
       #         should validate_length_of(:secret_key).
       #           is_at_most(100).
@@ -216,8 +216,50 @@ module Shoulda
       #         with_long_message('Secret key must be less than 100 characters')
       #     end
       #
+      # ##### allow_nil
+      #
+      # Use `allow_nil` to assert that the attribute allows nil.
+      #
+      #     class User
+      #       include ActiveModel::Model
+      #       attr_accessor :bio
+      #
+      #       validates_length_of :bio, minimum: 15, allow_nil: true
+      #     end
+      #
+      #     # RSpec
+      #     describe User do
+      #       it { should validate_length_of(:bio).is_at_least(15).allow_nil }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class UserTest < ActiveSupport::TestCase
+      #       should validate_length_of(:bio).is_at_least(15).allow_nil
+      #     end
+      #
       # @return [ValidateLengthOfMatcher]
       #
+      # ##### allow_blank
+      #
+      # Use `allow_blank` to assert that the attribute allows blank.
+      #
+      #     class User
+      #       include ActiveModel::Model
+      #       attr_accessor :bio
+      #
+      #       validates_length_of :bio, minimum: 15, allow_blank: true
+      #     end
+      #
+      #     # RSpec
+      #     describe User do
+      #       it { should validate_length_of(:bio).is_at_least(15).allow_blank }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class UserTest < ActiveSupport::TestCase
+      #       should validate_length_of(:bio).is_at_least(15).allow_blank
+      #     end
+      #
       def validate_length_of(attr)
         ValidateLengthOfMatcher.new(attr)
       end
@@ -281,6 +323,11 @@ module Shoulda
           self
         end
 
+        def allow_nil
+          @options[:allow_nil] = true
+          self
+        end
+
         def simple_description
           description = "validate that the length of :#{@attribute}"
 
@@ -302,69 +349,105 @@ module Shoulda
 
         def matches?(subject)
           super(subject)
-          translate_messages!
-          lower_bound_matches? && upper_bound_matches?
+
+          lower_bound_matches? &&
+            upper_bound_matches? &&
+            allow_nil_matches? &&
+            allow_blank_matches?
         end
 
-        private
+        def does_not_match?(subject)
+          super(subject)
 
-        def translate_messages!
-          if Symbol === @short_message
-            @short_message = default_error_message(@short_message,
-                                                   model_name: @subject.class.to_s.underscore,
-                                                   instance: @subject,
-                                                   attribute: @attribute,
-                                                   count: @options[:minimum])
-          end
+          lower_bound_does_not_match? ||
+            upper_bound_does_not_match? ||
+            allow_nil_does_not_match? ||
+            allow_blank_does_not_match?
+        end
 
-          if Symbol === @long_message
-            @long_message = default_error_message(@long_message,
-                                                  model_name: @subject.class.to_s.underscore,
-                                                  instance: @subject,
-                                                  attribute: @attribute,
-                                                  count: @options[:maximum])
-          end
+        private
+
+        def expects_to_allow_nil?
+          @options[:allow_nil]
         end
 
         def lower_bound_matches?
           disallows_lower_length? && allows_minimum_length?
         end
 
+        def lower_bound_does_not_match?
+          allows_lower_length? || disallows_minimum_length?
+        end
+
         def upper_bound_matches?
           disallows_higher_length? && allows_maximum_length?
         end
 
+        def upper_bound_does_not_match?
+          allows_higher_length? || disallows_maximum_length?
+        end
+
+        def allows_lower_length?
+          @options.key?(:minimum) &&
+            @options[:minimum] > 0 &&
+            allows_length_of?(
+              @options[:minimum] - 1,
+              translated_short_message,
+            )
+        end
+
         def disallows_lower_length?
-          if @options.key?(:minimum)
+          !@options.key?(:minimum) ||
             @options[:minimum] == 0 ||
-              disallows_length_of?(@options[:minimum] - 1, @short_message)
-          else
-            true
-          end
+            (@options[:minimum] == 1 && expects_to_allow_blank?) ||
+            disallows_length_of?(
+              @options[:minimum] - 1,
+              translated_short_message,
+            )
+        end
+
+        def allows_higher_length?
+          @options.key?(:maximum) &&
+            allows_length_of?(
+              @options[:maximum] + 1,
+              translated_long_message,
+            )
         end
 
         def disallows_higher_length?
-          if @options.key?(:maximum)
-            disallows_length_of?(@options[:maximum] + 1, @long_message)
-          else
-            true
-          end
+          !@options.key?(:maximum) ||
+            disallows_length_of?(
+              @options[:maximum] + 1,
+              translated_long_message,
+            )
         end
 
         def allows_minimum_length?
-          if @options.key?(:minimum)
-            allows_length_of?(@options[:minimum], @short_message)
-          else
-            true
-          end
+          !@options.key?(:minimum) ||
+            allows_length_of?(@options[:minimum], translated_short_message)
+        end
+
+        def disallows_minimum_length?
+          @options.key?(:minimum) &&
+            disallows_length_of?(@options[:minimum], translated_short_message)
         end
 
         def allows_maximum_length?
-          if @options.key?(:maximum)
-            allows_length_of?(@options[:maximum], @long_message)
-          else
-            true
-          end
+          !@options.key?(:maximum) ||
+            allows_length_of?(@options[:maximum], translated_long_message)
+        end
+
+        def disallows_maximum_length?
+          @options.key?(:maximum) &&
+            disallows_length_of?(@options[:maximum], translated_long_message)
+        end
+
+        def allow_nil_matches?
+          !expects_to_allow_nil? || allows_value_of(nil)
+        end
+
+        def allow_nil_does_not_match?
+          expects_to_allow_nil? && disallows_value_of(nil)
         end
 
         def allows_length_of?(length, message)
@@ -378,6 +461,36 @@ module Shoulda
         def string_of_length(length)
           'x' * length
         end
+
+        def translated_short_message
+          @_translated_short_message ||=
+            if @short_message.is_a?(Symbol)
+              default_error_message(
+                @short_message,
+                model_name: @subject.class.to_s.underscore,
+                instance: @subject,
+                attribute: @attribute,
+                count: @options[:minimum],
+              )
+            else
+              @short_message
+            end
+        end
+
+        def translated_long_message
+          @_translated_long_message ||=
+            if @long_message.is_a?(Symbol)
+              default_error_message(
+                @long_message,
+                model_name: @subject.class.to_s.underscore,
+                instance: @subject,
+                attribute: @attribute,
+                count: @options[:maximum],
+              )
+            else
+              @long_message
+            end
+        end
       end
     end
   end