dry-schema 1.3.4 → 1.5.0

data/lib/dry/schema/extensions.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
 Dry::Schema.register_extension(:monads) do
-  require 'dry/schema/extensions/monads'
+  require "dry/schema/extensions/monads"
 end
 
 Dry::Schema.register_extension(:hints) do
-  require 'dry/schema/extensions/hints'
+  require "dry/schema/extensions/hints"
+end
+
+Dry::Schema.register_extension(:struct) do
+  require "dry/schema/extensions/struct"
+end
+
+Dry::Schema.register_extension(:info) do
+  require "dry/schema/extensions/info"
 end

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'dry/schema/compiler'
-require 'dry/schema/message'
-require 'dry/schema/message_compiler'
+require "dry/schema/compiler"
+require "dry/schema/message"
+require "dry/schema/message_compiler"
 
-require 'dry/schema/extensions/hints/compiler_methods'
-require 'dry/schema/extensions/hints/message_compiler_methods'
-require 'dry/schema/extensions/hints/message_set_methods'
-require 'dry/schema/extensions/hints/result_methods'
+require "dry/schema/extensions/hints/compiler_methods"
+require "dry/schema/extensions/hints/message_compiler_methods"
+require "dry/schema/extensions/hints/message_set_methods"
+require "dry/schema/extensions/hints/result_methods"
 
 module Dry
   module Schema
@@ -22,7 +22,14 @@ module Dry
       # @see Message::Or
       #
       # @api public
-      class Or
+      class Or::SinglePath
+        # @api private
+        def hint?
+          false
+        end
+      end
+
+      class Or::MultiPath
         # @api private
         def hint?
           false

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

@@ -19,7 +19,7 @@ module Dry
           attr_reader :hints
 
           # @api private
-          def initialize(*args)
+          def initialize(*, **)
             super
             @hints = @options.fetch(:hints, true)
           end
@@ -73,7 +73,7 @@ module Dry
           end
 
           # @api private
-          def visit_each(node, opts)
+          def visit_each(_node, _opts)
             # TODO: we can still generate a hint for elements here!
             []
           end

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

@@ -37,53 +37,6 @@ module Dry
             @to_h ||= failures ? messages_map : messages_map(hints)
           end
           alias_method :to_hash, :to_h
-
-          private
-
-          # @api private
-          def unique_paths
-            messages.uniq(&:path).map(&:path)
-          end
-
-          # @api private
-          def messages_map(messages = self.messages)
-            return EMPTY_HASH if empty?
-
-            messages.reduce(placeholders) { |hash, msg|
-              node = msg.path.reduce(hash) { |a, e| a.is_a?(Hash) ? a[e] : a.last[e] }
-              (node[0].is_a?(::Array) ? node[0] : node) << msg.dump
-              hash
-            }
-          end
-
-          # @api private
-          #
-          # rubocop:disable Metrics/AbcSize
-          # rubocop:disable Metrics/PerceivedComplexity
-          def initialize_placeholders!
-            @placeholders = unique_paths.each_with_object(EMPTY_HASH.dup) { |path, hash|
-              curr_idx = 0
-              last_idx = path.size - 1
-              node = hash
-
-              while curr_idx <= last_idx
-                key = path[curr_idx]
-
-                next_node =
-                  if node.is_a?(Array) && key.is_a?(Symbol)
-                    node_hash = (node << [] << {}).last
-                    node_hash[key] || (node_hash[key] = curr_idx < last_idx ? {} : [])
-                  else
-                    node[key] || (node[key] = curr_idx < last_idx ? {} : [])
-                  end
-
-                node = next_node
-                curr_idx += 1
-              end
-            }
-          end
-          # rubocop:enable Metrics/AbcSize
-          # rubocop:enable Metrics/PerceivedComplexity
         end
       end
     end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "dry/schema/extensions/info/schema_compiler"
+
+module Dry
+  module Schema
+    # Info extension
+    #
+    # @api public
+    module Info
+      module SchemaMethods
+        # Return information about keys and types
+        #
+        # @return [Hash<Symbol=>Hash>]
+        #
+        # @api public
+        def info
+          compiler = SchemaCompiler.new
+          compiler.call(to_ast)
+          compiler.to_h
+        end
+      end
+    end
+
+    Processor.include(Info::SchemaMethods)
+  end
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "dry/schema/constants"
+
+module Dry
+  module Schema
+    # @api private
+    module Info
+      # @api private
+      class SchemaCompiler
+        PREDICATE_TO_TYPE = {
+          array?: "array",
+          bool?: "bool",
+          date?: "date",
+          date_time?: "date_time",
+          decimal?: "float",
+          float?: "float",
+          hash?: "hash",
+          int?: "integer",
+          nil?: "nil",
+          str?: "string",
+          time?: "time"
+        }.freeze
+
+        # @api private
+        attr_reader :keys
+
+        # @api private
+        def initialize
+          @keys = EMPTY_HASH.dup
+        end
+
+        # @api private
+        def to_h
+          {keys: keys}
+        end
+
+        # @api private
+        def call(ast)
+          visit(ast)
+        end
+
+        # @api private
+        def visit(node, opts = EMPTY_HASH)
+          meth, rest = node
+          public_send(:"visit_#{meth}", rest, opts)
+        end
+
+        # @api private
+        def visit_set(node, opts = EMPTY_HASH)
+          target = (key = opts[:key]) ? self.class.new : self
+
+          node.map { |child| target.visit(child, opts) }
+
+          return unless key
+
+          target_info = opts[:member] ? {member: target.to_h} : target.to_h
+          type = opts[:member] ? "array" : "hash"
+
+          keys.update(key => {**keys[key], type: type, **target_info})
+        end
+
+        # @api private
+        def visit_and(node, opts = EMPTY_HASH)
+          left, right = node
+
+          visit(left, opts)
+          visit(right, opts)
+        end
+
+        # @api private
+        def visit_implication(node, opts = EMPTY_HASH)
+          node.each do |el|
+            visit(el, opts.merge(required: false))
+          end
+        end
+
+        # @api private
+        def visit_each(node, opts = EMPTY_HASH)
+          visit(node, opts.merge(member: true))
+        end
+
+        # @api private
+        def visit_key(node, opts = EMPTY_HASH)
+          name, rest = node
+          visit(rest, opts.merge(key: name, required: true))
+        end
+
+        # @api private
+        def visit_predicate(node, opts = EMPTY_HASH)
+          name, rest = node
+
+          key = opts[:key]
+
+          if name.equal?(:key?)
+            keys[rest[0][1]] = {required: opts.fetch(:required, true)}
+          else
+            type = PREDICATE_TO_TYPE[name]
+            keys[key][:type] = type if type
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "dry/struct"
+require "dry/schema/predicate_inferrer"
+require "dry/schema/primitive_inferrer"
+require "dry/schema/macros/dsl"
+require "dry/schema/macros/hash"
+
+module Dry
+  module Schema
+    module Macros
+      Hash.prepend(::Module.new {
+        def call(*args)
+          if args.size >= 1 && args[0].is_a?(::Class) && args[0] <= ::Dry::Struct
+            if block_given?
+              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]))
+          else
+            super
+          end
+        end
+      })
+    end
+
+    PredicateInferrer::Compiler.send(:alias_method, :visit_struct, :visit_hash)
+    PrimitiveInferrer::Compiler.send(:alias_method, :visit_struct, :visit_hash)
+  end
+end

data/lib/dry/schema/json.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/schema/processor'
+require "dry/schema/processor"
 
 module Dry
   module Schema

data/lib/dry/schema/key.rb

@@ -27,8 +27,8 @@ module Dry
       end
 
       # @api private
-      def self.new(*args)
-        fetch_or_store(*args) { super }
+      def self.new(*args, **kwargs)
+        fetch_or_store(args, kwargs) { super }
       end
 
       # @api private
@@ -65,8 +65,13 @@ module Dry
       end
 
       # @api private
-      def new(new_opts = EMPTY_HASH)
-        self.class.new(id, { name: name, coercer: coercer }.merge(new_opts))
+      def to_dot_notation
+        [name.to_s]
+      end
+
+      # @api private
+      def new(**new_opts)
+        self.class.new(id, name: name, coercer: coercer, **new_opts)
       end
 
       # @api private
@@ -118,9 +123,14 @@ module Dry
         new(name: name.to_s, members: members.stringified)
       end
 
+      # @api private
+      def to_dot_notation
+        [name].product(members.flat_map(&:to_dot_notation)).map { |e| e.join(DOT) }
+      end
+
       # @api private
       def dump
-        { name => members.map(&:dump) }
+        {name => members.map(&:dump)}
       end
     end
 
@@ -155,6 +165,11 @@ module Dry
         new(name: name.to_s, member: member.stringified)
       end
 
+      # @api private
+      def to_dot_notation
+        [:"#{name}[]"].product(member.to_dot_notation).map { |el| el.join(DOT) }
+      end
+
       # @api private
       def dump
         [name, member.dump]

data/lib/dry/schema/key_coercer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/core/cache'
-require 'dry/equalizer'
+require "dry/core/cache"
+require "dry/equalizer"
 
 module Dry
   module Schema
@@ -32,8 +32,8 @@ module Dry
       end
 
       # @api private
-      def call(source)
-        key_map.write(source.to_h)
+      def call(result)
+        key_map.write(result.to_h)
       end
       alias_method :[], :call
     end

data/lib/dry/schema/key_map.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry/equalizer'
-require 'dry/core/cache'
-require 'dry/schema/constants'
-require 'dry/schema/key'
+require "dry/equalizer"
+require "dry/core/cache"
+require "dry/schema/constants"
+require "dry/schema/key"
 
 module Dry
   module Schema
@@ -100,6 +100,11 @@ module Dry
         self.class.new(map(&:stringified))
       end
 
+      # @api private
+      def to_dot_notation
+        @to_dot_notation ||= map(&:to_dot_notation).flatten
+      end
+
       # Iterate over keys
       #
       # @api public

data/lib/dry/schema/key_validator.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "dry/initializer"
+require "dry/schema/constants"
+
+module Dry
+  module Schema
+    # @api private
+    class KeyValidator
+      extend Dry::Initializer
+
+      INDEX_REGEX = /\[\d+\]/.freeze
+      DIGIT_REGEX = /\A\d+\z/.freeze
+      BRACKETS = "[]"
+
+      # @api private
+      option :key_map
+
+      # @api private
+      def call(result)
+        input = result.to_h
+
+        input_paths = key_paths(input)
+        key_paths = key_map.to_dot_notation
+
+        input_paths.each do |path|
+          error_path =
+            if path[INDEX_REGEX]
+              key = path.gsub(INDEX_REGEX, BRACKETS)
+
+              unless key_paths.include?(key)
+                arr = path.gsub(INDEX_REGEX) { |m| ".#{m[1]}" }
+                arr.split(DOT).map { |s| DIGIT_REGEX.match?(s) ? s.to_i : s.to_sym }
+              end
+            elsif !key_paths.include?(path)
+              path
+            end
+
+          next unless error_path
+
+          result.add_error([:unexpected_key, [error_path, input]])
+        end
+
+        result
+      end
+
+      private
+
+      # @api private
+      def key_paths(hash)
+        hash.flat_map { |key, _|
+          case (value = hash[key])
+          when Hash
+            [key].product(key_paths(hash[key])).map { |keys| keys.join(DOT) }
+          when Array
+            value.flat_map.with_index { |el, idx|
+              key_paths(el).map { |path| ["#{key}[#{idx}]", *path].join(DOT) }
+            }
+          else
+            key.to_s
+          end
+        }
+      end
+    end
+  end
+end