dry-validation 1.3.1 → 1.8.1

data/lib/dry/validation/macros.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/container'
-require 'dry/validation/macro'
+require "dry/container"
+require "dry/validation/macro"
 
 module Dry
   module Validation
@@ -25,7 +25,7 @@ module Dry
         #   end
         #
         # @param [Symbol] name The name of the macro
-        # @param [Array] *args Optional default arguments for the macro
+        # @param [Array] args Optional default positional arguments for the macro
         #
         # @return [self]
         #

data/lib/dry/validation/message.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry/equalizer'
+require "dry/core/equalizer"
 
-require 'dry/schema/constants'
-require 'dry/schema/message'
+require "dry/schema/constants"
+require "dry/schema/message"
 
 module Dry
   module Validation
@@ -52,7 +52,7 @@ module Dry
         #
         # @api public
         def evaluate(**opts)
-          evaluated_text, rest = text.(opts)
+          evaluated_text, rest = text.(**opts)
           Message.new(evaluated_text, path: path, meta: rest.merge(meta))
         end
       end
@@ -70,11 +70,13 @@ module Dry
       # Initialize a new error object
       #
       # @api private
+      # rubocop: disable Lint/MissingSuper
       def initialize(text, path:, meta: EMPTY_HASH)
         @text = text
         @path = Array(path)
         @meta = meta
       end
+      # rubocop: enable Lint/MissingSuper
 
       # Check if this is a base error not associated with any key
       #

data/lib/dry/validation/message_set.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry/schema/message_set'
+require "dry/schema/message_set"
 
-require 'dry/validation/constants'
-require 'dry/validation/message'
+require "dry/validation/constants"
+require "dry/validation/message"
 
 module Dry
   module Validation
@@ -41,7 +41,7 @@ module Dry
         return self if new_options.empty? && other.eql?(messages)
 
         self.class.new(
-          (other + select { |err| err.is_a?(Message) }).uniq,
+          other | select { |err| err.is_a?(Message) },
           options.merge(source: source_messages, **new_options)
         ).freeze
       end
@@ -54,9 +54,9 @@ module Dry
       #
       # @api private
       def add(message)
+        @empty = nil
         source_messages << message
         messages << message
-        initialize_placeholders!
         self
       end
 
@@ -85,58 +85,13 @@ module Dry
       # @api private
       def freeze
         source_messages.select { |err| err.respond_to?(:evaluate) }.each do |err|
-          idx = source_messages.index(err)
+          idx = messages.index(err) || source_messages.index(err)
           msg = err.evaluate(locale: locale, full: options[:full])
           messages[idx] = msg
         end
         to_h
         self
       end
-
-      private
-
-      # @api private
-      def unique_paths
-        source_messages.uniq(&:path).map(&:path)
-      end
-
-      # @api private
-      def messages_map
-        @messages_map ||= 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/validation/messages/resolver.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
-require 'dry/validation/message'
+require "dry/validation/message"
+require "dry/schema/message_compiler"
 
 module Dry
   module Validation
     module Messages
+      FULL_MESSAGE_WHITESPACE = Dry::Schema::MessageCompiler::FULL_MESSAGE_WHITESPACE
+
       # Resolve translated messages from failure arguments
       #
       # @api public
@@ -22,6 +25,8 @@ module Dry
         # Resolve Message object from provided args and path
         #
         # This is used internally by contracts when rules are applied
+        # If message argument is a Hash, then it MUST have a :text key,
+        # which value will be used as the message value
         #
         # @return [Message, Message::Localized]
         #
@@ -31,10 +36,15 @@ module Dry
           when Symbol
             Message[->(**opts) { message(message, path: path, tokens: tokens, **opts) }, path, meta]
           when String
-            Message[message, path, meta]
+            Message[->(**opts) { [message_text(message, path: path, **opts), meta] }, path, meta]
           when Hash
             meta = message.dup
-            text = meta.delete(:text)
+            text = meta.delete(:text) { |key|
+              raise ArgumentError, <<~STR
+                +message+ Hash must contain :#{key} key (#{message.inspect} given)
+              STR
+            }
+
             call(message: text, tokens: tokens, path: path, meta: meta)
           else
             raise ArgumentError, <<~STR
@@ -51,7 +61,8 @@ module Dry
         # @api public
         #
         # rubocop:disable Metrics/AbcSize
-        def message(rule, tokens: EMPTY_HASH, locale: nil, full: false, path:)
+        # rubocop:disable Metrics/PerceivedComplexity
+        def message(rule, path:, tokens: EMPTY_HASH, locale: nil, full: false)
           keys = path.to_a.compact
           msg_opts = tokens.merge(path: keys, locale: locale || messages.default_locale)
 
@@ -62,17 +73,56 @@ module Dry
             template, meta = messages[rule, msg_opts.merge(path: keys.last)] unless template
           end
 
+          if !template && keys.size > 1
+            non_index_keys = keys.reject { |k| k.is_a?(Integer) }
+            template, meta = messages[rule, msg_opts.merge(path: non_index_keys.join(DOT))]
+          end
+
           unless template
             raise MissingMessageError, <<~STR
               Message template for #{rule.inspect} under #{keys.join(DOT).inspect} was not found
             STR
           end
 
-          text = template.(template.data(tokens))
+          parsed_tokens = parse_tokens(tokens)
+          text = template.(template.data(parsed_tokens))
 
-          [full ? "#{messages.rule(keys.last, msg_opts)} #{text}" : text, meta]
+          [message_text(text, path: path, locale: locale, full: full), meta]
         end
+        # rubocop:enable Metrics/PerceivedComplexity
         # rubocop:enable Metrics/AbcSize
+
+        private
+
+        def message_text(text, path:, locale: nil, full: false)
+          return text unless full
+
+          key = key_text(path: path, locale: locale)
+
+          [key, text].compact.join(FULL_MESSAGE_WHITESPACE[locale])
+        end
+
+        def key_text(path:, locale: nil)
+          locale ||= messages.default_locale
+
+          keys = path.to_a.compact
+          msg_opts = {path: keys, locale: locale}
+
+          messages.rule(keys.last, msg_opts) || keys.last
+        end
+
+        def parse_tokens(tokens)
+          tokens.transform_values { parse_token(_1) }
+        end
+
+        def parse_token(token)
+          case token
+          when Array
+            token.join(", ")
+          else
+            token
+          end
+        end
       end
     end
   end

data/lib/dry/validation/result.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
-require 'dry/equalizer'
+require "concurrent/map"
+require "dry/core/equalizer"
 
-require 'dry/validation/constants'
-require 'dry/validation/message_set'
-require 'dry/validation/values'
+require "dry/validation/constants"
+require "dry/validation/message_set"
+require "dry/validation/values"
 
 module Dry
   module Validation
@@ -101,11 +101,32 @@ module Dry
 
       # Check if values include an error for the provided key
       #
-      # @api private
+      # @api public
       def error?(key)
+        errors.any? { |msg| Schema::Path[msg.path].include?(Schema::Path[key]) }
+      end
+
+      # Check if the base schema (without rules) includes an error for the provided key
+      #
+      # @api private
+      def schema_error?(key)
         schema_result.error?(key)
       end
 
+      # Check if the rules includes an error for the provided key
+      #
+      # @api private
+      def rule_error?(key)
+        !schema_error?(key) && error?(key)
+      end
+
+      # Check if the result contains any base rule errors
+      #
+      # @api private
+      def base_rule_error?
+        !errors.filter(:base?).empty?
+      end
+
       # Check if there's any error for the provided key
       #
       # This does not consider errors from the nested values
@@ -116,7 +137,7 @@ module Dry
           key_path = Schema::Path[key]
           err_path = Schema::Path[error.path]
 
-          return false unless key_path.same_root?(err_path)
+          next unless key_path.same_root?(err_path)
 
           key_path == err_path
         }
@@ -179,6 +200,22 @@ module Dry
         super
       end
 
+      if RUBY_VERSION >= "2.7"
+        # Pattern matching
+        #
+        # @api private
+        def deconstruct_keys(keys)
+          values.deconstruct_keys(keys)
+        end
+
+        # Pattern matching
+        #
+        # @api private
+        def deconstruct
+          [values, context.each.to_h]
+        end
+      end
+
       private
 
       # @api private

data/lib/dry/validation/rule.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry/equalizer'
+require "dry/core/equalizer"
 
-require 'dry/validation/constants'
-require 'dry/validation/function'
+require "dry/validation/constants"
+require "dry/validation/function"
 
 module Dry
   module Validation
@@ -65,8 +65,8 @@ module Dry
       # for a given array item.
       #
       # @example
-      #   rule(:nums).each do
-      #     key.failure("must be greater than 0") if value < 0
+      #   rule(:nums).each do |index:|
+      #     key([:number, index]).failure("must be greater than 0") if value < 0
       #   end
       #   rule(:nums).each(min: 3)
       #   rule(address: :city) do
@@ -76,19 +76,21 @@ module Dry
       # @return [Rule]
       #
       # @api public
+      #
+      # rubocop:disable Metrics/AbcSize
       def each(*macros, &block)
         root = keys[0]
         macros = parse_macros(*macros)
         @keys = []
 
         @block = proc do
-          unless result.base_error?(root) || !values.key?(root)
+          unless result.base_error?(root) || !values.key?(root) || values[root].nil?
             values[root].each_with_index do |_, idx|
               path = [*Schema::Path[root].to_a, idx]
 
-              next if result.error?(path)
+              next if result.schema_error?(path)
 
-              evaluator = with(macros: macros, keys: [path], &block)
+              evaluator = with(macros: macros, keys: [path], index: idx, &block)
 
               failures.concat(evaluator.failures)
             end
@@ -99,6 +101,7 @@ module Dry
 
         self
       end
+      # rubocop:enable Metrics/AbcSize
 
       # Return a nice string representation
       #
@@ -118,12 +121,18 @@ module Dry
         args.each_with_object([]) do |spec, macros|
           case spec
           when Hash
-            spec.each { |k, v| macros << [k, Array(v)] }
+            add_macro_from_hash(macros, spec)
           else
             macros << Array(spec)
           end
         end
       end
+
+      def add_macro_from_hash(macros, spec)
+        spec.each do |k, v|
+          macros << [k, v.is_a?(Array) ? v : [v]]
+        end
+      end
     end
   end
 end

data/lib/dry/validation/schema_ext.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/schema/key'
-require 'dry/schema/key_map'
+require "dry/schema/path"
 
 module Dry
   module Schema
@@ -16,31 +15,5 @@ module Dry
         to_a[0..-2].product(last).map { |spec| self.class[spec] }
       end
     end
-
-    # @api private
-    #
-    # TODO: this should be moved to dry-schema at some point
-    class Key
-      # @api private
-      def to_dot_notation
-        [name.to_s]
-      end
-
-      # @api private
-      class Hash < Key
-        # @api private
-        def to_dot_notation
-          [name].product(members.map(&:to_dot_notation).flatten(1)).map { |e| e.join(DOT) }
-        end
-      end
-    end
-
-    # @api private
-    class KeyMap
-      # @api private
-      def to_dot_notation
-        @to_dot_notation ||= map(&:to_dot_notation).flatten
-      end
-    end
   end
 end

data/lib/dry/validation/values.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'dry/equalizer'
-require 'dry/schema/path'
-require 'dry/validation/constants'
+require "dry/core/equalizer"
+require "dry/schema/path"
+require "dry/validation/constants"
 
 module Dry
   module Validation
@@ -35,7 +35,10 @@ module Dry
       #     key.failure('must be > 18') if values[:age] <= 18
       #   end
       #
-      # @param [Symbol] key
+      # @param args [Symbol, String, Hash, Array<Symbol>] If given as a single
+      #   Symbol, String, Array or Hash, build a key array using
+      #   {Dry::Schema::Path} digging for data. If given as positional
+      #   arguments, use these with Hash#dig on the data directly.
       #
       # @return [Object]
       #
@@ -53,11 +56,12 @@ module Dry
           vals = self.class.new(data.dig(*keys))
           vals.fetch_values(*last) { nil }
         else
-          raise ArgumentError, '+key+ must be a valid path specification'
+          raise ArgumentError, "+key+ must be a valid path specification"
         end
       end
 
       # @api public
+      # rubocop: disable Metrics/PerceivedComplexity
       def key?(key, hash = data)
         return hash.key?(key) if key.is_a?(Symbol)
 
@@ -65,14 +69,20 @@ module Dry
           if e.is_a?(Array)
             result = e.all? { |k| key?(k, a) }
             return result
+          elsif e.is_a?(Symbol) && a.is_a?(Array)
+            return false
+          elsif a.nil?
+            return false
+          elsif a.is_a?(String)
+            return false
           else
             return false unless a.is_a?(Array) ? (e >= 0 && e < a.size) : a.key?(e)
           end
           a[e]
         end
-
         true
       end
+      # rubocop: enable Metrics/PerceivedComplexity
 
       # @api private
       def respond_to_missing?(meth, include_private = false)
@@ -89,6 +99,7 @@ module Dry
           super
         end
       end
+      ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
     end
   end
 end

data/lib/dry/validation/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Validation
-    VERSION = '1.3.1'
+    VERSION = "1.8.1"
   end
 end

data/lib/dry/validation.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'dry/validation/constants'
-require 'dry/validation/contract'
-require 'dry/validation/macros'
+require "dry/validation/constants"
+require "dry/validation/contract"
+require "dry/validation/macros"
 
 # Main namespace
 #
@@ -16,15 +16,15 @@ module Dry
     extend Macros::Registrar
 
     register_extension(:monads) do
-      require 'dry/validation/extensions/monads'
+      require "dry/validation/extensions/monads"
     end
 
     register_extension(:hints) do
-      require 'dry/validation/extensions/hints'
+      require "dry/validation/extensions/hints"
     end
 
     register_extension(:predicates_as_macros) do
-      require 'dry/validation/extensions/predicates_as_macros'
+      require "dry/validation/extensions/predicates_as_macros"
     end
 
     # Define a contract and build its instance
@@ -46,11 +46,9 @@ module Dry
     #
     # @api public
     #
-    # rubocop:disable Naming/MethodName
     def self.Contract(options = EMPTY_HASH, &block)
       Contract.build(options, &block)
     end
-    # rubocop:enable Naming/MethodName
 
     # This is needed by Macros::Registrar
     #

data/lib/dry-validation.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'dry/validation'
+require "dry/validation"