shoulda-matchers 4.3.0 → 5.0.0.rc1

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

@@ -232,13 +232,34 @@ module Shoulda
       #       it { should validate_length_of(:bio).is_at_least(15).allow_nil }
       #     end
       #
-      #     # Test::Unit
+      #     # 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
@@ -331,7 +352,8 @@ module Shoulda
 
           lower_bound_matches? &&
             upper_bound_matches? &&
-            allow_nil_matches?
+            allow_nil_matches? &&
+            allow_blank_matches?
         end
 
         def does_not_match?(subject)
@@ -339,7 +361,8 @@ module Shoulda
 
           lower_bound_does_not_match? ||
             upper_bound_does_not_match? ||
-            allow_nil_does_not_match?
+            allow_nil_does_not_match? ||
+            allow_blank_does_not_match?
         end
 
         private
@@ -369,16 +392,17 @@ module Shoulda
             @options[:minimum] > 0 &&
             allows_length_of?(
               @options[:minimum] - 1,
-              translated_short_message
+              translated_short_message,
             )
         end
 
         def disallows_lower_length?
           !@options.key?(:minimum) ||
             @options[:minimum] == 0 ||
+            (@options[:minimum] == 1 && expects_to_allow_blank?) ||
             disallows_length_of?(
               @options[:minimum] - 1,
-              translated_short_message
+              translated_short_message,
             )
         end
 
@@ -386,7 +410,7 @@ module Shoulda
           @options.key?(:maximum) &&
             allows_length_of?(
               @options[:maximum] + 1,
-              translated_long_message
+              translated_long_message,
             )
         end
 
@@ -394,7 +418,7 @@ module Shoulda
           !@options.key?(:maximum) ||
             disallows_length_of?(
               @options[:maximum] + 1,
-              translated_long_message
+              translated_long_message,
             )
         end
 
@@ -446,7 +470,7 @@ module Shoulda
                 model_name: @subject.class.to_s.underscore,
                 instance: @subject,
                 attribute: @attribute,
-                count: @options[:minimum]
+                count: @options[:minimum],
               )
             else
               @short_message
@@ -461,7 +485,7 @@ module Shoulda
                 model_name: @subject.class.to_s.underscore,
                 instance: @subject,
                 attribute: @attribute,
-                count: @options[:maximum]
+                count: @options[:maximum],
               )
             else
               @long_message

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

@@ -204,6 +204,33 @@ module Shoulda
       #         is_greater_than(21)
       #     end
       #
+      # ##### is_other_than
+      #
+      # Use `is_other_than` to test usage of the `:other_than` option.
+      # This asserts that the attribute can take a number which is not equal to
+      # the given value.
+      #
+      #     class Person
+      #       include ActiveModel::Model
+      #       attr_accessor :legal_age
+      #
+      #       validates_numericality_of :legal_age, other_than: 21
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe Person, type: :model do
+      #       it do
+      #         should validate_numericality_of(:legal_age).
+      #           is_other_than(21)
+      #       end
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class PersonTest < ActiveSupport::TestCase
+      #       should validate_numericality_of(:legal_age).
+      #         is_other_than(21)
+      #     end
+      #
       # ##### even
       #
       # Use `even` to test usage of the `:even` option. This asserts that the
@@ -304,8 +331,7 @@ module Shoulda
 
       # @private
       class ValidateNumericalityOfMatcher
-        NUMERIC_NAME = 'number'
-        NON_NUMERIC_VALUE = 'abcd'
+        NUMERIC_NAME = 'number'.freeze
         DEFAULT_DIFF_TO_COMPARE = 1
 
         include Qualifiers::IgnoringInterferenceByWriter
@@ -337,7 +363,7 @@ module Shoulda
 
         def only_integer
           prepare_submatcher(
-            NumericalityMatchers::OnlyIntegerMatcher.new(self, @attribute)
+            NumericalityMatchers::OnlyIntegerMatcher.new(self, @attribute),
           )
           self
         end
@@ -345,9 +371,9 @@ module Shoulda
         def allow_nil
           @expects_to_allow_nil = true
           prepare_submatcher(
-            AllowValueMatcher.new(nil)
-              .for(@attribute)
-              .with_message(:not_a_number)
+            AllowValueMatcher.new(nil).
+              for(@attribute).
+              with_message(:not_a_number),
           )
           self
         end
@@ -358,14 +384,14 @@ module Shoulda
 
         def odd
           prepare_submatcher(
-            NumericalityMatchers::OddNumberMatcher.new(self, @attribute)
+            NumericalityMatchers::OddNumberMatcher.new(self, @attribute),
           )
           self
         end
 
         def even
           prepare_submatcher(
-            NumericalityMatchers::EvenNumberMatcher.new(self, @attribute)
+            NumericalityMatchers::EvenNumberMatcher.new(self, @attribute),
           )
           self
         end
@@ -395,6 +421,11 @@ module Shoulda
           self
         end
 
+        def is_other_than(value)
+          prepare_submatcher(comparison_matcher_for(value, :!=).for(@attribute))
+          self
+        end
+
         def with_message(message)
           @expects_custom_validation_message = true
           @expected_message = message
@@ -427,7 +458,7 @@ module Shoulda
           description << Shoulda::Matchers::Util.a_or_an(full_allowed_type)
 
           if comparison_descriptions.present?
-            description << ' ' + comparison_descriptions
+            description << " #{comparison_descriptions}"
           end
 
           description
@@ -447,7 +478,8 @@ module Shoulda
         def failure_message_when_negated
           overall_failure_message_when_negated.dup.tap do |message|
             message << "\n"
-            message << failure_message_for_first_submatcher_that_fails_to_not_match
+            message <<
+              failure_message_for_first_submatcher_that_fails_to_not_match
           end
         end
 
@@ -468,15 +500,15 @@ module Shoulda
 
         def overall_failure_message
           Shoulda::Matchers.word_wrap(
-            "Expected #{model.name} to #{description}, but this could not " +
-            'be proved.'
+            "Expected #{model.name} to #{description}, but this could not "\
+            'be proved.',
           )
         end
 
         def overall_failure_message_when_negated
           Shoulda::Matchers.word_wrap(
-            "Expected #{model.name} not to #{description}, but this could not " +
-            'be proved.'
+            "Expected #{model.name} not to #{description}, but this could not "\
+            'be proved.',
           )
         end
 
@@ -498,7 +530,7 @@ module Shoulda
 
         def add_disallow_value_matcher
           disallow_value_matcher = DisallowValueMatcher.
-            new(NON_NUMERIC_VALUE).
+            new(non_numeric_value).
             for(@attribute).
             with_message(:not_a_number)
 
@@ -526,7 +558,10 @@ module Shoulda
           end
 
           if submatcher.respond_to?(:diff_to_compare)
-            @diff_to_compare = [@diff_to_compare, submatcher.diff_to_compare].max
+            @diff_to_compare = [
+              @diff_to_compare,
+              submatcher.diff_to_compare,
+            ].max
           end
 
           @submatchers << submatcher
@@ -547,7 +582,7 @@ module Shoulda
             end
 
             submatcher.ignoring_interference_by_writer(
-              ignore_interference_by_writer
+              ignore_interference_by_writer,
             )
           end
         end
@@ -568,28 +603,30 @@ module Shoulda
         end
 
         def first_submatcher_that_fails_to_match
-          @_failing_submatchers ||= @submatchers.detect do |submatcher|
-            !submatcher.matches?(@subject)
-          end
+          @_first_submatcher_that_fails_to_match ||=
+            @submatchers.detect do |submatcher|
+              !submatcher.matches?(@subject)
+            end
         end
 
         def first_submatcher_that_fails_to_not_match
-          @_failing_submatchers ||= @submatchers.detect do |submatcher|
-            !submatcher.does_not_match?(@subject)
-          end
+          @_first_submatcher_that_fails_to_not_match ||=
+            @submatchers.detect do |submatcher|
+              !submatcher.does_not_match?(@subject)
+            end
         end
 
         def failure_message_for_first_submatcher_that_fails_to_match
           build_submatcher_failure_message_for(
             first_submatcher_that_fails_to_match,
-            :failure_message
+            :failure_message,
           )
         end
 
         def failure_message_for_first_submatcher_that_fails_to_not_match
           build_submatcher_failure_message_for(
             first_submatcher_that_fails_to_not_match,
-            :failure_message_when_negated
+            :failure_message_when_negated,
           )
         end
 
@@ -606,7 +643,7 @@ module Shoulda
             if number_of_submatchers_for_failure_message > 1
               "In checking that #{model.name} #{submatcher_description}, " +
                 failure_message[0].downcase +
-                failure_message[1..-1]
+                failure_message[1..]
             else
               failure_message
             end
@@ -620,7 +657,11 @@ module Shoulda
 
         def comparison_descriptions
           description_array = submatcher_comparison_descriptions
-          description_array.empty? ? '' : submatcher_comparison_descriptions.join(' and ')
+          if description_array.empty?
+            ''
+          else
+            submatcher_comparison_descriptions.join(' and ')
+          end
         end
 
         def submatcher_comparison_descriptions
@@ -635,6 +676,10 @@ module Shoulda
         def model
           @subject.class
         end
+
+        def non_numeric_value
+          'abcd'
+        end
       end
     end
   end

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

@@ -260,11 +260,11 @@ validation for you? Instead of using `validate_presence_of`, try
 
         def reason_for_existing_presence_validation
           if belongs_to_association_configured_to_be_required?
-            "you've instructed your `belongs_to` association to add a " +
+            "you've instructed your `belongs_to` association to add a "\
               'presence validation to the attribute'
           else
             # assume ::ActiveRecord::Base.belongs_to_required_by_default == true
-            'ActiveRecord is configured to add a presence validation to all ' +
+            'ActiveRecord is configured to add a presence validation to all '\
               '`belongs_to` associations, and this includes yours'
           end
         end
@@ -327,8 +327,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/validation_matcher.rb

@@ -24,6 +24,11 @@ module Shoulda
           self
         end
 
+        def allow_blank
+          options[:allow_blank] = true
+          self
+        end
+
         def strict
           @expects_strict = true
           self
@@ -62,7 +67,7 @@ module Shoulda
               message << "\n"
               message << Shoulda::Matchers.word_wrap(
                 failure_reason,
-                indent: 2
+                indent: 2,
               )
             end
           end
@@ -74,7 +79,7 @@ module Shoulda
               message << "\n"
               message << Shoulda::Matchers.word_wrap(
                 failure_reason,
-                indent: 2
+                indent: 2,
               )
             end
           end
@@ -116,19 +121,31 @@ module Shoulda
           )
         end
 
+        def allow_blank_matches?
+          !expects_to_allow_blank? ||
+            blank_values.all? { |value| allows_value_of(value) }
+        end
+
+        def allow_blank_does_not_match?
+          expects_to_allow_blank? &&
+            blank_values.all? { |value| disallows_value_of(value) }
+        end
+
         private
 
+        attr_reader :options
+
         def overall_failure_message
           Shoulda::Matchers.word_wrap(
-            "Expected #{model.name} to #{description}, but this could not be " +
-            'proved.'
+            "Expected #{model.name} to #{description}, but this could not be "\
+            'proved.',
           )
         end
 
         def overall_failure_message_when_negated
           Shoulda::Matchers.word_wrap(
-            "Expected #{model.name} not to #{description}, but this could " +
-            'not be proved.'
+            "Expected #{model.name} not to #{description}, but this could "\
+            'not be proved.',
           )
         end
 
@@ -161,6 +178,14 @@ module Shoulda
           @last_submatcher_run = matcher
           matcher.matches?(subject)
         end
+
+        def expects_to_allow_blank?
+          options[:allow_blank]
+        end
+
+        def blank_values
+          ['', ' ', "\n", "\r", "\t", "\f"]
+        end
       end
     end
   end

data/lib/shoulda/matchers/active_model/validation_matcher/build_description.rb

@@ -15,10 +15,8 @@ module Shoulda
 
           def call
             if description_clauses_for_qualifiers.any?
-              main_description +
-                clause_for_allow_blank_or_nil +
-                ', ' +
-                description_clauses_for_qualifiers.to_sentence
+              "#{main_description}#{clause_for_allow_blank_or_nil},"\
+              " #{description_clauses_for_qualifiers.to_sentence}"
             else
               main_description + clause_for_allow_blank_or_nil
             end