lotus-validations 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8038d2ee15fc8a3e5205d528f56db97024928714
-  data.tar.gz: 9136c6849b93c7869c4dbea6d91b163cce353a3c
+  metadata.gz: 36c1599d9dc59f556a6041f459b41fe23a629e12
+  data.tar.gz: 16fade6ce990dfa2dc5f6bd477dae2bdf0160ab5
 SHA512:
-  metadata.gz: 904a4cab5995195acfe618eb621ee6d48cd1a3746fb0546aa4f16ac983f67109c1969026bbfc0f48337006922eb9cd8391a8fecdf56afbfed77ba175f6a3d86c
-  data.tar.gz: 5bb93ddc815abdb33028dcbf16896acf276cdb75bcf4eb414e61ff28932b7ad90c1782cb1de57bdcdd8d1c925e60eaf38417b27747a92c99b7ea2c727d8c5ec9
+  metadata.gz: b53e4dfe4cc649cd1f7818d00b5de4a8171d6a0ffded3b12e603497abdbec84a31d97d062b87ed38b130e314beef3b06408a4632f957ba257823b9a4bafb22dc
+  data.tar.gz: 32dfdd1ed995e28ce04b631c2f9ee367347c7dfdf05936e9771f2c1254ea0aad763a91c62e0921c4ad9433487f5259bfb71e24a1133f7a7011aed78c9fa604b2

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Lotus::Validations
 Validations mixin for Ruby objects
 
+## v0.2.1 - 2014-12-23
+### Added
+- [Luca Guidi] Introduced `Validations::Errors#to_h` and `to_a`
+- [Luca Guidi] Introduced `Validations::Errors#any?`
+
+### Fixed
+- [Satoshi Amemiya] Made `Validations#valid?` idempotent
+
 ## v0.2.0 - 2014-11-23
 ### Added
 - [Luca Guidi] Skip attribute whitelisting when a validator does not define any attribute

data/lib/lotus/validations/attribute.rb

@@ -20,23 +20,24 @@ module Lotus
       #
       # @see Lotus::Validations::Attribute#confirmation
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       CONFIRMATION_TEMPLATE = '%{name}_confirmation'.freeze
 
+      # @since 0.2.0
+      # @api private
+      BLANK_STRING_MATCHER = /\A[[:space:]]*\z/.freeze
+
       # Instantiate an attribute
       #
-      # @param validator [Lotus::Validations] an object which included
-      #   Lotus::Validations module
+      # @param attributes [Hash] a set of attributes and values coming from the
+      #   input
       # @param name [Symbol] the name of the attribute
-      # @param options [Hash] the set of validations for the attribute
+      # @param value [Object,nil] the value coming from the input
+      # @param validations [Hash] a set of validation rules
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
-      # 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
@@ -46,7 +47,7 @@ module Lotus
       end
 
       # @api private
-      # @since x.x.x
+      # @since 0.2.0
       def validate
         _with_cleared_errors do
           presence
@@ -57,9 +58,10 @@ module Lotus
       end
 
       # @api private
-      # @since x.x.x
+      # @since 0.2.0
       def value
         if (coercer = @validations[:type])
+          return nil if blank_value?
           Lotus::Validations::Coercions.coerce(coercer, @value)
         else
           @value
@@ -76,7 +78,7 @@ module Lotus
       # @see Lotus::Validations::ClassMethods#attribute
       # @see Lotus::Validations::Attribute#nil_value?
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def presence
         _validate(__method__) { !blank_value? }
@@ -92,7 +94,7 @@ module Lotus
       # @see Lotus::Validations::ClassMethods#attribute
       # @see http://www.rubydoc.info/gems/lotus-utils/Lotus/Utils/Kernel#Boolean-class_method
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def acceptance
         _validate(__method__) { Lotus::Utils::Kernel.Boolean(@value) }
@@ -105,7 +107,7 @@ module Lotus
       #
       # @see Lotus::Validations::ClassMethods#attribute
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def format
         _validate(__method__) {|matcher| @value.to_s.match(matcher) }
@@ -117,10 +119,10 @@ module Lotus
       #
       # @see Lotus::Validations::ClassMethods#attribute
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def inclusion
-        _validate(__method__) {|collection| collection.include?(@value) }
+        _validate(__method__) {|collection| collection.include?(value) }
       end
 
       # Validates exclusion of the value in the defined collection.
@@ -129,10 +131,10 @@ module Lotus
       #
       # @see Lotus::Validations::ClassMethods#attribute
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def exclusion
-        _validate(__method__) {|collection| !collection.include?(@value) }
+        _validate(__method__) {|collection| !collection.include?(value) }
       end
 
       # Validates confirmation of the value with another corresponding value.
@@ -143,7 +145,7 @@ module Lotus
       # @see Lotus::Validations::ClassMethods#attribute
       # @see Lotus::Validations::Attribute::CONFIRMATION_TEMPLATE
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def confirmation
         _validate(__method__) do
@@ -180,15 +182,15 @@ module Lotus
       #
       # @see Lotus::Validations::ClassMethods#attribute
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def size
         _validate(__method__) do |validator|
           case validator
           when Numeric, ->(v) { v.respond_to?(:to_int) }
-            @value.size == validator.to_int
+            value.size == validator.to_int
           when Range
-            validator.include?(@value.size)
+            validator.include?(value.size)
           else
             raise ArgumentError.new("Size validator must be a number or a range, it was: #{ validator }")
           end
@@ -221,18 +223,18 @@ module Lotus
       # @see Lotus::Validations::ClassMethods#attribute
       # @see Lotus::Validations::Coercions
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def coerce
         _validate(:type) do |coercer|
-          @value = Lotus::Validations::Coercions.coerce(coercer, @value)
+          Lotus::Validations::Coercions.coerce(coercer, @value)
           true
         end
       end
 
       # Checks if the value is `nil`.
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def nil_value?
         @value.nil?
@@ -244,15 +246,27 @@ module Lotus
       #
       # @see Lotus::Validations::Attribute#presence
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def blank_value?
-        nil_value? || (@value.respond_to?(:empty?) && @value.empty?)
+        nil_value? || _blank_string? || _empty_value?
+      end
+
+      # @since 0.2.0
+      # @api private
+      def _blank_string?
+        (@value.respond_to?(:match) and @value.match(BLANK_STRING_MATCHER))
+      end
+
+      # @since 0.2.0
+      # @api private
+      def _empty_value?
+        (@value.respond_to?(:empty?) and @value.empty?)
       end
 
       # Run the defined validations
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def _run_validations
         return if skip?
@@ -266,7 +280,7 @@ module Lotus
       end
 
       # @api private
-      # @since x.x.x
+      # @since 0.2.0
       def _with_cleared_errors
         @errors.clear
         yield
@@ -275,7 +289,7 @@ module Lotus
 
       # Reads an attribute from the validator.
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def _attribute(name = @name)
         @attributes[name.to_sym]
@@ -283,7 +297,7 @@ module Lotus
 
       # Run a single validation and collects the results.
       #
-      # @since x.x.x
+      # @since 0.2.0
       # @api private
       def _validate(validation)
         if (validator = @validations[validation]) && !(yield validator)

data/lib/lotus/validations/attribute_set.rb

@@ -34,7 +34,7 @@ class AttributeSet
   # @raise [ArgumentError] if at least one of the validations are not
   #   recognized
   #
-  # @since x.x.x
+  # @since 0.2.0
   # @api private
   def validate_options!(name, options)
     if (unknown = (options.keys - VALIDATIONS)) && unknown.any?

data/lib/lotus/validations/errors.rb

@@ -23,10 +23,23 @@ module Lotus
       # @return [TrueClass,FalseClass] the result of the check
       #
       # @since 0.1.0
+      #
+      # @see Lotus::Validations::Errors#any?
       def empty?
         @errors.empty?
       end
 
+      # Check if the set has any entry
+      #
+      # @return [TrueClass,FalseClass] the result of the check
+      #
+      # @since 0.2.0
+      #
+      # @see Lotus::Validations::Errors#empty?
+      def any?
+        @errors.any?
+      end
+
       # Returns how many validations have failed
       #
       # @return [Fixnum] the count
@@ -74,12 +87,12 @@ module Lotus
       # Add an error to the set
       #
       # @param attribute [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 errors [Array] a collection of errors
       #
       # @since 0.1.0
       # @api private
+      #
+      # @see Lotus::Validations::Error
       def add(attribute, *errors)
         @errors[attribute].push(*errors) if errors.any?
       end
@@ -108,6 +121,24 @@ module Lotus
 
       alias_method :eql?, :==
 
+      # Return a serializable Hash representation of the errors.
+      #
+      # @return [Lotus::Utils::Hash] the Hash
+      #
+      # @since 0.2.1
+      def to_h
+        Utils::Hash.new(@errors).deep_dup
+      end
+
+      # Return a flat collection of errors.
+      #
+      # @return [Array]
+      #
+      # @since 0.2.1
+      def to_a
+        errors.dup
+      end
+
       protected
       # A flatten set of errors for all the attributes
       #

data/lib/lotus/validations/version.rb

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

data/lib/lotus/validations.rb

@@ -32,7 +32,7 @@ module Lotus
       #
       # @param base [Class] the target action
       #
-      # @since x.x.x
+      # @since 0.1.0
       # @api private
       #
       # @see http://www.ruby-doc.org/core/Module.html#method-i-included
@@ -384,7 +384,7 @@ module Lotus
     # @yieldparam attribute [Symbol] the name of the attribute
     # @yieldparam value [Object,nil] the value of the attribute
     #
-    # @since x.x.x
+    # @since 0.2.0
     def each(&blk)
       to_h.each(&blk)
     end
@@ -394,7 +394,7 @@ module Lotus
     #
     # @return [Hash]
     #
-    # @since x.x.x
+    # @since 0.1.0
     def to_h
       @attributes.dup
     end
@@ -402,7 +402,7 @@ module Lotus
     private
     # The set of user defined attributes.
     #
-    # @since x.x.x
+    # @since 0.1.0
     # @api private
     #
     # @see Lotus::Validations::ClassMethods#attributes

data/lotus-validations.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Lotus::Validations::VERSION
   spec.authors       = ['Luca Guidi']
   spec.email         = ['me@lucaguidi.com']
-  spec.summary       = %q{Validations for Lotus}
-  spec.description   = %q{Validate attributes on a class and manage error messages accordingly}
+  spec.summary       = %q{Validations mixin for Ruby objects}
+  spec.description   = %q{Validations mixin for Ruby objects and support for Lotus}
   spec.homepage      = 'http://lotusrb.org'
   spec.license       = 'MIT'
 
@@ -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.1'
+  spec.add_dependency 'lotus-utils', '~> 0.3', '>= 0.3.2'
 
   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.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -19,7 +19,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-description: Validate attributes on a class and manage error messages accordingly
+description: Validations mixin for Ruby objects and support for Lotus
 email:
 - me@lucaguidi.com
 executables: []
@@ -115,6 +115,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Validations for Lotus
+summary: Validations mixin for Ruby objects
 test_files: []
 has_rdoc: