lotus-validations 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36c1599d9dc59f556a6041f459b41fe23a629e12
-  data.tar.gz: 16fade6ce990dfa2dc5f6bd477dae2bdf0160ab5
+  metadata.gz: 0249c7c704d709f9579693a8f8b8faac3c1ca338
+  data.tar.gz: e2913b58194002b58ec6da05154982e46d30efd5
 SHA512:
-  metadata.gz: b53e4dfe4cc649cd1f7818d00b5de4a8171d6a0ffded3b12e603497abdbec84a31d97d062b87ed38b130e314beef3b06408a4632f957ba257823b9a4bafb22dc
-  data.tar.gz: 32dfdd1ed995e28ce04b631c2f9ee367347c7dfdf05936e9771f2c1254ea0aad763a91c62e0921c4ad9433487f5259bfb71e24a1133f7a7011aed78c9fa604b2
+  metadata.gz: e82fe5c215943d1fdfd11068c1b5639dcec94062a1e1cce5dafee5ee643e09dde7b05b826f1c32d7d9c10e33a0b618587cdae1a393c21f0361388f8162798afa
+  data.tar.gz: b92988e71b73a27e7319acf7957e001042035ce9091c3f2a1e55d83f7f9d4afb45f6c41c9742d1ba663e4eca107977c714685e53577143b7baf5e51bc11ad4b7

data/CHANGELOG.md

@@ -1,10 +1,15 @@
 # Lotus::Validations
 Validations mixin for Ruby objects
 
+## v0.2.2 - 2015-01-08
+### Added
+- [Steve Hodgkiss] Introduced `Validations.validates`. It defines validations, for already existing attributes.
+
 ## v0.2.1 - 2014-12-23
 ### Added
 - [Luca Guidi] Introduced `Validations::Errors#to_h` and `to_a`
 - [Luca Guidi] Introduced `Validations::Errors#any?`
+- [Luca Guidi] Official support for Ruby 2.2
 
 ### Fixed
 - [Satoshi Amemiya] Made `Validations#valid?` idempotent

data/README.md

@@ -57,14 +57,46 @@ require 'lotus/validations'
 class Person
   include Lotus::Validations
 
-  attribute :name
+  attribute :name,  presence: true
+  attribute :email, presence: true
 end
 
-person = Person.new(name: 'Luca', age: 32)
-person.name # => "Luca"
-person.age  # => raises NoMethodError because `:age` wasn't defined as attribute.
+person = Person.new(name: 'Luca', email: 'me@example.org', age: 32)
+person.name  # => "Luca"
+person.email # => "me@example.org"
+person.age   # => raises NoMethodError because `:age` wasn't defined as attribute.
 ```
 
+### Validations
+
+If you prefer Lotus::Validations to **only define validations**, but **not attributes**,
+you can use the following alternative syntax.
+
+```ruby
+require 'lotus/validations'
+
+class Person
+  include Lotus::Validations
+  attr_accessor :name, :email
+
+  # Custom initializer
+  def initialize(attributes = {})
+    @name, @email = attributes.values_at(:name, :email)
+  end
+
+  validates :name,  presence: true
+  validates :email, presence: true
+end
+
+person = Person.new(name: 'Luca', email: 'me@example.org')
+person.name  # => "Luca"
+person.email # => "me@example.org"
+```
+
+This is a bit more verbose, but offers a great level of flexibility for your
+Ruby objects. It also allows to use Lotus::Validations in combination with
+**other frameworks**.
+
 ### Coercions
 
 If a Ruby class is passed to the `:type` option, the given value is coerced, accordingly.
@@ -129,7 +161,7 @@ end
 person = Person.new(fav_number: '23', date: 'Oct 23, 2014')
 person.valid?
 
-person.fav_number # => 23
+person.fav_number # => #<FavNumber:0x007ffc644bba00 @number="23">
 person.date       # => this raises an error, because BirthDate#initialize doesn't accept any arg
 ```
 

data/lib/lotus/validations/attribute.rb

@@ -24,10 +24,6 @@ module Lotus
       # @api private
       CONFIRMATION_TEMPLATE = '%{name}_confirmation'.freeze
 
-      # @since 0.2.0
-      # @api private
-      BLANK_STRING_MATCHER = /\A[[:space:]]*\z/.freeze
-
       # Instantiate an attribute
       #
       # @param attributes [Hash] a set of attributes and values coming from the
@@ -50,23 +46,13 @@ module Lotus
       # @since 0.2.0
       def validate
         _with_cleared_errors do
-          presence
-          acceptance
-
           _run_validations
         end
       end
 
       # @api private
       # @since 0.2.0
-      def value
-        if (coercer = @validations[:type])
-          return nil if blank_value?
-          Lotus::Validations::Coercions.coerce(coercer, @value)
-        else
-          @value
-        end
-      end
+      attr_reader :value
 
       private
       # Validates presence of the value.
@@ -197,71 +183,20 @@ module Lotus
         end
       end
 
-      # Coerces the value to the defined type.
-      # Built in types are:
-      #
-      #   * `Array`
-      #   * `BigDecimal`
-      #   * `Boolean`
-      #   * `Date`
-      #   * `DateTime`
-      #   * `Float`
-      #   * `Hash`
-      #   * `Integer`
-      #   * `Pathname`
-      #   * `Set`
-      #   * `String`
-      #   * `Symbol`
-      #   * `Time`
-      #
-      # If a user defined class is specified, it can be freely used for coercion
-      # purposes. The only limitation is that the constructor should have
-      # **arity of 1**.
-      #
-      # @raise [ArgumentError] if the custom coercer's `#initialize` has a wrong arity.
-      #
-      # @see Lotus::Validations::ClassMethods#attribute
-      # @see Lotus::Validations::Coercions
-      #
-      # @since 0.2.0
-      # @api private
-      def coerce
-        _validate(:type) do |coercer|
-          Lotus::Validations::Coercions.coerce(coercer, @value)
-          true
-        end
-      end
-
-      # Checks if the value is `nil`.
-      #
-      # @since 0.2.0
+      # @since 0.1.0
       # @api private
-      def nil_value?
+      def skip?
         @value.nil?
       end
 
-      alias_method :skip?, :nil_value?
-
       # Checks if the value is "blank".
       #
-      # @see Lotus::Validations::Attribute#presence
+      # @see Lotus::Validations::BlankValueChecker
       #
       # @since 0.2.0
       # @api private
       def blank_value?
-        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?)
+        BlankValueChecker.new(@value).blank_value?
       end
 
       # Run the defined validations
@@ -269,10 +204,12 @@ module Lotus
       # @since 0.2.0
       # @api private
       def _run_validations
+        presence
+        acceptance
+
         return if skip?
 
         format
-        coerce
         inclusion
         exclusion
         size

data/lib/lotus/validations/attribute_definer.rb

@@ -0,0 +1,354 @@
+require 'set'
+require 'lotus/utils/attributes'
+
+module Lotus
+  module Validations
+    # Define attributes and their validations together
+    #
+    # @since 0.2.2
+    # @api private
+    module AttributeDefiner
+      # Override Ruby's hook for modules.
+      #
+      # @param base [Class] the target class
+      #
+      # @since 0.2.2
+      # @api private
+      #
+      # @see http://www.ruby-doc.org/core/Module.html#method-i-included
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # @since 0.2.2
+      # @api private
+      module ClassMethods
+        # Override Ruby's hook for modules.
+        #
+        # @param base [Class] the target class
+        #
+        # @since 0.2.2
+        # @api private
+        #
+        # @see http://www.ruby-doc.org/core/Module.html#method-i-extended
+        def included(base)
+          super
+          base.defined_attributes.merge(defined_attributes)
+        end
+
+        # Override Ruby's hook for modules.
+        #
+        # @param base [Class] the target class
+        #
+        # @since 0.2.2
+        # @api private
+        #
+        # @see http://www.ruby-doc.org/core/Module.html#method-i-extended
+        def inherited(base)
+          super
+          base.defined_attributes.merge(defined_attributes)
+        end
+
+        # Define an attribute
+        #
+        # @param name [#to_sym] the name of the attribute
+        # @param options [Hash] optional set of validations
+        # @option options [Class] :type the Ruby type used to coerce the value
+        # @option options [TrueClass,FalseClass] :acceptance requires Ruby
+        #   thruthiness of the value
+        # @option options [TrueClass,FalseClass] :confirmation requires the value
+        #   to be confirmed twice
+        # @option options [#include?] :exclusion requires the value NOT be
+        #   included in the given collection
+        # @option options [Regexp] :format requires value to match the given
+        #   Regexp
+        # @option options [#include?] :inclusion requires the value BE included in
+        #   the given collection
+        # @option options [TrueClass,FalseClass] :presence requires the value be
+        #   included in the given collection
+        # @option options [Numeric,Range] :size requires value's to be equal or
+        #   included by the given validator
+        #
+        # @raise [ArgumentError] if an unknown or mispelled validation is given
+        #
+        # @since 0.2.2
+        #
+        # @example Attributes
+        #   require 'lotus/validations'
+        #
+        #   class Person
+        #     include Lotus::Validations
+        #
+        #     attribute :name
+        #   end
+        #
+        #   person = Person.new(name: 'Luca', age: 32)
+        #   person.name # => "Luca"
+        #   person.age  # => raises NoMethodError because `:age` wasn't defined as attribute.
+        #
+        # @example Standard coercions
+        #   require 'lotus/validations'
+        #
+        #   class Person
+        #     include Lotus::Validations
+        #
+        #     attribute :fav_number, type: Integer
+        #   end
+        #
+        #   person = Person.new(fav_number: '23')
+        #   person.valid?
+        #
+        #   person.fav_number # => 23
+        #
+        # @example Custom coercions
+        #   require 'lotus/validations'
+        #
+        #   class FavNumber
+        #     def initialize(number)
+        #       @number = number
+        #     end
+        #   end
+        #
+        #   class BirthDate
+        #   end
+        #
+        #   class Person
+        #     include Lotus::Validations
+        #
+        #     attribute :fav_number, type: FavNumber
+        #     attribute :date,       type: BirthDate
+        #   end
+        #
+        #   person = Person.new(fav_number: '23', date: 'Oct 23, 2014')
+        #   person.valid?
+        #
+        #   person.fav_number # => 23
+        #   person.date       # => this raises an error, because BirthDate#initialize doesn't accept any arg
+        #
+        # @example Acceptance
+        #   require 'lotus/validations'
+        #
+        #   class Signup
+        #     include Lotus::Validations
+        #
+        #     attribute :terms_of_service, acceptance: true
+        #   end
+        #
+        #   signup = Signup.new(terms_of_service: '1')
+        #   signup.valid? # => true
+        #
+        #   signup = Signup.new(terms_of_service: '')
+        #   signup.valid? # => false
+        #
+        # @example Confirmation
+        #   require 'lotus/validations'
+        #
+        #   class Signup
+        #     include Lotus::Validations
+        #
+        #     attribute :password, confirmation: true
+        #   end
+        #
+        #   signup = Signup.new(password: 'secret', password_confirmation: 'secret')
+        #   signup.valid? # => true
+        #
+        #   signup = Signup.new(password: 'secret', password_confirmation: 'x')
+        #   signup.valid? # => false
+        #
+        # @example Exclusion
+        #   require 'lotus/validations'
+        #
+        #   class Signup
+        #     include Lotus::Validations
+        #
+        #     attribute :music, exclusion: ['pop']
+        #   end
+        #
+        #   signup = Signup.new(music: 'rock')
+        #   signup.valid? # => true
+        #
+        #   signup = Signup.new(music: 'pop')
+        #   signup.valid? # => false
+        #
+        # @example Format
+        #   require 'lotus/validations'
+        #
+        #   class Signup
+        #     include Lotus::Validations
+        #
+        #     attribute :name, format: /\A[a-zA-Z]+\z/
+        #   end
+        #
+        #   signup = Signup.new(name: 'Luca')
+        #   signup.valid? # => true
+        #
+        #   signup = Signup.new(name: '23')
+        #   signup.valid? # => false
+        #
+        # @example Inclusion
+        #   require 'lotus/validations'
+        #
+        #   class Signup
+        #     include Lotus::Validations
+        #
+        #     attribute :age, inclusion: 18..99
+        #   end
+        #
+        #   signup = Signup.new(age: 32)
+        #   signup.valid? # => true
+        #
+        #   signup = Signup.new(age: 17)
+        #   signup.valid? # => false
+        #
+        # @example Presence
+        #   require 'lotus/validations'
+        #
+        #   class Signup
+        #     include Lotus::Validations
+        #
+        #     attribute :name, presence: true
+        #   end
+        #
+        #   signup = Signup.new(name: 'Luca')
+        #   signup.valid? # => true
+        #
+        #   signup = Signup.new(name: nil)
+        #   signup.valid? # => false
+        #
+        # @example Size
+        #   require 'lotus/validations'
+        #
+        #   class Signup
+        #     MEGABYTE = 1024 ** 2
+        #     include Lotus::Validations
+        #
+        #     attribute :ssn,      size: 11    # exact match
+        #     attribute :password, size: 8..64 # range
+        #     attribute :avatar,   size  1..(5 * MEGABYTE)
+        #   end
+        #
+        #   signup = Signup.new(password: 'a-very-long-password')
+        #   signup.valid? # => true
+        #
+        #   signup = Signup.new(password: 'short')
+        #   signup.valid? # => false
+        def attribute(name, options = {})
+          define_attribute(name, options)
+          validates(name, options)
+        end
+
+        def defined_attributes
+          @defined_attributes ||= Set.new
+        end
+
+        private
+
+        # @since 0.2.2
+        # @api private
+        def define_attribute(name, options)
+          type = options.delete(:type)
+          define_accessor(name, type)
+          defined_attributes.add(name.to_s)
+
+          if options[:confirmation]
+            confirmation_accessor = "#{ name }_confirmation"
+            define_accessor(confirmation_accessor, type)
+            defined_attributes.add(confirmation_accessor)
+          end
+        end
+
+        # @since 0.2.2
+        # @api private
+        def define_accessor(name, type)
+          if type
+            define_reader(name)
+            define_coerced_writer(name, type)
+          else
+            define_reader(name)
+            define_writer(name)
+          end
+        end
+
+        # @since 0.2.2
+        # @api private
+        def define_coerced_writer(name, type)
+          define_method("#{ name }=") do |value|
+            @attributes.set(name, Lotus::Validations::Coercions.coerce(type, value))
+          end
+        end
+
+        # @since 0.2.2
+        # @api private
+        def define_writer(name)
+          define_method("#{ name }=") do |value|
+            @attributes.set(name, value)
+          end
+        end
+
+        # @since 0.2.2
+        # @api private
+        def define_reader(name)
+          define_method(name) do
+            @attributes.get(name)
+          end
+        end
+      end
+
+      # Create a new instance with the given attributes
+      #
+      # @param attributes [#to_h] an Hash like object which contains the
+      #   attributes
+      #
+      # @since 0.2.2
+      #
+      # @example Initialize with Hash
+      #   require 'lotus/validations'
+      #
+      #   class Signup
+      #     include Lotus::Validations
+      #
+      #     attribute :name
+      #   end
+      #
+      #   signup = Signup.new(name: 'Luca')
+      #
+      # @example Initialize with Hash like
+      #   require 'lotus/validations'
+      #
+      #   class Params
+      #     def initialize(attributes)
+      #       @attributes = Hash[*attributes]
+      #     end
+      #
+      #     def to_h
+      #       @attributes.to_h
+      #     end
+      #   end
+      #
+      #   class Signup
+      #     include Lotus::Validations
+      #
+      #     attribute :name
+      #   end
+      #
+      #   params = Params.new([:name, 'Luca'])
+      #   signup = Signup.new(params)
+      #
+      #   signup.name # => "Luca"
+      def initialize(attributes)
+        @attributes ||= Utils::Attributes.new
+
+        attributes.to_h.each do |key, value|
+          public_send("#{ key }=", value) if assign_attribute?(key)
+        end
+      end
+
+      private
+      # @since 0.2.2
+      # @api private
+      def assign_attribute?(attr)
+        self.class.defined_attributes.include?(attr.to_s)
+      end
+    end
+  end
+end

data/lib/lotus/validations/blank_value_checker.rb

@@ -0,0 +1,45 @@
+module Lotus
+  module Validations
+    # @since 0.2.2
+    # @api private
+    class BlankValueChecker
+      # @since 0.2.2
+      # @api private
+      BLANK_STRING_MATCHER = /\A[[:space:]]*\z/.freeze
+
+      def initialize(value)
+        @value = value
+      end
+
+      # Checks if the value is "blank".
+      #
+      # @since 0.2.2
+      # @api private
+      def blank_value?
+        _nil_value? || _blank_string? || _empty_value?
+      end
+
+      private
+
+      # Checks if the value is `nil`.
+      #
+      # @since 0.2.2
+      # @api private
+      def _nil_value?
+        @value.nil?
+      end
+
+      # @since 0.2.2
+      # @api private
+      def _blank_string?
+        (@value.respond_to?(:match) and @value.match(BLANK_STRING_MATCHER))
+      end
+
+      # @since 0.2.2
+      # @api private
+      def _empty_value?
+        (@value.respond_to?(:empty?) and @value.empty?)
+      end
+    end
+  end
+end

data/lib/lotus/validations/coercions.rb

@@ -10,7 +10,7 @@ module Lotus
       # Coerces the given values with the given type
       #
       # @param coercer [Class] the type
-      # @param values [Array] of objects to be coerced
+      # @param value [Array] of objects to be coerced
       # @param blk [Proc] an optional block to pass to the custom coercer
       #
       # @return [Object,nil] The result of the coercion, if possible
@@ -19,11 +19,11 @@ module Lotus
       #
       # @since 0.1.0
       # @api private
-      def self.coerce(coercer, *values, &blk)
+      def self.coerce(coercer, value, &blk)
         if ::Lotus::Utils::Kernel.respond_to?(coercer.to_s)
-          ::Lotus::Utils::Kernel.__send__(coercer.to_s, *values, &blk) rescue nil
+          ::Lotus::Utils::Kernel.__send__(coercer.to_s, value, &blk) rescue nil
         else
-          coercer.new(*values, &blk)
+          coercer.new(value, &blk)
         end
       end
     end

data/lib/lotus/validations/validation_set.rb

@@ -0,0 +1,73 @@
+module Lotus
+  module Validations
+    # A set of validations defined on an object
+    #
+    # @since 0.2.2
+    # @api private
+    class ValidationSet
+      # Allowed validations
+      #
+      # @since 0.2.2
+      # @api private
+      VALIDATIONS = [
+        :presence,
+        :acceptance,
+        :format,
+        :inclusion,
+        :exclusion,
+        :confirmation,
+        :size
+      ].freeze
+
+      # @since 0.2.2
+      # @api private
+      def initialize
+        @validations = Hash.new {|h,k| h[k] = {} }
+      end
+
+      # @since 0.2.2
+      # @api private
+      def add(name, options)
+        @validations[name.to_sym].merge!(
+          validate_options!(name, options)
+        )
+      end
+
+      # @since 0.2.2
+      # @api private
+      def each(&blk)
+        @validations.each(&blk)
+      end
+
+      # @since 0.2.2
+      # @api private
+      def each_key(&blk)
+        @validations.each_key(&blk)
+      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 0.2.2
+      # @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
+  end
+end

data/lib/lotus/validations/validator.rb

@@ -0,0 +1,28 @@
+module Lotus
+  module Validations
+    # Validate given validations and return a set of errors
+    #
+    # @since 0.2.2
+    # @api private
+    class Validator
+      def initialize(validation_set, attributes)
+        @validation_set = validation_set
+        @attributes = attributes
+      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?
+
+            attribute = Attribute.new(@attributes, name, value, validations)
+            errors.add name, *attribute.validate
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lotus/validations/version.rb

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

data/lib/lotus/validations.rb

@@ -1,7 +1,9 @@
 require 'lotus/utils/hash'
 require 'lotus/validations/version'
-require 'lotus/validations/attribute_set'
-require 'lotus/validations/attributes'
+require 'lotus/validations/blank_value_checker'
+require 'lotus/validations/attribute_definer'
+require 'lotus/validations/validation_set'
+require 'lotus/validations/validator'
 require 'lotus/validations/attribute'
 require 'lotus/validations/errors'
 
@@ -19,16 +21,34 @@ module Lotus
     #
     # @see http://www.ruby-doc.org/core/Module.html#method-i-included
     def self.included(base)
-      base.extend ClassMethods
+      base.class_eval do
+        extend ClassMethods
+        include AttributeDefiner
+      end
     end
 
     # Validations DSL
     #
     # @since 0.1.0
     module ClassMethods
+      # Override Ruby's hook for class inheritance. When a class includes
+      # Lotus::Validations and it is subclassed, this passes
+      # the attributes from the superclass to the subclass.
+      #
+      # @param base [Class] the target action
+      #
+      # @since 0.2.2
+      # @api private
+      #
+      # @see http://www.ruby-doc.org/core/Class.html#method-i-inherited
+      def inherited(base)
+        transfer_validations_to_base(base)
+        super
+      end
+
       # 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.
+      # the validations from the module to the base.
       #
       # @param base [Class] the target action
       #
@@ -60,167 +80,31 @@ module Lotus
           include Lotus::Validations
         end
 
-        attributes.each do |attribute, options|
-          base.attribute attribute, options
-        end
+        super
+
+        transfer_validations_to_base(base)
       end
 
-      # Define an attribute
+      # Define a validation for an existing attribute
       #
       # @param name [#to_sym] the name of the attribute
-      # @param options [Hash] optional set of validations
-      # @option options [Class] :type the Ruby type used to coerce the value
-      # @option options [TrueClass,FalseClass] :acceptance requires Ruby
-      #   thruthiness of the value
-      # @option options [TrueClass,FalseClass] :confirmation requires the value
-      #   to be confirmed twice
-      # @option options [#include?] :exclusion requires the value NOT be
-      #   included in the given collection
-      # @option options [Regexp] :format requires value to match the given
-      #   Regexp
-      # @option options [#include?] :inclusion requires the value BE included in
-      #   the given collection
-      # @option options [TrueClass,FalseClass] :presence requires the value be
-      #   included in the given collection
-      # @option options [Numeric,Range] :size requires value's to be equal or
-      #   included by the given validator
-      #
-      # @raise [ArgumentError] if an unknown or mispelled validation is given
-      #
-      # @example Attributes
-      #   require 'lotus/validations'
-      #
-      #   class Person
-      #     include Lotus::Validations
-      #
-      #     attribute :name
-      #   end
-      #
-      #   person = Person.new(name: 'Luca', age: 32)
-      #   person.name # => "Luca"
-      #   person.age  # => raises NoMethodError because `:age` wasn't defined as attribute.
-      #
-      # @example Standard coercions
-      #   require 'lotus/validations'
-      #
-      #   class Person
-      #     include Lotus::Validations
-      #
-      #     attribute :fav_number, type: Integer
-      #   end
-      #
-      #   person = Person.new(fav_number: '23')
-      #   person.valid?
-      #
-      #   person.fav_number # => 23
-      #
-      # @example Custom coercions
-      #   require 'lotus/validations'
-      #
-      #   class FavNumber
-      #     def initialize(number)
-      #       @number = number
-      #     end
-      #   end
-      #
-      #   class BirthDate
-      #   end
-      #
-      #   class Person
-      #     include Lotus::Validations
-      #
-      #     attribute :fav_number, type: FavNumber
-      #     attribute :date,       type: BirthDate
-      #   end
+      # @param options [Hash] set of validations
       #
-      #   person = Person.new(fav_number: '23', date: 'Oct 23, 2014')
-      #   person.valid?
+      # @see Lotus::Validations::ClassMethods#validations
       #
-      #   person.fav_number # => 23
-      #   person.date       # => this raises an error, because BirthDate#initialize doesn't accept any arg
-      #
-      # @example Acceptance
-      #   require 'lotus/validations'
-      #
-      #   class Signup
-      #     include Lotus::Validations
-      #
-      #     attribute :terms_of_service, acceptance: true
-      #   end
-      #
-      #   signup = Signup.new(terms_of_service: '1')
-      #   signup.valid? # => true
-      #
-      #   signup = Signup.new(terms_of_service: '')
-      #   signup.valid? # => false
-      #
-      # @example Confirmation
-      #   require 'lotus/validations'
-      #
-      #   class Signup
-      #     include Lotus::Validations
-      #
-      #     attribute :password, confirmation: true
-      #   end
-      #
-      #   signup = Signup.new(password: 'secret', password_confirmation: 'secret')
-      #   signup.valid? # => true
-      #
-      #   signup = Signup.new(password: 'secret', password_confirmation: 'x')
-      #   signup.valid? # => false
-      #
-      # @example Exclusion
-      #   require 'lotus/validations'
-      #
-      #   class Signup
-      #     include Lotus::Validations
-      #
-      #     attribute :music, exclusion: ['pop']
-      #   end
-      #
-      #   signup = Signup.new(music: 'rock')
-      #   signup.valid? # => true
-      #
-      #   signup = Signup.new(music: 'pop')
-      #   signup.valid? # => false
-      #
-      # @example Format
-      #   require 'lotus/validations'
-      #
-      #   class Signup
-      #     include Lotus::Validations
-      #
-      #     attribute :name, format: /\A[a-zA-Z]+\z/
-      #   end
-      #
-      #   signup = Signup.new(name: 'Luca')
-      #   signup.valid? # => true
-      #
-      #   signup = Signup.new(name: '23')
-      #   signup.valid? # => false
-      #
-      # @example Inclusion
+      # @example Presence
       #   require 'lotus/validations'
       #
       #   class Signup
       #     include Lotus::Validations
       #
-      #     attribute :age, inclusion: 18..99
-      #   end
-      #
-      #   signup = Signup.new(age: 32)
-      #   signup.valid? # => true
-      #
-      #   signup = Signup.new(age: 17)
-      #   signup.valid? # => false
+      #     def initialize(attributes = {})
+      #       @name = attributes.fetch(:name)
+      #     end
       #
-      # @example Presence
-      #   require 'lotus/validations'
+      #     attr_accessor :name
       #
-      #   class Signup
-      #     include Lotus::Validations
-      #
-      #     attribute :name, presence: true
+      #     validates :name, presence: true
       #   end
       #
       #   signup = Signup.new(name: 'Luca')
@@ -228,43 +112,32 @@ module Lotus
       #
       #   signup = Signup.new(name: nil)
       #   signup.valid? # => false
+      def validates(name, options)
+        validations.add(name, options)
+      end
+
+      # Set of user defined validations
       #
-      # @example Size
-      #   require 'lotus/validations'
-      #
-      #   class Signup
-      #     MEGABYTE = 1024 ** 2
-      #     include Lotus::Validations
-      #
-      #     attribute :ssn,      size: 11    # exact match
-      #     attribute :password, size: 8..64 # range
-      #     attribute :avatar,   size  1..(5 * MEGABYTE)
-      #   end
-      #
-      #   signup = Signup.new(password: 'a-very-long-password')
-      #   signup.valid? # => true
+      # @return [Hash]
       #
-      #   signup = Signup.new(password: 'short')
-      #   signup.valid? # => false
-      def attribute(name, options = {})
-        attributes.add(name, options)
-
-        class_eval %{
-          def #{ name }
-            @attributes.get(:#{ name })
-          end
-        }
+      # @since 0.2.2
+      # @api private
+      def validations
+        @validations ||= ValidationSet.new
       end
 
       private
-      # Set of user defined attributes
+
+      # Transfers attributes to a base class
       #
-      # @return [Hash]
+      # @param base [Module] the base class to transfer attributes to
       #
-      # @since 0.1.0
+      # @since 0.2.2
       # @api private
-      def attributes
-        @attributes ||= AttributeSet.new
+      def transfer_validations_to_base(base)
+        validations.each do |attribute, options|
+          base.validates attribute, options
+        end
       end
     end
 
@@ -315,52 +188,8 @@ module Lotus
     #     #     #<Lotus::Validations::Error:0x007fe00cee30d8 @attribute=:age, @validation=:size, @expected=18..99, @actual=17>
     #     #   ]
     #     # }>
-    attr_reader :errors
-
-    # Create a new instance with the given attributes
-    #
-    # @param attributes [#to_h] an Hash like object which contains the
-    #   attributes
-    #
-    # @since 0.1.0
-    #
-    # @example Initialize with Hash
-    #   require 'lotus/validations'
-    #
-    #   class Signup
-    #     include Lotus::Validations
-    #
-    #     attribute :name
-    #   end
-    #
-    #   signup = Signup.new(name: 'Luca')
-    #
-    # @example Initialize with Hash like
-    #   require 'lotus/validations'
-    #
-    #   class Params
-    #     def initialize(attributes)
-    #       @attributes = Hash[*attributes]
-    #     end
-    #
-    #     def to_h
-    #       @attributes.to_h
-    #     end
-    #   end
-    #
-    #   class Signup
-    #     include Lotus::Validations
-    #
-    #     attribute :name
-    #   end
-    #
-    #   params = Params.new([:name, 'Luca'])
-    #   signup = Signup.new(params)
-    #
-    #   signup.name # => "Luca"
-    def initialize(attributes)
-      @attributes = Attributes.new(defined_attributes, attributes)
-      @errors     = Errors.new
+    def errors
+      @errors ||= Errors.new
     end
 
     # Checks if the current data satisfies the defined validations
@@ -369,13 +198,10 @@ module Lotus
     #
     # @since 0.1.0
     def valid?
-      @errors.clear
+      validator = Validator.new(defined_validations, read_attributes)
+      @errors = validator.validate
 
-      @attributes.each do |name, attribute|
-        @errors.add(name, *attribute.validate)
-      end
-
-      @errors.empty?
+      errors.empty?
     end
 
     # Iterates thru the defined attributes and their values
@@ -396,18 +222,30 @@ module Lotus
     #
     # @since 0.1.0
     def to_h
-      @attributes.dup
+      Utils::Hash.new(read_attributes).deep_dup
     end
 
     private
-    # The set of user defined attributes.
+    # The set of user defined validations.
     #
-    # @since 0.1.0
+    # @since 0.2.2
     # @api private
     #
-    # @see Lotus::Validations::ClassMethods#attributes
-    def defined_attributes
-      self.class.__send__(:attributes)
+    # @see Lotus::Validations::ClassMethods#validations
+    def defined_validations
+      self.class.__send__(:validations)
+    end
+
+    # Builds a Hash of current attribute values.
+    #
+    # @since 0.2.2
+    # @api private
+    def read_attributes
+      {}.tap do |attributes|
+        defined_validations.each_key do |attribute|
+          attributes[attribute] = public_send(attribute)
+        end
+      end
     end
   end
 end

data/lotus-validations.gemspec

@@ -6,8 +6,8 @@ require 'lotus/validations/version'
 Gem::Specification.new do |spec|
   spec.name          = 'lotus-validations'
   spec.version       = Lotus::Validations::VERSION
-  spec.authors       = ['Luca Guidi']
-  spec.email         = ['me@lucaguidi.com']
+  spec.authors       = ['Luca Guidi', 'Trung Lê']
+  spec.email         = ['me@lucaguidi.com', 'trung.le@ruby-journal.com']
   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'
@@ -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.2'
+  spec.add_dependency 'lotus-utils', '~> 0.3', '>= 0.3.3'
 
   spec.add_development_dependency 'bundler',  '~> 1.6'
   spec.add_development_dependency 'minitest', '~> 5'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lotus-validations
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Luca Guidi
+- Trung Lê
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-23 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -19,7 +20,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +30,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +76,7 @@ dependencies:
 description: Validations mixin for Ruby objects and support for Lotus
 email:
 - me@lucaguidi.com
+- trung.le@ruby-journal.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -85,11 +87,13 @@ files:
 - lib/lotus-validations.rb
 - lib/lotus/validations.rb
 - lib/lotus/validations/attribute.rb
-- lib/lotus/validations/attribute_set.rb
-- lib/lotus/validations/attributes.rb
+- lib/lotus/validations/attribute_definer.rb
+- lib/lotus/validations/blank_value_checker.rb
 - lib/lotus/validations/coercions.rb
 - lib/lotus/validations/error.rb
 - lib/lotus/validations/errors.rb
+- lib/lotus/validations/validation_set.rb
+- lib/lotus/validations/validator.rb
 - lib/lotus/validations/version.rb
 - lotus-validations.gemspec
 homepage: http://lotusrb.org
@@ -112,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Validations mixin for Ruby objects

data/lib/lotus/validations/attribute_set.rb

@@ -1,51 +0,0 @@
-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 0.2.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
-
-    # FIXME remove
-    if options[:confirmation]
-      add(:"#{ name }_confirmation", {})
-    end
-
-    options
-  end
-end

data/lib/lotus/validations/attributes.rb

@@ -1,38 +0,0 @@
-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