hanami-validations 1.3.6 → 2.0.0.alpha1

data/hanami-validations.gemspec

@@ -1,28 +1,28 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hanami/validations/version'
+require "hanami/validations/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'hanami-validations'
+  spec.name          = "hanami-validations"
   spec.version       = Hanami::Validations::VERSION
-  spec.authors       = ['Luca Guidi']
-  spec.email         = ['me@lucaguidi.com']
-  spec.summary       = 'Validations mixin for Ruby objects'
-  spec.description   = 'Validations mixin for Ruby objects and support for Hanami'
-  spec.homepage      = 'http://hanamirb.org'
-  spec.license       = 'MIT'
+  spec.authors       = ["Luca Guidi"]
+  spec.email         = ["me@lucaguidi.com"]
+  spec.summary       = "Validations mixin for Ruby objects"
+  spec.description   = "Validations mixin for Ruby objects and support for Hanami"
+  spec.homepage      = "http://hanamirb.org"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -- lib/* LICENSE.md README.md CHANGELOG.md hanami-validations.gemspec`.split($INPUT_RECORD_SEPARATOR)
   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.3.0'
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_dependency 'hanami-utils',   '~> 1.3'
-  spec.add_dependency 'dry-validation', '~> 0.11', '< 0.12'
-  spec.add_dependency 'dry-logic',      '~> 0.4.2', '< 0.5'
+  spec.add_dependency "dry-validation", "~> 1.0"
 
-  spec.add_development_dependency 'bundler', '>= 1.6', '< 3'
-  spec.add_development_dependency 'rake',    '~> 13'
-  spec.add_development_dependency 'rspec',   '~> 3.7'
+  spec.add_development_dependency "bundler", ">= 1.6", "< 3"
+  spec.add_development_dependency "rake",    "~> 12"
+  spec.add_development_dependency "rspec",   "~> 3.7"
 end

data/lib/hanami/validations.rb

@@ -1,63 +1,34 @@
-require 'dry-validation'
-require 'hanami/utils/class_attribute'
-require 'hanami/validations/namespace'
-require 'hanami/validations/predicates'
-require 'hanami/validations/inline_predicate'
-require 'set'
+# frozen_string_literal: true
 
-Dry::Validation::Messages::Namespaced.configure do |config|
-  # rubocop:disable Lint/NestedPercentLiteral
-  #
-  # This is probably a false positive.
-  # See: https://github.com/bbatsov/rubocop/issues/5314
-  config.lookup_paths = config.lookup_paths + %w[
-    %<root>s.%<rule>s.%<predicate>s
-  ].freeze
-  # rubocop:enable Lint/NestedPercentLiteral
-end
+require "dry/validation"
+require "delegate"
 
-# @since 0.1.0
 module Hanami
-  # Hanami::Validations is a set of lightweight validations for Ruby objects.
-  #
   # @since 0.1.0
-  #
-  # @example
-  #   require 'hanami/validations'
-  #
-  #   class Signup
-  #     include Hanami::Validations
-  #
-  #     validations do
-  #       # ...
-  #     end
-  #   end
   module Validations
-    # @since 0.6.0
-    # @api private
-    DEFAULT_MESSAGES_ENGINE = :yaml
+    class Error < StandardError; end
 
-    # Override Ruby's hook for modules.
-    #
-    # @param base [Class] the target action
-    #
-    # @since 0.1.0
-    # @api private
-    #
-    # @see http://www.ruby-doc.org/core/Module.html#method-i-included
-    def self.included(base) # rubocop:disable Metrics/MethodLength
-      base.class_eval do
-        extend ClassMethods
+    require "hanami/validations/version"
+    require "hanami/validator"
 
-        include Utils::ClassAttribute
-        class_attribute :schema
-        class_attribute :_messages
-        class_attribute :_messages_path
-        class_attribute :_namespace
-        class_attribute :_predicates_module
+    def self.included(klass)
+      super
+      klass.extend(ClassMethods)
+    end
 
-        class_attribute :_predicates
-        self._predicates = Set.new
+    # @since 2.0.0
+    # @api private
+    class Result < SimpleDelegator
+      # @since 2.0.0
+      # @api private
+      def output
+        __getobj__.to_h
+      end
+
+      # @since 2.0.0
+      # @api private
+      def messages
+        __getobj__.errors.to_h
       end
     end
 
@@ -74,13 +45,13 @@ module Hanami
       # @see https://guides.hanamirb.org/validations/overview
       #
       # @example Basic Example
-      #   require 'hanami/validations'
+      #   require "hanami/validations"
       #
       #   class Signup
       #     include Hanami::Validations
       #
       #     validations do
-      #       required(:name).filled
+      #       required(:name).filled(:string)
       #     end
       #   end
       #
@@ -95,261 +66,14 @@ module Hanami
       #   result.success? # => false
       #   result.messages # => {:name=>["must be filled"]}
       #   result.output   # => {:name=>""}
-      def validations(&blk) # rubocop:disable Metrics/AbcSize
-        schema_predicates = _predicates_module || __predicates
-
-        base   = _build(predicates: schema_predicates, &_base_rules)
-        schema = _build(predicates: schema_predicates, rules: base.rules, &blk)
-        schema.configure(&_schema_config)
-        schema.configure(&_schema_predicates)
-        schema.extend(__messages) unless _predicates.empty?
-
-        self.schema = schema.new
-      end
-
-      # Define an inline predicate
-      #
-      # @param name [Symbol] inline predicate name
-      # @param message [String] optional error message
-      # @param blk [Proc] predicate implementation
-      #
-      # @return nil
-      #
-      # @since 0.6.0
-      #
-      # @example Without Custom Message
-      #   require 'hanami/validations'
-      #
-      #   class Signup
-      #     include Hanami::Validations
-      #
-      #     predicate :foo? do |actual|
-      #       actual == 'foo'
-      #     end
-      #
-      #     validations do
-      #       required(:name).filled(:foo?)
-      #     end
-      #   end
-      #
-      #   result = Signup.new(name: nil).call
-      #   result.messages # => { :name => ['is invalid'] }
-      #
-      # @example With Custom Message
-      #   require 'hanami/validations'
-      #
-      #   class Signup
-      #     include Hanami::Validations
-      #
-      #     predicate :foo?, message: 'must be foo' do |actual|
-      #       actual == 'foo'
-      #     end
-      #
-      #     validations do
-      #       required(:name).filled(:foo?)
-      #     end
-      #   end
-      #
-      #   result = Signup.new(name: nil).call
-      #   result.messages # => { :name => ['must be foo'] }
-      def predicate(name, message: 'is invalid', &blk)
-        _predicates << InlinePredicate.new(name, message, &blk)
+      def validations(&blk)
+        @_validator = Dry::Validation::Contract.build { schema(&blk) }
       end
 
-      # Assign a set of shared predicates wrapped in a module
-      #
-      # @param mod [Module] a module with shared predicates
-      #
-      # @since 0.6.0
-      #
-      # @see Hanami::Validations::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
-      def predicates(mod)
-        self._predicates_module = mod
-      end
-
-      # Define the type of engine for error messages.
-      #
-      # Accepted values are `:yaml` (default), `:i18n`.
-      #
-      # @param type [Symbol] the preferred engine
-      #
-      # @since 0.6.0
-      #
-      # @example
-      #   require 'hanami/validations'
-      #
-      #   class Signup
-      #     include Hanami::Validations
-      #
-      #     messages :i18n
-      #   end
-      def messages(type)
-        self._messages = type
-      end
-
-      # Define the path where to find translation file
-      #
-      # @param path [String] path to translation file
-      #
-      # @since 0.6.0
-      #
-      # @example
-      #   require 'hanami/validations'
-      #
-      #   class Signup
-      #     include Hanami::Validations
-      #
-      #     messages_path 'config/messages.yml'
-      #   end
-      def messages_path(path)
-        self._messages_path = path
-      end
-
-      # Namespace for error messages.
-      #
-      # @param name [String] namespace
-      #
-      # @since 0.6.0
-      #
-      # @example
-      #   require 'hanami/validations'
-      #
-      #   module MyApp
-      #     module Validators
-      #       class Signup
-      #         include Hanami::Validations
-      #
-      #         namespace 'signup'
-      #       end
-      #     end
-      #   end
-      #
-      #   # Instead of looking for error messages under the `my_app.validator.signup`
-      #   # namespace, it will look just for `signup`.
-      #   #
-      #   # This helps to simplify YAML files where are stored error messages
-      def namespace(name = nil)
-        if name.nil?
-          Namespace.new(_namespace, self)
-        else
-          self._namespace = name.to_s
-        end
-      end
-
-      private
-
-      # @since 0.6.0
+      # @since 2.0.0
       # @api private
-      def _build(options = {}, &blk)
-        options = { build: false }.merge(options)
-        Dry::Validation.__send__(_schema_type, options, &blk)
-      end
-
-      # @since 0.6.0
-      # @api private
-      def _schema_type
-        :Schema
-      end
-
-      # @since 0.6.0
-      # @api private
-      def _base_rules
-        lambda do
-        end
-      end
-
-      # @since 0.6.0
-      # @api private
-      def _schema_config
-        lambda do |config|
-          config.messages      = _messages      unless _messages.nil?
-          config.messages_file = _messages_path unless _messages_path.nil?
-          config.namespace     = namespace
-
-          require "dry/validation/messages/i18n" if config.messages == :i18n
-        end
-      end
-
-      # @since 0.6.0
-      # @api private
-      def _schema_predicates # rubocop:disable Metrics/CyclomaticComplexity
-        return if _predicates_module.nil? && _predicates.empty?
-
-        lambda do |config|
-          config.messages      = _predicates_module&.messages || @_messages || DEFAULT_MESSAGES_ENGINE
-          config.messages_file = _predicates_module.messages_path unless _predicates_module.nil?
-
-          require "dry/validation/messages/i18n" if config.messages == :i18n
-        end
-      end
-
-      # @since 0.6.0
-      # @api private
-      def __predicates
-        mod = Module.new { include Hanami::Validations::Predicates }
-
-        _predicates.each do |p|
-          mod.module_eval do
-            predicate(p.name, &p.to_proc)
-          end
-        end
-
-        mod
-      end
-
-      # @since 0.6.0
-      # @api private
-      def __messages # rubocop:disable Metrics/MethodLength
-        result = _predicates.each_with_object({}) do |p, ret|
-          ret[p.name] = p.message
-        end
-
-        # @api private
-        Module.new do
-          @@__messages = result # rubocop:disable Style/ClassVars
-
-          # @api private
-          def self.extended(base)
-            base.instance_eval do
-              def __messages
-                Hash[en: { errors: @@__messages }]
-              end
-            end
-          end
-
-          # @api private
-          def messages
-            engine = super
-
-            messages = if engine.respond_to?(:merge)
-                         engine
-                       else
-                         engine.messages
-                       end
-
-            config.messages == :i18n ? messages : messages.merge(__messages)
-          end
-        end
+      def _validator
+        @_validator
       end
     end
 
@@ -358,17 +82,19 @@ module Hanami
     # @param input [#to_h] a set of input data
     #
     # @since 0.6.0
-    def initialize(input = {})
-      @input = input.to_h
+    def initialize(input)
+      @input = input
     end
 
     # Validates the object.
     #
-    # @return [Dry::Validations::Result]
+    # @return [Hanami::Validations::Result]
     #
     # @since 0.2.4
     def validate
-      self.class.schema.call(@input)
+      Result.new(
+        self.class._validator.call(@input)
+      )
     end
 
     # Returns a Hash with the defined attributes as symbolized keys, and their
@@ -378,7 +104,7 @@ module Hanami
     #
     # @since 0.1.0
     def to_h
-      validate.output
+      validate.to_h
     end
   end
 end

data/lib/hanami/validations/form.rb

@@ -1,4 +1,4 @@
-require 'hanami/validations'
+# frozen_string_literal: true
 
 module Hanami
   module Validations
@@ -10,57 +10,65 @@ module Hanami
     # @since 0.6.0
     #
     # @example
-    #   require 'hanami/validations/form'
+    #   require "hanami/validations/form"
     #
     #   class Signup
     #     include Hanami::Validations::Form
     #
     #     validations do
-    #       required(:name).filled(:str?)
-    #       optional(:location).filled(:str?)
+    #       required(:name).filled(:string)
+    #       optional(:location).filled(:string)
     #     end
     #   end
     #
-    #   result = Signup.new('location' => 'Rome').validate
+    #   result = Signup.new("location" => "Rome").validate
     #   result.success? # => false
     #
-    #   result = Signup.new('name' => 'Luca').validate
+    #   result = Signup.new("name" => "Luca").validate
     #   result.success? # => true
     #
     #   # it works with symbol keys too
-    #   result = Signup.new(location: 'Rome').validate
+    #   result = Signup.new(location: "Rome").validate
     #   result.success? # => false
     #
-    #   result = Signup.new(name: 'Luca').validate
+    #   result = Signup.new(name: "Luca").validate
     #   result.success? # => true
     #
-    #   result = Signup.new(name: 'Luca', location: 'Rome').validate
+    #   result = Signup.new(name: "Luca", location: "Rome").validate
     #   result.success? # => true
     module Form
+      # @since 2.0.0
+      # @api private
+      class BaseValidator < Dry::Validation::Contract
+        params do
+          optional(:_csrf_token).filled(:string)
+        end
+      end
+
       # Override Ruby's hook for modules.
       #
-      # @param base [Class] the target action
+      # @param klass [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
+      def self.included(klass)
+        super
+
+        klass.class_eval do
+          include ::Hanami::Validations
+          extend ClassMethods
         end
       end
 
       # @since 0.6.0
       # @api private
       module ClassMethods
-        private
-
-        # @since 0.6.0
+        # @since 2.0.0
         # @api private
-        def _schema_type
-          :Form
+        def validations(&blk)
+          @_validator = Class.new(BaseValidator) { params(&blk) }.new
         end
       end
     end