shoulda-matchers 3.1.0 → 5.2.0

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

@@ -12,7 +12,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it { should validate_numericality_of(:gpa) }
       #     end
       #
@@ -35,7 +35,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it do
       #         should validate_numericality_of(:number_of_dependents).
       #           on(:create)
@@ -61,7 +61,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it { should validate_numericality_of(:age).only_integer }
       #     end
       #
@@ -85,7 +85,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it do
       #         should validate_numericality_of(:number_of_cars).
       #           is_less_than(2)
@@ -113,7 +113,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it do
       #         should validate_numericality_of(:birth_year).
       #           is_less_than_or_equal_to(1987)
@@ -140,7 +140,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it { should validate_numericality_of(:weight).is_equal_to(150) }
       #     end
       #
@@ -164,7 +164,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it do
       #         should validate_numericality_of(:height).
       #           is_greater_than_or_equal_to(55)
@@ -191,7 +191,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it do
       #         should validate_numericality_of(:legal_age).
       #           is_greater_than(21)
@@ -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
@@ -217,7 +244,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it { should validate_numericality_of(:birth_month).even }
       #     end
       #
@@ -240,7 +267,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it { should validate_numericality_of(:birth_day).odd }
       #     end
       #
@@ -262,7 +289,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it do
       #         should validate_numericality_of(:number_of_dependents).
       #           with_message('Number of dependents must be a number')
@@ -287,7 +314,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Post do
+      #     RSpec.describe Post, type: :model do
       #       it { should validate_numericality_of(:age).allow_nil }
       #     end
       #
@@ -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
@@ -411,13 +442,13 @@ module Shoulda
         end
 
         def matches?(subject)
-          @subject = subject
-          @number_of_submatchers = @submatchers.size
-
-          add_disallow_value_matcher
-          qualify_submatchers
+          matches_or_does_not_match?(subject)
+          first_submatcher_that_fails_to_match.nil?
+        end
 
-          first_failing_submatcher.nil?
+        def does_not_match?(subject)
+          matches_or_does_not_match?(subject)
+          first_submatcher_that_fails_to_not_match.nil?
         end
 
         def simple_description
@@ -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
@@ -440,20 +471,15 @@ module Shoulda
         def failure_message
           overall_failure_message.dup.tap do |message|
             message << "\n"
-            message << failure_message_for_first_failing_submatcher
+            message << failure_message_for_first_submatcher_that_fails_to_match
           end
         end
 
         def failure_message_when_negated
           overall_failure_message_when_negated.dup.tap do |message|
-            if submatcher_failure_message_when_negated.present?
-              raise "hmm, this needs to be implemented."
-              message << "\n"
-              message << Shoulda::Matchers.word_wrap(
-                submatcher_failure_message_when_negated,
-                indent: 2
-              )
-            end
+            message << "\n"
+            message <<
+              failure_message_for_first_submatcher_that_fails_to_not_match
           end
         end
 
@@ -464,19 +490,25 @@ module Shoulda
 
         private
 
-        def model
-          @subject.class
+        def matches_or_does_not_match?(subject)
+          @subject = subject
+          @number_of_submatchers = @submatchers.size
+
+          add_disallow_value_matcher
+          qualify_submatchers
         end
 
         def overall_failure_message
           Shoulda::Matchers.word_wrap(
-            "#{model.name} did not properly #{description}."
+            "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 it did."
+            "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
@@ -562,39 +597,56 @@ module Shoulda
 
         def has_been_qualified?
           @submatchers.any? do |submatcher|
-            submatcher.class.parent == NumericalityMatchers
+            Shoulda::Matchers::RailsShim.parent_of(submatcher.class) ==
+              NumericalityMatchers
           end
         end
 
-        def first_failing_submatcher
-          @_failing_submatchers ||= @submatchers.detect do |submatcher|
-            !submatcher.matches?(@subject)
-          end
+        def first_submatcher_that_fails_to_match
+          @_first_submatcher_that_fails_to_match ||=
+            @submatchers.detect do |submatcher|
+              !submatcher.matches?(@subject)
+            end
         end
 
-        def submatcher_failure_message
-          first_failing_submatcher.failure_message
+        def first_submatcher_that_fails_to_not_match
+          @_first_submatcher_that_fails_to_not_match ||=
+            @submatchers.detect do |submatcher|
+              !submatcher.does_not_match?(@subject)
+            end
         end
 
-        def submatcher_failure_message_when_negated
-          first_failing_submatcher.failure_message_when_negated
+        def failure_message_for_first_submatcher_that_fails_to_match
+          build_submatcher_failure_message_for(
+            first_submatcher_that_fails_to_match,
+            :failure_message,
+          )
         end
 
-        def failure_message_for_first_failing_submatcher
-          submatcher = first_failing_submatcher
+        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,
+          )
+        end
 
-          if number_of_submatchers_for_failure_message > 1
-            submatcher_description = submatcher.simple_description.
-              sub(/\bvalidate that\b/, 'validates').
-              sub(/\bdisallow\b/, 'disallows').
-              sub(/\ballow\b/, 'allows')
-            submatcher_message =
+        def build_submatcher_failure_message_for(
+          submatcher,
+          failure_message_method
+        )
+          failure_message = submatcher.public_send(failure_message_method)
+          submatcher_description = submatcher.simple_description.
+            sub(/\bvalidate that\b/, 'validates').
+            sub(/\bdisallow\b/, 'disallows').
+            sub(/\ballow\b/, 'allows')
+          submatcher_message =
+            if number_of_submatchers_for_failure_message > 1
               "In checking that #{model.name} #{submatcher_description}, " +
-              submatcher.failure_message[0].downcase +
-              submatcher.failure_message[1..-1]
-          else
-            submatcher_message = submatcher.failure_message
-          end
+                failure_message[0].downcase +
+                failure_message[1..]
+            else
+              failure_message
+            end
 
           Shoulda::Matchers.word_wrap(submatcher_message, indent: 2)
         end
@@ -605,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
@@ -616,6 +672,14 @@ module Shoulda
             arr
           end
         end
+
+        def model
+          @subject.class
+        end
+
+        def non_numeric_value
+          'abcd'
+        end
       end
     end
   end