hanami-validations 0.5.0 → 0.6.0

data/lib/hanami/validations/attribute_definer.rb

@@ -1,526 +0,0 @@
-require 'set'
-require 'hanami/utils/attributes'
-require 'hanami/validations/nested_attributes'
-
-module Hanami
-  module Validations
-    # Define attributes and their validations together
-    #
-    # @since 0.2.2
-    # @api private
-    module AttributeDefiner
-      # @since 0.2.3
-      # @api private
-      HANAMI_ENTITY_CLASS_NAME = 'Hanami::Entity'.freeze
-
-      # @since 0.2.3
-      # @api private
-      HANAMI_ENTITY_ID         = 'id'.freeze
-
-      # 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
-        base.extend EntityAttributeDefiner if hanami_entity?(base)
-      end
-
-      # Decide if enable the support for `Hanami::Entity`.
-      #
-      # @param base [Class]
-      #
-      # @since 0.2.3
-      # @api private
-      def self.hanami_entity?(base)
-        base.included_modules.any? do |m|
-          m.to_s == HANAMI_ENTITY_CLASS_NAME
-        end
-      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 a non-empty
-        # value which coerces to TrueClass
-        # @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 'hanami/validations'
-        #
-        #   class Person
-        #     include Hanami::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 'hanami/validations'
-        #
-        #   class Person
-        #     include Hanami::Validations
-        #
-        #     attribute :fav_number, type: Integer
-        #   end
-        #
-        #   person = Person.new(fav_number: '23')
-        #   person.valid?
-        #
-        #   person.fav_number # => 23
-        #
-        # @example Custom coercions
-        #   require 'hanami/validations'
-        #
-        #   class FavNumber
-        #     def initialize(number)
-        #       @number = number
-        #     end
-        #   end
-        #
-        #   class BirthDate
-        #   end
-        #
-        #   class Person
-        #     include Hanami::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 'hanami/validations'
-        #
-        #   class Signup
-        #     include Hanami::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 'hanami/validations'
-        #
-        #   class Signup
-        #     include Hanami::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 'hanami/validations'
-        #
-        #   class Signup
-        #     include Hanami::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 'hanami/validations'
-        #
-        #   class Signup
-        #     include Hanami::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 'hanami/validations'
-        #
-        #   class Signup
-        #     include Hanami::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 'hanami/validations'
-        #
-        #   class Signup
-        #     include Hanami::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 'hanami/validations'
-        #
-        #   class Signup
-        #     MEGABYTE = 1024 ** 2
-        #     include Hanami::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 = {}, &block)
-          _attribute(name, options, &block)
-        end
-
-        # Define an attribute
-        #
-        # @see Hanami::Validations::AttributeDefiner#attribute
-        #
-        # @since 0.3.1
-        # @api private
-        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
-        #
-        # @return [Array<String>]
-        #
-        # @since 0.2.2
-        # @api private
-        def defined_attributes
-          @defined_attributes ||= Set.new(super)
-        end
-
-        private
-
-        # @since 0.2.2
-        # @api private
-        def define_attribute(name, options)
-          type = options.fetch(:type) { nil }
-
-          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.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)
-          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, Hanami::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
-
-        # 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(&blk)
-          NestedAttributes.fabricate(&blk)
-        end
-      end
-
-      # Support for `Hanami::Entity`
-      #
-      # @since 0.2.3
-      # @api private
-      #
-      # @example
-      #   require 'hanami/model'
-      #   require 'hanami/validations'
-      #
-      #   class Product
-      #     include Hanami::Entity
-      #     include Hanami::Validations
-      #
-      #     attribute :name,  type: String,  presence: true
-      #     attribute :price, type: Integer, presence: true
-      #   end
-      #
-      #   product = Product.new(name: 'Computer', price: '100')
-      #
-      #   product.name   # => "Computer"
-      #   product.price  # => 100
-      #   product.valid? # => true
-      module EntityAttributeDefiner
-        # Override for Module#extend
-        #
-        # @since 0.2.3
-        # @api private
-        #
-        # @see http://ruby-doc.org/Module.html#method-i-extended
-        def self.extended(base)
-          base.class_eval do
-            include EntityAttributeDefiner::InstanceMethods
-          end
-        end
-
-        # @return [Array<String>]
-        #
-        # @since 0.3.1
-        # @api private
-        def defined_attributes
-          super
-          @defined_attributes.merge(attributes.map(&:to_s))
-        end
-
-        # Override attribute accessors function.
-        #
-        # @since 0.3.1
-        #
-        # @api private
-        # @see Hanami::Model::Entity#define_attr_accessor
-        def define_attr_accessor(attr)
-          _attribute(attr)
-          super
-        end
-
-        # @since 0.2.3
-        # @api private
-        #
-        # @see Hanami::Validations::AttributeDefiner#attribute
-        def attribute(name, options = {})
-          attributes name
-          super
-        end
-
-        # @since 0.2.3
-        # @api private
-        #
-        # @see Hanami::Validations::ClassMethods#validates
-        def validates(name, options = {})
-          super
-          define_attribute(name, options)
-        end
-
-        # @since 0.2.3
-        # @api private
-        module InstanceMethods
-          private
-          # @since 0.2.3
-          # @api private
-          #
-          # @see Hanami::Validations::AttributeDefiner#assign_attribute?
-          def assign_attribute?(attr)
-            super || attr.to_s == HANAMI_ENTITY_ID
-          end
-
-          def initialize(attributes = {})
-            super
-            @attributes.set(HANAMI_ENTITY_ID, id)
-            self.class.attribute(HANAMI_ENTITY_ID)
-          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 'hanami/validations'
-      #
-      #   class Signup
-      #     include Hanami::Validations
-      #
-      #     attribute :name
-      #   end
-      #
-      #   signup = Signup.new(name: 'Luca')
-      #
-      # @example Initialize with Hash like
-      #   require 'hanami/validations'
-      #
-      #   class Params
-      #     def initialize(attributes)
-      #       @attributes = Hash[*attributes]
-      #     end
-      #
-      #     def to_h
-      #       @attributes.to_h
-      #     end
-      #   end
-      #
-      #   class Signup
-      #     include Hanami::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