shoulda-matchers 3.1.0 → 5.2.0

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

@@ -1,4 +1,5 @@
 require 'bigdecimal'
+require 'date'
 
 module Shoulda
   module Matchers
@@ -18,7 +19,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Issue do
+      #     RSpec.describe Issue, type: :model do
       #       it do
       #         should validate_inclusion_of(:state).
       #           in_array(['open', 'resolved', 'unresolved'])
@@ -41,7 +42,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Issue do
+      #     RSpec.describe Issue, type: :model do
       #       it { should validate_inclusion_of(:state).in_range(1..5) }
       #     end
       #
@@ -83,7 +84,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Issue do
+      #     RSpec.describe Issue, type: :model do
       #       it do
       #         should validate_inclusion_of(:severity).
       #           in_array(%w(low medium high)).
@@ -112,7 +113,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Issue do
+      #     RSpec.describe Issue, type: :model do
       #       it do
       #         should validate_inclusion_of(:severity).
       #           in_array(%w(low medium high)).
@@ -148,7 +149,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it do
       #         should validate_inclusion_of(:age).
       #           in_range(0..65).
@@ -184,7 +185,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Person do
+      #     RSpec.describe Person, type: :model do
       #       it do
       #         should validate_inclusion_of(:age).
       #           in_range(0..21).
@@ -214,7 +215,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Issue do
+      #     RSpec.describe Issue, type: :model do
       #       it do
       #         should validate_inclusion_of(:state).
       #           in_array(['open', 'resolved', 'unresolved']).
@@ -244,7 +245,7 @@ module Shoulda
       #     end
       #
       #     # RSpec
-      #     describe Issue do
+      #     RSpec.describe Issue, type: :model do
       #       it do
       #         should validate_inclusion_of(:state).
       #           in_array(['open', 'resolved', 'unresolved']).
@@ -267,19 +268,20 @@ module Shoulda
 
       # @private
       class ValidateInclusionOfMatcher < ValidationMatcher
-        ARBITRARY_OUTSIDE_STRING = 'shoulda-matchers test string'
-        ARBITRARY_OUTSIDE_FIXNUM = 123456789
-        ARBITRARY_OUTSIDE_DECIMAL = BigDecimal.new('0.123456789')
+        BLANK_VALUES = ['', ' ', "\n", "\r", "\t", "\f"].freeze
+        ARBITRARY_OUTSIDE_STRING = 'shoulda-matchers test string'.freeze
+        ARBITRARY_OUTSIDE_INTEGER = 123456789
+        ARBITRARY_OUTSIDE_DECIMAL = BigDecimal('0.123456789')
         ARBITRARY_OUTSIDE_DATE = Date.jd(9999999)
         ARBITRARY_OUTSIDE_DATETIME = DateTime.jd(9999999)
         ARBITRARY_OUTSIDE_TIME = Time.at(9999999999)
-        BOOLEAN_ALLOWS_BOOLEAN_MESSAGE = <<EOT
+        BOOLEAN_ALLOWS_BOOLEAN_MESSAGE = <<EOT.freeze
 You are using `validate_inclusion_of` to assert that a boolean column allows
 boolean values and disallows non-boolean ones. Be aware that it is not possible
 to fully test this, as boolean columns will automatically convert non-boolean
 values to boolean ones. Hence, you should consider removing this test.
 EOT
-        BOOLEAN_ALLOWS_NIL_MESSAGE = <<EOT
+        BOOLEAN_ALLOWS_NIL_MESSAGE = <<EOT.freeze
 You are using `validate_inclusion_of` to assert that a boolean column allows nil.
 Be aware that it is not possible to fully test this, as anything other than
 true, false or nil will be converted to false. Hence, you should consider
@@ -293,8 +295,8 @@ EOT
           @range = nil
           @minimum = nil
           @maximum = nil
-          @low_message = nil
-          @high_message = nil
+          @low_message = :inclusion
+          @high_message = :inclusion
         end
 
         def in_array(array)
@@ -309,17 +311,8 @@ EOT
           self
         end
 
-        def allow_blank(allow_blank = true)
-          @options[:allow_blank] = allow_blank
-          self
-        end
-
-        def expects_to_allow_blank?
-          @options[:allow_blank]
-        end
-
-        def allow_nil(allow_nil = true)
-          @options[:allow_nil] = allow_nil
+        def allow_nil
+          @options[:allow_nil] = true
           self
         end
 
@@ -361,11 +354,12 @@ EOT
           else
             description = "validate that :#{@attribute}"
 
-            if @array.many?
-              description << " is either #{inspected_array}"
-            else
-              description << " is #{inspected_array}"
-            end
+            description <<
+              if @array.count > 1
+                " is either #{inspected_array}"
+              else
+                " is #{inspected_array}"
+              end
 
             description
           end
@@ -375,8 +369,6 @@ EOT
           super(subject)
 
           if @range
-            @low_message  ||= :inclusion
-            @high_message ||= :inclusion
             matches_for_range?
           elsif @array
             if matches_for_array?
@@ -388,47 +380,55 @@ EOT
           end
         end
 
+        def does_not_match?(subject)
+          super(subject)
+
+          if @range
+            does_not_match_for_range?
+          elsif @array
+            if does_not_match_for_array?
+              true
+            else
+              @failure_message = "#{@array} matches array in validation"
+              false
+            end
+          end
+        end
+
         private
 
         def matches_for_range?
           disallows_lower_value &&
             allows_minimum_value &&
-            disallows_higher_value &&
-            allows_maximum_value
+            allows_maximum_value &&
+            disallows_higher_value
+        end
+
+        def does_not_match_for_range?
+          allows_lower_value ||
+            disallows_minimum_value ||
+            disallows_maximum_value ||
+            allows_higher_value
         end
 
         def matches_for_array?
           allows_all_values_in_array? &&
-            allows_blank_value? &&
+            disallows_all_values_outside_of_array? &&
             allows_nil_value? &&
-            disallows_value_outside_of_array?
+            allow_blank_matches?
         end
 
-        def allows_blank_value?
-          if @options.key?(:allow_blank)
-            blank_values = ['', ' ', "\n", "\r", "\t", "\f"]
-            @options[:allow_blank] == blank_values.all? { |value| allows_value_of(value) }
-          else
-            true
-          end
+        def does_not_match_for_array?
+          disallows_any_values_in_array? ||
+            allows_any_value_outside_of_array? ||
+            disallows_nil_value? ||
+            allow_blank_does_not_match?
         end
 
-        def allows_nil_value?
-          if @options.key?(:allow_nil)
-            @options[:allow_nil] == allows_value_of(nil)
-          else
-            true
-          end
-        end
-
-        def inspect_message
-          @range.nil? ? @array.inspect : @range.inspect
-        end
-
-        def allows_all_values_in_array?
-          @array.all? do |value|
-            allows_value_of(value, @low_message)
-          end
+        def allows_lower_value
+          @minimum &&
+            @minimum != 0 &&
+            allows_value_of(@minimum - 1, @low_message)
         end
 
         def disallows_lower_value
@@ -437,19 +437,43 @@ EOT
             disallows_value_of(@minimum - 1, @low_message)
         end
 
-        def disallows_higher_value
-          disallows_value_of(@maximum + 1, @high_message)
-        end
-
         def allows_minimum_value
           allows_value_of(@minimum, @low_message)
         end
 
+        def disallows_minimum_value
+          disallows_value_of(@minimum, @low_message)
+        end
+
         def allows_maximum_value
           allows_value_of(@maximum, @high_message)
         end
 
-        def disallows_value_outside_of_array?
+        def disallows_maximum_value
+          disallows_value_of(@maximum, @high_message)
+        end
+
+        def allows_higher_value
+          allows_value_of(@maximum + 1, @high_message)
+        end
+
+        def disallows_higher_value
+          disallows_value_of(@maximum + 1, @high_message)
+        end
+
+        def allows_all_values_in_array?
+          @array.all? do |value|
+            allows_value_of(value, @low_message)
+          end
+        end
+
+        def disallows_any_values_in_array?
+          @array.any? do |value|
+            disallows_value_of(value, @low_message)
+          end
+        end
+
+        def allows_any_value_outside_of_array?
           if attribute_type == :boolean
             case @array
             when [false, true], [true, false]
@@ -465,11 +489,32 @@ EOT
             end
           end
 
-          !values_outside_of_array.any? do |value|
+          values_outside_of_array.any? do |value|
             allows_value_of(value, @low_message)
           end
         end
 
+        def disallows_all_values_outside_of_array?
+          if attribute_type == :boolean
+            case @array
+            when [false, true], [true, false]
+              Shoulda::Matchers.warn BOOLEAN_ALLOWS_BOOLEAN_MESSAGE
+              return true
+            when [nil]
+              if attribute_column.null
+                Shoulda::Matchers.warn BOOLEAN_ALLOWS_NIL_MESSAGE
+                return true
+              else
+                raise NonNullableBooleanError.create(@attribute)
+              end
+            end
+          end
+
+          values_outside_of_array.all? do |value|
+            disallows_value_of(value, @low_message)
+          end
+        end
+
         def values_outside_of_array
           if !(@array & outside_values).empty?
             raise CouldNotDetermineValueOutsideOfArray
@@ -482,8 +527,8 @@ EOT
           case attribute_type
           when :boolean
             boolean_outside_values
-          when :fixnum
-            [ARBITRARY_OUTSIDE_FIXNUM]
+          when :integer
+            [ARBITRARY_OUTSIDE_INTEGER]
           when :decimal
             [ARBITRARY_OUTSIDE_DECIMAL]
           when :date
@@ -501,10 +546,10 @@ EOT
           values = []
 
           values << case @array
-            when [true]  then false
-            when [false] then true
-            else              raise CouldNotDetermineValueOutsideOfArray
-          end
+                    when [true]  then false
+                    when [false] then true
+                    else              raise CouldNotDetermineValueOutsideOfArray
+                    end
 
           if attribute_allows_nil?
             values << nil
@@ -537,28 +582,36 @@ EOT
 
         def column_type_to_attribute_type(type)
           case type
-            when :integer, :float then :fixnum
-            when :timestamp then :datetime
-            else type
+          when :float then :integer
+          when :timestamp then :datetime
+          else type
           end
         end
 
         def value_to_attribute_type(value)
           case value
-            when true, false then :boolean
-            when BigDecimal then :decimal
-            when Fixnum then :fixnum
-            when Date then :date
-            when DateTime then :datetime
-            when Time then :time
-            else :unknown
+          when true, false then :boolean
+          when BigDecimal then :decimal
+          when Integer then :integer
+          when Date then :date
+          when DateTime then :datetime
+          when Time then :time
+          else :unknown
           end
         end
 
+        def allows_nil_value?
+          @options[:allow_nil] != true || allows_value_of(nil)
+        end
+
+        def disallows_nil_value?
+          @options[:allow_nil] && disallows_value_of(nil)
+        end
+
         def inspected_array
           Shoulda::Matchers::Util.inspect_values(@array).to_sentence(
-            two_words_connector: " or ",
-            last_word_connector: ", or "
+            two_words_connector: ' or ',
+            last_word_connector: ', or ',
           )
         end
       end