dry-schema 1.3.0 → 1.4.0

data/lib/dry/schema/constants.rb

@@ -26,10 +26,11 @@ module Dry
     # An error raised when a localized message cannot be found
     MissingMessageError = Class.new(StandardError) do
       # @api private
-      def initialize(path)
+      def initialize(path, paths = [])
         *rest, rule = path
         super(<<~STR)
-          Message template for #{rule.inspect} under #{rest.join(DOT).inspect} was not found
+          Message template for #{rule.inspect} under #{rest.join(DOT).inspect} was not found. Searched in:
+          #{paths.map { |string| "\"#{string}\"" }.join("\n")}
         STR
       end
     end

data/lib/dry/schema/dsl.rb

@@ -9,6 +9,7 @@ require 'dry/schema/types'
 require 'dry/schema/macros'
 
 require 'dry/schema/processor'
+require 'dry/schema/processor_steps'
 require 'dry/schema/key_map'
 require 'dry/schema/key_coercer'
 require 'dry/schema/value_coercer'
@@ -64,18 +65,21 @@ module Dry
       # @return [Compiler] A key=>type map defined within the DSL
       option :types, default: -> { EMPTY_HASH.dup }
 
-      # @return [DSL] An optional parent DSL object that will be used to merge keys and rules
-      option :parent, optional: true
+      # @return [Array] Optional parent DSL objects, that will be used to merge keys and rules
+      option :parent, Types::Coercible::Array, default: -> { EMPTY_ARRAY.dup }, as: :parents
 
       # @return [Config] Configuration object exposed via `#configure` method
       option :config, optional: true, default: proc { parent ? parent.config.dup : Config.new }
 
+      # @return [ProcessorSteps] Steps for the processor
+      option :steps, default: proc { parent ? parent.steps.dup : ProcessorSteps.new }
+
       # Build a new DSL object and evaluate provided block
       #
       # @param [Hash] options
       # @option options [Class] :processor The processor type (`Params`, `JSON` or a custom sub-class)
       # @option options [Compiler] :compiler An instance of a rule compiler (must be compatible with `Schema::Compiler`) (optional)
-      # @option options [DSL] :parent An instance of the parent DSL (optional)
+      # @option options [Array[DSL]] :parent One or more instances of the parent DSL (optional)
       # @option options [Config] :config A configuration object (optional)
       #
       # @see Schema.define
@@ -189,9 +193,10 @@ module Dry
       #
       # @api private
       def call
-        steps = [key_coercer]
-        steps << filter_schema.rule_applier if filter_rules?
-        steps << value_coercer << rule_applier
+        steps[:key_coercer] = key_coercer
+        steps[:value_coercer] = value_coercer
+        steps[:rule_applier] = rule_applier
+        steps[:filter_schema] = filter_schema.rule_applier if filter_rules?
 
         processor_type.new(schema_dsl: self, steps: steps)
       end
@@ -215,14 +220,54 @@ module Dry
         -> member_type { type_registry['array'].of(resolve_type(member_type)) }
       end
 
+      # Method allows steps injection to the processor
+      #
+      # @example
+      #   before(:rule_applier) do |input|
+      #     input.compact
+      #   end
+      #
+      # @return [DSL]
+      #
+      # @api public
+      def before(key, &block)
+        steps.before(key, &block)
+        self
+      end
+
+      # Method allows steps injection to the processor
+      #
+      # @example
+      #   after(:rule_applier) do |input|
+      #     input.compact
+      #   end
+      #
+      # @return [DSL]
+      #
+      # @api public
+      def after(key, &block)
+        steps.after(key, &block)
+        self
+      end
+
+      # The parent (last from parents) which is used for copying non mergeable configuration
+      #
+      # @return DSL
+      #
+      # @api public
+      def parent
+        @parent ||= parents.last
+      end
+
       # Return type schema used by the value coercer
       #
       # @return [Dry::Types::Safe]
       #
       # @api private
       def type_schema
-        schema = type_registry['hash'].schema(types).lax
-        parent ? parent.type_schema.schema(schema.to_a) : schema
+        our_schema = type_registry['hash'].schema(types).lax
+        schemas = [*parents.map(&:type_schema), our_schema]
+        schemas.inject { |result, schema| result.schema(schema.to_a) }
       end
 
       # Return a new DSL instance using the same processor type
@@ -276,14 +321,18 @@ module Dry
       #
       # @api private
       def filter_schema_dsl
-        @filter_schema_dsl ||= new(parent: parent_filter_schema)
+        @filter_schema_dsl ||= new(parent: parent_filter_schemas)
       end
 
       # Check if any filter rules were defined
       #
       # @api private
       def filter_rules?
-        (instance_variable_defined?('@filter_schema_dsl') && !filter_schema_dsl.macros.empty?) || parent&.filter_rules?
+        if instance_variable_defined?('@filter_schema_dsl') && !filter_schema_dsl.macros.empty?
+          return true
+        end
+
+        parents.any?(&:filter_rules?)
       end
 
       protected
@@ -323,10 +372,8 @@ module Dry
       private
 
       # @api private
-      def parent_filter_schema
-        return unless parent
-
-        parent.filter_schema if parent.filter_rules?
+      def parent_filter_schemas
+        parents.select(&:filter_rules?).map(&:filter_schema)
       end
 
       # Build a key coercer
@@ -380,12 +427,12 @@ module Dry
 
       # @api private
       def parent_rules
-        parent&.rules || EMPTY_HASH
+        parents.reduce({}) { |rules, parent| rules.merge(parent.rules) }
       end
 
       # @api private
       def parent_key_map
-        parent&.key_map || EMPTY_ARRAY
+        parents.reduce([]) { |key_map, parent| parent.key_map + key_map }
       end
     end
   end

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

@@ -12,7 +12,7 @@ module Dry
           #
           # @return [Array<Message::Hint>]
           attr_reader :hints
-          
+
           # Configuration option to enable/disable showing errors
           #
           # @return [Boolean]
@@ -37,6 +37,53 @@ 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/macros/dsl.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'dry/logic/operators'
+require 'dry/types/predicate_inferrer'
+require 'dry/types/primitive_inferrer'
 
 require 'dry/schema/macros/core'
 
@@ -26,7 +28,13 @@ module Dry
         #   PredicateInferrer is used to infer predicate type-check from a type spec
         #   @return [PredicateInferrer]
         #   @api private
-        option :predicate_inferrer, default: proc { PredicateInferrer.new(compiler.predicates) }
+        option :predicate_inferrer, default: proc { ::Dry::Types::PredicateInferrer.new(compiler.predicates) }
+
+        # @!attribute [r] primitive_inferrer
+        #   PrimitiveInferrer used to get a list of primitive classes from configured type
+        #   @return [PrimitiveInferrer]
+        #   @api private
+        option :primitive_inferrer, default: proc { ::Dry::Types::PrimitiveInferrer.new }
 
         # @overload value(*predicates, **predicate_opts)
         #   Set predicates without and with arguments
@@ -192,9 +200,7 @@ module Dry
           predicates = Array(type_spec ? args[1..-1] : args)
 
           if type_spec
-            resolved_type = schema_dsl.resolve_type(
-              nullable && !type_spec.is_a?(::Array) ? [:nil, type_spec] : type_spec
-            )
+            resolved_type = resolve_type(type_spec, nullable)
 
             type(resolved_type) if set_type
 
@@ -207,6 +213,17 @@ module Dry
 
           yield(*predicates, type_spec: type_spec)
         end
+
+        # @api private
+        def resolve_type(type_spec, nullable)
+          resolved = schema_dsl.resolve_type(type_spec)
+
+          if type_spec.is_a?(::Array) || !nullable || resolved.optional?
+            resolved
+          else
+            schema_dsl.resolve_type([:nil, resolved])
+          end
+        end
       end
     end
   end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/schema/primitive_inferrer'
 require 'dry/schema/macros/value'
 
 module Dry
@@ -10,12 +9,6 @@ module Dry
       #
       # @api private
       class Filled < Value
-        # @!attribute [r] primitive_inferrer
-        #   PrimitiveInferrer used to get a list of primitive classes from configured type
-        #   @return [PrimitiveInferrer]
-        #   @api private
-        option :primitive_inferrer, default: proc { PrimitiveInferrer.new }
-
         # @api private
         def call(*predicates, **opts, &block)
           ensure_valid_predicates(predicates)

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/schema/predicate_inferrer'
 require 'dry/schema/processor'
 require 'dry/schema/macros/dsl'
 require 'dry/schema/constants'

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

@@ -28,8 +28,8 @@ module Dry
           definition = schema_dsl.new(&block)
           schema = definition.call
           type_schema =
-            if array?
-              parent_type.of(definition.type_schema)
+            if array_type?(parent_type)
+              build_array_type(parent_type, definition.type_schema)
             elsif redefined_schema?(args)
               parent_type.schema(definition.types)
             else
@@ -56,11 +56,6 @@ module Dry
           parent_type.optional?
         end
 
-        # @api private
-        def array?
-          parent_type.respond_to?(:of)
-        end
-
         # @api private
         def schema?
           parent_type.respond_to?(:schema)

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

@@ -17,8 +17,8 @@ module Dry
             current_type = schema_dsl.types[name]
 
             updated_type =
-              if current_type.respond_to?(:of)
-                current_type.of(schema.type_schema)
+              if array_type?(current_type)
+                build_array_type(current_type, schema.type_schema)
               else
                 schema.type_schema
               end
@@ -39,6 +39,25 @@ module Dry
           self
         end
 
+        # @api private
+        def array_type?(type)
+          primitive_inferrer[type].eql?([::Array])
+        end
+
+        # @api private
+        def build_array_type(array_type, member)
+          if array_type.respond_to?(:of)
+            array_type.of(member)
+          else
+            raise ArgumentError, <<~ERROR.split("\n").join(' ')
+              Cannot define schema for a nominal array type.
+              Array types must be instances of Dry::Types::Array,
+              usually constructed with Types::Constructor(Array) { ... } or
+              Dry::Types['array'].constructor { ... }
+            ERROR
+          end
+        end
+
         # @api private
         def respond_to_missing?(meth, include_private = false)
           super || meth.to_s.end_with?(QUESTION_MARK)

data/lib/dry/schema/message.rb

@@ -60,7 +60,7 @@ module Dry
       #
       # If a string is passed, it will be compared with the text
       #
-      # @param [Message,String]
+      # @param other [Message,String]
       #
       # @return [Boolean]
       #

data/lib/dry/schema/message_compiler.rb

@@ -130,7 +130,8 @@ module Dry
           path: path.last, **tokens, **lookup_options(arg_vals: arg_vals, input: input)
         ).to_h
 
-        template, meta = messages[predicate, options] || raise(MissingMessageError, path)
+        template, meta = messages[predicate, options] ||
+          raise(MissingMessageError.new(path, messages.looked_up_paths(predicate, options)))
 
         text = message_text(template, tokens, options)
 

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

@@ -92,30 +92,34 @@ module Dry
         #
         # @api public
         def call(predicate, options)
-          cache.fetch_or_store([predicate, options.reject { |k,| k.equal?(:input) }]) do
+          cache.fetch_or_store(cache_key(predicate, options)) do
             text, meta = lookup(predicate, options)
             [Template[text], meta] if text
           end
         end
         alias_method :[], :call
 
+        # Retrieve an array of looked up paths
+        #
+        # @param [Symbol] predicate
+        # @param [Hash] options
+        #
+        # @return [String]
+        #
+        # @api public
+        def looked_up_paths(predicate, options)
+          tokens = lookup_tokens(predicate, options)
+          filled_lookup_paths(tokens)
+        end
+
         # Try to find a message for the given predicate and its options
         #
         # @api private
         #
         # rubocop:disable Metrics/AbcSize
         def lookup(predicate, options)
-          tokens = options.merge(
-            predicate: predicate,
-            root: options[:not] ? "#{root}.not" : root,
-            arg_type: config.arg_types[options[:arg_type]],
-            val_type: config.val_types[options[:val_type]],
-            message_type: options[:message_type] || :failure
-          )
-
           opts = options.reject { |k, _| config.lookup_options.include?(k) }
-
-          path = lookup_paths(tokens).detect { |key| key?(key, opts) }
+          path = lookup_paths(predicate, options).detect { |key| key?(key, opts) }
 
           return unless path
 
@@ -130,7 +134,13 @@ module Dry
         # rubocop:enable Metrics/AbcSize
 
         # @api private
-        def lookup_paths(tokens)
+        def lookup_paths(predicate, options)
+          tokens = lookup_tokens(predicate, options)
+          filled_lookup_paths(tokens)
+        end
+
+        # @api private
+        def filled_lookup_paths(tokens)
           config.lookup_paths.map { |path| path % tokens }
         end
 
@@ -167,8 +177,28 @@ module Dry
           config.default_locale
         end
 
+        # @api private
+        def cache_key(predicate, options)
+          if options.key?(:input)
+            [predicate, options.reject { |k,| k.equal?(:input) }]
+          else
+            [predicate, options]
+          end
+        end
+
         private
 
+        # @api private
+        def lookup_tokens(predicate, options)
+          options.merge(
+            predicate: predicate,
+            root: options[:not] ? "#{root}.not" : root,
+            arg_type: config.arg_types[options[:arg_type]],
+            val_type: config.val_types[options[:val_type]],
+            message_type: options[:message_type] || :failure
+          )
+        end
+
         # @api private
         def custom_top_namespace?(path)
           path.to_s == DEFAULT_MESSAGES_PATH.to_s && config.top_namespace != DEFAULT_MESSAGES_ROOT