dry-schema 1.3.4 → 1.5.0

data/lib/dry/schema/message_compiler/visitor_opts.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/schema/constants'
-require 'dry/schema/message'
+require "dry/schema/constants"
+require "dry/schema/message"
 
 module Dry
   module Schema

data/lib/dry/schema/message_set.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/equalizer'
+require "dry/equalizer"
 
 module Dry
   module Schema
@@ -17,13 +17,7 @@ module Dry
       #
       # @return [Array<Message>]
       attr_reader :messages
-      
-      # An internal hash that is filled in with dumped messages
-      # when a message set is coerced to a hash
-      #
-      # @return [Hash<Symbol=>[Array,Hash]>]
-      attr_reader :placeholders
-      
+
       # Options hash
       #
       # @return [Hash]
@@ -38,7 +32,6 @@ module Dry
       def initialize(messages, options = EMPTY_HASH)
         @messages = messages
         @options = options
-        initialize_placeholders!
       end
 
       # Iterate over messages
@@ -112,43 +105,39 @@ module Dry
 
       # @api private
       def messages_map(messages = self.messages)
-        return EMPTY_HASH if empty?
-
-        messages.group_by(&:path).reduce(placeholders) do |hash, (path, msgs)|
-          node = path.reduce(hash) { |a, e| a[e] }
+        combine_message_hashes(messages.map(&:to_h))
+      end
 
-          msgs.each do |msg|
-            node << msg
+      # @api private
+      def combine_message_hashes(hashes)
+        hashes.reduce(EMPTY_HASH.dup) do |a, e|
+          a.merge(e) do |_, *values|
+            combine_message_values(values)
           end
-
-          node.map!(&:dump)
-
-          hash
         end
       end
 
       # @api private
-      def paths
-        @paths ||= messages.map(&:path).uniq
+      def combine_message_values(values)
+        hashes, other = partition_message_values(values)
+        combined = combine_message_hashes(hashes)
+        flattened = other.flatten
+
+        if flattened.empty?
+          combined
+        elsif combined.empty?
+          flattened
+        else
+          [flattened, combined]
+        end
       end
 
       # @api private
-      def initialize_placeholders!
-        return @placeholders = EMPTY_HASH if empty?
-
-        @placeholders = paths.reduce(EMPTY_HASH.dup) do |hash, path|
-          curr_idx = 0
-          last_idx = path.size - 1
-          node = hash
-
-          while curr_idx <= last_idx
-            key = path[curr_idx]
-            node = (node[key] || node[key] = curr_idx < last_idx ? {} : [])
-            curr_idx += 1
-          end
-
-          hash
-        end
+      def partition_message_values(values)
+        values
+          .map { |value| value.is_a?(Array) ? value : [value] }
+          .reduce(EMPTY_ARRAY.dup, :+)
+          .partition { |value| value.is_a?(Hash) && !value[:text].is_a?(String) }
       end
     end
   end

data/lib/dry/schema/messages.rb

@@ -7,8 +7,8 @@ module Dry
     # @api private
     module Messages
       BACKENDS = {
-        i18n: 'I18n',
-        yaml: 'YAML'
+        i18n: "I18n",
+        yaml: "YAML"
       }.freeze
 
       module_function
@@ -31,7 +31,7 @@ module Dry
   end
 end
 
-require 'dry/schema/messages/abstract'
-require 'dry/schema/messages/namespaced'
-require 'dry/schema/messages/yaml'
-require 'dry/schema/messages/i18n' if defined?(I18n)
+require "dry/schema/messages/abstract"
+require "dry/schema/messages/namespaced"
+require "dry/schema/messages/yaml"
+require "dry/schema/messages/i18n" if defined?(I18n)

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'concurrent/map'
-require 'dry/equalizer'
-require 'dry/configurable'
+require "set"
+require "concurrent/map"
+require "dry/equalizer"
+require "dry/configurable"
 
-require 'dry/schema/constants'
-require 'dry/schema/messages/template'
+require "dry/schema/constants"
+require "dry/schema/messages/template"
 
 module Dry
   module Schema
@@ -21,36 +21,31 @@ module Dry
         setting :default_locale, nil
         setting :load_paths, Set[DEFAULT_MESSAGES_PATH]
         setting :top_namespace, DEFAULT_MESSAGES_ROOT
-        setting :root, 'errors'
+        setting :root, "errors"
         setting :lookup_options, %i[root predicate path val_type arg_type].freeze
 
         setting :lookup_paths, [
-          '%<root>s.rules.%<path>s.%<predicate>s.arg.%<arg_type>s',
-          '%<root>s.rules.%<path>s.%<predicate>s',
-          '%<root>s.%<predicate>s.%<message_type>s',
-          '%<root>s.%<predicate>s.value.%<path>s',
-          '%<root>s.%<predicate>s.value.%<val_type>s.arg.%<arg_type>s',
-          '%<root>s.%<predicate>s.value.%<val_type>s',
-          '%<root>s.%<predicate>s.arg.%<arg_type>s',
-          '%<root>s.%<predicate>s'
+          "%<root>s.rules.%<path>s.%<predicate>s.arg.%<arg_type>s",
+          "%<root>s.rules.%<path>s.%<predicate>s",
+          "%<root>s.%<predicate>s.%<message_type>s",
+          "%<root>s.%<predicate>s.value.%<path>s",
+          "%<root>s.%<predicate>s.value.%<val_type>s.arg.%<arg_type>s",
+          "%<root>s.%<predicate>s.value.%<val_type>s",
+          "%<root>s.%<predicate>s.arg.%<arg_type>s",
+          "%<root>s.%<predicate>s"
         ].freeze
 
-        setting :rule_lookup_paths, ['rules.%<name>s'].freeze
+        setting :rule_lookup_paths, ["rules.%<name>s"].freeze
 
-        setting :arg_types, Hash.new { |*| 'default' }.update(
-          Range => 'range'
+        setting :arg_types, Hash.new { |*| "default" }.update(
+          Range => "range"
         )
 
-        setting :val_types, Hash.new { |*| 'default' }.update(
-          Range => 'range',
-          String => 'string'
+        setting :val_types, Hash.new { |*| "default" }.update(
+          Range => "range",
+          String => "string"
         )
 
-        # @api private
-        def self.cache
-          @cache ||= Concurrent::Map.new { |h, k| h[k] = Concurrent::Map.new }
-        end
-
         # @api private
         def self.build(options = EMPTY_HASH)
           messages = new
@@ -79,7 +74,7 @@ module Dry
 
         # @api private
         def rule(name, options = {})
-          tokens = { name: name, locale: options.fetch(:locale, default_locale) }
+          tokens = {name: name, locale: options.fetch(:locale, default_locale)}
           path = rule_lookup_paths(tokens).detect { |key| key?(key, options) }
 
           rule = get(path, options) if path
@@ -92,45 +87,56 @@ module Dry
         #
         # @api public
         def call(predicate, options)
-          cache.fetch_or_store(cache_key(predicate, options)) do
-            text, meta = lookup(predicate, options)
-            [Template[text], meta] if text
-          end
+          options = {locale: default_locale, **options}
+          opts = options.reject { |k,| config.lookup_options.include?(k) }
+          path = lookup_paths(predicate, options).detect { |key| key?(key, opts) }
+
+          return unless path
+
+          result = get(path, opts)
+
+          [
+            Template.new(
+              messages: self,
+              key: path,
+              options: opts
+            ),
+            result[:meta]
+          ]
         end
+
         alias_method :[], :call
 
-        # Try to find a message for the given predicate and its options
+        # Check if given key is defined
         #
-        # @api private
+        # @return [Boolean]
         #
-        # 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) }
-
-          return unless path
+        # @api public
+        def key?(_key, _options = EMPTY_HASH)
+          raise NotImplementedError
+        end
 
-          text = get(path, opts)
+        # 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
 
-          if text.is_a?(Hash)
-            text.values_at(:text, :meta)
-          else
-            [text, EMPTY_HASH]
-          end
+        # @api private
+        def lookup_paths(predicate, options)
+          tokens = lookup_tokens(predicate, options)
+          filled_lookup_paths(tokens)
         end
-        # rubocop:enable Metrics/AbcSize
 
         # @api private
-        def lookup_paths(tokens)
+        def filled_lookup_paths(tokens)
           config.lookup_paths.map { |path| path % tokens }
         end
 
@@ -158,26 +164,33 @@ module Dry
         end
 
         # @api private
-        def cache
-          @cache ||= self.class.cache[self]
+        def default_locale
+          config.default_locale
         end
 
         # @api private
-        def default_locale
-          config.default_locale
+        def interpolatable_data(_key, _options, **_data)
+          raise NotImplementedError
         end
 
         # @api private
-        def cache_key(predicate, options)
-          if options.key?(:input)
-            [predicate, options.reject { |k,| k.equal?(:input) }]
-          else
-            [predicate, options]
-          end
+        def interpolate(_key, _options, **_data)
+          raise NotImplementedError
         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

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'i18n'
-require 'dry/schema/messages/abstract'
+require "i18n"
+require "dry/schema/messages/abstract"
 
 module Dry
   module Schema
@@ -29,7 +29,22 @@ module Dry
       #
       # @api public
       def get(key, options = EMPTY_HASH)
-        t.(key, locale: options.fetch(:locale, default_locale)) if key
+        return unless key
+
+        result = t.(key, locale: options.fetch(:locale, default_locale))
+
+        if result.is_a?(Hash)
+          text = result[:text]
+          meta = result.dup.tap { |h| h.delete(:text) }
+        else
+          text = result
+          meta = EMPTY_HASH.dup
+        end
+
+        {
+          text: text,
+          meta: meta
+        }
       end
 
       # Check if given key is defined
@@ -67,7 +82,7 @@ module Dry
             top_namespace = config.top_namespace
 
             mapped_data = data
-              .map { |k, v| [k, { top_namespace => v[DEFAULT_MESSAGES_ROOT] }] }
+              .map { |k, v| [k, {top_namespace => v[DEFAULT_MESSAGES_ROOT]}] }
               .to_h
 
             store_translations(mapped_data)
@@ -80,12 +95,23 @@ module Dry
       end
 
       # @api private
-      def cache_key(predicate, options)
-        if options[:locale]
-          super
-        else
-          [*super, I18n.locale]
-        end
+      def interpolatable_data(_key, _options, **data)
+        data
+      end
+
+      # @api private
+      def interpolate(key, options, **data)
+        text_key = "#{key}.text"
+
+        opts = {
+          locale: default_locale,
+          **options,
+          **data
+        }
+
+        resolved_key = key?(text_key, opts) ? text_key : key
+
+        t.(resolved_key, **opts)
       end
 
       private

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

@@ -24,7 +24,7 @@ module Dry
           @config = messages.config
           @namespace = namespace
           @messages = messages
-          @call_opts = { namespace: namespace }.freeze
+          @call_opts = {namespace: namespace}.freeze
         end
 
         # Get a message for the given key and its options
@@ -55,20 +55,30 @@ module Dry
         end
 
         # @api private
-        def lookup_paths(tokens)
+        def filled_lookup_paths(tokens)
           super(tokens.merge(root: "#{tokens[:root]}.#{namespace}")) + super
         end
 
         # @api private
         def rule_lookup_paths(tokens)
           base_paths = messages.rule_lookup_paths(tokens)
-          base_paths.map { |key| key.gsub('dry_schema', "dry_schema.#{namespace}") } + base_paths
+          base_paths.map { |key| key.gsub("dry_schema", "dry_schema.#{namespace}") } + base_paths
         end
 
         # @api private
         def cache_key(predicate, options)
           messages.cache_key(predicate, options)
         end
+
+        # @api private
+        def interpolatable_data(key, options, **data)
+          messages.interpolatable_data(key, options, **data)
+        end
+
+        # @api private
+        def interpolate(key, options, **data)
+          messages.interpolate(key, options, **data)
+        end
       end
     end
   end