dry-validation 1.0.0 → 1.5.6

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 dry-rb team
+Copyright (c) 2015-2020 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,26 +1,25 @@
 [gem]: https://rubygems.org/gems/dry-validation
-[travis]: https://travis-ci.org/dry-rb/dry-validation
-[codeclimate]: https://codeclimate.com/github/dry-rb/dry-validation
+[actions]: https://github.com/dry-rb/dry-validation/actions
+[codacy]: https://www.codacy.com/gh/dry-rb/dry-validation
 [chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-validation
 
 # dry-validation [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-validation.svg)][gem]
-[![Build Status](https://travis-ci.org/dry-rb/dry-validation.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/dry-rb/dry-validation/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/dry-rb/dry-validation/badges/coverage.svg)][codeclimate]
+[![CI Status](https://github.com/dry-rb/dry-validation/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f30e3ff5ec304c55a73868cdbf055c67)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/f30e3ff5ec304c55a73868cdbf055c67)][codacy]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-validation.svg?branch=master)][inchpages]
 
 ## Links
 
-* [User documentation](https://dry-rb.org/gems/dry-validation)
+* [User documentation](http://dry-rb.org/gems/dry-validation)
 * [API documentation](http://rubydoc.info/gems/dry-validation)
-* [Guidelines for contributing](CONTRIBUTING.md)
 
 ## Supported Ruby versions
 
-This library officially supports following Ruby versions:
+This library officially supports the following Ruby versions:
 
 * MRI >= `2.4`
 * jruby >= `9.2`

data/dry-validation.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# this file is managed by dry-rb/devtools project
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-validation'
+  spec.authors       = ["Piotr Solnica"]
+  spec.email         = ["piotr.solnica@gmail.com"]
+  spec.license       = 'MIT'
+  spec.version       = Dry::Validation::VERSION.dup
+
+  spec.summary       = "Validation library"
+  spec.description   = spec.summary
+  spec.homepage      = 'https://dry-rb.org/gems/dry-validation'
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-validation.gemspec", "lib/**/*", "config/*.yml"]
+  spec.bindir        = 'bin'
+  spec.executables   = []
+  spec.require_paths = ['lib']
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-validation/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-validation'
+  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-validation/issues'
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # to update dependencies edit project.yml
+  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_runtime_dependency "dry-container", "~> 0.7", ">= 0.7.1"
+  spec.add_runtime_dependency "dry-core", "~> 0.4"
+  spec.add_runtime_dependency "dry-equalizer", "~> 0.2"
+  spec.add_runtime_dependency "dry-initializer", "~> 3.0"
+  spec.add_runtime_dependency "dry-schema", "~> 1.5", ">= 1.5.2"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/dry-validation.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'dry/validation'
+require "dry/validation"

data/lib/dry/validation.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'dry/validation/constants'
-require 'dry/validation/contract'
-require 'dry/validation/macros'
+require "dry/validation/constants"
+require "dry/validation/contract"
+require "dry/validation/macros"
 
 # Main namespace
 #
@@ -16,11 +16,15 @@ module Dry
     extend Macros::Registrar
 
     register_extension(:monads) do
-      require 'dry/validation/extensions/monads'
+      require "dry/validation/extensions/monads"
     end
 
     register_extension(:hints) do
-      require 'dry/validation/extensions/hints'
+      require "dry/validation/extensions/hints"
+    end
+
+    register_extension(:predicates_as_macros) do
+      require "dry/validation/extensions/predicates_as_macros"
     end
 
     # Define a contract and build its instance
@@ -41,6 +45,7 @@ module Dry
     # @return [Contract]
     #
     # @api public
+    #
     def self.Contract(options = EMPTY_HASH, &block)
       Contract.build(options, &block)
     end

data/lib/dry/validation/config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/schema/config'
-require 'dry/validation/macros'
+require "dry/schema/config"
+require "dry/validation/macros"
 
 module Dry
   module Validation

data/lib/dry/validation/constants.rb

@@ -1,16 +1,23 @@
 # frozen_string_literal: true
 
-require 'dry/core/constants'
+require "pathname"
+require "dry/core/constants"
 
 module Dry
   module Validation
     include Dry::Core::Constants
 
-    DOT = '.'
+    DOT = "."
 
     # Root path is used for base errors in hash representation of error messages
     ROOT_PATH = [nil].freeze
 
+    # Path to the default errors locale file
+    DEFAULT_ERRORS_NAMESPACE = "dry_validation"
+
+    # Path to the default errors locale file
+    DEFAULT_ERRORS_PATH = Pathname(__FILE__).join("../../../../config/errors.yml").realpath.freeze
+
     # Mapping for block kwarg options used by block_options
     #
     # @see Rule#block_options

data/lib/dry/validation/contract.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
+require "concurrent/map"
 
-require 'dry/equalizer'
-require 'dry/initializer'
-require 'dry/schema/path'
+require "dry/equalizer"
+require "dry/initializer"
+require "dry/schema/path"
 
-require 'dry/validation/config'
-require 'dry/validation/constants'
-require 'dry/validation/rule'
-require 'dry/validation/evaluator'
-require 'dry/validation/messages/resolver'
-require 'dry/validation/result'
-require 'dry/validation/contract/class_interface'
+require "dry/validation/config"
+require "dry/validation/constants"
+require "dry/validation/rule"
+require "dry/validation/evaluator"
+require "dry/validation/messages/resolver"
+require "dry/validation/result"
+require "dry/validation/contract/class_interface"
 
 module Dry
   module Validation
@@ -54,8 +54,8 @@ module Dry
       extend Dry::Initializer
       extend ClassInterface
 
-      config.messages.top_namespace = 'dry_validation'
-      config.messages.load_paths << Pathname(__FILE__).join('../../../../config/errors.yml').realpath
+      config.messages.top_namespace = DEFAULT_ERRORS_NAMESPACE
+      config.messages.load_paths << DEFAULT_ERRORS_PATH
 
       # @!attribute [r] config
       #   @return [Config] Contract's configuration object
@@ -98,7 +98,7 @@ module Dry
             rule_result = rule.(self, result)
 
             rule_result.failures.each do |failure|
-              result.add_error(message_resolver[failure])
+              result.add_error(message_resolver.(**failure))
             end
           end
         end
@@ -116,9 +116,26 @@ module Dry
       private
 
       # @api private
-      def error?(result, key)
-        path = Schema::Path[key]
-        result.error?(path) || path.map.with_index { |_k, i| result.error?(path.keys[0..i - 2]) }.any?
+      def error?(result, spec)
+        path = Schema::Path[spec]
+
+        if path.multi_value?
+          return path.expand.any? { |nested_path| error?(result, nested_path) }
+        end
+
+        return true if result.schema_error?(path)
+
+        path
+          .to_a[0..-2]
+          .any? { |key|
+            curr_path = Schema::Path[path.keys[0..path.keys.index(key)]]
+
+            return false unless result.schema_error?(curr_path)
+
+            result.errors.any? { |err|
+              (other = Schema::Path[err.path]).same_root?(curr_path) && other == curr_path
+            }
+          }
       end
 
       # Get a registered macro

data/lib/dry/validation/contract/class_interface.rb

@@ -1,40 +1,15 @@
 # frozen_string_literal: true
 
-require 'dry/schema'
-require 'dry/schema/messages'
-require 'dry/schema/path'
-require 'dry/schema/key_map'
+require "dry/schema"
+require "dry/schema/messages"
+require "dry/schema/path"
+require "dry/schema/key_map"
 
-require 'dry/validation/constants'
-require 'dry/validation/macros'
+require "dry/validation/constants"
+require "dry/validation/macros"
+require "dry/validation/schema_ext"
 
 module Dry
-  module Schema
-    # @api private
-    class Key
-      # @api private
-      def to_dot_notation
-        [name.to_s]
-      end
-
-      # @api private
-      class Hash < Key
-        # @api private
-        def to_dot_notation
-          [name].product(members.map(&:to_dot_notation).flatten(1)).map { |e| e.join(DOT) }
-        end
-      end
-    end
-
-    # @api private
-    class KeyMap
-      # @api private
-      def to_dot_notation
-        @to_dot_notation ||= map(&:to_dot_notation).flatten
-      end
-    end
-  end
-
   module Validation
     class Contract
       # Contract's class interface
@@ -48,7 +23,7 @@ module Dry
         # @api private
         def inherited(klass)
           super
-          klass.instance_variable_set('@config', config.dup)
+          klass.instance_variable_set("@config", config.dup)
         end
 
         # Configuration
@@ -78,36 +53,36 @@ module Dry
         #
         # This type of schema is suitable for HTTP parameters
         #
-        # @return [Dry::Schema::Params]
+        # @return [Dry::Schema::Params,NilClass]
         # @see https://dry-rb.org/gems/dry-schema/params/
         #
         # @api public
-        def params(&block)
-          define(:Params, &block)
+        def params(*external_schemas, &block)
+          define(:Params, external_schemas, &block)
         end
 
         # Define a JSON schema for your contract
         #
         # This type of schema is suitable for JSON data
         #
-        # @return [Dry::Schema::JSON]
+        # @return [Dry::Schema::JSON,NilClass]
         # @see https://dry-rb.org/gems/dry-schema/json/
         #
         # @api public
-        def json(&block)
-          define(:JSON, &block)
+        def json(*external_schemas, &block)
+          define(:JSON, external_schemas, &block)
         end
 
         # Define a plain schema for your contract
         #
         # This type of schema does not offer coercion out of the box
         #
-        # @return [Dry::Schema::Processor]
+        # @return [Dry::Schema::Processor,NilClass]
         # @see https://dry-rb.org/gems/dry-schema/
         #
         # @api public
-        def schema(&block)
-          define(:schema, &block)
+        def schema(*external_schemas, &block)
+          define(:schema, external_schemas, &block)
         end
 
         # Define a rule for your contract
@@ -126,7 +101,7 @@ module Dry
         #
         # @api public
         def rule(*keys, &block)
-          ensure_valid_keys(*keys)
+          ensure_valid_keys(*keys) if __schema__
 
           Rule.new(keys: keys, block: block).tap do |rule|
             rules << rule
@@ -148,7 +123,7 @@ module Dry
         #
         # @api public
         def build(options = EMPTY_HASH, &block)
-          Class.new(self, &block).new(options)
+          Class.new(self, &block).new(**options)
         end
 
         # @api private
@@ -180,11 +155,14 @@ module Dry
 
         # @api private
         def ensure_valid_keys(*keys)
-          valid_paths = key_map.to_dot_notation.map { |value| Schema::Path[value] }
+          valid_paths = key_map.to_dot_notation
+          key_paths = key_paths(keys)
 
-          invalid_keys = Schema::KeyMap[*keys]
-            .map(&:dump)
-            .reject { |spec| valid_paths.any? { |path| path.include?(Schema::Path[spec]) } }
+          invalid_keys = key_paths.map { |(key, path)|
+            unless valid_paths.any? { |vp| vp.include?(path) || vp.include?("#{path}[]") }
+              key
+            end
+          }.compact.uniq
 
           return if invalid_keys.empty?
 
@@ -193,29 +171,57 @@ module Dry
           STR
         end
 
+        # @api private
+        def key_paths(keys)
+          keys.map { |key|
+            case key
+            when Hash
+              path = Schema::Path[key]
+              if path.multi_value?
+                *head, tail = Array(path)
+                [key].product(
+                  tail.map { |el| [*head, *el] }.map { |parts| parts.join(DOT) }
+                )
+              else
+                [[key, path.to_a.join(DOT)]]
+              end
+            when Array
+              [[key, Schema::Path[key].to_a.join(DOT)]]
+            else
+              [[key, key.to_s]]
+            end
+          }.flatten(1)
+        end
+
         # @api private
         def key_map
           __schema__.key_map
         end
 
         # @api private
-        def schema_opts
-          { parent: superclass&.__schema__, config: config }
+        def core_schema_opts
+          {parent: superclass&.__schema__, config: config}
         end
 
         # @api private
-        def define(method_name, &block)
-          if defined?(@__schema__)
-            raise ::Dry::Validation::DuplicateSchemaError, 'Schema has already been defined'
+        def define(method_name, external_schemas, &block)
+          return __schema__ if external_schemas.empty? && block.nil?
+
+          unless __schema__.nil?
+            raise ::Dry::Validation::DuplicateSchemaError, "Schema has already been defined"
           end
 
+          schema_opts = core_schema_opts
+
+          schema_opts.update(parent: external_schemas) if external_schemas.any?
+
           case method_name
           when :schema
-            @__schema__ = Schema.define(schema_opts, &block)
+            @__schema__ = Schema.define(**schema_opts, &block)
           when :Params
-            @__schema__ = Schema.Params(schema_opts, &block)
+            @__schema__ = Schema.Params(**schema_opts, &block)
           when :JSON
-            @__schema__ = Schema.JSON(schema_opts, &block)
+            @__schema__ = Schema.JSON(**schema_opts, &block)
           end
         end
       end

data/lib/dry/validation/evaluator.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'dry/initializer'
+require "dry/initializer"
+require "dry/core/deprecations"
 
-require 'dry/validation/constants'
-require 'dry/validation/failures'
+require "dry/validation/constants"
+require "dry/validation/failures"
 
 module Dry
   module Validation
@@ -16,6 +17,9 @@ module Dry
     # @api public
     class Evaluator
       extend Dry::Initializer
+      extend Dry::Core::Deprecations[:'dry-validation']
+
+      deprecate :error?, :schema_error?
 
       # @!attribute [r] _contract
       #   @return [Contract]
@@ -63,19 +67,19 @@ module Dry
       # Initialize a new evaluator
       #
       # @api private
-      def initialize(contract, options, &block)
-        super(contract, options)
+      def initialize(contract, **options, &block)
+        super(contract, **options)
 
         @_options = options
 
         if block
           exec_opts = block_options.map { |key, value| [key, _options[value]] }.to_h
-          instance_exec(exec_opts, &block)
+          instance_exec(**exec_opts, &block)
         end
 
         macros.each do |args|
           macro = macro(*args.flatten(1))
-          instance_exec(macro.extract_block_options(_options.merge(macro: macro)), &macro.block)
+          instance_exec(**macro.extract_block_options(_options.merge(macro: macro)), &macro.block)
         end
       end
 
@@ -117,7 +121,7 @@ module Dry
 
       # @api private
       def with(new_opts, &block)
-        self.class.new(_contract, _options.merge(new_opts), &block)
+        self.class.new(_contract, **_options, **new_opts, &block)
       end
 
       # Return default (first) key name
@@ -142,20 +146,52 @@ module Dry
       #
       # @return [Object]
       #
-      # @public
+      # @api public
       def value
         values[key_name]
       end
 
-      # Check if there are any errors under the provided path
+      # Return if the value under the default key is available
+      #
+      # This is useful when dealing with rules for optional keys
+      #
+      # @example use the default key name
+      #   rule(:age) do
+      #     key.failure(:invalid) if key? && value < 18
+      #   end
+      #
+      # @example specify the key name
+      #   rule(:start_date, :end_date) do
+      #     if key?(:start_date) && !key?(:end_date)
+      #       key(:end_date).failure("must provide an end_date with start_date")
+      #     end
+      #   end
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def key?(name = key_name)
+        values.key?(name)
+      end
+
+      # Check if there are any errors on the schema under the provided path
+      #
+      # @param path [Symbol, String, Array] A Path-compatible spec
       #
-      # @param [Symbol, String, Array] A Path-compatible spec
+      # @return [Boolean]
+      #
+      # @api public
+      def schema_error?(path)
+        result.schema_error?(path)
+      end
+
+      # Check if there are any errors on the current rule
       #
       # @return [Boolean]
       #
       # @api public
-      def error?(path)
-        result.error?(path)
+      def rule_error?
+        !key(path).empty?
       end
 
       # @api private
@@ -176,6 +212,7 @@ module Dry
           super
         end
       end
+      ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
     end
   end
 end