can_has_validations 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb1dc3533f35f980fd7061b9ac1aaa3b8cf4f9c43af0ed1d7d6d4fb898bf7931
-  data.tar.gz: 02d171105d2abf207de0a182e0f7a81344afafb0c8191d2e186929f4dfe0344a
+  metadata.gz: bdd7c0ba5910899942ccfa116005b0458596cd475c30495c788fbd72bf25f8f6
+  data.tar.gz: 1507f461b6c2a10e1084d4e7af494924b168b4db83f318eac672b9ac94b58817
 SHA512:
-  metadata.gz: ef067e3db2f6f0d157390794db619f77048c3cce20951efd2ee17276be321fad01f9923c984b268f9d95db51235a1afb191d6d3d763cae245176adcc39e73f70
-  data.tar.gz: b46c618a0b3d4cea672626766b71944ccef2e2150495bbc2de06329edf4c1ff521e0903e18dde409404af7f32a0561887d6df45d3dba907906b8397e500a9b2f
+  metadata.gz: 8e9d0f1333fbd0f77cb45ec67c741f9b63b5609324e919830e7a4076831a2527efd222ede98fabcb4b632ccdc76fc4a4ce048f2e7bd0659504928f80e7dcdc70
+  data.tar.gz: c85f1eabcbe0e2579dc2ea5917d731088fa7afe0a5da14ddb8a40ccee8a94bca0c6af44405f263a978cad987ce1695e0abbe47ae7d3cfc113fccec153618d0e6

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012-2019 thomas morgan
+Copyright 2012-2021 thomas morgan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -9,7 +9,10 @@ Validations provided:
 * Email
 * Existence
 * Grandparent
+* Hash Keys
+* Hash Values
 * Hostname
+* IP address
 * Ordering
 * URL
 * Write Once
@@ -134,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
@@ -147,6 +186,9 @@ TLD, so as to not fail as ICANN continues to add TLDs.
     # allows '_abc.example.com'
     validates :domain, hostname: {allow_underscore: true}
 
+    # allows '4.0/25.3.2.1.example.com'
+    validates :domain, hostname: {allow_slash: true}
+
     # allows 'a.example.com', but not 'example.com'
     validates :domain, hostname: {segments: 3..100}
 
@@ -158,6 +200,34 @@ TLD, so as to not fail as ICANN continues to add TLDs.
     # use 4 or 6 for ipv4 or ipv6 only
 
 
+## IP address validator ##
+
+Ensures an attribute is generally formatted as a IP or IP block.
+
+    # allows '1.2.3.4' or '::1'
+    validates :ip, ipaddr: true
+
+    # allows '1.2.3.0/24' or '2001:db8::/64'
+    validates :cidr, ipaddr: {allow_block: true}
+
+    # if an ip block, the attribute must be fully contained within an allowed block.
+    # allows '10.0.0.1' and '10.0.0.0/24', but not '10.0.0.0/15'
+    validates :private_ip, ipaddr: {
+      allow_block: true,
+      within: [IPAddr.new('10.0.0.0/16'), '127.0.0.1']
+        # allowed IPs and blocks may be IPAddrs or Strings
+    }
+
+    # the inverse of :within
+    validates :public_ip6, ipaddr: {without: ['fc00::/7']]}
+
+    # :within and :without may also be procs or method names
+    validates :ip, ipaddr: {
+      within: :some_method,
+      without: ->(record){ ... }
+    }
+
+
 ## Ordering validators ##
 
 Ensures two attribute values maintain a relative order to one another. This is
@@ -183,9 +253,9 @@ Always skips over nil values; use `:presence` to validate those.
 
 ## URL validator ##
 
-Ensure an attribute is generally formatted as a URL. If `addressable/uri` is
+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'}
@@ -205,8 +275,8 @@ can be specified; they default to ['http','https'].
 
 ## Write Once validator ##
 
-Ensure that once a value is written, it becomes readonly. There are two uses
-for this. 
+Ensures that once a value is written, it becomes readonly. There are a few
+uses for this.
 
 The first is as an equivalent to `attr_readonly :user_id` except that it also
 produces a validation error instead of silently ignoring the change as
@@ -221,6 +291,10 @@ sorts.
 
     validates :user_id, allow_nil: true, write_once: true
 
+The third use is to allow a nil value, and treat the nil also as write-once.
+
+    validates :source, write_once: {immutable_nil: true}
+
 
 ## Error messages
 
@@ -232,6 +306,9 @@ Default messages are as follows:
         messages:
           invalid_email: "is an invalid email"
           invalid_hostname: "is an invalid hostname"
+          invalid_ip: "is an invalid IP"
+          ip_not_allowed: "is not an allowed IP"
+          single_ip_required: "must be a single IP"
           invalid_url: "is an invalid URL"
           unchangeable: "cannot be changed"
           before: "must be before %{attribute2}"

data/lib/can_has_validations.rb

@@ -1,6 +1,6 @@
 require 'active_model/validations'
 
-%w(array email existence grandparent hostname 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/en.yml

@@ -3,8 +3,10 @@ en:
     messages:
       invalid_email: "is an invalid email"
       invalid_hostname: "is an invalid hostname"
+      invalid_ip: "is an invalid IP"
+      ip_not_allowed: "is not an allowed IP"
+      single_ip_required: "must be a single IP"
       invalid_url: "is an invalid URL"
       unchangeable: "cannot be changed"
       before: "must be before %{attribute2}"
       after: "must be after %{attribute2}"
-      

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,14 +83,21 @@ 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
 
       def count_errors(record)
-        # more efficient than calling record.errors.size
-        record.errors.messages.sum{|key, val| val.blank? ? 0 : val.size }
+        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

@@ -18,6 +18,7 @@ module ActiveModel::Validations
     end
 
     def email_valid?(value)
+      return unless value
       recipient, domain = value.split('@', 2)
       is_valid = true
 

data/lib/can_has_validations/validators/grandparent_validator.rb

@@ -16,7 +16,8 @@ module ActiveModel::Validations
         if cousin.nil?
           options[:allow_nil]
         else
-          association.send(options[:parent]) == cousin.send(options[:parent])
+          association &&
+            association.send(options[:parent]) == cousin.send(options[:parent])
         end
       end
       unless all_match

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

@@ -18,6 +18,8 @@
 #       allows '*.example.com'
 #     validates :domain, hostname: {allow_underscore: true}
 #       allows '_abc.example.com'
+#     validates :domain, hostname: {allow_slash: true}
+#       allows '4.0/25.3.2.1.example.com'  # rfc2317
 #     validates :domain, hostname: {segments: 3..100}
 #       allows 'a.example.com', but not 'example.com'
 #     validates :domain, hostname: {allow_ip: true}  # or 4 or 6 for ipv4 or ipv6 only
@@ -30,9 +32,9 @@ require 'resolv'
 module ActiveModel::Validations
   class HostnameValidator < ActiveModel::EachValidator
 
-    LABEL_REGEXP = /\A([a-zA-Z0-9_]([a-zA-Z0-9_-]+)?)?[a-zA-Z0-9]\z/
-    FINAL_LABEL_REGEXP = /\A(xn--[a-zA-Z0-9]{2,}|[a-zA-Z]{2,})\z/
-    RESERVED_OPTIONS = %i(allow_ip allow_underscore allow_wildcard)
+    LABEL_REGEXP = %r{\A([a-zA-Z0-9_]([a-zA-Z0-9_/-]+)?)?[a-zA-Z0-9]\z}
+    FINAL_LABEL_REGEXP = %r{\A(xn--[a-zA-Z0-9]{2,}|[a-zA-Z]{2,})\z}
+    RESERVED_OPTIONS = %i(allow_ip allow_slash allow_underscore allow_wildcard)
 
     def validate_each(record, attribute, value)
       case options[:allow_ip]
@@ -55,6 +57,7 @@ module ActiveModel::Validations
       is_valid &&= value.length <= 255
       is_valid &&= value !~ /\.\./
       is_valid &&= value !~ /_/ unless options[:allow_underscore]
+      is_valid &&= value !~ %r{/} unless options[:allow_slash]
       is_valid &&= labels.size.in? segments
       labels.each_with_index do |label, idx|
         is_valid &&= label.length <= 63

data/lib/can_has_validations/validators/ipaddr_validator.rb

@@ -0,0 +1,91 @@
+# Ensure an attribute is generally formatted as a IP or IP block.
+# eg: validates :ip, ipaddr: true
+#     validates :cidr, ipaddr: {allow_block: true}
+#     validates :private_ip, ipaddr: {within: [IPAddr.new('10.0.0.0/8'), '127.0.0.1']}
+#       ip must be within any one of the provided ips/blocks
+#       if ip is block, it must be fully contained within any one of the provided blocks
+#     validates :public_ip6, ipaddr: {without: ['fc00::/7']]}
+#       ip must be outside all of the provided ips/blocks
+#       if ip is block, it must be fully outside all of the provided blocks
+
+require 'ipaddr'
+
+module ActiveModel::Validations
+  class IpaddrValidator < ActiveModel::EachValidator
+
+    def initialize(options)
+      options[:within]  = normalize_within options[:within], :within
+      options[:without] = normalize_within options[:without], :without
+      super
+    end
+
+    def validate_each(record, attribute, value)
+      allowed_ips    = resolve_array record, options[:within]
+      disallowed_ips = resolve_array record, options[:without]
+
+      ip = case value
+        when IPAddr
+          ip
+        when String
+          IPAddr.new(value) rescue nil
+      end
+      unless ip
+        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))
+      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))
+      end
+    end
+
+
+    private
+
+    def normalize_within(val, key)
+      if val.nil? || val.respond_to?(:call) || val.is_a?(Symbol)
+        val
+      else
+        Array(val).flatten.map do |i|
+          case i
+          when IPAddr
+            i
+          when String
+            IPAddr.new i
+          else
+            raise "Unexpected value for #{key.inspect} : #{i}"
+          end
+        end
+      end
+    end
+
+    def resolve_array(record, val)
+      res = if val.respond_to?(:call)
+        val.call(record)
+      elsif val.is_a?(Symbol)
+        record.send(val)
+      else
+        val
+      end
+    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/write_once_validator.rb

@@ -12,14 +12,20 @@ module ActiveModel::Validations
     #   nil to be allowed. prevent this.
     def validate(record)
       attributes.each do |attribute|
-        value = record.read_attribute_for_validation(attribute)
-        validate_each(record, attribute, value)
+        validate_each(record, attribute, nil)
       end
     end
 
-    def validate_each(record, attribute, value)
-      if record.persisted? && record.send("#{attribute}_changed?")
-        if options[:immutable_nil] || !record.send("#{attribute}_was").nil?
+    def validate_each(record, attribute, _)
+      return unless record.persisted?
+      if !record.respond_to?("#{attribute}_changed?") && record.respond_to?("#{attribute}_id_changed?")
+        attr2 = "#{attribute}_id"
+      else
+        attr2 = attribute
+      end
+      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))
         end
       end

data/lib/can_has_validations/version.rb

@@ -1,3 +1,3 @@
 module CanHasValidations
-  VERSION = '1.0.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.0.1
+  version: 1.3.0
 platform: ruby
 authors:
 - thomas morgan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +44,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Assorted Rails 5.x-6.x validators.
+description: 'Assorted Rails 5.x-6.x validators: Array, Email, Existence, Grandparent,
+  Hostname, IP address, Ordering, URL, Write Once'
 email:
 - tm@iprog.com
 executables: []
@@ -56,11 +57,15 @@ 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
 - lib/can_has_validations/validators/url_validator.rb
 - lib/can_has_validations/validators/write_once_validator.rb
@@ -98,9 +103,10 @@ files:
 - test/dummy/script/rails
 - test/test_helper.rb
 homepage: https://github.com/zarqman/can_has_validations
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Assorted Rails 5.x-6.x validators
 test_files: