can_has_validations 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c82e1883d7ee1fa1dd3a098f4f9bfd716b63321cec4b2aa4ff873351144f9fc
-  data.tar.gz: b4ab341c9a388e8e3bdcd8f10fbaa4ca1c2b7ab5f6db345ae3f7d84b65fc26b5
+  metadata.gz: bdd7c0ba5910899942ccfa116005b0458596cd475c30495c788fbd72bf25f8f6
+  data.tar.gz: 1507f461b6c2a10e1084d4e7af494924b168b4db83f318eac672b9ac94b58817
 SHA512:
-  metadata.gz: 23684cebc4fce328fa9d9333a48332f7070c354c7876b5f0ee878917e7fdd6b2ae1256b33b99e9ed086bc1a6a323c440c4746b93851e4734182d9783ff5e22a2
-  data.tar.gz: '0941308278c6c9ea1a7b9b0a4b157b28e83bbe061a52f3dee0ffc2c9961e54f742fa7698516c02f5c8909795fe9297ec4093f744b323bb57a17c920dabaf4035'
+  metadata.gz: 8e9d0f1333fbd0f77cb45ec67c741f9b63b5609324e919830e7a4076831a2527efd222ede98fabcb4b632ccdc76fc4a4ce048f2e7bd0659504928f80e7dcdc70
+  data.tar.gz: c85f1eabcbe0e2579dc2ea5917d731088fa7afe0a5da14ddb8a40ccee8a94bca0c6af44405f263a978cad987ce1695e0abbe47ae7d3cfc113fccec153618d0e6

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.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
 

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/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/version.rb

@@ -1,3 +1,3 @@
 module CanHasValidations
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 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.3.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-17 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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