hanami-validations 0.5.0 → 0.6.0

data/lib/hanami/validations/form.rb

@@ -0,0 +1,47 @@
+require 'hanami/validations'
+
+module Hanami
+  module Validations
+    # Validations mixin for forms/HTTP params.
+    #
+    # This must be used when the input comes from a browser or an HTTP endpoint.
+    # It knows how to deal with common data types, and common edge cases like blank strings.
+    #
+    # @since 0.6.0
+    #
+    # @example
+    #   require 'hanami/validations/form'
+    #
+    #   class Signup
+    #     include Hanami::Validations::Form
+    #   end
+    module Form
+      # Override Ruby's hook for modules.
+      #
+      # @param base [Class] the target action
+      #
+      # @since 0.6.0
+      # @api private
+      #
+      # @see http://www.ruby-doc.org/core/Module.html#method-i-included
+      def self.included(base)
+        base.class_eval do
+          include Validations
+          extend  ClassMethods
+        end
+      end
+
+      # @since 0.6.0
+      # @api private
+      module ClassMethods
+        private
+
+        # @since 0.6.0
+        # @api private
+        def _schema_type
+          :Form
+        end
+      end
+    end
+  end
+end

data/lib/hanami/validations/inline_predicate.rb

@@ -0,0 +1,46 @@
+module Hanami
+  module Validations
+    # Inline predicate
+    #
+    # @since 0.6.0
+    # @api private
+    class InlinePredicate
+      # @since 0.6.0
+      # @api private
+      attr_reader :name
+
+      # @since 0.6.0
+      # @api private
+      attr_reader :message
+
+      # Return a new instance.
+      #
+      # @param name [Symbol] inline predicate name
+      # @param message [String] optional failure message
+      # @param blk [Proc] predicate implementation
+      #
+      # @return [Hanami::Validations::InlinePredicate] a new instance
+      #
+      # @since 0.6.0
+      # @api private
+      def initialize(name, message, &blk)
+        @name    = name
+        @message = message
+        @blk     = blk
+      end
+
+      # @since 0.6.0
+      # @api private
+      def to_proc
+        @blk
+      end
+
+      # @since 0.6.0
+      # @api private
+      def ==(other)
+        self.class == other.class &&
+          name == other.name
+      end
+    end
+  end
+end

data/lib/hanami/validations/namespace.rb

@@ -0,0 +1,65 @@
+require 'hanami/utils/string'
+
+module Hanami
+  module Validations
+    # Validations message namespace.
+    #
+    # For a given `FooValidator` class, it will look for I18n messages within
+    # the `foo` group.
+    #
+    # @since 0.6.0
+    # @api private
+    class Namespace
+      # @since 0.6.0
+      # @api private
+      SUFFIX = 'Validator'.freeze
+
+      # @since 0.6.0
+      # @api private
+      SUFFIX_REPLACEMENT = ''.freeze
+
+      # @since 0.6.0
+      # @api private
+      RUBY_NAMESPACE_SEPARATOR = '/'.freeze
+
+      # @since 0.6.0
+      # @api private
+      RUBY_NAMESPACE_REPLACEMENT = '.'.freeze
+
+      # @since 0.6.0
+      # @api private
+      def self.new(name, klass)
+        result = name || klass.name
+        return nil if result.nil?
+
+        super(result)
+      end
+
+      # @since 0.6.0
+      # @api private
+      def initialize(name)
+        @name = name
+      end
+
+      # @since 0.6.0
+      # @api private
+      def to_s
+        underscored_name.gsub(RUBY_NAMESPACE_SEPARATOR, RUBY_NAMESPACE_REPLACEMENT)
+      end
+
+      private
+
+      # @since 0.6.0
+      # @api private
+      def underscored_name
+        Utils::String.new(name_without_suffix).underscore
+      end
+
+      # @since 0.6.0
+      # @api private
+      def name_without_suffix
+        @name.sub(SUFFIX, SUFFIX_REPLACEMENT)
+      end
+    end
+  end
+end

data/lib/hanami/validations/predicates.rb

@@ -0,0 +1,45 @@
+require 'dry/logic/predicates'
+require 'hanami/utils/class_attribute'
+
+module Hanami
+  module Validations
+    # Mixin to include when defining shared predicates
+    #
+    # @since 0.6.0
+    #
+    # @see Hanami::Validations::ClassMethods#predicates
+    #
+    # @example
+    #   require 'hanami/validations'
+    #
+    #   module MySharedPredicates
+    #     include Hanami::Validations::Predicates
+    #
+    #     predicate :foo? fo |actual|
+    #       actual == 'foo'
+    #     end
+    #   end
+    #
+    #   class MyValidator
+    #     include Hanami::Validations
+    #     predicates MySharedPredicates
+    #
+    #     validations do
+    #       required(:name).filled(:foo?)
+    #     end
+    #   end
+    module Predicates
+      # @since 0.6.0
+      # @api private
+      def self.included(base)
+        base.class_eval do
+          include Dry::Logic::Predicates
+          include Utils::ClassAttribute
+
+          class_attribute :messages
+          class_attribute :messages_path
+        end
+      end
+    end
+  end
+end

data/lib/hanami/validations/version.rb

@@ -1,6 +1,6 @@
 module Hanami
   module Validations
     # @since 0.1.0
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-validations
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
@@ -18,14 +18,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -83,15 +97,10 @@ files:
 - hanami-validations.gemspec
 - lib/hanami-validations.rb
 - lib/hanami/validations.rb
-- lib/hanami/validations/attribute.rb
-- lib/hanami/validations/attribute_definer.rb
-- lib/hanami/validations/blank_value_checker.rb
-- lib/hanami/validations/coercions.rb
-- lib/hanami/validations/error.rb
-- lib/hanami/validations/errors.rb
-- lib/hanami/validations/nested_attributes.rb
-- lib/hanami/validations/validation_set.rb
-- lib/hanami/validations/validator.rb
+- lib/hanami/validations/form.rb
+- lib/hanami/validations/inline_predicate.rb
+- lib/hanami/validations/namespace.rb
+- lib/hanami/validations/predicates.rb
 - lib/hanami/validations/version.rb
 homepage: http://hanamirb.org
 licenses:
@@ -105,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -113,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Validations mixin for Ruby objects
 test_files: []
-has_rdoc: 

data/lib/hanami/validations/attribute.rb

@@ -1,252 +0,0 @@
-require 'hanami/validations/coercions'
-
-# Quick fix for non MRI VMs that don't implement Range#size
-#
-# @since 0.1.0
-class Range
-  def size
-    to_a.size
-  end unless instance_methods.include?(:size)
-end
-
-module Hanami
-  module Validations
-    # A validable attribute
-    #
-    # @since 0.1.0
-    # @api private
-    class Attribute
-      # Attribute naming convention for "confirmation" validation
-      #
-      # @see Hanami::Validations::Attribute#confirmation
-      #
-      # @since 0.2.0
-      # @api private
-      CONFIRMATION_TEMPLATE = '%{name}_confirmation'.freeze
-
-      # Instantiate an attribute
-      #
-      # @param attributes [Hash] a set of attributes and values coming from the
-      #   input
-      # @param name [Symbol] the name of the attribute
-      # @param value [Object,nil] the value coming from the input
-      # @param validations [Hash] a set of validation rules
-      #
-      # @since 0.2.0
-      # @api private
-      def initialize(attributes, name, value, validations, errors)
-        @attributes  = attributes
-        @name        = name
-        @value       = value
-        @validations = validations
-        @errors      = errors
-      end
-
-      # @api private
-      # @since 0.2.0
-      def validate
-        presence
-        acceptance
-
-        return if skip?
-
-        format
-        inclusion
-        exclusion
-        size
-        confirmation
-        nested
-
-        @errors
-      end
-
-      # @api private
-      # @since 0.2.0
-      attr_reader :value
-
-      private
-      # Validates presence of the value.
-      # This fails with `nil` and "blank" values.
-      #
-      # An object is blank if it isn't `nil`, but doesn't hold a value.
-      # Empty strings and enumerables are an example.
-      #
-      # @see Hanami::Validations::ClassMethods#attribute
-      # @see Hanami::Validations::Attribute#nil_value?
-      #
-      # @since 0.2.0
-      # @api private
-      def presence
-        _validate(__method__) { !blank_value? }
-      end
-
-      # Validates acceptance of the value.
-      #
-      # This passes if the value is "truthy", it fails if not.
-      #
-      # Truthy examples: `Object.new`, `1`, `"1"`, `true`.
-      # Falsy examples: `nil`, `0`, `"0"`, `false`, `""`.
-      #
-      # @see Hanami::Validations::ClassMethods#attribute
-      # @see http://www.rubydoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Boolean-class_method
-      #
-      # @since 0.2.0
-      # @api private
-      def acceptance
-        _validate(__method__) do
-          !blank_value? && Hanami::Utils::Kernel.Boolean(@value)
-        end
-      end
-
-      # Validates format of the value.
-      #
-      # Coerces the value to a string and then check if it satisfies the defined
-      # matcher.
-      #
-      # @see Hanami::Validations::ClassMethods#attribute
-      #
-      # @since 0.2.0
-      # @api private
-      def format
-        _validate(__method__) {|matcher| @value.to_s.match(matcher) } unless blank_value?
-      end
-
-      # Validates inclusion of the value in the defined collection.
-      #
-      # The collection is an objects which implements `#include?`.
-      #
-      # @see Hanami::Validations::ClassMethods#attribute
-      #
-      # @since 0.2.0
-      # @api private
-      def inclusion
-        _validate(__method__) {|collection| collection.include?(value) }
-      end
-
-      # Validates exclusion of the value in the defined collection.
-      #
-      # The collection is an objects which implements `#include?`.
-      #
-      # @see Hanami::Validations::ClassMethods#attribute
-      #
-      # @since 0.2.0
-      # @api private
-      def exclusion
-        _validate(__method__) {|collection| !collection.include?(value) }
-      end
-
-      # Validates confirmation of the value with another corresponding value.
-      #
-      # Given a `:password` attribute, it passes if the corresponding attribute
-      # `:password_confirmation` has the same value.
-      #
-      # @see Hanami::Validations::ClassMethods#attribute
-      # @see Hanami::Validations::Attribute::CONFIRMATION_TEMPLATE
-      #
-      # @since 0.2.0
-      # @api private
-      def confirmation
-        _validate(__method__) do
-          _attribute == _attribute(CONFIRMATION_TEMPLATE % { name: @name })
-        end
-      end
-
-      # Validates if value's size matches the defined quantity.
-      #
-      # The quantity can be a Ruby Numeric:
-      #
-      #   * `Integer`
-      #   * `Fixnum`
-      #   * `Float`
-      #   * `BigNum`
-      #   * `BigDecimal`
-      #   * `Complex`
-      #   * `Rational`
-      #   * Octal literals
-      #   * Hex literals
-      #   * `#to_int`
-      #
-      # The quantity can be also any object which implements `#include?`.
-      #
-      # If the quantity is a Numeric, the size of the value MUST be exactly the
-      # same.
-      #
-      # If the quantity is a Range, the size of the value MUST be included.
-      #
-      # If the attribute's value is blank, the size will not be considered
-      #
-      # The value is an object which implements `#size`.
-      #
-      # @raise [ArgumentError] if the defined quantity isn't a Numeric or a
-      #   collection
-      #
-      # @see Hanami::Validations::ClassMethods#attribute
-      #
-      # @since 0.2.0
-      # @api private
-      def size
-        return if blank_value?
-
-        _validate(__method__) do |validator|
-          case validator
-          when Numeric, ->(v) { v.respond_to?(:to_int) }
-            value.size == validator.to_int
-          when Range
-            validator.include?(value.size)
-          else
-            raise ArgumentError.new("Size validator must be a number or a range, it was: #{ validator }")
-          end
-        end
-      end
-
-      # Validates nested Hanami 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?
-        @value.nil?
-      end
-
-      # Checks if the value is "blank".
-      #
-      # @see Hanami::Validations::BlankValueChecker
-      #
-      # @since 0.2.0
-      # @api private
-      def blank_value?
-        BlankValueChecker.new(@value).blank_value?
-      end
-
-      # Reads an attribute from the validator.
-      #
-      # @since 0.2.0
-      # @api private
-      def _attribute(name = @name)
-        @attributes[name.to_sym]
-      end
-
-      # Run a single validation and collects the results.
-      #
-      # @since 0.2.0
-      # @api private
-      def _validate(validation)
-        if (validator = @validations[validation]) && !(yield validator)
-          @errors.add(@name, Error.new(@name, validation, @validations.fetch(validation), @value))
-        end
-      end
-    end
-  end
-end