dry-validation 1.3.1 → 1.8.1

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 dry-rb team
+Copyright (c) 2015-2021 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,29 +1,29 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-validation
-[travis]: https://travis-ci.com/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.com/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]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-validation.svg?branch=master)][inchpages]
+[![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=main)][inchpages]
 
 ## Links
 
 * [User documentation](https://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`
+* MRI `>= 2.7.0`
+* jruby `>= 9.3` (postponed until 2.7 is supported)
 
 ## License
 

data/dry-validation.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# this file is synced from dry-rb/template-gem 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/main/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.7.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.5", ">= 0.5"
+  spec.add_runtime_dependency "dry-initializer", "~> 3.0"
+  spec.add_runtime_dependency "dry-schema", "~> 1.8", ">= 1.8.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+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
@@ -11,7 +11,7 @@ module Dry
     #
     # @api public
     class Config < Schema::Config
-      setting :macros, Macros::Container.new, &:dup
+      setting :macros, default: Macros::Container.new, constructor: :dup.to_proc
 
       # @api private
       def dup

data/lib/dry/validation/constants.rb

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require 'pathname'
-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'
+    DEFAULT_ERRORS_NAMESPACE = "dry_validation"
 
     # Path to the default errors locale file
-    DEFAULT_ERRORS_PATH = Pathname(__FILE__).join('../../../../config/errors.yml').realpath.freeze
+    DEFAULT_ERRORS_PATH = Pathname(__FILE__).join("../../../../config/errors.yml").realpath.freeze
 
     # Mapping for block kwarg options used by block_options
     #

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

@@ -1,13 +1,13 @@
 # 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/schema_ext'
+require "dry/validation/constants"
+require "dry/validation/macros"
+require "dry/validation/schema_ext"
 
 module Dry
   module Validation
@@ -23,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
@@ -57,8 +57,8 @@ module Dry
         # @see https://dry-rb.org/gems/dry-schema/params/
         #
         # @api public
-        def params(external_schema = nil, &block)
-          define(:Params, external_schema, &block)
+        def params(*external_schemas, &block)
+          define(:Params, external_schemas, &block)
         end
 
         # Define a JSON schema for your contract
@@ -69,8 +69,8 @@ module Dry
         # @see https://dry-rb.org/gems/dry-schema/json/
         #
         # @api public
-        def json(external_schema = nil, &block)
-          define(:JSON, external_schema, &block)
+        def json(*external_schemas, &block)
+          define(:JSON, external_schemas, &block)
         end
 
         # Define a plain schema for your contract
@@ -81,8 +81,8 @@ module Dry
         # @see https://dry-rb.org/gems/dry-schema/
         #
         # @api public
-        def schema(external_schema = nil, &block)
-          define(:schema, external_schema, &block)
+        def schema(*external_schemas, &block)
+          define(:schema, external_schemas, &block)
         end
 
         # Define a rule for your contract
@@ -123,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
@@ -154,29 +154,17 @@ module Dry
         private
 
         # @api private
-        # rubocop:disable Metrics/AbcSize
         def ensure_valid_keys(*keys)
-          valid_paths = key_map.to_dot_notation.map { |value| Schema::Path[value] }
-
-          invalid_keys = keys
-            .map { |key|
-              [key, Schema::Path[key]]
-            }
-            .map { |(key, path)|
-              if (last = path.last).is_a?(Array)
-                last.map { |last_key|
-                  path_key = [*path.to_a[0..-2], last_key]
-                  [path_key, Schema::Path[path_key]]
-                }
-              else
-                [[key, path]]
-              end
-            }
-            .flatten(1)
-            .reject { |(_, path)|
-              valid_paths.any? { |valid_path| valid_path.include?(path) }
-            }
-            .map(&:first)
+          valid_paths = key_map.to_dot_notation
+          key_paths = key_paths(keys)
+
+          invalid_keys = key_paths.filter_map { |(key, path)|
+            if valid_paths.none? { |vp|
+                 vp == path || vp.start_with?("#{path}.", "#{path}[]")
+               }
+              key
+            end
+          }.uniq
 
           return if invalid_keys.empty?
 
@@ -184,7 +172,28 @@ module Dry
             #{name}.rule specifies keys that are not defined by the schema: #{invalid_keys.inspect}
           STR
         end
-        # rubocop:enable Metrics/AbcSize
+
+        # @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
@@ -193,28 +202,28 @@ module Dry
 
         # @api private
         def core_schema_opts
-          { parent: superclass&.__schema__, config: config }
+          {parent: superclass&.__schema__, config: config}
         end
 
         # @api private
-        def define(method_name, external_schema, &block)
-          return __schema__ if external_schema.nil? && block.nil?
+        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'
+            raise ::Dry::Validation::DuplicateSchemaError, "Schema has already been defined"
           end
 
           schema_opts = core_schema_opts
 
-          schema_opts.update(parent: external_schema) if external_schema
+          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/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/core/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
@@ -68,6 +68,11 @@ module Dry
       #   @api public
       option :macros, default: -> { config.macros }
 
+      # @!attribute [r] default_context
+      #   @return [Hash] Default context for rules
+      #   @api public
+      option :default_context, default: -> { EMPTY_HASH }
+
       # @!attribute [r] schema
       #   @return [Dry::Schema::Params, Dry::Schema::JSON, Dry::Schema::Processor]
       #   @api private
@@ -86,23 +91,31 @@ module Dry
       # Apply the contract to an input
       #
       # @param [Hash] input The input to validate
+      # @param [Hash] context Initial context for rules
       #
       # @return [Result]
       #
       # @api public
-      def call(input)
-        Result.new(schema.(input), Concurrent::Map.new) do |result|
+      # rubocop: disable Metrics/AbcSize
+      def call(input, context = EMPTY_HASH)
+        context_map = Concurrent::Map.new.tap do |map|
+          default_context.each { |key, value| map[key] = value }
+          context.each { |key, value| map[key] = value }
+        end
+
+        Result.new(schema.(input), context_map) do |result|
           rules.each do |rule|
             next if rule.keys.any? { |key| error?(result, key) }
 
             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
       end
+      # rubocop: enable Metrics/AbcSize
 
       # Return a nice string representation
       #
@@ -123,14 +136,14 @@ module Dry
           return path.expand.any? { |nested_path| error?(result, nested_path) }
         end
 
-        return true if result.error?(path)
+        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.error?(curr_path)
+            return false unless result.schema_error?(curr_path)
 
             result.errors.any? { |err|
               (other = Schema::Path[err.path]).same_root?(curr_path) && other == curr_path

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)
+          exec_opts = block_options.transform_values { _options[_1] }
+          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,7 +146,7 @@ module Dry
       #
       # @return [Object]
       #
-      # @public
+      # @api public
       def value
         values[key_name]
       end
@@ -151,27 +155,58 @@ module Dry
       #
       # This is useful when dealing with rules for optional keys
       #
-      # @example
+      # @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
+      #
       # @return [Boolean]
       #
       # @api public
-      def key?
-        values.key?(key_name)
+      def schema_error?(path)
+        result.schema_error?(path)
       end
 
-      # Check if there are any errors under the provided path
+      # Check if there are any errors on the current rule
+      #
+      # @param path [Symbol, String, Array] A Path-compatible spec
+      #
+      # @return [Boolean]
       #
-      # @param [Symbol, String, Array] A Path-compatible spec
+      # @api public
+      def rule_error?(path = nil)
+        if path.nil?
+          !key(self.path).empty?
+        else
+          result.rule_error?(path)
+        end
+      end
+
+      # Check if there are any base rule errors
       #
       # @return [Boolean]
       #
       # @api public
-      def error?(path)
-        result.error?(path)
+      def base_rule_error?
+        !base.empty? || result.base_rule_error?
       end
 
       # @api private
@@ -192,6 +227,7 @@ module Dry
           super
         end
       end
+      ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
     end
   end
 end

data/lib/dry/validation/extensions/hints.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
-
 module Dry
   module Validation
     # Hints extension
@@ -46,7 +44,7 @@ module Dry
         #
         # @api public
         def messages(new_options = EMPTY_HASH)
-          errors.with(hints.to_a, options.merge(**new_options))
+          errors.with(hints(new_options).to_a, options.merge(**new_options))
         end
 
         # Return hint messages

data/lib/dry/validation/extensions/monads.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
+require "dry/monads/result"
 
 module Dry
   module Validation

data/lib/dry/validation/extensions/predicates_as_macros.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/schema/predicate_registry'
-require 'dry/validation/contract'
+require "dry/schema/predicate_registry"
+require "dry/validation/contract"
 
 module Dry
   module Validation
@@ -12,7 +12,7 @@ module Dry
       #
       # @see Dry::Validation::Contract
       WHITELIST = %i[
-        filled? gt? gteq? included_in? includes? inclusion? is? lt?
+        filled? format? gt? gteq? included_in? includes? inclusion? is? lt?
         lteq? max_size? min_size? not_eql? odd? respond_to? size? true?
         uuid_v4?
       ].freeze

data/lib/dry/validation/failures.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/schema/path'
-require 'dry/validation/constants'
+require "dry/schema/path"
+require "dry/validation/constants"
 
 module Dry
   module Validation
@@ -45,14 +45,26 @@ module Dry
       #   @example
       #     failure(:taken)
       #
+      # @overload failure(meta_hash)
+      #   Use meta_hash[:text] as a message (either explicitely or as an identifier),
+      #   setting the rest of the hash as error meta attribute
+      #   @param meta [Hash] The hash containing the message as value for the :text key
+      #   @example
+      #     failure({text: :invalid, key: value})
+      #
       # @see Evaluator#key
       # @see Evaluator#base
       #
       # @api public
       def failure(message, tokens = EMPTY_HASH)
-        opts << { message: message, tokens: tokens, path: path }
+        opts << {message: message, tokens: tokens, path: path}
         self
       end
+
+      # @api private
+      def empty?
+        opts.empty?
+      end
     end
   end
 end

data/lib/dry/validation/function.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/initializer'
-require 'dry/validation/constants'
+require "dry/initializer"
+require "dry/validation/constants"
 
 module Dry
   module Validation
@@ -36,8 +36,7 @@ module Dry
         block
           .parameters
           .select { |arg,| arg.equal?(:keyreq) }
-          .map { |_, name| [name, BLOCK_OPTIONS_MAPPINGS[name]] }
-          .to_h
+          .to_h { [_2, BLOCK_OPTIONS_MAPPINGS[_2]] }
       end
     end
   end

data/lib/dry/validation/macro.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/validation/constants'
-require 'dry/validation/function'
+require "dry/validation/constants"
+require "dry/validation/function"
 
 module Dry
   module Validation
@@ -31,7 +31,7 @@ module Dry
 
       # @api private
       def extract_block_options(options)
-        block_options.map { |key, value| [key, options[value]] }.to_h
+        block_options.transform_values { options[_1] }
       end
     end
   end