dry-validation 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3821e92d2dced61bb892e20a5e5d69b596128fcdbd05596e41fff8716767b08c
-  data.tar.gz: f797d5e46604e777966cb3d9a7a4032265227684164224a8ff109fc8ba51d1c1
+  metadata.gz: 46364c3c3ebe05837ab81f0406c1bbd6d0ad4f6359017dedc92f25627aae6bd4
+  data.tar.gz: eaefd86e8b6ce0eebd7140c8eae37f3b40eb7d85400b97cd3e7fa6cf58b8c8af
 SHA512:
-  metadata.gz: 7504498b77c794b9fe37e0384fba50a8fb6c99e3fecd3423e66fe018006288b3ba1a5a7a2232fb53dede256ba0a13630313748a0214b4a0d9865fc22c0b9edae
-  data.tar.gz: 654233d365e7844985f465e16335a234a2d5c2c240b97a485d286a52e6229e3ee80d8719e76d3ec95fe393d75f480617452b7813cb36b4b033021f9b98958461
+  metadata.gz: ea2bf0a1bf9d3c451f6d073a6edfcbd6e2b1e33c67a6fa94d3f0c0005155d81fccc6159c9a575dc1b2736a6a00abb094fbd8bb556007f7e980b278404b9e4ed1
+  data.tar.gz: be84af9fc46f27e28afc97d7b58dbdf6f031c978d9d94e75a4d2e795a9e0bace3e0db42261259559618291b4dbf637afd8ddeea4ad9f620271dbc7033c5fd212

data/CHANGELOG.md

@@ -1,3 +1,46 @@
+# v1.3.0 2019-08-14
+
+### Added
+
+* Support for setting an external schema (that can be extended too) (fixed #574) (@solnic)
+
+### Fixed
+
+* Using a hash spec to define rule keys with more than one value is properly handled by rule guard now (fixed #576) (@solnic)
+
+### Changed
+
+* `values` within rules uses `Hash#fetch_values` internally now, which improves performance (@esparta)
+
+[Compare v1.2.1...v1.3.0](https://github.com/dry-rb/dry-validation/compare/v1.2.1...v1.3.0)
+
+# v1.2.1 2019-07-16
+
+### Fixed
+
+* Defining an abstract contract class that has no schema no longer crashes (issue #565) (@solnic)
+* Fixed an issue where `Rule#each` would crash when the value is not an array (issue #567) (@solnic)
+* Fixed an issue where guarding a rule would crash when keys are missing in the input (issue #569) (@solnic)
+* Added missing "pathname" require (issue #570) (@solnic)
+
+[Compare v1.2.0...v1.2.1](https://github.com/dry-rb/dry-validation/compare/v1.2.0...v1.2.1)
+
+# v1.2.0 2019-07-08
+
+### Added
+
+* New extension `:predicates_as_macros` (@waiting-for-dev)
+
+### Fixed
+
+* Guarding rules for nested keys works correctly (issue #560) (@solnic)
+
+### Changed
+
+* `dry-schema` dependency was bumped to `>= 1.3.1` (@solnic)
+
+[Compare v1.1.1...v1.2.0](https://github.com/dry-rb/dry-validation/compare/v1.1.1...v1.2.0)
+
 # v1.1.1 2019-06-24
 
 ### Fixed

data/README.md

@@ -1,5 +1,5 @@
 [gem]: https://rubygems.org/gems/dry-validation
-[travis]: https://travis-ci.org/dry-rb/dry-validation
+[travis]: https://travis-ci.com/dry-rb/dry-validation
 [codeclimate]: https://codeclimate.com/github/dry-rb/dry-validation
 [chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-validation
@@ -7,7 +7,7 @@
 # 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]
+[![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]

data/lib/dry/validation.rb

@@ -23,6 +23,10 @@ module Dry
       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
     #
     # @example

data/lib/dry/validation/constants.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'pathname'
 require 'dry/core/constants'
 
 module Dry

data/lib/dry/validation/contract.rb

@@ -116,11 +116,26 @@ module Dry
       private
 
       # @api private
-      def error?(result, key)
-        path = Schema::Path[key]
+      def error?(result, spec)
+        path = Schema::Path[spec]
 
-        result.error?(path) ||
-          path.map.with_index { |_k, i| result.error?(path.keys[0..i - 2]) }.any?
+        if path.multi_value?
+          return path.expand.any? { |nested_path| error?(result, nested_path) }
+        end
+
+        return true if result.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)
+
+            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

@@ -7,34 +7,9 @@ require 'dry/schema/key_map'
 
 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
@@ -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_schema = nil, &block)
+          define(:Params, external_schema, &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_schema = nil, &block)
+          define(:JSON, external_schema, &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_schema = nil, &block)
+          define(:schema, external_schema, &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
@@ -179,12 +154,29 @@ 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 = Schema::KeyMap[*keys]
-            .map(&:dump)
-            .reject { |spec| valid_paths.any? { |path| path.include?(Schema::Path[spec]) } }
+          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)
 
           return if invalid_keys.empty?
 
@@ -192,6 +184,7 @@ 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_map
@@ -199,16 +192,22 @@ module Dry
         end
 
         # @api private
-        def schema_opts
+        def core_schema_opts
           { parent: superclass&.__schema__, config: config }
         end
 
         # @api private
-        def define(method_name, &block)
-          if defined?(@__schema__)
+        def define(method_name, external_schema, &block)
+          return __schema__ if 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_schema) if external_schema
+
           case method_name
           when :schema
             @__schema__ = Schema.define(schema_opts, &block)

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'dry/schema/predicate_registry'
+require 'dry/validation/contract'
+
+module Dry
+  module Validation
+    # Predicate registry with additional needed methods.
+    class PredicateRegistry < Schema::PredicateRegistry
+      # List of predicates to be imported by `:predicates_as_macros`
+      # extension.
+      #
+      # @see Dry::Validation::Contract
+      WHITELIST = %i[
+        filled? gt? gteq? included_in? includes? inclusion? is? lt?
+        lteq? max_size? min_size? not_eql? odd? respond_to? size? true?
+        uuid_v4?
+      ].freeze
+
+      # @api private
+      def arg_names(name)
+        arg_list(name).map(&:first)
+      end
+
+      # @api private
+      def call(name, args)
+        self[name].(*args)
+      end
+
+      # @api private
+      def message_opts(name, arg_values)
+        arg_names(name).zip(arg_values).to_h
+      end
+    end
+
+    # Extension to use dry-logic predicates as macros.
+    #
+    # @see Dry::Validation::PredicateRegistry::WHITELIST Available predicates
+    #
+    # @example
+    #   Dry::Validation.load_extensions(:predicates_as_macros)
+    #
+    #   class ApplicationContract < Dry::Validation::Contract
+    #     import_predicates_as_macros
+    #   end
+    #
+    #   class AgeContract < ApplicationContract
+    #     schema do
+    #       required(:age).filled(:integer)
+    #     end
+    #
+    #     rule(:age).validate(gteq?: 18)
+    #   end
+    #
+    #   AgeContract.new.(age: 17).errors.first.text
+    #   # => 'must be greater than or equal to 18'
+    #
+    # @api public
+    class Contract
+      # Make macros available for self and its descendants.
+      def self.import_predicates_as_macros
+        registry = PredicateRegistry.new
+
+        PredicateRegistry::WHITELIST.each do |name|
+          register_macro(name) do |macro:|
+            predicate_args = [*macro.args, value]
+            message_opts = registry.message_opts(name, predicate_args)
+
+            key.failure(name, message_opts) unless registry.(name, predicate_args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/validation/function.rb

@@ -19,21 +19,24 @@ module Dry
       #   @api private
       option :block
 
+      # @!attribute [r] block_options
+      #   @return [Hash]
+      #   @api private
+      option :block_options, default: -> { block ? map_keywords(block) : EMPTY_HASH }
+
       private
 
       # Extract options for the block kwargs
       #
-      # @return [Hash]
+      # @param [Proc] block Callable
+      # @return Hash
       #
       # @api private
-      def block_options
-        return EMPTY_HASH unless block
-
-        @block_options ||= block
+      def map_keywords(block)
+        block
           .parameters
-          .select { |arg| arg[0].equal?(:keyreq) }
-          .map(&:last)
-          .map { |name| [name, BLOCK_OPTIONS_MAPPINGS[name]] }
+          .select { |arg,| arg.equal?(:keyreq) }
+          .map { |_, name| [name, BLOCK_OPTIONS_MAPPINGS[name]] }
           .to_h
       end
     end

data/lib/dry/validation/result.rb

@@ -106,6 +106,22 @@ module Dry
         schema_result.error?(key)
       end
 
+      # Check if there's any error for the provided key
+      #
+      # This does not consider errors from the nested values
+      #
+      # @api private
+      def base_error?(key)
+        schema_result.errors.any? { |error|
+          key_path = Schema::Path[key]
+          err_path = Schema::Path[error.path]
+
+          return false unless key_path.same_root?(err_path)
+
+          key_path == err_path
+        }
+      end
+
       # Add a new error for the provided key
       #
       # @api private

data/lib/dry/validation/rule.rb

@@ -82,17 +82,21 @@ module Dry
         @keys = []
 
         @block = proc do
-          (values[root] || []).each_with_index do |_, idx|
-            path = [*Schema::Path[root].to_a, idx]
+          unless result.base_error?(root) || !values.key?(root)
+            values[root].each_with_index do |_, idx|
+              path = [*Schema::Path[root].to_a, idx]
 
-            next if result.error?(path)
+              next if result.error?(path)
 
-            evaluator = with(macros: macros, keys: [path], &block)
+              evaluator = with(macros: macros, keys: [path], &block)
 
-            failures.concat(evaluator.failures)
+              failures.concat(evaluator.failures)
+            end
           end
         end
 
+        @block_options = map_keywords(block) if block
+
         self
       end
 

data/lib/dry/validation/schema_ext.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'dry/schema/key'
+require 'dry/schema/key_map'
+
+module Dry
+  module Schema
+    class Path
+      # @api private
+      def multi_value?
+        last.is_a?(Array)
+      end
+
+      # @api private
+      def expand
+        to_a[0..-2].product(last).map { |spec| self.class[spec] }
+      end
+    end
+
+    # @api private
+    #
+    # TODO: this should be moved to dry-schema at some point
+    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
+end

data/lib/dry/validation/values.rb

@@ -45,15 +45,13 @@ module Dry
 
         case (key = args[0])
         when Symbol, String, Array, Hash
-          path = Schema::Path[key]
-          keys = path.to_a
+          keys = Schema::Path[key].to_a
 
           return data.dig(*keys) unless keys.last.is_a?(Array)
 
           last = keys.pop
           vals = self.class.new(data.dig(*keys))
-
-          last.map { |name| vals[name] }
+          vals.fetch_values(*last) { nil }
         else
           raise ArgumentError, '+key+ must be a valid path specification'
         end

data/lib/dry/validation/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Validation
-    VERSION = '1.1.1'
+    VERSION = '1.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-validation
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -95,7 +95,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -105,7 +105,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -168,6 +168,7 @@ files:
 - lib/dry/validation/evaluator.rb
 - lib/dry/validation/extensions/hints.rb
 - lib/dry/validation/extensions/monads.rb
+- lib/dry/validation/extensions/predicates_as_macros.rb
 - lib/dry/validation/failures.rb
 - lib/dry/validation/function.rb
 - lib/dry/validation/macro.rb
@@ -177,6 +178,7 @@ files:
 - lib/dry/validation/messages/resolver.rb
 - lib/dry/validation/result.rb
 - lib/dry/validation/rule.rb
+- lib/dry/validation/schema_ext.rb
 - lib/dry/validation/values.rb
 - lib/dry/validation/version.rb
 homepage: https://dry-rb.org/gems/dry-validation