dry-schema 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286fc26d17ad546acf8370b4fdba754c85f495a0d6dd8da0c4ce564066c30859
-  data.tar.gz: b6f080291da562eca2e1e4407e9fc079062b45a12c7d24739137b5e7502be429
+  metadata.gz: 377172612c5f08c6325b7d71c749296505cbb3811894496da15ee5ed1aa1b69a
+  data.tar.gz: 8b55f71218c418f073b8daf84a64a8d31aa02035908c7cd301df2780f5a2c2c0
 SHA512:
-  metadata.gz: 340ac4d40469019131a1bc3ff0284b95ee7d83b151b013cc91ded5eb1629cc35ab535ac7e3c8a3dc70033e955ec91629df8ed18b89b44f9cacb50c4c1231f283
-  data.tar.gz: 4847c4e9ee2d9fa28051d6ec0a160415505e3f7475c95ef550cca927ed9b59f78da4be4333064a9e750a395cb497e09d36f9e70e44333e46850506f6365ba82e
+  metadata.gz: 07152d8d51f7f93dff3409b7c14b89f6a374158ed3ecc5d22dc2103a579b653c6ba085f6ec8b9464bcc406b1c123a669a4112b2b3d541b644cdaf65492ccb5a3
+  data.tar.gz: dc9e7d840f6c40436d3234698c5ce5d04e23952678ffb36694e715dcbc9e455b1a0efb4a81919a9f01c7d0ebfe4f37dd88f611b04e1d4e7b1c576f84f5ffba1d

data/CHANGELOG.md

@@ -1,5 +1,58 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 1.7.1 2021-08-29
+
+
+### Changed
+
+- [internal] Use explicit `#to_h` conversion of Dry::Configurable::Config, to ensure compatibility with upcoming dry-configurable 0.13.0 release (via #371) (@timriley)
+
+[Compare v1.7.0...v1.7.1](https://github.com/dry-rb/dry-schema/compare/v1.7.0...v1.7.1)
+
+## 1.7.0 2021-06-29
+
+This release ships with a bunch of internal refactorings that should improve performance but if you see any unexpected behavior please do report issues.
+
+### Fixed
+
+- Handle arrays of hashes where Array constructor coerces non-Hash input (#351 fixed via #354) (@ojab)
+- Run outer schema processor steps before inner ones (issue #350 fixed via #361) (@ojab)
+- Fix key validator false negatives on empty collections (see #363) (@Drenmi)
+- Prevent error message YAML files from being parsed multiple times (issue #352 via #364) (@alassek)
+- Using constructor types should work fine now ie `required(:foo).filled(Types::Params::Integer.constructor(&:succ))` (issue #280 fixed via #365) (@solnic)
+- Handle non-Hash to Hash transformation in `before(:key_coercer)` (issue #350 fixed via #362) (@ojab)
+
+### Changed
+
+- [internal] `Dry::Schema::Path` clean up and performance improvements (via #358) (@ojab)
+- [internal] simplify and speed up handling of steps in nested schemas (via #360) (@ojab)
+
+[Compare v1.6.2...v1.7.0](https://github.com/dry-rb/dry-schema/compare/v1.6.2...v1.7.0)
+
+## 1.6.2 2021-04-15
+
+
+### Added
+
+- A default error message for `respond_to?` predicate (@rindek)
+
+### Fixed
+
+- Using `respond_to?` predicate in blocks works now (@rindek)
+
+
+[Compare v1.6.1...v1.6.2](https://github.com/dry-rb/dry-schema/compare/v1.6.1...v1.6.2)
+
+## 1.6.1 2021-02-02
+
+
+### Fixed
+
+- Messages#[] handles meta/no meta cases more gracefully and has better interoperability with the I18n backend. This brings MessageCompiler#visit_unexpected_key up to parity with MessageCompiler#visit_predicate. Uses visit_predicate as basis for visit_unexpected_key. (@robhanlon22)
+
+
+[Compare v1.6.0...v1.6.1](https://github.com/dry-rb/dry-schema/compare/v1.6.0...v1.6.1)
+
 ## 1.6.0 2021-01-21
 
 

data/README.md

@@ -1,3 +1,4 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-schema
 [actions]: https://github.com/dry-rb/dry-schema/actions
 [codacy]: https://www.codacy.com/gh/dry-rb/dry-schema
@@ -7,22 +8,22 @@
 # dry-schema [![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-schema.svg)][gem]
-[![CI Status](https://github.com/dry-rb/dry-schema/workflows/ci/badge.svg)][actions]
+[![CI Status](https://github.com/dry-rb/dry-schema/workflows/CI/badge.svg)][actions]
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/961f5c776f1d49218b2cede3745e059c)][codacy]
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/961f5c776f1d49218b2cede3745e059c)][codacy]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-schema.svg?branch=master)][inchpages]
 
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-schema)
+* [User documentation](https://dry-rb.org/gems/dry-schema)
 * [API documentation](http://rubydoc.info/gems/dry-schema)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.5`
-* jruby >= `9.2`
+* MRI `>= 2.6.0`
+* ~~jruby~~ `>= 9.3` (we are waiting for [2.6 support](https://github.com/jruby/jruby/issues/6161))
 
 ## License
 

data/config/errors.yml

@@ -87,6 +87,8 @@ en:
 
       type?: "must be %{type}"
 
+      respond_to?: "must respond to %{method}"
+
       size?:
         arg:
           default: "size must be %{size}"

data/dry-schema.gemspec

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
-# this file is managed by dry-rb/devtools project
 
-lib = File.expand_path('lib', __dir__)
+# 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/schema/version'
+require "dry/schema/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-schema'
+  spec.name          = "dry-schema"
   spec.authors       = ["Piotr Solnica"]
   spec.email         = ["piotr.solnica@gmail.com"]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
   spec.version       = Dry::Schema::VERSION.dup
 
   spec.summary       = "Coercion and validation for data structures"
@@ -17,19 +18,20 @@ Gem::Specification.new do |spec|
     dry-schema provides a DSL for defining schemas with keys and rules that should be applied to
     values. It supports coercion, input sanitization, custom types and localized error messages
     (with or without I18n gem). It's also used as the schema engine in dry-validation.
+
   TEXT
-  spec.homepage      = 'https://dry-rb.org/gems/dry-schema'
+  spec.homepage      = "https://dry-rb.org/gems/dry-schema"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-schema.gemspec", "lib/**/*", "config/*.yml"]
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-schema/blob/master/CHANGELOG.md'
-  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-schema'
-  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-schema/issues'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-schema/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-schema"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-schema/issues"
 
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.6.0"
 
   # to update dependencies edit project.yml
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"

data/lib/dry/schema/key.rb

@@ -151,7 +151,11 @@ module Dry
       # @api private
       def write(source, target)
         read(source) { |value|
-          target[coerced_name] = value.is_a?(::Array) ? value.map { |el| member.write(el) } : value
+          target[coerced_name] = if value.is_a?(::Array)
+                                   value.map { |el| el.is_a?(::Hash) ? member.write(el) : el }
+                                 else
+                                   value
+                                 end
         }
       end
 

data/lib/dry/schema/key_validator.rb

@@ -51,9 +51,14 @@ module Dry
         hash.flat_map { |key, _|
           case (value = hash[key])
           when Hash
+            next key.to_s if value.empty?
+
             [key].product(key_paths(hash[key])).map { |keys| keys.join(DOT) }
           when Array
-            hashes_or_arrays = value.select { |e| e.is_a?(Array) || e.is_a?(Hash) }
+            hashes_or_arrays = value.select { |e| (e.is_a?(Array) || e.is_a?(Hash)) && !e.empty? }
+
+            next key.to_s if hashes_or_arrays.empty?
+
             hashes_or_arrays.flat_map.with_index { |el, idx|
               key_paths(el).map { |path| ["#{key}[#{idx}]", *path].join(DOT) }
             }

data/lib/dry/schema/macros/dsl.rb

@@ -17,6 +17,7 @@ module Dry
 
         undef :eql?
         undef :nil?
+        undef :respond_to?
 
         # @!attribute [r] chain
         #   Indicate if the macro should append its rules to the provided trace

data/lib/dry/schema/macros/value.rb

@@ -11,9 +11,14 @@ module Dry
       # @api private
       class Value < DSL
         # @api private
-        def call(*predicates, **opts, &block)
+        def call(*args, **opts, &block)
+          types, predicates = args.partition { |arg| arg.is_a?(Dry::Types::Type) }
+
+          constructor = types.select { |type| type.is_a?(Dry::Types::Constructor) }.reduce(:>>)
           schema = predicates.detect { |predicate| predicate.is_a?(Processor) }
 
+          schema_dsl.set_type(name, constructor) if constructor
+
           type_spec = opts[:type_spec]
 
           if schema

data/lib/dry/schema/message_compiler.rb

@@ -4,8 +4,9 @@ require "dry/initializer"
 
 require "dry/schema/constants"
 require "dry/schema/message"
-require "dry/schema/message_set"
 require "dry/schema/message_compiler/visitor_opts"
+require "dry/schema/message_set"
+require "dry/schema/path"
 
 module Dry
   module Schema
@@ -109,18 +110,8 @@ module Dry
       end
 
       # @api private
-      def visit_unexpected_key(node, _opts)
-        path, input = node
-
-        msg = messages.translate("errors.unexpected_key")
-
-        Message.new(
-          path: path,
-          meta: msg[:meta] || EMPTY_HASH,
-          text: msg[:text],
-          predicate: nil,
-          input: input
-        )
+      def visit_unexpected_key(node, opts)
+        visit_predicate([:unexpected_key, []], opts.dup.update(path: Path[node.first]))
       end
 
       # @api private

data/lib/dry/schema/messages/yaml.rb

@@ -71,6 +71,11 @@ module Dry
         @cache ||= Concurrent::Map.new { |h, k| h[k] = Concurrent::Map.new }
       end
 
+      # @api private
+      def self.source_cache
+        @source_cache ||= Concurrent::Map.new
+      end
+
       # @api private
       def initialize(data: EMPTY_HASH, config: nil)
         super()
@@ -179,7 +184,9 @@ module Dry
 
       # @api private
       def load_translations(path)
-        data = self.class.flat_hash(YAML.load_file(path))
+        data = self.class.source_cache.fetch_or_store(path) do
+          self.class.flat_hash(YAML.load_file(path)).freeze
+        end
 
         return data unless custom_top_namespace?(path)
 

data/lib/dry/schema/path.rb

@@ -32,10 +32,10 @@ module Dry
           new(spec.split(DOT).map(&:to_sym))
         when Hash
           new(keys_from_hash(spec))
-        when Path
+        when self
           spec
         else
-          raise ArgumentError, "+spec+ must be either a Symbol, Array, Hash or a Path"
+          raise ArgumentError, "+spec+ must be either a Symbol, Array, Hash or a #{name}"
         end
       end
 
@@ -60,24 +60,9 @@ module Dry
 
       # @api private
       def to_h(value = EMPTY_ARRAY.dup)
-        curr_idx = 0
-        last_idx = keys.size - 1
-        hash = EMPTY_HASH.dup
-        node = hash
-
-        while curr_idx <= last_idx
-          node =
-            node[keys[curr_idx]] =
-              if curr_idx == last_idx
-                value.is_a?(Array) ? value : [value]
-              else
-                EMPTY_HASH.dup
-              end
-
-          curr_idx += 1
-        end
+        value = [value] unless value.is_a?(Array)
 
-        hash
+        keys.reverse_each.reduce(value) { |result, key| {key => result} }
       end
 
       # @api private
@@ -85,59 +70,27 @@ module Dry
         keys.each(&block)
       end
 
-      # @api private
-      def index(key)
-        keys.index(key)
-      end
-
-      def without_index
-        self.class.new(to_a[0..-2])
-      end
-
       # @api private
       def include?(other)
-        if !same_root?(other)
-          false
-        elsif index?
-          if other.index?
-            last.equal?(other.last)
-          else
-            without_index.include?(other)
-          end
-        elsif other.index? && key_matches(other, :select).size < 2
-          false
-        else
-          self >= other && !other.key_matches(self).include?(nil)
-        end
+        keys[0, other.keys.length].eql?(other.keys)
       end
 
       # @api private
       def <=>(other)
-        raise ArgumentError, "Can't compare paths from different branches" unless same_root?(other)
+        return keys.length <=> other.keys.length if include?(other) || other.include?(self)
 
-        return 0 if keys.eql?(other.keys)
+        first_uncommon_index = (self & other).keys.length
 
-        res = key_matches(other).compact.reject { |value| value.equal?(false) }
-
-        res.size < count ? 1 : -1
+        keys[first_uncommon_index] <=> other.keys[first_uncommon_index]
       end
 
       # @api private
       def &(other)
-        unless same_root?(other)
-          raise ArgumentError, "#{other.inspect} doesn't have the same root #{inspect}"
-        end
-
         self.class.new(
-          key_matches(other, :select).compact.reject { |value| value.equal?(false) }
+          keys.take_while.with_index { |key, index| other.keys[index].eql?(key) }
         )
       end
 
-      # @api private
-      def key_matches(other, meth = :map)
-        public_send(meth) { |key| (idx = other.index(key)) && keys[idx].equal?(key) }
-      end
-
       # @api private
       def last
         keys.last
@@ -148,10 +101,7 @@ module Dry
         root.equal?(other.root)
       end
 
-      # @api private
-      def index?
-        last.is_a?(Integer)
-      end
+      EMPTY = new(EMPTY_ARRAY).freeze
     end
   end
 end

data/lib/dry/schema/processor.rb

@@ -53,7 +53,7 @@ module Dry
         # @api public
         def define(&block)
           @definition ||= DSL.new(
-            processor_type: self, parent: superclass.definition, **config, &block
+            processor_type: self, parent: superclass.definition, **config.to_h, &block
           )
           self
         end
@@ -84,14 +84,14 @@ module Dry
       #
       # @api public
       def call(input)
-        Result.new(input, input: input, message_compiler: message_compiler) do |result|
+        Result.new(input.dup, message_compiler: message_compiler) do |result|
           steps.call(result)
         end
       end
       alias_method :[], :call
 
       # @api public
-      def xor(other)
+      def xor(_other)
         raise NotImplementedError, "composing schemas using `xor` operator is not supported yet"
       end
       alias_method :^, :xor

data/lib/dry/schema/processor_steps.rb

@@ -87,6 +87,7 @@ module Dry
       def after(name, &block)
         after_steps[name] ||= EMPTY_ARRAY.dup
         after_steps[name] << Step.new(type: :after, name: name, executor: block)
+        after_steps[name].sort_by!(&:path)
         self
       end
 
@@ -100,6 +101,7 @@ module Dry
       def before(name, &block)
         before_steps[name] ||= EMPTY_ARRAY.dup
         before_steps[name] << Step.new(type: :before, name: name, executor: block)
+        before_steps[name].sort_by!(&:path)
         self
       end
 
@@ -120,18 +122,20 @@ module Dry
       # @api private
       def merge_callbacks(left, right)
         left.merge(right) do |_key, oldval, newval|
-          oldval + newval
+          (oldval + newval).sort_by(&:path)
         end
       end
 
       # @api private
       def import_callbacks(path, other)
         other.before_steps.each do |name, steps|
-          (before_steps[name] ||= []).concat(steps.map { |step| step.scoped(path) })
+          before_steps[name] ||= []
+          before_steps[name].concat(steps.map { |step| step.scoped(path) }).sort_by!(&:path)
         end
 
         other.after_steps.each do |name, steps|
-          (after_steps[name] ||= []).concat(steps.map { |step| step.scoped(path) })
+          after_steps[name] ||= []
+          after_steps[name].concat(steps.map { |step| step.scoped(path) }).sort_by!(&:path)
         end
       end
     end

data/lib/dry/schema/result.rb

@@ -15,24 +15,21 @@ module Dry
     class Result
       include Dry::Equalizer(:output, :errors)
 
-      extend Dry::Initializer
+      extend Dry::Initializer[undefined: false]
 
       # @api private
-      param :output
+      param :output, reader: false
 
-      # Dump result to a hash returning processed and validated data
+      # A list of failure ASTs produced by rule result objects
       #
-      # @return [Hash]
-      alias_method :to_h, :output
-
       # @api private
-      param :results, default: -> { EMPTY_ARRAY.dup }
+      option :result_ast, default: -> { EMPTY_ARRAY.dup }
 
       # @api private
       option :message_compiler
 
       # @api private
-      option :parent, default: -> { nil }
+      option :path, optional: true, reader: false
 
       # @api private
       def self.new(*, **)
@@ -48,8 +45,8 @@ module Dry
       # @return [Result]
       #
       # @api private
-      def at(path, &block)
-        new(Path[path].reduce(output) { |a, e| a[e] }, parent: self, &block)
+      def at(at_path, &block)
+        new(@output, path: Path.new([*path, *Path[at_path]]), &block)
       end
 
       # @api private
@@ -57,7 +54,7 @@ module Dry
         self.class.new(
           output,
           message_compiler: message_compiler,
-          results: results,
+          result_ast: result_ast,
           **opts,
           &block
         )
@@ -70,14 +67,35 @@ module Dry
       end
 
       # @api private
-      def replace(hash)
-        @output = hash
+      def path
+        @path || Path::EMPTY
+      end
+
+      # Dump result to a hash returning processed and validated data
+      #
+      # @return [Hash]
+      def output
+        path.equal?(Path::EMPTY) ? @output : @output.dig(*path)
+      end
+      alias_method :to_h, :output
+
+      # @api private
+      def replace(value)
+        if value.is_a?(output.class)
+          output.replace(value)
+        elsif path.equal?(Path::EMPTY)
+          @output = value
+        else
+          value_holder = path.keys.length > 1 ? @output.dig(*path.to_a[0..-2]) : @output
+
+          value_holder[path.last] = value
+        end
+
         self
       end
 
       # @api private
       def concat(other)
-        results.concat(other)
         result_ast.concat(other.map(&:to_ast))
         self
       end
@@ -164,7 +182,7 @@ module Dry
       #
       # @api public
       def inspect
-        "#<#{self.class}#{to_h.inspect} errors=#{errors.to_h.inspect}>"
+        "#<#{self.class}#{to_h.inspect} errors=#{errors.to_h.inspect} path=#{path.keys.inspect}>"
       end
 
       if RUBY_VERSION >= "2.7"
@@ -182,15 +200,6 @@ module Dry
       def add_error(node)
         result_ast << node
       end
-
-      private
-
-      # A list of failure ASTs produced by rule result objects
-      #
-      # @api private
-      def result_ast
-        @result_ast ||= results.map(&:to_ast)
-      end
     end
   end
 end

data/lib/dry/schema/step.rb

@@ -17,53 +17,34 @@ module Dry
       attr_reader :executor
 
       # @api private
-      class Scoped
-        # @api private
-        attr_reader :path
-
-        # @api private
-        attr_reader :step
-
-        # @api private
-        def initialize(path, step)
-          @path = Path[path]
-          @step = step
-        end
-
-        # @api private
-        def scoped(new_path)
-          self.class.new(Path[[*new_path, *path]], step)
-        end
-
-        # @api private
-        def call(result)
-          result.at(path) do |scoped_result|
-            output = step.(scoped_result).to_h
-            target = Array(path)[0..-2].reduce(result) { |a, e| a[e] }
-
-            target.update(path.last => output)
-          end
-        end
-      end
+      attr_reader :path
 
       # @api private
-      def initialize(type:, name:, executor:)
+      def initialize(type:, name:, executor:, path: Path::EMPTY)
         @type = type
         @name = name
         @executor = executor
+        @path = path
         validate_name(name)
       end
 
       # @api private
       def call(result)
-        output = executor.(result)
-        result.replace(output) if output.is_a?(Hash)
+        scoped_result = path.equal?(Path::EMPTY) ? result : result.at(path)
+
+        output = executor.(scoped_result)
+        scoped_result.replace(output) if output.is_a?(Hash)
         output
       end
 
       # @api private
-      def scoped(path)
-        Scoped.new(path, self)
+      def scoped(parent_path)
+        self.class.new(
+          type: type,
+          name: name,
+          executor: executor,
+          path: Path.new([*parent_path, *path])
+        )
       end
 
       private

data/lib/dry/schema/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Schema
-    VERSION = "1.6.0"
+    VERSION = "1.7.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-schema
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -148,10 +148,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
+description: |+
   dry-schema provides a DSL for defining schemas with keys and rules that should be applied to
   values. It supports coercion, input sanitization, custom types and localized error messages
   (with or without I18n gem). It's also used as the schema engine in dry-validation.
+
 email:
 - piotr.solnica@gmail.com
 executables: []
@@ -245,14 +246,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Coercion and validation for data structures