can_has_validations 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8eada0f5dd41202696bbab1b493bb017489452ed29459b3f48925236eaec01d
-  data.tar.gz: 357ffbc02deb80c773b0b0f604c8dc0f773d7fd62da030f7fa03299a0fe3ba20
+  metadata.gz: 39feb1ba720229383addaf65d761cf38ce5da9545b5e402cf3a9a064523b987a
+  data.tar.gz: 8128047f635300ddae1771a1d997f22cb732391d79f4d49bc7c2e47bab2c51a4
 SHA512:
-  metadata.gz: d5a8f3386d4e3d420a4492370a77479658557f0d5d97e3f04fc7fe95bb04934a9e23cc4146b6f2be60d20db25a049b8387bc46ee1f6dd6156b175b69a8f598e1
-  data.tar.gz: 6cfa0fab71ff63d23c0d53c9b3780107b99a0af9a126cc695022613fe6b6b5ff28f68315706cd1153114d2c3e90bfb65401d9e4c99ba6fde8578c02c9982c82c
+  metadata.gz: 212be440432bb1ff47193b1948a603138d01e813fd88d0978c8fd8c9ab1d61d39dee23914a1aa0b91abbd955a520b991c609b0a597571e253edfa3242f8006b2
+  data.tar.gz: 190a03e36354954c46b9a1b4e45e22197cad6b6819565320446f55fb9e6f6ed3cbfe42d038afd141ba9ca61f087da392c84464636a7c5ce12bea3035c38b01e7

data/README.md

@@ -5,6 +5,7 @@ ActiveModel.
 
 Validations provided:
 
+* Array
 * Email
 * Existence
 * Grandparent
@@ -29,6 +30,35 @@ Add it to your `Gemfile`:
 
 
 
+## Array validator ##
+
+Many database engines allow for arrays of attributes. This validates each
+member element of those arrays.
+
+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 will stop validation of an array attribute after the first error
+per validator, regardless of how many elements might fail validation. This both
+improves performance as well as avoids producing a large number of duplicate
+error messages. Add `multiple_errors: true` on `:array` or any individual
+sub-validator to instead return all errors (useful if each error message will
+vary based on the element's value).
+
+    validates :tags,
+      array: {
+        format: /\A[^aeiou]*\z/,
+        length: 5..10
+      }
+
+    validates :permissions,
+      array: {
+        multiple_errors: true,
+        format: /\A[^aeiou]*\z/
+      }
+
+
 ## Email validator ##
 
 Ensures an attribute is generally formatted as an email. It uses a basic regex
@@ -51,7 +81,7 @@ avoid any potential conflicts).
 Mongoid 3 and 4 also exhibit the same behavior as Rails 4, even under Rails 3,
 so this is useful with Mongoid as well.
 
-    validates :name, presence: true
+    validates :name, existence: true
 
 
 ## Grandparent validator ##

data/lib/can_has_validations.rb

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

data/lib/can_has_validations/validators/array_validator.rb

@@ -0,0 +1,104 @@
+# validates each member element of an array attribute
+#
+# by default will allow only the first error per validator, regardless of how
+# many elements might fail validation. this improves performance as well as
+# averting a large number of repeating error messages.
+# use  multiple_errors: true  on :array or a single sub-validator to enable the
+# full set of errors. this is potentially useful if each error message will
+# vary based upon the array element's contents.
+#
+# usage:
+#   validates :tags,
+#     array: {
+#       format: /\A[^aeiou]*\z/,
+#       length: 5..10
+#     }
+#
+#   validates :permissions,
+#     array: {
+#       multiple_errors: true,
+#       format: /\A[^aeiou]*\z/
+#     }
+
+module ActiveModel
+  module Validations
+    class ArrayValidator < ActiveModel::EachValidator
+      attr_reader :validators
+
+      def initialize(options)
+        record_class = options[:class]
+        super
+        record_class.prepend DefaultKeys
+
+        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?
+
+        defaults[:attributes] = attributes
+
+        @validators = validations.map do |key, options|
+          next unless options
+          key = "#{key.to_s.camelize}Validator"
+
+          begin
+            klass = key.include?("::".freeze) ? key.constantize : record_class.const_get(key)
+          rescue NameError
+            raise ArgumentError, "Unknown validator: '#{key}'"
+          end
+
+          validator = klass.new(defaults.merge(_parse_validates_options(options)))
+        end
+      end
+
+      def validate_each(record, attribute, array_values)
+        @validators.each do |validator|
+          error_count = count_errors(record)
+
+          Array(array_values).each do |value|
+            validator.validate_each(record, attribute, value)
+
+            # to avoid repeating error messages, stop after a single error
+            unless validator.options[:multiple_errors]
+              break if error_count != count_errors(record)
+            end
+          end
+        end
+      end
+
+
+      private
+
+      def count_errors(record)
+        # more efficient than calling record.errors.size
+        record.errors.messages.sum{|key, val| val.blank? ? 0 : val.size }
+      end
+
+      def _parse_validates_options(options)
+        case options
+        when TrueClass
+          {}
+        when Hash
+          options
+        when Range, Array
+          { in: options }
+        else
+          { with: options }
+        end
+      end
+
+
+      module DefaultKeys
+        private
+
+        # When creating custom validators, it might be useful to be able to specify
+        # additional default keys. This can be done by overwriting this method.
+        def _validates_default_keys
+          super + [:multiple_errors]
+        end
+      end
+
+    end
+
+  end
+end

data/lib/can_has_validations/version.rb

@@ -1,3 +1,3 @@
 module CanHasValidations
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: can_has_validations
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2018-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,12 +56,12 @@ files:
 - Rakefile
 - lib/can_has_validations.rb
 - lib/can_has_validations/locale/en.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/hostname_validator.rb
 - lib/can_has_validations/validators/ordering_validator.rb
-- lib/can_has_validations/validators/safe_uniqueness_validator.rb
 - lib/can_has_validations/validators/url_validator.rb
 - lib/can_has_validations/validators/write_once_validator.rb
 - lib/can_has_validations/version.rb

data/lib/can_has_validations/validators/safe_uniqueness_validator.rb

@@ -1,15 +0,0 @@
-# better behaved version of the uniqueness validator
-#   Difference is it doesn't puke if the foreign_key is an invalid type (for
-#   example, an invalid string being provided for UUID type key). Instead,
-#   returns an error about being unable to find the key value.
-# eg: validates :user_id, safe_uniqueness: true
-
-class SafeUniquenessValidator < ActiveRecord::Validations::UniquenessValidator
-  def validate_each(record, attribute, value)
-    record.transaction(requires_new: true) do
-      super
-    end
-  rescue ActiveRecord::StatementInvalid
-    record.errors.add(attribute, "%{attribute} %{value} not found", options.except(:case_sensitive, :scope).merge(value: value))
-  end  
-end