can_has_validations 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c82e1883d7ee1fa1dd3a098f4f9bfd716b63321cec4b2aa4ff873351144f9fc
-  data.tar.gz: b4ab341c9a388e8e3bdcd8f10fbaa4ca1c2b7ab5f6db345ae3f7d84b65fc26b5
+  metadata.gz: 35a018491f2cdaaf42b335b1d161573555a41b10f3a01b3789e51afbc8b75a0e
+  data.tar.gz: acfa4a74d6709f9184fe46d24eef3fa36771c0f1a540fdbd1d75682b49e67bf8
 SHA512:
-  metadata.gz: 23684cebc4fce328fa9d9333a48332f7070c354c7876b5f0ee878917e7fdd6b2ae1256b33b99e9ed086bc1a6a323c440c4746b93851e4734182d9783ff5e22a2
-  data.tar.gz: '0941308278c6c9ea1a7b9b0a4b157b28e83bbe061a52f3dee0ffc2c9961e54f742fa7698516c02f5c8909795fe9297ec4093f744b323bb57a17c920dabaf4035'
+  metadata.gz: ea6a073102cae7965b1f430c169db660f16fcbb826271016a991fef4888401fbb0da206dcd030c61bdf4aab04100d934eaa6efbb76fb12f276f25a1ae30c6a04
+  data.tar.gz: 328d8fe59d6e527cc5373a1193654a689c3ff418573b4114fe358475ab5ce1c2a8e64e00ac85bd04cc5a55bd090c276cad4f19711c0919baae6895627958c455

data/README.md

@@ -9,6 +9,8 @@ Validations provided:
 * Email
 * Existence
 * Grandparent
+* Hash Keys
+* Hash Values
 * Hostname
 * IP address
 * Ordering
@@ -135,6 +137,42 @@ or the database foreign key (`:user_id`). You can also use any other field. The
 test is merely that they match, not that they are associations.
 
 
+## Hash Keys validator ##
+
+Many databases now allow storing hashes. This validates the keys of those
+hashes. It is conceptually the same as using the Array validator to validate
+`hash_attribute.keys`.
+
+It is able to use most existing validators that themselves work on individual
+attribute values (including standard Rails validators, others that are part of
+this gem, and likely many from other gems too).
+
+By default it reports only one validation error per sub-validator, regardless
+of how many keys fail validation. Use `multiple_errors: true` to report all
+errors. See Array validator for more details.
+
+    validates :subjects,
+      hash_keys: {
+        format: /\A[a-z]+\z/,
+        # multiple_errors: true
+      }
+
+
+## Hash Values validator ##
+
+This is the companion to the Hash Keys validator and validates hash values
+instead. It is conceptually the same as using the Array validator to validate
+`hash_attribute.values`.
+
+See Hash Keys validator for more details.
+
+    validates :subjects,
+      hash_values: {
+        length: 3..100,
+        # multiple_errors: true
+      }
+
+
 ## Hostname validator ##
 
 Ensures an attribute is generally formatted as a hostname. It allows for any
@@ -217,7 +255,7 @@ Always skips over nil values; use `:presence` to validate those.
 
 Ensures an attribute is generally formatted as a URL. If `addressable/uri` is
 already loaded, it will be used to parse IDN's. Additionally, allowed schemes
-can be specified; they default to ['http','https'].
+can be specified; they default to `['http','https']`.
 
     validates :website, url: true
     validates :secure_url, url: {scheme: 'https'}

data/lib/can_has_validations/locale/es.yml

@@ -0,0 +1,12 @@
+es:
+  errors:
+    messages:
+      invalid_email: "es un correo electrónico no válido"
+      invalid_hostname: "es un nombre de sistema no válido"
+      invalid_ip: "es una IP no válida"
+      ip_not_allowed: "no es una IP permitida"
+      single_ip_required: "debe ser solo una IP"
+      invalid_url: "es una URL no válida"
+      unchangeable: "no se puede cambiar"
+      before: "debe ser antes de %{attribute2}"
+      after: "debe ser después de %{attribute2}"

data/lib/can_has_validations/validators/array_validator.rb

@@ -19,6 +19,18 @@
 #       multiple_errors: true,
 #       format: /\A[^aeiou]*\z/
 #     }
+#
+# the :if, :unless, and :on conditionals are not supported on sub-validators,
+# but do work as normal on the :array validator itself.
+#
+#   validates :permissions, if: :this_condition_works,
+#     array: {
+#       if: :this_condition_applies_to_permissions_but_not_each_element,
+#       inclusion: {
+#         in: %w(one two),
+#         unless: :conditions_on_subvalidators_are_ignored
+#       }
+#     }
 
 module ActiveModel
   module Validations
@@ -33,12 +45,17 @@ module ActiveModel
         defaults = @options.dup
         validations = defaults.slice!(*record_class.send(:_validates_default_keys), :attributes)
 
-        raise ArgumentError, "You need to supply at least one array validation" if validations.empty?
+        raise ArgumentError, "You need to supply at least one validation for :#{kind}" if validations.empty?
 
         defaults[:attributes] = attributes
 
         @validators = validations.map do |key, sub_options|
           next unless sub_options
+
+          if (cond_keys = _parse_validates_options(sub_options).keys & %i(if on unless)).any?
+            raise ArgumentError, ":#{kind} does not support conditionals on sub-validators - found on #{key}: #{cond_keys.map(&:inspect).join(', ')}"
+          end
+
           key = "#{key.to_s.camelize}Validator"
 
           begin
@@ -47,7 +64,7 @@ module ActiveModel
             raise ArgumentError, "Unknown validator: '#{key}'"
           end
 
-          klass.new(defaults.merge(_parse_validates_options(sub_options)))
+          klass.new(defaults.merge(_parse_validates_options(sub_options)).except(:if, :on, :unless))
         end
       end
 
@@ -56,7 +73,7 @@ module ActiveModel
           error_count = count_errors(record)
 
           Array(array_values).each do |value|
-            validator.validate_each(record, attribute, value)
+            validate_one(validator, record, attribute, value)
 
             # to avoid repeating error messages, stop after a single error
             unless validator.options[:multiple_errors]
@@ -66,6 +83,13 @@ module ActiveModel
         end
       end
 
+      def validate_one(validator, record, attribute, value)
+        unless validator.is_a?(ExistenceValidator)
+          return if (value.nil? && validator.options[:allow_nil]) || (value.blank? && validator.options[:allow_blank])
+        end
+        validator.validate_each(record, attribute, value)
+      end
+
 
       private
 
@@ -73,6 +97,7 @@ module ActiveModel
         record.errors.count
       end
 
+      # copied from active_model/validations/validates.rb
       def _parse_validates_options(options)
         case options
         when TrueClass

data/lib/can_has_validations/validators/email_validator.rb

@@ -13,7 +13,7 @@ module ActiveModel::Validations
 
     def validate_each(record, attribute, value)
       unless email_valid?(value)
-        record.errors.add(attribute, :invalid_email, options.merge(value: value))
+        record.errors.add(attribute, :invalid_email, **options.merge(value: value))
       end
     end
 

data/lib/can_has_validations/validators/grandparent_validator.rb

@@ -21,7 +21,7 @@ module ActiveModel::Validations
         end
       end
       unless all_match
-        record.errors.add(attribute, :invalid, options.except(:allow_nil, :parent, :scope))
+        record.errors.add(attribute, :invalid, **options.except(:allow_nil, :parent, :scope))
       end
     end
   end

data/lib/can_has_validations/validators/hash_keys_validator.rb

@@ -0,0 +1,30 @@
+# validates each key of a hash attribute
+#
+# by default only allows the first error per validator, regardless of how many
+# keys fail validation. this improves performance and avoids a bunch of
+# repeating error messages.
+# use `multiple_errors: true` on :hash_keys or a single sub-validator to
+# enable the full set of errors. this is potentially useful if each error
+# message will vary based upon each hash key.
+#
+# the :if, :unless, and :on conditionals are not supported on sub-validators,
+# but do work as normal on the :hash_keys validator itself.
+#
+# usage:
+#   validates :subjects,
+#     hash_keys: {
+#       format: /\A[a-z]+\z/,
+#       # multiple_errors: true
+#     }
+
+module ActiveModel
+  module Validations
+    class HashKeysValidator < ArrayValidator
+
+      def validate_each(record, attribute, hash)
+        super(record, attribute, Hash(hash).keys)
+      end
+
+    end
+  end
+end

data/lib/can_has_validations/validators/hash_values_validator.rb

@@ -0,0 +1,55 @@
+# validates each value of a hash attribute
+#
+# by default only allows the first error per validator, regardless of how many
+# values fail validation. this improves performance and avoids a bunch of
+# repeating error messages.
+# use `multiple_errors: true` on :hash_values or a single sub-validator to
+# enable the full set of errors. this is potentially useful if each error
+# message will vary based upon each hash value.
+#
+# the :if, :unless, and :on conditionals are not supported on sub-validators,
+# but do work as normal on the :hash_values validator itself.
+#
+# usage:
+#   validates :subjects,
+#     hash_values: {
+#       length: 3..100,
+#       # multiple_errors: true
+#     }
+
+module ActiveModel
+  module Validations
+    class HashValuesValidator < ArrayValidator
+
+      def initialize(options)
+        record_class = options[:class]
+        super
+        record_class.include HashValidatorKey
+      end
+
+      def validate_each(record, attribute, hash)
+        super(record, attribute, Array(Hash(hash)))
+      end
+
+      def validate_one(validator, record, attribute, key_and_value)
+        key, value = key_and_value
+        record.hash_validator_key = key
+        super(validator, record, attribute, value)
+      ensure
+        record.hash_validator_key = nil
+      end
+
+
+      module HashValidatorKey
+        def hash_validator_key
+          @_hash_validator_key
+        end
+
+        def hash_validator_key=(v)
+          @_hash_validator_key = v
+        end
+      end
+
+    end
+  end
+end

data/lib/can_has_validations/validators/hostname_validator.rb

@@ -24,8 +24,8 @@
 #       allows 'a.example.com', but not 'example.com'
 #     validates :domain, hostname: {allow_ip: true}  # or 4 or 6 for ipv4 or ipv6 only
 #       allows '1.2.3.4' or 'a.example.com'
-#     validates :subdomain, hostname: {skip_tld: true, segments: 1}
-#       allows 'subdomain1'
+#     validates :subdomain, hostname: {skip_tld: true}
+#       allows 'subdomain1'; implies segments: 1..100 unless otherwise specified
 
 require 'resolv'
 
@@ -46,7 +46,7 @@ module ActiveModel::Validations
         return if value =~ Resolv::IPv4::Regex || value =~ Resolv::IPv6::Regex
       end
 
-      segments = options[:segments] || (2..100)
+      segments = options[:segments] || (options[:skip_tld] ? 1..100 : 2..100)
       segments = segments..segments if segments.is_a?(Integer)
       if defined?(Addressable::IDNA)
         value &&= Addressable::IDNA.to_ascii(value)
@@ -63,6 +63,8 @@ module ActiveModel::Validations
         is_valid &&= label.length <= 63
         if !options[:skip_tld] && idx+1==labels.size
           is_valid &&= label =~ FINAL_LABEL_REGEXP
+        elsif options[:allow_wildcard]==:multi && idx==0
+          is_valid &&= %w(** *).include?(label) || label =~ LABEL_REGEXP
         elsif options[:allow_wildcard] && idx==0
           is_valid &&= label=='*' || label =~ LABEL_REGEXP
         else
@@ -71,7 +73,7 @@ module ActiveModel::Validations
       end
 
       unless is_valid
-        record.errors.add(attribute, :invalid_hostname, options.except(*RESERVED_OPTIONS).merge!(value: value))
+        record.errors.add(attribute, :invalid_hostname, **options.except(*RESERVED_OPTIONS).merge!(value: value))
       end
     end
 

data/lib/can_has_validations/validators/ipaddr_validator.rb

@@ -30,23 +30,30 @@ module ActiveModel::Validations
           IPAddr.new(value) rescue nil
       end
       unless ip
-        record.errors.add(attribute, :invalid_ip, options.merge(value: value))
+        record.errors.add(attribute, :invalid_ip, **options.merge(value: value))
         return
       end
 
       if !options[:allow_block] && (ip.ipv4? && ip.prefix!=32 or ip.ipv6? && ip.prefix!=128)
-        record.errors.add(attribute, :single_ip_required, options.merge(value: value))
+        record.errors.add(attribute, :single_ip_required, **options.merge(value: value))
       end
-      if allowed_ips && allowed_ips.none?{|blk| blk.include? ip}
-        record.errors.add(attribute, :ip_not_allowed, options.merge(value: value))
-      elsif disallowed_ips && disallowed_ips.any?{|blk| blk.include? ip}
-        record.errors.add(attribute, :ip_not_allowed, options.merge(value: value))
+      if allowed_ips && allowed_ips.none?{|blk| ip_within_block? ip, blk}
+        record.errors.add(attribute, :ip_not_allowed, **options.merge(value: value))
+      elsif disallowed_ips && disallowed_ips.any?{|blk| ip_within_block? ip, blk}
+        record.errors.add(attribute, :ip_not_allowed, **options.merge(value: value))
       end
     end
 
 
     private
 
+    def ip_within_block?(ip, blk)
+      return false unless ip.family == blk.family
+      ip = ip.to_range
+      blk = blk.to_range
+      ip.begin >= blk.begin && ip.end <= blk.end
+    end
+
     def normalize_within(val, key)
       if val.nil? || val.respond_to?(:call) || val.is_a?(Symbol)
         val
@@ -72,20 +79,9 @@ module ActiveModel::Validations
       else
         val
       end
+      # raise "#{val.inspect} did not resolve to an Array of IPAddr" unless res.is_a?(Array) && res.all?{|r| r.is_a?(IPAddr)}
+      # res
     end
 
   end
 end
-
-# tests for & fixes broken IPAddr <= 1.2.2
-if IPAddr.new('192.168.2.0/32').include? '192.168.2.0/24'
-  # warn 'IPAddr <= 1.2.2 is broken; monkey-patching'
-  class IPAddr
-    def include?(other)
-      range = to_range
-      other = coerce_other(other).to_range
-      range.begin <= other.begin && range.end >= other.end
-    end
-    alias === include?
-  end
-end

data/lib/can_has_validations/validators/ordering_validator.rb

@@ -18,7 +18,7 @@ module ActiveModel::Validations
         next unless value && greater
         unless value < greater
           attr2 = attr_name.respond_to?(:call) ? 'it is' : record.class.human_attribute_name(attr_name)
-          record.errors.add(attribute, :before, options.except(:before).merge!(attribute2: attr2, value: value))
+          record.errors.add(attribute, :before, **options.except(:before).merge!(attribute2: attr2, value: value))
         end
       end
     end
@@ -33,7 +33,7 @@ module ActiveModel::Validations
         next unless value && lesser
         unless value > lesser
           attr2 = attr_name.respond_to?(:call) ? 'it is' : record.class.human_attribute_name(attr_name)
-          record.errors.add(attribute, :after, options.except(:after).merge!(attribute2: attr2, value: value))
+          record.errors.add(attribute, :after, **options.except(:after).merge!(attribute2: attr2, value: value))
         end
       end
     end

data/lib/can_has_validations/validators/url_validator.rb

@@ -22,7 +22,7 @@ module ActiveModel::Validations
         u2 = u = URI.parse(value) rescue nil
       end
       if !u || !u2 || u.relative? || allowed_schemes.exclude?(u.scheme)
-        record.errors.add(attribute, :invalid_url, options.merge(value: value, scheme: allowed_schemes))
+        record.errors.add(attribute, :invalid_url, **options.merge(value: value, scheme: allowed_schemes))
       end
     end
   end

data/lib/can_has_validations/validators/write_once_validator.rb

@@ -26,7 +26,7 @@ module ActiveModel::Validations
       if record.send("#{attr2}_changed?")
         if options[:immutable_nil] || !record.send("#{attr2}_was").nil?
           value = record.read_attribute_for_validation(attribute)
-          record.errors.add(attribute, :unchangeable, options.except(:immutable_nil).merge!(value: value))
+          record.errors.add(attribute, :unchangeable, **options.except(:immutable_nil).merge!(value: value))
         end
       end
     end

data/lib/can_has_validations/version.rb

@@ -1,3 +1,3 @@
 module CanHasValidations
-  VERSION = '1.2.1'
+  VERSION = '1.4.0'
 end

data/lib/can_has_validations.rb

@@ -1,6 +1,6 @@
 require 'active_model/validations'
 
-%w(array email existence grandparent hostname ipaddr ordering url write_once).each do |validator|
+%w(array email existence grandparent hash_keys hash_values hostname ipaddr ordering url write_once).each do |validator|
   require "can_has_validations/validators/#{validator}_validator"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: can_has_validations
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-17 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 'Assorted Rails 5.x-6.x validators: Array, Email, Existence, Grandparent,
-  Hostname, IP address, Ordering, URL, Write Once'
+  Hash keys, Hash values, Hostname, IP address, Ordering, URL, Write Once'
 email:
 - tm@iprog.com
 executables: []
@@ -57,10 +57,13 @@ files:
 - Rakefile
 - lib/can_has_validations.rb
 - lib/can_has_validations/locale/en.yml
+- lib/can_has_validations/locale/es.yml
 - lib/can_has_validations/validators/array_validator.rb
 - lib/can_has_validations/validators/email_validator.rb
 - lib/can_has_validations/validators/existence_validator.rb
 - lib/can_has_validations/validators/grandparent_validator.rb
+- lib/can_has_validations/validators/hash_keys_validator.rb
+- lib/can_has_validations/validators/hash_values_validator.rb
 - lib/can_has_validations/validators/hostname_validator.rb
 - lib/can_has_validations/validators/ipaddr_validator.rb
 - lib/can_has_validations/validators/ordering_validator.rb
@@ -118,39 +121,39 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Assorted Rails 5.x-6.x validators
 test_files:
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/views/layouts/application.html.erb
+- test/can_has_validations_test.rb
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environment.rb
+- test/dummy/app/views/layouts/application.html.erb
 - test/dummy/config/application.rb
-- test/dummy/config/database.yml
 - test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
 - test/dummy/config.ru
-- test/dummy/script/rails
-- test/dummy/Rakefile
-- test/dummy/public/favicon.ico
+- test/dummy/log/test.log
+- test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
-- test/dummy/public/404.html
-- test/dummy/log/test.log
-- test/dummy/README.rdoc
-- test/can_has_validations_test.rb
+- test/dummy/public/favicon.ico
+- test/dummy/script/rails
 - test/test_helper.rb