dry-validation 1.0.0 → 1.5.6

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/monads/result'
-
 module Dry
   module Validation
     # Hints extension
@@ -46,7 +44,7 @@ module Dry
         #
         # @api public
         def messages(new_options = EMPTY_HASH)
-          errors.with(hints.to_a, options.merge(**new_options))
+          errors.with(hints(new_options).to_a, options.merge(**new_options))
         end
 
         # Return hint messages

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

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

data/lib/dry/validation/extensions/predicates_as_macros.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "dry/schema/predicate_registry"
+require "dry/validation/contract"
+
+module Dry
+  module Validation
+    # Predicate registry with additional needed methods.
+    class PredicateRegistry < Schema::PredicateRegistry
+      # List of predicates to be imported by `:predicates_as_macros`
+      # extension.
+      #
+      # @see Dry::Validation::Contract
+      WHITELIST = %i[
+        filled? format? gt? gteq? included_in? includes? inclusion? is? lt?
+        lteq? max_size? min_size? not_eql? odd? respond_to? size? true?
+        uuid_v4?
+      ].freeze
+
+      # @api private
+      def arg_names(name)
+        arg_list(name).map(&:first)
+      end
+
+      # @api private
+      def call(name, args)
+        self[name].(*args)
+      end
+
+      # @api private
+      def message_opts(name, arg_values)
+        arg_names(name).zip(arg_values).to_h
+      end
+    end
+
+    # Extension to use dry-logic predicates as macros.
+    #
+    # @see Dry::Validation::PredicateRegistry::WHITELIST Available predicates
+    #
+    # @example
+    #   Dry::Validation.load_extensions(:predicates_as_macros)
+    #
+    #   class ApplicationContract < Dry::Validation::Contract
+    #     import_predicates_as_macros
+    #   end
+    #
+    #   class AgeContract < ApplicationContract
+    #     schema do
+    #       required(:age).filled(:integer)
+    #     end
+    #
+    #     rule(:age).validate(gteq?: 18)
+    #   end
+    #
+    #   AgeContract.new.(age: 17).errors.first.text
+    #   # => 'must be greater than or equal to 18'
+    #
+    # @api public
+    class Contract
+      # Make macros available for self and its descendants.
+      def self.import_predicates_as_macros
+        registry = PredicateRegistry.new
+
+        PredicateRegistry::WHITELIST.each do |name|
+          register_macro(name) do |macro:|
+            predicate_args = [*macro.args, value]
+            message_opts = registry.message_opts(name, predicate_args)
+
+            key.failure(name, message_opts) unless registry.(name, predicate_args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/validation/failures.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/schema/path'
-require 'dry/validation/constants'
+require "dry/schema/path"
+require "dry/validation/constants"
 
 module Dry
   module Validation
@@ -45,14 +45,26 @@ module Dry
       #   @example
       #     failure(:taken)
       #
+      # @overload failure(meta_hash)
+      #   Use meta_hash[:text] as a message (either explicitely or as an identifier),
+      #   setting the rest of the hash as error meta attribute
+      #   @param meta [Hash] The hash containing the message as value for the :text key
+      #   @example
+      #     failure({text: :invalid, key: value})
+      #
       # @see Evaluator#key
       # @see Evaluator#base
       #
       # @api public
       def failure(message, tokens = EMPTY_HASH)
-        opts << { message: message, tokens: tokens, path: path }
+        opts << {message: message, tokens: tokens, path: path}
         self
       end
+
+      # @api private
+      def empty?
+        opts.empty?
+      end
     end
   end
 end

data/lib/dry/validation/function.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/initializer'
-require 'dry/validation/constants'
+require "dry/initializer"
+require "dry/validation/constants"
 
 module Dry
   module Validation
@@ -19,21 +19,24 @@ module Dry
       #   @api private
       option :block
 
+      # @!attribute [r] block_options
+      #   @return [Hash]
+      #   @api private
+      option :block_options, default: -> { block ? map_keywords(block) : EMPTY_HASH }
+
       private
 
       # Extract options for the block kwargs
       #
-      # @return [Hash]
+      # @param [Proc] block Callable
+      # @return Hash
       #
       # @api private
-      def block_options
-        return EMPTY_HASH unless block
-
-        @block_options ||= block
+      def map_keywords(block)
+        block
           .parameters
-          .select { |arg| arg[0].equal?(:keyreq) }
-          .map(&:last)
-          .map { |name| [name, BLOCK_OPTIONS_MAPPINGS[name]] }
+          .select { |arg,| arg.equal?(:keyreq) }
+          .map { |_, name| [name, BLOCK_OPTIONS_MAPPINGS[name]] }
           .to_h
       end
     end

data/lib/dry/validation/macro.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/validation/constants'
-require 'dry/validation/function'
+require "dry/validation/constants"
+require "dry/validation/function"
 
 module Dry
   module Validation

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/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

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
@@ -49,6 +59,8 @@ module Dry
         # @return [String]
         #
         # @api public
+        #
+        # rubocop:disable Metrics/AbcSize
         def message(rule, tokens: EMPTY_HASH, locale: nil, full: false, path:)
           keys = path.to_a.compact
           msg_opts = tokens.merge(path: keys, locale: locale || messages.default_locale)
@@ -60,15 +72,58 @@ 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/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)
+          Hash[
+            tokens.map do |key, token|
+              [key, parse_token(token)]
+            end
+          ]
+        end
+
+        def parse_token(token)
+          case token
+          when Array
+            token.join(", ")
+          else
+            token
+          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/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,34 @@ 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 there's any error for the provided key
+      #
+      # This does not consider errors from the nested values
+      #
+      # @api private
+      def base_error?(key)
+        schema_result.errors.any? { |error|
+          key_path = Schema::Path[key]
+          err_path = Schema::Path[error.path]
+
+          next unless key_path.same_root?(err_path)
+
+          key_path == err_path
+        }
+      end
+
       # Add a new error for the provided key
       #
       # @api private
@@ -148,9 +171,9 @@ module Dry
       # @api public
       def inspect
         if context.empty?
-          "#<#{self.class}#{to_h.inspect} errors=#{errors.to_h.inspect}>"
+          "#<#{self.class}#{to_h} errors=#{errors.to_h}>"
         else
-          "#<#{self.class}#{to_h.inspect} errors=#{errors.to_h.inspect} context=#{context.each.to_h.inspect}>"
+          "#<#{self.class}#{to_h} errors=#{errors.to_h} context=#{context.each.to_h}>"
         end
       end
 
@@ -163,6 +186,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