lotus-validations 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88761697180386ed3a562170900b63ceb0618b03
-  data.tar.gz: e98d3b024612251600f74e104a3f6f43eb9bf33e
+  metadata.gz: 8038d2ee15fc8a3e5205d528f56db97024928714
+  data.tar.gz: 9136c6849b93c7869c4dbea6d91b163cce353a3c
 SHA512:
-  metadata.gz: 76fac7ccbbafca4210be4ab570a3e5ae708378a08478aae7836a4dfd2e0ddf70c33a99bdaef93e544bbcd3d78917a65ce5f5868ea17e17788e75a1203471d7cb
-  data.tar.gz: 7185e7295684adaf616fa8abb450f11126adc2cc4ea8ed7d1769c27ebfad9a975b76e2727096832ff49e7cfa94a1d7c536293b612e823daaf90659e109502d46
+  metadata.gz: 904a4cab5995195acfe618eb621ee6d48cd1a3746fb0546aa4f16ac983f67109c1969026bbfc0f48337006922eb9cd8391a8fecdf56afbfed77ba175f6a3d86c
+  data.tar.gz: 5bb93ddc815abdb33028dcbf16896acf276cdb75bcf4eb414e61ff28932b7ad90c1782cb1de57bdcdd8d1c925e60eaf38417b27747a92c99b7ea2c727d8c5ec9

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Lotus::Validations
+Validations mixin for Ruby objects
+
+## v0.2.0 - 2014-11-23
+### Added
+- [Luca Guidi] Skip attribute whitelisting when a validator does not define any attribute
+- [Luca Guidi] Official support for Rubinius 2.3+
+- [Luca Guidi] Implemented `#each` in order to allow bulk operations on attributes
+- [Luca Guidi] Implemented `#to_h` to make validations usable by other libraries
+- [Luca Guidi] Made `#initialize` to accept Hashes with strings as keys, but only for declared attributes
+- [Luca Guidi] Lazy coercions, from now on `valid?` is not required to obtain a coerced value from a single attribute
+- [Rik Tonnard] Made validators reusable by allowing infinite inclusion
+
+## v0.1.0 - 2014-10-23
+### Added
+- [Luca Guidi] Made `#initialize` to accept any object that implements `#to_h`
+- [Luca Guidi] Custom coercions for user defined classes
+- [Luca Guidi] Raise an exception at the load time when a validation is not recognized
+- [Luca Guidi] Allow validators inheritance
+- [Luca Guidi] Confirmation validation
+- [Luca Guidi] Exclusion validation
+- [Luca Guidi] Size validation
+- [Luca Guidi] Acceptance validation
+- [Jeremy Stephens] Inclusion validation
+- [Luca Guidi] Format validation
+- [Luca Guidi] Presence validation
+- [Luca Guidi] Coercions
+- [Luca Guidi] Basic module inclusion
+- [Luca Guidi] Official support for JRuby 1.7+ (with 2.0 mode)
+- [Luca Guidi] Official support for MRI 2.0+
+
+### Fixed
+- [Jeremy Stephens] Ensure to not fail validations when coerce falsey values
+- [Luca Guidi] Ensure `Lotus::Validations#valid?` to be idempotent

data/README.md

@@ -22,7 +22,7 @@ Validations mixins for objects
 
 ## Rubies
 
-__Lotus::Validations__ supports Ruby (MRI) 2+ and JRuby 1.7 (with 2.0 mode).
+__Lotus::Validations__ supports Ruby (MRI) 2+, JRuby 1.7 (with 2.0 mode) and Rubinius 2.3.0+.
 
 ## Installation
 
@@ -311,7 +311,7 @@ class Signup
 
   attribute :ssn,      size: 11    # exact match
   attribute :password, size: 8..64 # range
-  attribute :avatar,   size  1..(5 * MEGABYTE)
+  attribute :avatar,   size: 1..(5 * MEGABYTE)
 end
 
 signup = Signup.new(password: 'a-very-long-password')
@@ -331,6 +331,64 @@ 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).
 
+### Composable validations
+
+Validations can be reused via composition:
+
+```ruby
+require 'lotus/validations'
+
+module NameValidations
+  include Lotus::Validations
+
+  attribute :name, presence: true
+end
+
+module EmailValidations
+  include Lotus::Validations
+
+  attribute :email, presence: true, format: /.../
+end
+
+module PasswordValidations
+  include Lotus::Validations
+
+  # We validate only the presence here
+  attribute :password, presence: true
+end
+
+module CommonValidations
+  include EmailValidations
+  include PasswordValidations
+end
+
+# A valid signup requires:
+#   * name (presence)
+#   * email (presence and format)
+#   * password (presence and confirmation)
+class Signup
+  include NameValidations
+  include CommonValidations
+
+  # We decorate PasswordValidations behavior, by requiring the confirmation too.
+  # This additional validation is active only in this case.
+  attribute :password, confirmation: true
+end
+
+# A valid signin requires:
+#   * email (presence)
+#   * password (presence)
+class Signin
+  include CommonValidations
+end
+
+# A valid "forgot password" requires:
+#   * email (presence)
+class ForgotPassword
+  include EmailValidations
+end
+```
+
 ### Complete example
 
 ```ruby

data/lib/lotus/validations.rb

@@ -1,13 +1,15 @@
+require 'lotus/utils/hash'
 require 'lotus/validations/version'
+require 'lotus/validations/attribute_set'
+require 'lotus/validations/attributes'
+require 'lotus/validations/attribute'
 require 'lotus/validations/errors'
-require 'lotus/validations/attribute_validator'
 
 module Lotus
   # Lotus::Validations is a set of lightweight validations for Ruby objects.
   #
   # @since 0.1.0
   module Validations
-
     # Override Ruby's hook for modules.
     #
     # @param base [Class] the target action
@@ -24,6 +26,45 @@ module Lotus
     #
     # @since 0.1.0
     module ClassMethods
+      # Override Ruby's hook for modules. When a module includes
+      # Lotus::Validations and it is included in a class or module, this passes
+      # the attributes from the module to the base.
+      #
+      # @param base [Class] the target action
+      #
+      # @since x.x.x
+      # @api private
+      #
+      # @see http://www.ruby-doc.org/core/Module.html#method-i-included
+      #
+      # @example
+      #   require 'lotus/validations'
+      #
+      #   module NameValidations
+      #     include Lotus::Validations
+      #
+      #     attribute :name, presence: true
+      #   end
+      #
+      #   class Signup
+      #     include NameValidations
+      #   end
+      #
+      #   signup = Signup.new(name: '')
+      #   signup.valid? # => false
+      #
+      #   signup = Signup.new(name: 'Luca')
+      #   signup.valid? # => true
+      def included(base)
+        base.class_eval do
+          include Lotus::Validations
+        end
+
+        attributes.each do |attribute, options|
+          base.attribute attribute, options
+        end
+      end
+
       # Define an attribute
       #
       # @param name [#to_sym] the name of the attribute
@@ -206,11 +247,11 @@ module Lotus
       #   signup = Signup.new(password: 'short')
       #   signup.valid? # => false
       def attribute(name, options = {})
-        attributes[name.to_sym] = validate_options!(name, options)
+        attributes.add(name, options)
 
         class_eval %{
           def #{ name }
-            @attributes[:#{ name }]
+            @attributes.get(:#{ name })
           end
         }
       end
@@ -223,35 +264,7 @@ module Lotus
       # @since 0.1.0
       # @api private
       def attributes
-        @attributes ||= Hash.new
-      end
-
-      # Checks at the loading time if the user defined validations are recognized
-      #
-      # @param name [Symbol] the attribute name
-      # @param options [Hash] the set of validations associated with the given attribute
-      #
-      # @raise [ArgumentError] if at least one of the validations are not
-      #   recognized
-      #
-      # @since 0.1.0
-      # @api private
-      def validate_options!(name, options)
-        if (unknown = (options.keys - validations)) && unknown.any?
-          raise ArgumentError.new(%(Unknown validation(s): #{ unknown.join ', ' } for "#{ name }" attribute))
-        end
-
-        options
-      end
-
-      # Names of the implemented validations
-      #
-      # @return [Array]
-      #
-      # @since 0.1.0
-      # @api private
-      def validations
-        [:presence, :acceptance, :format, :inclusion, :exclusion, :confirmation, :size, :type]
+        @attributes ||= AttributeSet.new
       end
     end
 
@@ -346,7 +359,7 @@ module Lotus
     #
     #   signup.name # => "Luca"
     def initialize(attributes)
-      @attributes = attributes.to_h
+      @attributes = Attributes.new(defined_attributes, attributes)
       @errors     = Errors.new
     end
 
@@ -358,40 +371,42 @@ module Lotus
     def valid?
       @errors.clear
 
-      _attributes.each do |name, options|
-        AttributeValidator.new(self, name, options).validate!
+      @attributes.each do |name, attribute|
+        @errors.add(name, *attribute.validate)
       end
 
       @errors.empty?
     end
 
-    protected
-    # Returns the attributes passed at the initialize time
+    # Iterates thru the defined attributes and their values
     #
-    # @return [Hash] attributes
+    # @param blk [Proc] a block
+    # @yieldparam attribute [Symbol] the name of the attribute
+    # @yieldparam value [Object,nil] the value of the attribute
     #
-    # @since 0.1.0
-    # @api private
-    #
-    # @example
-    #   require 'lotus/validations'
-    #
-    #   class Signup
-    #     include Lotus::Validations
+    # @since x.x.x
+    def each(&blk)
+      to_h.each(&blk)
+    end
+
+    # Returns a Hash with the defined attributes as symbolized keys, and their
+    # relative values.
     #
-    #     attribute :email
-    #   end
+    # @return [Hash]
     #
-    #   signup = Signup.new(email: 'user@example.org')
-    #   signup.attributes # => {:email=>"user@example.org"}
-    attr_reader :attributes
+    # @since x.x.x
+    def to_h
+      @attributes.dup
+    end
 
     private
-    # @since 0.1.0
+    # The set of user defined attributes.
+    #
+    # @since x.x.x
     # @api private
     #
     # @see Lotus::Validations::ClassMethods#attributes
-    def _attributes
+    def defined_attributes
       self.class.__send__(:attributes)
     end
   end

data/lib/lotus/validations/{attribute_validator.rb → attribute.rb}

@@ -11,44 +11,59 @@ end
 
 module Lotus
   module Validations
-    # Validator for a single attribute
+    # A validable attribute
     #
     # @since 0.1.0
     # @api private
-    class AttributeValidator
+    class Attribute
       # Attribute naming convention for "confirmation" validation
       #
-      # @see Lotus::Validations::AttributeValidator#confirmation
+      # @see Lotus::Validations::Attribute#confirmation
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       CONFIRMATION_TEMPLATE = '%{name}_confirmation'.freeze
 
-      # Initialize a validator
+      # Instantiate an attribute
       #
       # @param validator [Lotus::Validations] an object which included
       #   Lotus::Validations module
       # @param name [Symbol] the name of the attribute
       # @param options [Hash] the set of validations for the attribute
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
-      def initialize(validator, name, options)
-        @validator, @name, @options = validator, name, options
-        @value = _attribute(@name)
+      # def initialize(validator, name, options)
+      #   @validator, @name, @options = validator, name, options
+      #   @value = _attribute(@name)
+      # end
+      def initialize(attributes, name, value, validations)
+        @attributes  = attributes
+        @name        = name
+        @value       = value
+        @validations = validations
+        @errors      = []
       end
 
-      # Validate the attribute
-      #
-      # @return [void]
-      #
-      # @since 0.1.0
       # @api private
-      def validate!
-        presence
-        acceptance
+      # @since x.x.x
+      def validate
+        _with_cleared_errors do
+          presence
+          acceptance
 
-        _run_validations
+          _run_validations
+        end
+      end
+
+      # @api private
+      # @since x.x.x
+      def value
+        if (coercer = @validations[:type])
+          Lotus::Validations::Coercions.coerce(coercer, @value)
+        else
+          @value
+        end
       end
 
       private
@@ -59,9 +74,9 @@ module Lotus
       # Empty strings and enumerables are an example.
       #
       # @see Lotus::Validations::ClassMethods#attribute
-      # @see Lotus::Validations::AttributeValidator#nil_value?
+      # @see Lotus::Validations::Attribute#nil_value?
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def presence
         _validate(__method__) { !blank_value? }
@@ -77,7 +92,7 @@ module Lotus
       # @see Lotus::Validations::ClassMethods#attribute
       # @see http://www.rubydoc.info/gems/lotus-utils/Lotus/Utils/Kernel#Boolean-class_method
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def acceptance
         _validate(__method__) { Lotus::Utils::Kernel.Boolean(@value) }
@@ -90,7 +105,7 @@ module Lotus
       #
       # @see Lotus::Validations::ClassMethods#attribute
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def format
         _validate(__method__) {|matcher| @value.to_s.match(matcher) }
@@ -102,7 +117,7 @@ module Lotus
       #
       # @see Lotus::Validations::ClassMethods#attribute
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def inclusion
         _validate(__method__) {|collection| collection.include?(@value) }
@@ -114,7 +129,7 @@ module Lotus
       #
       # @see Lotus::Validations::ClassMethods#attribute
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def exclusion
         _validate(__method__) {|collection| !collection.include?(@value) }
@@ -126,9 +141,9 @@ module Lotus
       # `:password_confirmation` has the same value.
       #
       # @see Lotus::Validations::ClassMethods#attribute
-      # @see Lotus::Validations::AttributeValidator::CONFIRMATION_TEMPLATE
+      # @see Lotus::Validations::Attribute::CONFIRMATION_TEMPLATE
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def confirmation
         _validate(__method__) do
@@ -165,7 +180,7 @@ module Lotus
       #
       # @see Lotus::Validations::ClassMethods#attribute
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def size
         _validate(__method__) do |validator|
@@ -201,25 +216,23 @@ module Lotus
       # purposes. The only limitation is that the constructor should have
       # **arity of 1**.
       #
-      # @raise [TypeError] if the coercion fails
       # @raise [ArgumentError] if the custom coercer's `#initialize` has a wrong arity.
       #
       # @see Lotus::Validations::ClassMethods#attribute
       # @see Lotus::Validations::Coercions
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def coerce
         _validate(:type) do |coercer|
           @value = Lotus::Validations::Coercions.coerce(coercer, @value)
-          _attributes[@name] = @value
           true
         end
       end
 
       # Checks if the value is `nil`.
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def nil_value?
         @value.nil?
@@ -229,9 +242,9 @@ module Lotus
 
       # Checks if the value is "blank".
       #
-      # @see Lotus::Validations::AttributeValidator#presence
+      # @see Lotus::Validations::Attribute#presence
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def blank_value?
         nil_value? || (@value.respond_to?(:empty?) && @value.empty?)
@@ -239,7 +252,7 @@ module Lotus
 
       # Run the defined validations
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def _run_validations
         return if skip?
@@ -252,27 +265,29 @@ module Lotus
         confirmation
       end
 
-      # Reads an attribute from the validator.
-      #
-      # @since 0.1.0
       # @api private
-      def _attribute(name = @name)
-        _attributes[name.to_sym]
+      # @since x.x.x
+      def _with_cleared_errors
+        @errors.clear
+        yield
+        @errors.dup.tap {|_| @errors.clear }
       end
 
-      # @since 0.1.0
+      # Reads an attribute from the validator.
+      #
+      # @since x.x.x
       # @api private
-      def _attributes
-        @validator.__send__(:attributes)
+      def _attribute(name = @name)
+        @attributes[name.to_sym]
       end
 
       # Run a single validation and collects the results.
       #
-      # @since 0.1.0
+      # @since x.x.x
       # @api private
       def _validate(validation)
-        if (validator = @options[validation]) && !(yield validator)
-          @validator.errors.add(@name, validation, @options.fetch(validation), @value)
+        if (validator = @validations[validation]) && !(yield validator)
+          @errors.push(Error.new(@name, validation, @validations.fetch(validation), @value))
         end
       end
     end

data/lib/lotus/validations/attribute_set.rb

@@ -0,0 +1,51 @@
+class AttributeSet
+  VALIDATIONS = [:presence, :acceptance, :format, :inclusion, :exclusion, :confirmation, :size, :type].freeze
+
+  def initialize
+    @attributes = Hash.new {|h,k| h[k] = {} }
+  end
+
+  def add(name, options)
+    @attributes[name.to_sym].merge!(
+      validate_options!(name, options)
+    )
+  end
+
+  def each(&blk)
+    @attributes.each(&blk)
+  end
+
+  def iterate(attributes, &blk)
+    if @attributes.any?
+      @attributes.each(&blk)
+    else
+      attributes.each do |name, _|
+        blk.call(name, {})
+      end
+    end
+  end
+
+  private
+  # Checks at the loading time if the user defined validations are recognized
+  #
+  # @param name [Symbol] the attribute name
+  # @param options [Hash] the set of validations associated with the given attribute
+  #
+  # @raise [ArgumentError] if at least one of the validations are not
+  #   recognized
+  #
+  # @since x.x.x
+  # @api private
+  def validate_options!(name, options)
+    if (unknown = (options.keys - VALIDATIONS)) && unknown.any?
+      raise ArgumentError.new(%(Unknown validation(s): #{ unknown.join ', ' } for "#{ name }" attribute))
+    end
+
+    # FIXME remove
+    if options[:confirmation]
+      add(:"#{ name }_confirmation", {})
+    end
+
+    options
+  end
+end

data/lib/lotus/validations/attributes.rb

@@ -0,0 +1,38 @@
+module Lotus
+  module Validations
+    class Attributes
+      def initialize(definitions, attributes)
+        attributes  = attributes.to_h
+
+        @attributes = Utils::Hash.new.tap do |result|
+          definitions.iterate(attributes) do |name, validations|
+            value = attributes[name]
+            value = attributes[name.to_s] if value.nil?
+
+            result[name] = Attribute.new(attributes, name, value, validations)
+          end
+        end
+      end
+
+      def get(name)
+        (attr = @attributes[name]) and attr.value
+      end
+
+      def dup
+        Utils::Hash.new(to_h).deep_dup
+      end
+
+      def each(&blk)
+        @attributes.each(&blk)
+      end
+
+      def to_h
+        ::Hash.new.tap do |result|
+          each do |name, _|
+            result[name] = get(name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lotus/validations/coercions.rb

@@ -13,14 +13,15 @@ module Lotus
       # @param values [Array] of objects to be coerced
       # @param blk [Proc] an optional block to pass to the custom coercer
       #
-      # @raise [TypeError] if the coercion fails
+      # @return [Object,nil] The result of the coercion, if possible
+      #
       # @raise [ArgumentError] if the custom coercer's `#initialize` has a wrong arity.
       #
       # @since 0.1.0
       # @api private
       def self.coerce(coercer, *values, &blk)
         if ::Lotus::Utils::Kernel.respond_to?(coercer.to_s)
-          ::Lotus::Utils::Kernel.__send__(coercer.to_s, *values, &blk)
+          ::Lotus::Utils::Kernel.__send__(coercer.to_s, *values, &blk) rescue nil
         else
           coercer.new(*values, &blk)
         end

data/lib/lotus/validations/errors.rb

@@ -80,10 +80,8 @@ module Lotus
       #
       # @since 0.1.0
       # @api private
-      def add(attribute, validation, expected, actual)
-        @errors[attribute].push(
-          Error.new(attribute, validation, expected, actual)
-        )
+      def add(attribute, *errors)
+        @errors[attribute].push(*errors) if errors.any?
       end
 
       # Return the errors for the given attribute

data/lib/lotus/validations/version.rb

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

data/lotus-validations.gemspec

@@ -13,13 +13,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'http://lotusrb.org'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -- lib/* LICENSE.md README.md lotus-validations.gemspec`.split($/)
+  spec.files         = `git ls-files -- lib/* LICENSE.md README.md CHANGELOG.md lotus-validations.gemspec`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'lotus-utils', '~> 0.3'
+  spec.add_dependency 'lotus-utils', '~> 0.3', '>= 0.3.1'
 
   spec.add_development_dependency 'bundler',  '~> 1.6'
   spec.add_development_dependency 'minitest', '~> 5'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotus-validations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,11 +79,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.md
 - README.md
 - lib/lotus-validations.rb
 - lib/lotus/validations.rb
-- lib/lotus/validations/attribute_validator.rb
+- lib/lotus/validations/attribute.rb
+- lib/lotus/validations/attribute_set.rb
+- lib/lotus/validations/attributes.rb
 - lib/lotus/validations/coercions.rb
 - lib/lotus/validations/error.rb
 - lib/lotus/validations/errors.rb