lotus-validations 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c28b2bd092a3123b3449bd57ce7aa6bf641aef7
-  data.tar.gz: 6def7642d5acb0049d3f9656ccb22617a7a0a97c
+  metadata.gz: ddd486452556cb357a7742a46ce462e15ba9c206
+  data.tar.gz: 48fbf0ec796aaf18df2a2d138daed1c25f3335dd
 SHA512:
-  metadata.gz: 721ec4289267c55b2ac39e132568568023c3a51ba3ecf1faca3627d7a1a60a351985aa0dfb778808fbfa19f3dec305fd1830e179a1f5f8d1ae4252676130a81b
-  data.tar.gz: 695f77817307e158789652f4a584bad04af0cf05e5f65d48068389a6db9e1153b613f827e45c25a5a3051c355eee28cc32889488988435798625a3b1f6d1a780
+  metadata.gz: c25f6c2b8dd39d3d4cba3c0c7473c85f9572c23124d1e02cb5c354d145c4315262bbc576f6d99939048a1f58c6f68e4b6135542d33a843e8309f6f794c4ba771
+  data.tar.gz: 8bb02cb2c960d93b6e146cd61a4cd68fc5a0292188c8e61726a1e0bf7e09d5c3246e2d20de3adb2367756429e1bbbb4ad7750bfffd0544252cd6b4d94220e3b6

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Lotus::Validations
 Validations mixin for Ruby objects
 
+## v0.2.4 - 2015-01-30
+### Added
+- [Steve Hodgkiss] Introduced `Lotus::Validations::Error#attribute_name`
+- [Steve Hodgkiss] Nested validations
+
+### Changed
+- [Steve Hodgkiss] `Lotus::Validations::Error#name` returns the complete attribute name (Eg. `first_name` or `address.street`)
+
 ## v0.2.3 - 2015-01-12
 ### Added
 - [Luca Guidi] Compatibility with Lotus::Entity

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Luca Guidi
+Copyright © 2014-2015 Luca Guidi
 
 MIT License
 

data/README.md

@@ -363,6 +363,51 @@ The other reason is that this isn't an effective way to ensure uniqueness of a v
 
 Please read more at: [The Perils of Uniqueness Validations](http://robots.thoughtbot.com/the-perils-of-uniqueness-validations).
 
+### Nested validations
+
+Nested validations are handled with a nested block syntax.
+
+```ruby
+class ShippingDetails
+  include Lotus::Validations
+
+  attribute :full_name, presence: true
+
+  attribute :address do
+    attribute :street,      presence: true
+    attribute :city,        presence: true
+    attribute :country,     presence: true
+    attribute :postal_code, presence: true, format: /.../
+  end
+end
+
+validator = ShippingDetails.new
+validator.valid? # => false
+```
+
+Bulk operations on errors are guaranteed by `#each`.
+This method yields a **flatten collection of errors**.
+
+```ruby
+validator.errors.each do |error|
+  error.name
+    # => on the first iteration it returns "full_name"
+    # => the second time it returns "address.street" and so on..
+end
+```
+
+Errors for a specific attribute can be accessed via `#for`.
+
+```ruby
+error = validator.errors.for('full_name').first
+error.name           # => "full_name"
+error.attribute_name # => "full_name"
+
+error = validator.errors.for('address.street').first
+error.name           # => "address.street"
+error.attribute_name # => "street"
+```
+
 ### Composable validations
 
 Validations can be reused via composition:
@@ -504,4 +549,4 @@ product.price # => 100
 
 ## Copyright
 
-Copyright 2014-2015 Luca Guidi – Released under MIT License
+Copyright © 2014-2015 Luca Guidi – Released under MIT License

data/lib/lotus/validations.rb

@@ -208,12 +208,24 @@ module Lotus
     #
     # @since 0.1.0
     def valid?
-      validator = Validator.new(defined_validations, read_attributes)
-      @errors = validator.validate
+      validate
 
       errors.empty?
     end
 
+    # Validates the object.
+    #
+    # @return [Errors]
+    #
+    # @since 0.2.4
+    # @api private
+    #
+    # @see Lotus::Attribute#nested
+    def validate
+      validator = Validator.new(defined_validations, read_attributes, errors)
+      validator.validate
+    end
+
     # Iterates thru the defined attributes and their values
     #
     # @param blk [Proc] a block

data/lib/lotus/validations/attribute.rb

@@ -34,20 +34,30 @@ module Lotus
       #
       # @since 0.2.0
       # @api private
-      def initialize(attributes, name, value, validations)
+      def initialize(attributes, name, value, validations, errors)
         @attributes  = attributes
         @name        = name
         @value       = value
         @validations = validations
-        @errors      = []
+        @errors      = errors
       end
 
       # @api private
       # @since 0.2.0
       def validate
-        _with_cleared_errors do
-          _run_validations
-        end
+        presence
+        acceptance
+
+        return if skip?
+
+        format
+        inclusion
+        exclusion
+        size
+        confirmation
+        nested
+
+        @errors
       end
 
       # @api private
@@ -183,6 +193,21 @@ module Lotus
         end
       end
 
+      # Validates nested Lotus Validations objects
+      #
+      # @since 0.2.4
+      # @api private
+      def nested
+        _validate(__method__) do |validator|
+          errors = value.validate
+          errors.each do |error|
+            new_error = Error.new(error.attribute, error.validation, error.expected, error.actual, @name)
+            @errors.add new_error.attribute, new_error
+          end
+          true
+        end
+      end
+
       # @since 0.1.0
       # @api private
       def skip?
@@ -199,31 +224,6 @@ module Lotus
         BlankValueChecker.new(@value).blank_value?
       end
 
-      # Run the defined validations
-      #
-      # @since 0.2.0
-      # @api private
-      def _run_validations
-        presence
-        acceptance
-
-        return if skip?
-
-        format
-        inclusion
-        exclusion
-        size
-        confirmation
-      end
-
-      # @api private
-      # @since 0.2.0
-      def _with_cleared_errors
-        @errors.clear
-        yield
-        @errors.dup.tap {|_| @errors.clear }
-      end
-
       # Reads an attribute from the validator.
       #
       # @since 0.2.0
@@ -238,7 +238,7 @@ module Lotus
       # @api private
       def _validate(validation)
         if (validator = @validations[validation]) && !(yield validator)
-          @errors.push(Error.new(@name, validation, @validations.fetch(validation), @value))
+          @errors.add(@name, Error.new(@name, validation, @validations.fetch(validation), @value))
         end
       end
     end

data/lib/lotus/validations/attribute_definer.rb

@@ -253,9 +253,14 @@ module Lotus
         #
         #   signup = Signup.new(password: 'short')
         #   signup.valid? # => false
-        def attribute(name, options = {})
-          define_attribute(name, options)
-          validates(name, options)
+        def attribute(name, options = {}, &block)
+          if block_given?
+            define_nested_attribute(name, options, &block)
+            validates(name, {})
+          else
+            define_attribute(name, options)
+            validates(name, options)
+          end
         end
 
         # Set of user defined attributes
@@ -285,6 +290,16 @@ module Lotus
           end
         end
 
+        # @since 0.2.4
+        # @api private
+        def define_nested_attribute(name, options, &block)
+          nested_class = build_validation_class(&block)
+          define_lazy_reader(name, nested_class)
+          define_coerced_writer(name, nested_class)
+          defined_attributes.add(name.to_s)
+          validates(name, nested: true)
+        end
+
         # @since 0.2.2
         # @api private
         def define_accessor(name, type)
@@ -320,6 +335,35 @@ module Lotus
             @attributes.get(name)
           end
         end
+
+        # Defines a reader that will return a new instance of
+        # the given type if one is not already present
+        #
+        # @since 0.2.4
+        # @api private
+        def define_lazy_reader(name, type)
+          define_method(name) do
+            value = @attributes.get(name)
+            return value if value
+
+            type.new({}).tap do |val|
+              @attributes.set(name, val)
+            end
+          end
+        end
+
+        # Creates a validation class and configures it with the
+        # given block.
+        #
+        # @since 0.2.4
+        # @api private
+        def build_validation_class(&block)
+          kls = Class.new do
+            include Lotus::Validations
+          end
+          kls.class_eval(&block)
+          kls
+        end
       end
 
       # Support for `Lotus::Entity`

data/lib/lotus/validations/error.rb

@@ -4,12 +4,24 @@ module Lotus
     #
     # @since 0.1.0
     class Error
+      # @since 0.2.4
+      # @api private
+      NAMESPACE_SEPARATOR = '.'.freeze
+
       # The name of the attribute
       #
       # @return [Symbol] the name of the attribute
       #
-      # @since 0.1.0
-      attr_reader :attribute
+      # @since 0.2.4
+      #
+      # @see Lotus::Validations::Error#attribute
+      #
+      # @example
+      #   error = Error.new(:name, :presence, true, nil, 'author')
+      #
+      #   error.attribute      # => "author.name"
+      #   error.attribute_name # => "name"
+      attr_reader :attribute_name
 
       # The name of the validation
       #
@@ -32,18 +44,40 @@ module Lotus
       # @since 0.1.0
       attr_reader :actual
 
+      # Returns the namespaced attribute name
+      #
+      # In cases where the error was pulled up from nested validators,
+      # `attribute` will be a namespaced string containing
+      # parent attribute names separated by a period.
+      #
+      # @since 0.1.0
+      #
+      # @see Lotus::Validations::Error#attribute_name
+      #
+      # @example
+      #   error = Error.new(:name, :presence, true, nil, 'author')
+      #
+      #   error.attribute      # => "author.name"
+      #   error.attribute_name # => "name"
+      attr_accessor :attribute
+
       # Initialize a validation error
       #
-      # @param attribute [Symbol] the name of the attribute
+      # @param attribute_name [Symbol] the name of the attribute
       # @param validation [Symbol] the name of the validation
       # @param expected [Object] the expected value
       # @param actual [Object] the actual value
+      # @param namespace [String] the optional namespace
       #
       # @since 0.1.0
       # @api private
-      def initialize(attribute, validation, expected, actual)
-        @attribute, @validation, @expected, @actual =
-          attribute, validation, expected, actual
+      def initialize(attribute_name, validation, expected, actual, namespace = nil)
+        @attribute_name = attribute_name.to_s
+        @validation = validation
+        @expected = expected
+        @actual = actual
+        @namespace = namespace
+        @attribute = [@namespace, attribute_name].compact.join(NAMESPACE_SEPARATOR)
       end
 
       # Check if self equals to `other`

data/lib/lotus/validations/errors.rb

@@ -15,7 +15,7 @@ module Lotus
       # @since 0.1.0
       # @api private
       def initialize
-        @errors = Hash.new {|h,k| h[k] = [] }
+        @errors = Hash.new
       end
 
       # Check if the set is empty
@@ -94,7 +94,10 @@ module Lotus
       #
       # @see Lotus::Validations::Error
       def add(attribute, *errors)
-        @errors[attribute].push(*errors) if errors.any?
+        if errors.any?
+          @errors[attribute] ||= []
+          @errors[attribute].push(*errors)
+        end
       end
 
       # Return the errors for the given attribute
@@ -103,7 +106,7 @@ module Lotus
       #
       # @since 0.1.0
       def for(attribute)
-        @errors[attribute]
+        @errors.fetch(attribute) { [] }
       end
 
       # Check if the current set of errors equals to the one who belongs to

data/lib/lotus/validations/validation_set.rb

@@ -17,7 +17,8 @@ module Lotus
         :exclusion,
         :confirmation,
         :size,
-        :type
+        :type,
+        :nested
       ].freeze
 
       # @since 0.2.2

data/lib/lotus/validations/validator.rb

@@ -5,23 +5,24 @@ module Lotus
     # @since 0.2.2
     # @api private
     class Validator
-      def initialize(validation_set, attributes)
+      def initialize(validation_set, attributes, errors)
         @validation_set = validation_set
         @attributes = attributes
+        @errors = errors
       end
 
       # @since 0.2.2
       # @api private
       def validate
-        Errors.new.tap do |errors|
-          @validation_set.each do |name, validations|
-            value = @attributes[name]
-            value = @attributes[name.to_s] if value.nil?
+        @errors.clear
+        @validation_set.each do |name, validations|
+          value = @attributes[name]
+          value = @attributes[name.to_s] if value.nil?
 
-            attribute = Attribute.new(@attributes, name, value, validations)
-            errors.add name, *attribute.validate
-          end
+          attribute = Attribute.new(@attributes, name, value, validations, @errors)
+          attribute.validate
         end
+        @errors
       end
     end
   end

data/lib/lotus/validations/version.rb

@@ -1,6 +1,6 @@
 module Lotus
   module Validations
     # @since 0.1.0
-    VERSION = '0.2.3'.freeze
+    VERSION = '0.2.4'.freeze
   end
 end

data/lotus-validations.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'lotus-utils', '~> 0.3', '>= 0.3.3'
+  spec.add_dependency 'lotus-utils', '~> 0.3', '>= 0.3.4'
 
   spec.add_development_dependency 'bundler',  '~> 1.6'
   spec.add_development_dependency 'minitest', '~> 5'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-validations
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Luca Guidi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -20,7 +20,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement