dry-schema 1.13.4 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a740c1cb0f62a33428ff5c187c9a93ce6fdd2dc567dd904f86e07d68d94f119
-  data.tar.gz: b25d1dc73b7f6a2a7161a06495e4f1d5e4dfd6bafc52ad2a2088018fe9ecaf10
+  metadata.gz: c3e83fff26178481b1d8c4f4e3b5da6f1138268bf85123f59eb1806590217093
+  data.tar.gz: 865bcc2b635075227c513dbd54c2450f32a6d603ce734aa26f3be7a9d14dc8f4
 SHA512:
-  metadata.gz: e914b3630c16022e6fb323a749ca66ad2dcff14ba24cff66f16b36fc102092ec9269d95e1f25dad3817eb4a44786d3a6a21d1fe7a930a75d63532a2fdcca663c
-  data.tar.gz: d0436db384cf03b10eed4a20717de7f06c12fdfa94426af6bae7e92c93c88efcbc851ad658f0370add6fc0ebf1bad9b636fdc7d41faf75299da3c57fa947e767
+  metadata.gz: 2cc07bad04e6e1aeb9045fdca2dbd2c4f0aeaac3e541d0b8ce485c6eb03489e957e290ee57b3cb38570d77018c83bca8e7fc5f93ab5cec425592d52ff41dd189
+  data.tar.gz: 2265866e7fed3d481963450c7e9c928217482df3ac99820653a9e5007001344d4d3dbe6e66321faf6f193f4a37de20a185243a57c532464b68bc946b396617a9

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 <!--- 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
 
 

data/README.md

@@ -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,9 +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"
 
-      uri?: "is not a valid URI"
+      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
       #
@@ -33,7 +33,7 @@ module Dry
       # @return [Hash]
       #
       # @api public
-      setting :types, default: Dry::Types
+      setting :types, default: ::Dry::Types
 
       # @!method messages
       #
@@ -45,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
@@ -74,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,7 +37,7 @@ module Dry
     class DSL
       Types = Schema::Types
 
-      extend Dry::Initializer
+      extend ::Dry::Initializer
 
       # @return [Compiler] The type of the processor (Params, JSON, or a custom sub-class)
       option :processor_type, default: -> { Processor }
@@ -78,9 +78,9 @@ 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
@@ -99,8 +99,8 @@ module Dry
       # @return [DSL]
       #
       # @api public
-      def configure(&block)
-        config.configure(&block)
+      def configure(&)
+        config.configure(&)
         self
       end
 
@@ -141,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
@@ -157,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
@@ -170,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))
@@ -182,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
@@ -249,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
 
@@ -264,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
 
@@ -301,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
@@ -501,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
@@ -97,7 +97,7 @@ module Dry
           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

@@ -23,7 +23,7 @@ module Dry
         def call(*args)
           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
 
@@ -44,7 +44,7 @@ module Dry
       })
     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,7 +7,7 @@ module Dry
   module Schema
     # @api private
     class KeyValidator
-      extend Dry::Initializer
+      extend ::Dry::Initializer
 
       INDEX_REGEX = /\[\d+\]/
       DIGIT_REGEX = /\A\d+\z/
@@ -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/dsl.rb

@@ -7,7 +7,7 @@ module Dry
       #
       # @api public
       class DSL < Core
-        include Dry::Logic::Operators
+        include ::Dry::Logic::Operators
 
         undef :eql?
         undef :nil?
@@ -52,15 +52,15 @@ module Dry
         # @return [Macros::Core]
         #
         # @api public
-        def value(*args, **opts, &block)
+        def value(*args, **opts, &)
           if (type_spec_from_opts = opts[:type_spec])
             append_macro(Macros::Value) do |macro|
-              macro.call(*args, type_spec: type_spec_from_opts, **opts, &block)
+              macro.call(*args, type_spec: type_spec_from_opts, **opts, &)
             end
           else
             extract_type_spec(args) do |*predicates, type_spec:, type_rule:|
               append_macro(Macros::Value) do |macro|
-                macro.call(*predicates, type_spec: type_spec, type_rule: type_rule, **opts, &block)
+                macro.call(*predicates, type_spec: type_spec, type_rule: type_rule, **opts, &)
               end
             end
           end
@@ -77,10 +77,10 @@ module Dry
         # @return [Macros::Core]
         #
         # @api public
-        def filled(*args, **opts, &block)
+        def filled(*args, **opts, &)
           extract_type_spec(args) do |*predicates, type_spec:, type_rule:|
             append_macro(Macros::Filled) do |macro|
-              macro.call(*predicates, type_spec: type_spec, type_rule: type_rule, **opts, &block)
+              macro.call(*predicates, type_spec: type_spec, type_rule: type_rule, **opts, &)
             end
           end
         end
@@ -95,10 +95,10 @@ module Dry
         # @return [Macros::Key]
         #
         # @api public
-        def maybe(*args, **opts, &block)
+        def maybe(*args, **opts, &)
           extract_type_spec(args, nullable: true) do |*predicates, type_spec:, type_rule:|
             append_macro(Macros::Maybe) do |macro|
-              macro.call(*predicates, type_spec: type_spec, type_rule: type_rule, **opts, &block)
+              macro.call(*predicates, type_spec: type_spec, type_rule: type_rule, **opts, &)
             end
           end
         end

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

@@ -8,14 +8,14 @@ module Dry
       # @api private
       class Each < DSL
         # @api private
-        def value(*args, **opts, &block)
+        def value(*args, **opts, &)
           extract_type_spec(args, set_type: false) do |*predicates, type_spec:, type_rule:|
             if type_spec && !type_spec.is_a?(Dry::Types::Type)
               type(schema_dsl.array[type_spec])
             end
 
             append_macro(Macros::Value) do |macro|
-              macro.call(*predicates, type_spec: type_spec, type_rule: type_rule, **opts, &block)
+              macro.call(*predicates, type_spec: type_spec, type_rule: type_rule, **opts, &)
             end
           end
         end

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

@@ -8,17 +8,16 @@ module Dry
       # @api private
       class Filled < Value
         # @api private
-        def call(*predicates, **opts, &block)
+        def call(*predicates, **opts, &)
           ensure_valid_predicates(predicates)
 
           append_macro(Macros::Value) do |macro|
             if opts[:type_spec] && !filter_empty_string?
-              macro.call(predicates[0], :filled?, *predicates[1..predicates.size - 1], **opts,
-                         &block)
+              macro.call(predicates[0], :filled?, *predicates.drop(1), **opts, &)
             elsif opts[:type_rule]
-              macro.call(:filled?).value(*predicates, **opts, &block)
+              macro.call(:filled?).value(*predicates, **opts, &)
             else
-              macro.call(:filled?, *predicates, **opts, &block)
+              macro.call(:filled?, *predicates, **opts, &)
             end
           end
         end

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

@@ -8,7 +8,7 @@ module Dry
       # @api private
       class Hash < Schema
         # @api private
-        def call(*args, &block)
+        def call(*args, &)
           if args.size >= 1 && args[0].respond_to?(:keys)
             hash_type = args[0]
             type_predicates = predicate_inferrer[hash_type]
@@ -21,7 +21,7 @@ module Dry
                 else
                   optional(key.name).value(key.type)
                 end
-                instance_exec(&block) if block
+                instance_exec(&) if block_given?
               end
             end
           else

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

@@ -8,7 +8,7 @@ module Dry
       # @api private
       class Maybe < DSL
         # @api private
-        def call(*args, **opts, &block)
+        def call(*args, **opts, &)
           if args.include?(:empty?)
             raise ::Dry::Schema::InvalidSchemaError, "Using maybe with empty? predicate is invalid"
           end
@@ -18,7 +18,7 @@ module Dry
           end
 
           append_macro(Macros::Value) do |macro|
-            macro.call(*args, **opts, &block)
+            macro.call(*args, **opts, &)
           end
 
           self