better_validations 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe4e4a0e2cf6d27dd73e985d29bceb8e6aff0657304639964eff597d6d47cde
-  data.tar.gz: eb28f4cf0c70b38f97f89e5a582a4c5bb985f1af8242c37ec085502a4b346b7d
+  metadata.gz: 76ca8c12dfb8eac58738773cab5d49cfad6d1b1e58728873fac9f740b72fbc0b
+  data.tar.gz: a9c10806fb84f110dd5a13b07aea6f036d295c6eb81810ea8ab788aacb859cd0
 SHA512:
-  metadata.gz: 3ee9b4c10050311661e8955c6ee0e5015062473885a793fa0946283469c2e97b2352ddee92c058f1bd2d01b1e20ee99698f5e6d2715c99b198e572b8458c1864
-  data.tar.gz: 40c4eb08fbba1f0b0cdb28f4534899d9241553623a358e96dd455b1f0e941e10a62fb7a2e144a50616ddda9da2b17fe81b0159684d017acd92f5c376226c8a24
+  metadata.gz: 06c42b8d5a217a8eaf63be99d335dc9df563285b54b0d8ee76f5a8c2841ee926bf40dfa6f123a1d2a486740c025643eb73d9c388c0d807439f1356ea8147e275
+  data.tar.gz: d68999c0de44a3a2705d4cb299ae7ec5ba3714cf80d1465173364584c85f232b2a271a3452cbc89f31a1f6aa55e66bce61ca5bbd827559adc02666e74edd9f4b

data/README.md

@@ -185,6 +185,23 @@ object = ActionController::Parameters.new(nested_object: { attribute_one: nil })
 validator = SomeModelValidator.new(object)
 ```
 
+Names of nested objects with the `_attributes` suffix is also acceptable:
+
+```ruby
+validator = SomeModelValidator.new(
+  nested_object_attributes: { attribute_one: nil }
+)
+```
+
+You can initialize fields by setters if needs:
+
+```ruby
+validator = SomeModelValidator.new
+validator.attribute_one = 'filled'
+validator.nested_object = { attribute_one: 'filled' }
+validator.valid?
+```
+
 ### Merge error messages from multiple validators
 
 Better Validations provides the ability to merge validators in order to get merged detailed errors.
@@ -212,25 +229,6 @@ class SomeModelValidator < ApplicationValidator
 end
 ```
 
-This will allow you to easily add common functionality to the validators. For example, add automatic  parsing of keys with `_attributes` suffix to validator properties in order to support format of `accepts_nested_attributes_for` parameters:
-
-```ruby
-class ApplicationValidator
-  include BetterValidations::Validator
-
-  def self.validate_nested(nested_name, validator_class)
-    define_attributes_accessor(nested_name)
-    bind_validator(nested_name, validator_class)
-  end
-
-  def self.define_attributes_accessor(nested_name)
-    setter_name = "#{nested_name}_attributes="
-    define_method(setter_name) { |value| set_value(nested_name, value) }
-  end
-end
-
-```
-
 ## Development
 
 1. Clone project.

data/lib/better_validations/nested_validator.rb

@@ -1,50 +1,54 @@
 class BetterValidations::NestedValidator < ActiveModel::EachValidator
-  attr_reader :validator_class
-
-  def initialize(options)
-    @validator_class = options.delete(:validator_class)
-    super
-  end
-
   def validate_each(record, attr_name, value)
     return if value.nil?
 
-    validator = init_validator(value)
-    cache_validator(record, attr_name, validator)
+    validator = value
     return if validator_valid?(validator)
 
-    record.errors.add(error_key(attr_name), error_text)
+    add_errors(validator, record, attr_name)
   end
 
   protected
 
-  def init_validator(value)
-    # A value can be a single object or a list of objects
-    if value.is_a?(Hash) || value.is_a?(ActionController::Parameters)
-      validator_class.new(value)
-    elsif value.is_a?(Enumerable)
-      value.map { |object| validator_class.new(object) }
-    else
-      validator_class.new(value)
-    end
-  end
-
-  def cache_validator(record, attr_name, validator)
-    record.nested_object_validators[attr_name.to_sym] = validator
-  end
-
   def validator_valid?(validator)
     validators = validator.is_a?(Enumerable) ? validator : [validator]
     validators.map(&:valid?).all?
   end
 
-  def error_key(attr_name)
-    # Create a key with a dot to tell a framework that an error happened in
-    # a nested object
-    "#{attr_name}.attributes".to_sym
+  def add_errors(validator, record, attr_name)
+    # Should copy all errors from nested object to the record
+    # in order to emulate active record nested errors.
+    # But in case of list should merge errors of all items together.
+    details = if validator.is_a?(Enumerable)
+                collect_nested_errors_details(validator)
+              else
+                validator.errors.details
+              end
+
+    add_errors_details(details, record, attr_name)
+  end
+
+  def add_errors_details(details, record, attr_name)
+    details.each do |field_name, errors|
+      errors.each do |error|
+        record.errors.add("#{attr_name}.#{field_name}",
+                          error[:error],
+                          error.except(:error))
+      end
+    end
   end
 
-  def error_text
-    I18n.t('errors.messages.invalid')
+  def collect_nested_errors_details(validators)
+    result = {}
+
+    validators.each do |validator|
+      validator.errors.details.each do |field_name, errors|
+        # Use set to remove duplicates automalically
+        result_errors = result[field_name] || Set.new
+        result[field_name] = result_errors + errors
+      end
+    end
+
+    result.transform_values(&:to_a)
   end
 end

data/lib/better_validations/validator.rb

@@ -7,11 +7,6 @@ module BetterValidations::Validator
     # A system accessors required by BetterValidations::Object
     attr_accessor :id, :client_id
 
-    # A hash with cached instances of nested validators by field.
-    # Filled by instances of a BetterValidations::NestedValidator class
-    # in the process of validation.
-    attr_accessor :nested_object_validators
-
     # A validation object as a possible data source
     attr_reader :validation_object
 
@@ -21,15 +16,32 @@ module BetterValidations::Validator
     # Example of usage in a User model for validating nested PersonalInfo:
     # validate_nested :personal_info, PersonalInfoValidator
     def self.validate_nested(nested_name, validator_class)
-      bind_validator(nested_name, validator_class)
+      bind_validator(nested_name)
+      define_nested_object_setter(nested_name, validator_class)
+      define_attributes_setter(nested_name)
     end
 
     # Calls a validates_with method to save information about
     # the validating object to the validator and run validations.
-    def self.bind_validator(nested_name, validator_class)
+    def self.bind_validator(nested_name)
       validates_with BetterValidations::NestedValidator,
-                     attributes: [nested_name],
-                     validator_class: validator_class
+                     attributes: [nested_name]
+    end
+
+    # Overriders the setter for nested object in order to create the
+    # instance of validator instead of hash/params/ActiveRecord.
+    def self.define_nested_object_setter(nested_name, validator_class)
+      define_method("#{nested_name}=".to_sym) do |value|
+        validator = init_nested_object_validator(validator_class, value)
+        instance_variable_set("@#{nested_name}".to_sym, validator)
+      end
+    end
+
+    # Defines an _attributes setter in order to set a value by _attributes key
+    # instead of an original name.
+    def self.define_attributes_setter(nested_name)
+      setter_name = "#{nested_name}_attributes="
+      define_method(setter_name) { |value| set_value(nested_name, value) }
     end
 
     # Returns a structure of validators such as:
@@ -72,17 +84,11 @@ module BetterValidations::Validator
       BetterValidations::ValidatorsList.new(*([self] + validators))
     end
 
-    # Override to define a start value and getter by name
-    def nested_object_validators(name = nil)
-      return nested_object_validators[name.to_sym] unless name.nil?
-
-      @nested_object_validators ||= {}
-    end
-
-    # The method is overriden for providing a validator object instead of
-    # an active record to collecting error messages.
-    def relation_for_nested_messages(relation)
-      nested_object_validators(relation.to_sym)
+    def read_attribute_for_validation(attr)
+      # Default implementation is 'send(attr)', but it fails if set
+      # an :blank error as a symbol to the nested object:
+      #   errors.add(:'nested_name.nested_attribute', :blank)
+      try(attr)
     end
 
     protected
@@ -112,5 +118,30 @@ module BetterValidations::Validator
       setter = "#{key}=".to_sym
       public_send(setter, value) if respond_to?(setter)
     end
+
+    def init_nested_object_validator(validator_class, value)
+      return nil if value.nil?
+
+      # A value can be a single object or a list of objects
+      if value.is_a?(Hash) || value.is_a?(ActionController::Parameters)
+        validator_class.new(value)
+      elsif value.is_a?(Enumerable)
+        init_nested_object_validators_list(value, validator_class)
+      elsif value.is_a?(BetterValidations::Validator)
+        value
+      else
+        validator_class.new(value)
+      end
+    end
+
+    def init_nested_object_validators_list(list, validator_class)
+      list.map do |object|
+        if object.is_a?(BetterValidations::Validator)
+          object
+        else
+          validator_class.new(object)
+        end
+      end
+    end
   end
 end

data/lib/better_validations/version.rb

@@ -1,3 +1,3 @@
 module BetterValidations
-  VERSION = '0.1.4'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_validations
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Petr Bazov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails