dry-validation 0.12.0 → 1.6.0

data/lib/dry/validation/message.rb

@@ -1,98 +1,98 @@
-require 'dry/equalizer'
+# frozen_string_literal: true
 
-module Dry
-  module Validation
-    class Message
-      include Dry::Equalizer(:predicate, :path, :text, :options)
-
-      attr_reader :predicate, :path, :text, :rule, :args, :options
-
-      class Or
-        attr_reader :left
-
-        attr_reader :right
+require "dry/equalizer"
 
-        attr_reader :path
+require "dry/schema/constants"
+require "dry/schema/message"
 
-        attr_reader :messages
-
-        def initialize(left, right, messages)
-          @left = left
-          @right = right
-          @messages = messages
-          @path = left.path
-        end
-
-        def hint?
-          false
-        end
-
-        def root?
-          path.empty?
-        end
-
-        def to_s
-          [left, right].uniq.join(" #{messages[:or]} ")
+module Dry
+  module Validation
+    # Message message
+    #
+    # @api public
+    class Message < Schema::Message
+      include Dry::Equalizer(:text, :path, :meta)
+
+      # The error message text
+      #
+      # @return [String] text
+      #
+      # @api public
+      attr_reader :text
+
+      # The path to the value with the error
+      #
+      # @return [Array<Symbol, Integer>]
+      #
+      # @api public
+      attr_reader :path
+
+      # Optional hash with meta-data
+      #
+      # @return [Hash]
+      #
+      # @api public
+      attr_reader :meta
+
+      # A localized message type
+      #
+      # Localized messsages can be translated to other languages at run-time
+      #
+      # @api public
+      class Localized < Message
+        # Evaluate message text using provided locale
+        #
+        # @example
+        #   result.errors[:email].evaluate(locale: :en, full: true)
+        #   # "email is invalid"
+        #
+        # @param [Hash] opts
+        # @option opts [Symbol] :locale Which locale to use
+        # @option opts [Boolean] :full Whether message text should include the key name
+        #
+        # @api public
+        def evaluate(**opts)
+          evaluated_text, rest = text.(**opts)
+          Message.new(evaluated_text, path: path, meta: rest.merge(meta))
         end
       end
 
-      class Check < Message
-        def initialize(*args)
-          super
-          @path = [rule] unless rule.to_s.end_with?('?') || path.include?(rule)
-        end
+      # Build an error
+      #
+      # @return [Message, Message::Localized]
+      #
+      # @api private
+      def self.[](text, path, meta)
+        klass = text.respond_to?(:call) ? Localized : Message
+        klass.new(text, path: path, meta: meta)
       end
 
-      def self.[](predicate, path, text, options)
-        if options[:check]
-          Message::Check.new(predicate, path, text, options)
-        else
-          Message.new(predicate, path, text, options)
-        end
-      end
-
-      def initialize(predicate, path, text, options)
-        @predicate = predicate
-        @path = path
+      # Initialize a new error object
+      #
+      # @api private
+      def initialize(text, path:, meta: EMPTY_HASH)
         @text = text
-        @options = options
-        @rule = options[:rule]
-        @args = options[:args] || EMPTY_ARRAY
+        @path = Array(path)
+        @meta = meta
+      end
 
-        if predicate == :key?
-          @path << rule
-        end
+      # Check if this is a base error not associated with any key
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def base?
+        @base ||= path.compact.empty?
       end
 
+      # Dump error to a string
+      #
+      # @return [String]
+      #
+      # @api public
       def to_s
         text
       end
-
-      def signature
-        @signature ||= [predicate, args, path].hash
-      end
-
-      def hint?
-        false
-      end
-
-      def root?
-        path.empty?
-      end
-
-      def eql?(other)
-        other.is_a?(String) ? text == other : super
-      end
-    end
-
-    class Hint < Message
-      def self.[](predicate, path, text, options)
-        Hint.new(predicate, path, text, options)
-      end
-
-      def hint?
-        true
-      end
     end
   end
 end

data/lib/dry/validation/message_set.rb

@@ -1,121 +1,96 @@
-module Dry
-  module Validation
-    class MessageSet
-      include Enumerable
+# frozen_string_literal: true
 
-      HINT_EXCLUSION = %i(
-        key? filled? none? bool?
-        str? int? float? decimal?
-        date? date_time? time? hash?
-        array? format?
-      ).freeze
+require "dry/schema/message_set"
 
-      attr_reader :messages, :failures, :hints, :paths, :placeholders, :options
-
-      def self.[](messages, options = EMPTY_HASH)
-        new(messages.flatten, options)
-      end
+require "dry/validation/constants"
+require "dry/validation/message"
 
+module Dry
+  module Validation
+    # MessageSet is a specialized message set for handling validation messages
+    #
+    # @api public
+    class MessageSet < Schema::MessageSet
+      # Return the source set of messages used to produce final evaluated messages
+      #
+      # @return [Array<Message, Message::Localized, Schema::Message>]
+      #
+      # @api private
+      attr_reader :source_messages
+
+      # Configured locale
+      #
+      # @return [Symbol]
+      #
+      # @api public
+      attr_reader :locale
+
+      # @api private
       def initialize(messages, options = EMPTY_HASH)
-        @messages = messages
-        @hints = messages.select(&:hint?)
-        @failures = messages - hints
-        @paths = failures.map(&:path).uniq
-        @options = options
-
-        initialize_hints!
-        initialize_placeholders!
-      end
-
-      def dump
-        root? ? to_a : to_h
-      end
-
-      def failures?
-        options[:failures].equal?(true)
-      end
-
-      def empty?
-        messages.empty?
-      end
-
-      def root?
-        !empty? && failures.all?(&:root?)
-      end
-
-      def each(&block)
-        return to_enum unless block
-        messages.each(&block)
-      end
-
-      def to_h
-        if root?
-          { nil => failures.map(&:to_s) }
-        else
-          failures? ? messages_map : hints_map
-        end
-      end
-      alias_method :to_hash, :to_h
-
-      def to_a
-        to_h.values.flatten
-      end
-
-      private
-
-      def messages_map
-        failures.group_by(&:path).reduce(placeholders) do |hash, (path, msgs)|
-          node = path.reduce(hash) { |a, e| a[e] }
-
-          msgs.each do |msg|
-            node << msg
-
-            msg_hints = hint_groups[msg.path]
-            node.concat(msg_hints) if msg_hints
-          end
-
-          node.map!(&:to_s)
-
-          hash
-        end
+        @locale = options[:locale]
+        @source_messages = options.fetch(:source) { messages.dup }
+        super
       end
 
-      def hints_map
-        hints.group_by(&:path).reduce(placeholders) do |hash, (path, msgs)|
-          node = path.reduce(hash) { |a, e| a[e] }
-
-          msgs.each do |msg|
-            node << msg
-          end
-
-          node.map!(&:to_s)
-
-          hash
-        end
+      # Return a new message set using updated options
+      #
+      # @return [MessageSet]
+      #
+      # @api private
+      def with(other, new_options = EMPTY_HASH)
+        return self if new_options.empty? && other.eql?(messages)
+
+        self.class.new(
+          other | select { |err| err.is_a?(Message) },
+          options.merge(source: source_messages, **new_options)
+        ).freeze
       end
 
-      def hint_groups
-        @hint_groups ||= hints.group_by(&:path)
+      # Add a new message
+      #
+      # This is used when result is being prepared
+      #
+      # @return [MessageSet]
+      #
+      # @api private
+      def add(message)
+        @empty = nil
+        source_messages << message
+        messages << message
+        self
       end
 
-      def initialize_hints!
-        hints.reject! { |hint| HINT_EXCLUSION.include?(hint.predicate) }
+      # Filter message set using provided predicates
+      #
+      # This method is open to any predicate because messages can be anything that
+      # implements Message API, thus they can implement whatever predicates you
+      # may need.
+      #
+      # @example get a list of base messages
+      #   message_set = contract.(input).errors
+      #   message_set.filter(:base?)
+      #
+      # @param [Array<Symbol>] predicates
+      #
+      # @return [MessageSet]
+      #
+      # @api public
+      def filter(*predicates)
+        messages = select { |msg|
+          predicates.all? { |predicate| msg.respond_to?(predicate) && msg.public_send(predicate) }
+        }
+        self.class.new(messages)
       end
 
-      def initialize_placeholders!
-        @placeholders = paths.reduce({}) do |hash, path|
-          curr_idx = 0
-          last_idx = path.size - 1
-          node = hash
-
-          while curr_idx <= last_idx do
-            key = path[curr_idx]
-            node = (node[key] || node[key] = curr_idx < last_idx ? {} : [])
-            curr_idx += 1
-          end
-
-          hash
+      # @api private
+      def freeze
+        source_messages.select { |err| err.respond_to?(:evaluate) }.each do |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
     end
   end

data/lib/dry/validation/messages/resolver.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+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
+      class Resolver
+        # @!attribute [r] messages
+        #   @return [Messages::I18n, Messages::YAML] messages backend
+        #   @api private
+        attr_reader :messages
+
+        # @api private
+        def initialize(messages)
+          @messages = messages
+        end
+
+        # 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]
+        #
+        # @api public
+        def call(message:, tokens:, path:, meta: EMPTY_HASH)
+          case message
+          when Symbol
+            Message[->(**opts) { message(message, path: path, tokens: tokens, **opts) }, path, meta]
+          when String
+            Message[->(**opts) { [message_text(message, path: path, **opts), meta] }, path, meta]
+          when Hash
+            meta = message.dup
+            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
+              +message+ must be either a Symbol, String or Hash (#{message.inspect} given)
+            STR
+          end
+        end
+        alias_method :[], :call
+
+        # Resolve a message
+        #
+        # @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)
+
+          if keys.empty?
+            template, meta = messages["rules.#{rule}", msg_opts]
+          else
+            template, meta = messages[rule, msg_opts.merge(path: keys.join(DOT))]
+            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
+
+          parsed_tokens = parse_tokens(tokens)
+          text = template.(template.data(parsed_tokens))
+
+          [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
+  end
+end