dry-schema 1.13.1 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1949729f55d95db1df478e3d2bf0077728c2cfaa5a66ac3d6d00bdbaaf55347
-  data.tar.gz: 574d9ebd59457187c161730f8b2f232d299ff813fb6af10c680b57ce17c5ee46
+  metadata.gz: b6967bfe7737c11a9df20fc846698f42a911e454cb8c1621d20bc69d93e53dca
+  data.tar.gz: 0a97d750986808ca32535839e779485018d9a7eba1d6a5f09f2128e93f8bbaef
 SHA512:
-  metadata.gz: 520e01dc0ab8454bb981fcba032d3a1099fb7fad15b7eaf4008a094fae381178ab389b143a83b2f9f46522722aa14498bcf9a85e9708537d773a3b8f07c81635
-  data.tar.gz: 6d3c13d9d1c13dd632368fd4a3ff34aaa8fec5573a5001540552eadd3debe413160d54bbc8051822deb029c9bf20ffe301a120dbd97f2a569eac398de767053e
+  metadata.gz: b42eb4a52a991fdf5605d8dc69b6b7362578ef140e272a2cff4ef0fc3852e01797714dfbe2507f9aa05ef6885b738413bd8f93536e4aabb8cccbd1c8a23e7cf1
+  data.tar.gz: a59cc89f18b981031fc7df87e0c3df9692512617dc0bdc35a417a5dce55196788262969ea742da0957a0616a9a0f648c78b4905abb031977570da0751002572b

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 1.14.0 2025-01-06
+
+
+### Added
+
+- Better support for sets in `excluded_from?` and `included_in?` predicates (via #480) (@flash-gordon)
+
+### Fixed
+
+- Fix info extension for maybe macro (via #484) (@flash-gordon + @santiagodoldan)
+- Missing message for :uri? predicate (via #477) (@timjnh)
+- JSON schema output for `maybe(:array)` (via #463) (@tomgi)
+
+### Changed
+
+- Set minimum Ruby version to 3.1 (@flash-gordon)
+- `KeyValidator` works faster for large schemas (via #461) (@radarek)
+
+[Compare v1.13.4...v1.14.0](https://github.com/dry-rb/dry-schema/compare/v1.13.4...v1.14.0)
+
+## 1.13.4 2024-05-22
+
+
+### Added
+
+- Default error message for `:uri?` (issue #476 via #477) (@timjnh)
+
+### Fixed
+
+- Fix json-schema type of objects nested under arrays (issue #400 fixed via #462) (@tomgi)
+
+### Changed
+
+- i18n backend is no longer eager-loaded (via 85a9e0b) (@adam12)
+
+[Compare v1.13.3...v1.13.4](https://github.com/dry-rb/dry-schema/compare/v1.13.3...v1.13.4)
+
+## 1.13.3 2023-08-26
+
+
+### Fixed
+
+- Fix struct extension for nested struct definitions (via #466) (@flash-gordon)
+
+
+[Compare v1.13.2...v1.13.3](https://github.com/dry-rb/dry-schema/compare/v1.13.2...v1.13.3)
+
+## 1.13.2 2023-05-31
+
+
+### Fixed
+
+- Fix custom predicates setting (via #460) (@solnic)
+
+
+[Compare v1.13.1...v1.13.2](https://github.com/dry-rb/dry-schema/compare/v1.13.1...v1.13.2)
+
 ## 1.13.1 2023-04-07
 
 

data/README.md

@@ -2,7 +2,7 @@
 [gem]: https://rubygems.org/gems/dry-schema
 [actions]: https://github.com/dry-rb/dry-schema/actions
 
-# dry-schema [![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]
+# dry-schema [![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]
 
 ## Links
 
@@ -14,7 +14,7 @@
 
 This library officially supports the following Ruby versions:
 
-* MRI `>= 3.0.0`
+* MRI `>= 3.1`
 * jruby `>= 9.4` (not tested on CI)
 
 ## License

data/config/errors.yml

@@ -105,7 +105,17 @@ en:
           default: "must be %{size} bytes long"
           range: "must be within %{size_left} - %{size_right} bytes long"
 
+      uri?: "is not a valid URI"
+      
+      uuid_v1?: "is not a valid UUID"
+
+      uuid_v2?: "is not a valid UUID"
+
+      uuid_v3?: "is not a valid UUID"
+
       uuid_v4?: "is not a valid UUID"
 
+      uuid_v5?: "is not a valid UUID"
+
       not:
         empty?: "cannot be empty"

data/dry-schema.gemspec

@@ -21,28 +21,26 @@ Gem::Specification.new do |spec|
 
   TEXT
   spec.homepage      = "https://dry-rb.org/gems/dry-schema"
-  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-schema.gemspec", "lib/**/*", "config/*.yml"]
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-schema.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-schema/blob/main/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/main/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["rubygems_mfa_required"] = "true"
 
-  spec.required_ruby_version = ">= 2.7"
+  spec.required_ruby_version = ">= 3.1"
 
   # to update dependencies edit project.yml
-  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
-  spec.add_runtime_dependency "dry-configurable", "~> 1.0", ">= 1.0.1"
-  spec.add_runtime_dependency "dry-core", "~> 1.0", "< 2"
-  spec.add_runtime_dependency "dry-initializer", "~> 3.0"
-  spec.add_runtime_dependency "dry-logic", ">= 1.4", "< 2"
-  spec.add_runtime_dependency "dry-types", ">= 1.7", "< 2"
-  spec.add_runtime_dependency "zeitwerk", "~> 2.6"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_dependency "dry-configurable", "~> 1.0", ">= 1.0.1"
+  spec.add_dependency "dry-core", "~> 1.1"
+  spec.add_dependency "dry-initializer", "~> 3.2"
+  spec.add_dependency "dry-logic", "~> 1.5"
+  spec.add_dependency "dry-types", "~> 1.8"
+  spec.add_dependency "zeitwerk", "~> 2.6"
 end

data/lib/dry/schema/config.rb

@@ -12,8 +12,8 @@ module Dry
     #
     # @api public
     class Config
-      include Dry::Configurable
-      include Dry::Equalizer(:to_h, inspect: false)
+      include ::Dry::Configurable
+      include ::Dry::Equalizer(:to_h, inspect: false)
 
       # @!method predicates
       #
@@ -22,7 +22,9 @@ module Dry
       # @return [Schema::PredicateRegistry]
       #
       # @api public
-      setting :predicates, default: Schema::PredicateRegistry.new
+      setting :predicates, default: PredicateRegistry.new, constructor: -> predicates {
+        predicates.is_a?(PredicateRegistry) ? predicates : PredicateRegistry.new(predicates)
+      }
 
       # @!method types
       #
@@ -31,7 +33,7 @@ module Dry
       # @return [Hash]
       #
       # @api public
-      setting :types, default: Dry::Types
+      setting :types, default: ::Dry::Types
 
       # @!method messages
       #
@@ -43,7 +45,7 @@ module Dry
       setting :messages do
         setting :backend, default: :yaml
         setting :namespace
-        setting :load_paths, default: Set[DEFAULT_MESSAGES_PATH], constructor: :dup.to_proc
+        setting :load_paths, default: ::Set[DEFAULT_MESSAGES_PATH], constructor: :dup.to_proc
         setting :top_namespace, default: DEFAULT_MESSAGES_ROOT
         setting :default_locale
       end
@@ -72,9 +74,9 @@ module Dry
       # Forward to the underlying config object
       #
       # @api private
-      def method_missing(meth, *args, &block)
+      def method_missing(meth, ...)
         super unless config.respond_to?(meth)
-        config.public_send(meth, *args)
+        config.public_send(meth, ...)
       end
     end
   end

data/lib/dry/schema/constants.rb

@@ -30,10 +30,10 @@ module Dry
     DEFAULT_MESSAGES_ROOT = "dry_schema"
 
     # An error raised when DSL is used in an incorrect way
-    InvalidSchemaError = Class.new(StandardError)
+    InvalidSchemaError = ::Class.new(::StandardError)
 
     # An error raised when a localized message cannot be found
-    MissingMessageError = Class.new(StandardError) do
+    MissingMessageError = ::Class.new(::StandardError) do
       # @api private
       def initialize(path, paths = [])
         *rest, rule = path

data/lib/dry/schema/dsl.rb

@@ -37,10 +37,7 @@ module Dry
     class DSL
       Types = Schema::Types
 
-      extend Dry::Initializer
-
-      # @return [Compiler] The rule compiler object
-      option :compiler, default: -> { Compiler.new }
+      extend ::Dry::Initializer
 
       # @return [Compiler] The type of the processor (Params, JSON, or a custom sub-class)
       option :processor_type, default: -> { Processor }
@@ -81,9 +78,10 @@ module Dry
       # @return [DSL]
       #
       # @api public
-      def self.new(**options, &block)
+      def self.new(**options, &)
         dsl = super
-        dsl.instance_eval(&block) if block
+        dsl.instance_eval(&) if block_given?
+        dsl.instance_variable_set("@compiler", options[:compiler]) if options[:compiler]
         dsl
       end
 
@@ -101,11 +99,21 @@ module Dry
       # @return [DSL]
       #
       # @api public
-      def configure(&block)
-        config.configure(&block)
+      def configure(&)
+        config.configure(&)
         self
       end
 
+      # @api private
+      def compiler
+        @compiler ||= Compiler.new(predicates)
+      end
+
+      # @api private
+      def predicates
+        @predicates ||= config.predicates
+      end
+
       # Return a macro with the provided name
       #
       # @param [Symbol] name
@@ -133,8 +141,8 @@ module Dry
       # @return [Macros::Required]
       #
       # @api public
-      def required(name, &block)
-        key(name, macro: Macros::Required, &block)
+      def required(name, &)
+        key(name, macro: Macros::Required, &)
       end
 
       # Define an optional key
@@ -149,8 +157,8 @@ module Dry
       # @return [Macros::Optional]
       #
       # @api public
-      def optional(name, &block)
-        key(name, macro: Macros::Optional, &block)
+      def optional(name, &)
+        key(name, macro: Macros::Optional, &)
       end
 
       # A generic method for defining keys
@@ -162,7 +170,7 @@ module Dry
       # @return [Macros::Key]
       #
       # @api public
-      def key(name, macro:, &block)
+      def key(name, macro:, &)
         raise ArgumentError, "Key +#{name}+ is not a symbol" unless name.is_a?(::Symbol)
 
         set_type(name, Types::Any.meta(default: true))
@@ -174,7 +182,7 @@ module Dry
           filter_schema_dsl: filter_schema_dsl
         )
 
-        macro.value(&block) if block
+        macro.value(&) if block_given?
         macros << macro
         macro
       end
@@ -241,8 +249,8 @@ module Dry
       # @return [DSL]
       #
       # @api public
-      def before(key, &block)
-        steps.before(key, &block)
+      def before(key, &)
+        steps.before(key, &)
         self
       end
 
@@ -256,8 +264,8 @@ module Dry
       # @return [DSL]
       #
       # @api public
-      def after(key, &block)
-        steps.after(key, &block)
+      def after(key, &)
+        steps.after(key, &)
         self
       end
 
@@ -293,8 +301,8 @@ module Dry
       # @return [Dry::Types::Safe]
       #
       # @api private
-      def new(klass: self.class, **options, &block)
-        klass.new(**options, processor_type: processor_type, config: config, &block)
+      def new(klass: self.class, **options, &)
+        klass.new(**options, processor_type: processor_type, config: config, &)
       end
 
       # Set a type for the given key name
@@ -493,7 +501,7 @@ module Dry
       def default_config
         parents.each_cons(2) do |left, right|
           unless left.config == right.config
-            raise ArgumentError,
+            raise ::ArgumentError,
                   "Parent configs differ, left=#{left.inspect}, right=#{right.inspect}"
           end
         end

data/lib/dry/schema/extensions/hints/message_compiler_methods.rb

@@ -31,7 +31,7 @@ module Dry
 
           # @api private
           def filter(messages, opts)
-            Array(messages).flatten.map { |msg| msg unless exclude?(msg, opts) }.compact.uniq
+            Array(messages).flatten.reject { |msg| exclude?(msg, opts) }.uniq
           end
 
           # @api private

data/lib/dry/schema/extensions/info/schema_compiler.rb

@@ -70,20 +70,25 @@ module Dry
 
         # @api private
         def visit_implication(node, opts = EMPTY_HASH)
-          node.each do |el|
-            visit(el, opts.merge(required: false))
+          case node
+          in [:not, [:predicate, [:nil?, _]]], el
+            visit(el, {**opts, nullable: true})
+          else
+            node.each do |el|
+              visit(el, {**opts, required: false})
+            end
           end
         end
 
         # @api private
         def visit_each(node, opts = EMPTY_HASH)
-          visit(node, opts.merge(member: true))
+          visit(node, {**opts, member: true})
         end
 
         # @api private
         def visit_key(node, opts = EMPTY_HASH)
           name, rest = node
-          visit(rest, opts.merge(key: name, required: true))
+          visit(rest, {**opts, key: name, required: true})
         end
 
         # @api private
@@ -93,19 +98,23 @@ module Dry
           key = opts[:key]
 
           if name.equal?(:key?)
-            keys[rest[0][1]] = {required: opts.fetch(:required, true)}
+            keys[rest[0][1]] = {
+              required: opts.fetch(:required, true)
+            }
           else
             type = PREDICATE_TO_TYPE[name]
-            assign_type(key, type) if type
+            nullable = opts.fetch(:nullable, false)
+            assign_type(key, type, nullable) if type
           end
         end
 
         # @api private
-        def assign_type(key, type)
+        def assign_type(key, type, nullable)
           if keys[key][:type]
             keys[key][:member] = type
           else
             keys[key][:type] = type
+            keys[key][:nullable] = nullable
           end
         end
       end

data/lib/dry/schema/extensions/json_schema/schema_compiler.rb

@@ -9,7 +9,7 @@ module Dry
       # @api private
       class SchemaCompiler
         # An error raised when a predicate cannot be converted
-        UnknownConversionError = Class.new(StandardError)
+        UnknownConversionError = ::Class.new(::StandardError)
 
         IDENTITY = ->(v, _) { v }.freeze
         TO_INTEGER = ->(v, _) { v.to_i }.freeze
@@ -90,14 +90,14 @@ module Dry
         def visit_set(node, opts = EMPTY_HASH)
           target = (key = opts[:key]) ? self.class.new(loose: loose?) : self
 
-          node.map { |child| target.visit(child, opts) }
+          node.map { |child| target.visit(child, opts.except(:member)) }
 
           return unless key
 
           target_info = opts[:member] ? {items: target.to_h} : target.to_h
           type = opts[:member] ? "array" : "object"
 
-          keys.update(key => {**keys[key], type: type, **target_info})
+          merge_opts!(keys[key], {type: type, **target_info})
         end
 
         # @api private
@@ -210,7 +210,7 @@ module Dry
           orig_type = orig_opts[:type]
 
           if orig_type && new_type && orig_type != new_type
-            new_opts[:type] = [orig_type, new_type]
+            new_opts[:type] = [orig_type, new_type].flatten.uniq
           end
 
           orig_opts.merge!(new_opts)

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

@@ -11,7 +11,7 @@ module Dry
     #
     # @api public
     class Result
-      include Dry::Monads::Result::Mixin
+      include ::Dry::Monads::Result::Mixin
 
       # Turn result into a monad
       #

data/lib/dry/schema/extensions/struct.rb

@@ -5,24 +5,46 @@ require "dry/struct"
 module Dry
   module Schema
     module Macros
+      class StructToSchema < ::Dry::Struct::Compiler
+        def call(struct)
+          visit(struct.to_ast)
+        end
+
+        # strip away structs from AST
+        def visit_struct(node)
+          _, ast = node
+          visit(ast)
+        end
+      end
+
+      Hash.option :struct_compiler, default: proc { StructToSchema.new(schema_dsl.config.types) }
+
       Hash.prepend(::Module.new {
         def call(*args)
-          if args.size >= 1 && args[0].is_a?(::Class) && args[0] <= ::Dry::Struct
+          if args.size >= 1 && struct?(args[0])
             if block_given?
-              raise ArgumentError, "blocks are not supported when using "\
+              raise ArgumentError, "blocks are not supported when using " \
                                    "a struct class (#{name.inspect} => #{args[0]})"
             end
 
-            super(args[0].schema, *args.drop(1))
-            type(schema_dsl.types[name].constructor(args[0].schema))
+            schema = struct_compiler.(args[0])
+
+            super(schema, *args.drop(1))
+            type(schema_dsl.types[name].constructor(schema))
           else
             super
           end
         end
+
+        private
+
+        def struct?(type)
+          type.is_a?(::Class) && type <= ::Dry::Struct
+        end
       })
     end
 
-    PredicateInferrer::Compiler.send(:alias_method, :visit_struct, :visit_hash)
-    PrimitiveInferrer::Compiler.send(:alias_method, :visit_struct, :visit_hash)
+    PredicateInferrer::Compiler.alias_method(:visit_struct, :visit_hash)
+    PrimitiveInferrer::Compiler.alias_method(:visit_struct, :visit_hash)
   end
 end

data/lib/dry/schema/key.rb

@@ -6,11 +6,11 @@ module Dry
     #
     # @api public
     class Key
-      extend Dry::Core::Cache
+      extend ::Dry::Core::Cache
 
       DEFAULT_COERCER = :itself.to_proc.freeze
 
-      include Dry.Equalizer(:name, :coercer)
+      include ::Dry.Equalizer(:name, :coercer)
 
       # @return [Symbol] The key identifier
       attr_reader :id
@@ -90,7 +90,7 @@ module Dry
       #
       # @api private
       class Hash < self
-        include Dry.Equalizer(:name, :members, :coercer)
+        include ::Dry.Equalizer(:name, :members, :coercer)
 
         # @api private
         attr_reader :members
@@ -137,7 +137,7 @@ module Dry
       #
       # @api private
       class Array < self
-        include Dry.Equalizer(:name, :member, :coercer)
+        include ::Dry.Equalizer(:name, :member, :coercer)
 
         attr_reader :member
 

data/lib/dry/schema/key_coercer.rb

@@ -9,7 +9,7 @@ module Dry
     #
     # @api private
     class KeyCoercer
-      extend Dry::Core::Cache
+      extend ::Dry::Core::Cache
       include ::Dry::Equalizer(:key_map, :coercer)
 
       TO_SYM = :to_sym.to_proc.freeze
@@ -27,8 +27,8 @@ module Dry
       end
 
       # @api private
-      def initialize(key_map, &coercer)
-        @key_map = key_map.coercible(&coercer)
+      def initialize(key_map, &)
+        @key_map = key_map.coercible(&)
       end
 
       # @api private

data/lib/dry/schema/key_map.rb

@@ -13,10 +13,10 @@ module Dry
     #
     # @api public
     class KeyMap
-      extend Dry::Core::Cache
+      extend ::Dry::Core::Cache
 
-      include Dry.Equalizer(:keys)
-      include Enumerable
+      include ::Dry.Equalizer(:keys)
+      include ::Enumerable
 
       # @return [Array<Key>] A list of defined key objects
       attr_reader :keys
@@ -105,8 +105,8 @@ module Dry
       # Iterate over keys
       #
       # @api public
-      def each(&block)
-        keys.each(&block)
+      def each(&)
+        keys.each(&)
       end
 
       # Return a new key map merged with the provided one

data/lib/dry/schema/key_validator.rb

@@ -7,10 +7,10 @@ module Dry
   module Schema
     # @api private
     class KeyValidator
-      extend Dry::Initializer
+      extend ::Dry::Initializer
 
-      INDEX_REGEX = /\[\d+\]/.freeze
-      DIGIT_REGEX = /\A\d+\z/.freeze
+      INDEX_REGEX = /\[\d+\]/
+      DIGIT_REGEX = /\A\d+\z/
       BRACKETS = "[]"
 
       # @api private
@@ -21,7 +21,7 @@ module Dry
         input = result.to_h
 
         input_paths = key_paths(input)
-        key_paths = key_map.to_dot_notation
+        key_paths = key_map.to_dot_notation.sort
 
         input_paths.each do |path|
           error_path = validate_path(key_paths, path)
@@ -40,20 +40,31 @@ module Dry
       def validate_path(key_paths, path)
         if path[INDEX_REGEX]
           key = path.gsub(INDEX_REGEX, BRACKETS)
-
-          if key_paths.none? { paths_match?(key, _1) }
+          if none_key_paths_match?(key_paths, key)
             arr = path.gsub(INDEX_REGEX) { ".#{_1[1]}" }
             arr.split(DOT).map { DIGIT_REGEX.match?(_1) ? Integer(_1, 10) : _1.to_sym }
           end
-        elsif key_paths.none? { paths_match?(path, _1) }
+        elsif none_key_paths_match?(key_paths, path)
           path
         end
       end
 
       # @api private
-      def paths_match?(input_path, key_path)
-        residue = key_path.sub(input_path, "")
-        residue.empty? || residue.start_with?(DOT, BRACKETS)
+      def none_key_paths_match?(key_paths, path)
+        !any_key_paths_match?(key_paths, path)
+      end
+
+      # @api private
+      def any_key_paths_match?(key_paths, path)
+        find_path(key_paths, path, false) ||
+          find_path(key_paths, path + DOT, true) ||
+          find_path(key_paths, path + BRACKETS, true)
+      end
+
+      # @api private
+      def find_path(key_paths, path, prefix_match)
+        key = key_paths.bsearch { |key_path| key_path >= path }
+        prefix_match ? key&.start_with?(path) : key == path
       end
 
       # @api private

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

@@ -19,10 +19,10 @@ module Dry
         option :compiler, default: proc { Compiler.new }
 
         # @api private
-        option :trace, default: proc { Trace.new }
+        option :schema_dsl, optional: true
 
         # @api private
-        option :schema_dsl, optional: true
+        option :trace, default: proc { Trace.new(schema_dsl&.compiler || Compiler.new) }
 
         # @api private
         def new(**options)