can_has_validations 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b18aa1039ebc20678d9781ff0e90d495253b6d40fa39c3ffec9ae69c03b6d298
-  data.tar.gz: 6657e468172b9f6cdbd7f69f7d68a105c82661b521e5473d50fda8ca37387558
+  metadata.gz: 4b8c22fcbf2964d57091e6b566e5d05a1b501f286722ae26e4c63be5d42989f9
+  data.tar.gz: c2cdd19af9fa8459007d506f93e4dec5b1311c173d4fdf087c7438a1d387d97f
 SHA512:
-  metadata.gz: 129fe04836706f5aa89ba7d1116b857375bd3088f1b3953247c045c8c75c385adc981d2d1e0189810aae40009689c4a18da2f714ac52b79869ba01ea3cd9f823
-  data.tar.gz: 3454442e03e74108c632ac8f7dfed962850e36a5ce16afd595eb21b1855653edf8c4cefa4181f4eb7f65b308fc85a7d2341afcbab0a7d31ad268f4e0da000e8e
+  metadata.gz: 115570baed1e6a8061612de3f6428599ab4b76afab032756db8a7df5d5aa8bf8ec76f91d52849b5a28b154349965028c5f295350e4fd8f62d86b7f298e046cf2
+  data.tar.gz: fa601d54efefa5ee3d83299b9838ba6684450009ef3f782e3904de6405ea6ecd05869e79e89daadf42904f8cfe8c791a2f397a1fb24ec08cd9ff1ced1bd269a9

data/README.md

@@ -10,6 +10,7 @@ Validations provided:
 * Existence
 * Grandparent
 * Hostname
+* IP address
 * Ordering
 * URL
 * Write Once
@@ -147,6 +148,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 +162,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,7 +215,7 @@ 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'].
 
@@ -205,8 +237,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 +253,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 +268,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 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/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/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/version.rb

@@ -1,3 +1,3 @@
 module CanHasValidations
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: can_has_validations
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - thomas morgan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -61,6 +61,7 @@ files:
 - lib/can_has_validations/validators/existence_validator.rb
 - lib/can_has_validations/validators/grandparent_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
@@ -100,7 +101,7 @@ files:
 homepage: https://github.com/zarqman/can_has_validations
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,8 +116,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.8
+signing_key:
 specification_version: 4
 summary: Assorted Rails 5.x-6.x validators
 test_files: