tater 2.0.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb7166fcdf9b548f8837e4411bfe5d83712f202e1de27c299fa0e5694b50bc2b
-  data.tar.gz: ab3f53e56fa8538f39ce59ba9f2e42496e5bea116a880fc26e23ad2091e5e93c
+  metadata.gz: 866326a5050b49de428a273e71709fe84f1a4e2e82c5325fef634fcea8282878
+  data.tar.gz: af9bdb6c35c928886bf3f50779447e88a9a4f4ce7c36222bb3f5bb762ec2f59a
 SHA512:
-  metadata.gz: ceb821ff34a086711feb0df9e21a7aa4c7891a3e84fc52a9cf62d5972462c6ab0a5f81eef2ab820ef95df7211dda82e2a56299a1ced017e468c50358b6e537db
-  data.tar.gz: 2ad3f4c078bb63e39b5650254f92cb3859c39c73f4eaf2dfae18320e60712bf2c632e42c38770c39a456ee62f13fbf6262e1fef527846c17c53d7ebd859fa6de
+  metadata.gz: fb353520b23e2235ee49899e84460f5667a6767c38019ce38e19eb823fe181eba3d7cecc9a4f72a907c77afc279a94994ab505073e29861169cb064b1f56bf32
+  data.tar.gz: b6ff46ec8d5f33f44bae20a3996aa9e77bd1a101a6f841e1a35c7af74fca33353817974a2414739734095f6a3315898bec0edd2726eef18ec78feae28edee58d

data/lib/tater.rb

@@ -1,97 +1,26 @@
 # frozen_string_literal: true
 require 'bigdecimal'
+require 'date'
+require 'time'
 require 'yaml'
+require 'tater/utils'
+require 'tater/hash' unless Hash.method_defined?(:except)
 
 # Tater is a internationalization (i18n) and localization (l10n) library
 # designed for speed and simplicity.
 class Tater
   class MissingLocalizationFormat < ArgumentError; end
-
   class UnLocalizableObject < ArgumentError; end
 
-  module Utils # :nodoc:
-    # Merge all the way down.
-    #
-    # @param to [Hash]
-    #   The target Hash to merge into.
-    # @param from [Hash]
-    #   The Hash to copy values from.
-    # @return [Hash]
-    def self.deep_merge(to, from)
-      to.merge(from) do |_key, left, right|
-        if left.is_a?(Hash) && right.is_a?(Hash)
-          Utils.deep_merge(left, right)
-        else
-          right
-        end
-      end
-    end
-
-    # Transform keys all the way down.
-    #
-    # @param hash [Hash]
-    #   The Hash to stringify keys for.
-    # @return [Hash]
-    def self.deep_stringify_keys(hash)
-      hash.transform_keys(&:to_s).transform_values do |value|
-        if value.is_a?(Hash)
-          Utils.deep_stringify_keys(value)
-        else
-          value
-        end
-      end
-    end
-
-    # Freeze all the way down.
-    #
-    # @param hash [Hash]
-    # @return [Hash]
-    def self.deep_freeze(hash)
-      hash.transform_keys(&:freeze).transform_values do |value|
-        if value.is_a?(Hash)
-          Utils.deep_freeze(value)
-        else
-          value.freeze
-        end
-      end.freeze
-    end
-
-    # Try to interpolate these things, if one of them is a string.
-    #
-    # @param string [String]
-    #   The target string to interpolate into.
-    # @param options [Hash]
-    #   The values to interpolate into the target string.
-    #
-    # @return [String]
-    def self.interpolate(string, options = HASH)
-      return string unless string.is_a?(String)
-      return string if options.empty?
-
-      format(string, options)
-    end
-
-    # Convert a Numeric to a string, particularly formatting BigDecimals to a
-    # Float-like string representation.
-    #
-    # @param numeric [Numeric]
-    #
-    # @return [String]
-    def self.string_from_numeric(numeric)
-      if numeric.is_a?(BigDecimal)
-        numeric.to_s('F')
-      else
-        numeric.to_s
-      end
-    end
-  end
-
   DEFAULT = 'default'
   DELIMITING_REGEX = /(\d)(?=(\d\d\d)+(?!\d))/.freeze
   HASH = {}.freeze
   SEPARATOR = '.'
   SUBSTITUTION_REGEX = /%(|\^)[aAbBpP]/.freeze
 
+  # Needed for Ruby < 3.
+  using HashExcept unless Hash.method_defined?(:except)
+
   # @return [String]
   attr_reader :locale
 
@@ -107,7 +36,6 @@ class Tater
   # @param path [String]
   #   A path to search for YAML or Ruby files to load messages from.
   def initialize(cascade: false, locale: nil, messages: nil, path: nil)
-    @cache = {}
     @cascade = cascade
     @locale = locale
     @messages = {}
@@ -153,7 +81,7 @@ class Tater
       end
 
       Dir.glob(File.join(path, '**', '*.rb')).each do |file|
-        @messages = Utils.deep_merge(@messages, Utils.deep_stringify_keys(eval(IO.read(file), binding, file))) # rubocop:disable Security/Eval
+        @messages = Utils.deep_merge(@messages, Utils.deep_stringify_keys(eval(File.read(file), binding, file))) # rubocop:disable Security/Eval
       end
     end
 
@@ -165,8 +93,10 @@ class Tater
 
     # Not only does this clear our cache but it establishes the basic structure
     # that we rely on in other methods.
+    @cache = {}
+
     @messages.each_key do |key|
-      @cache[key] = { true => {}, false => {} }
+      @cache[key] = { false => {}, true => {} }
     end
   end
 
@@ -190,9 +120,9 @@ class Tater
   # @option options [String] :locale
   #   The locale to use in lieu of the current default.
   # @option options [String] :delimiter
-  #   The delimiter to use when localizing numberic values.
+  #   The delimiter to use when localizing numeric values.
   # @option options [String] :separator
-  #   The separator to use when localizing numberic values.
+  #   The separator to use when localizing numeric values.
   # @option options [String] :two_words_connector
   #   The string used to join two array elements together e.g. " and ".
   # @option options [String] :words_connector
@@ -208,109 +138,57 @@ class Tater
     when String
       object
     when Numeric
-      delimiter = options[:delimiter] || lookup('numeric.delimiter', locale: options[:locale])
-      separator = options[:separator] || lookup('numeric.separator', locale: options[:locale])
-      precision = options[:precision] || 2
-
-      raise(MissingLocalizationFormat, "Numeric localization delimiter ('numeric.delimiter') missing or not passed as option :delimiter") unless delimiter
-      raise(MissingLocalizationFormat, "Numeric localization separator ('numeric.separator') missing or not passed as option :separator") unless separator
-
-      # Break the number up into integer and fraction parts.
-      integer = Utils.string_from_numeric(object)
-      integer, fraction = integer.split('.') unless object.is_a?(Integer)
-
-      if integer.length > 3
-        integer.gsub!(DELIMITING_REGEX) do |number|
-          "#{ number }#{ delimiter }"
-        end
-      end
-
-      if precision.zero? || fraction.nil?
-        integer
-      else
-        "#{ integer }#{ separator }#{ fraction.ljust(precision, '0').slice(0, precision) }"
-      end
+      localize_numeric(object, options)
     when Date, Time, DateTime
-      format = lookup("#{ object.class.to_s.downcase }.formats.#{ options[:format] || DEFAULT }", locale: options[:locale]) || options[:format] || DEFAULT
-
-      # Heavily cribbed from I18n, many thanks to the people who sorted this out
-      # before I worked on this library.
-      format = format.gsub(SUBSTITUTION_REGEX) do |match|
-        case match
-        when '%a'  then lookup('date.abbreviated_days', locale: options[:locale])[object.wday]
-        when '%^a' then lookup('date.abbreviated_days', locale: options[:locale])[object.wday].upcase
-        when '%A'  then lookup('date.days', locale: options[:locale])[object.wday]
-        when '%^A' then lookup('date.days', locale: options[:locale])[object.wday].upcase
-        when '%b'  then lookup('date.abbreviated_months', locale: options[:locale])[object.mon - 1]
-        when '%^b' then lookup('date.abbreviated_months', locale: options[:locale])[object.mon - 1].upcase
-        when '%B'  then lookup('date.months', locale: options[:locale])[object.mon - 1]
-        when '%^B' then lookup('date.months', locale: options[:locale])[object.mon - 1].upcase
-        when '%p'  then lookup("time.#{ object.hour < 12 ? 'am' : 'pm' }", locale: options[:locale]).upcase if object.respond_to?(:hour) # rubocop:disable Metrics/BlockNesting
-        when '%P'  then lookup("time.#{ object.hour < 12 ? 'am' : 'pm' }", locale: options[:locale]).downcase if object.respond_to?(:hour) # rubocop:disable Metrics/BlockNesting
-        end
-      end
-
-      object.strftime(format)
+      localize_datetime(object, options)
     when Array
-      case object.length
-      when 0
-        ''
-      when 1
-        object[0]
-      when 2
-        two_words_connector = options[:two_words_connector] || lookup('array.two_words_connector', locale: options[:locale])
-
-        raise(MissingLocalizationFormat, "Sentence localization connector ('array.two_words_connector') missing or not passed as option :two_words_connector") unless two_words_connector
-
-        "#{ object[0] }#{ two_words_connector }#{ object[1] }"
-      else
-        last_word_connector = options[:last_word_connector] || lookup('array.last_word_connector', locale: options[:locale])
-        words_connector = options[:words_connector] || lookup('array.words_connector', locale: options[:locale])
-
-        raise(MissingLocalizationFormat, "Sentence localization connector ('array.last_word_connector') missing or not passed as option :last_word_connector") unless last_word_connector
-        raise(MissingLocalizationFormat, "Sentence localization connector ('array.words_connector') missing or not passed as option :words_connector") unless words_connector
-
-        "#{ object[0...-1].join(words_connector) }#{ last_word_connector }#{ object[-1] }"
-      end
+      localize_array(object, options)
     else
       raise(UnLocalizableObject, "The object class #{ object.class } cannot be localized by Tater.")
     end
   end
-  alias l localize
 
   # Lookup a key in the messages hash, using the current locale or an override.
   #
+  # @example Using the default locale, look up a key's value.
+  #   i18n = Tater.new(locale: 'en', messages: { 'en' => { 'greeting' => { 'world' => 'Hello, world!' } } })
+  #   i18n.lookup('greeting.world') # => "Hello, world!"
+  #
   # @param key [String]
+  #   The period-separated key path to look for within our messages.
   # @param locale [String]
-  #   A locale to use instead of our current one.
+  #   A locale to use instead of our current one, if any.
   # @param cascade [Boolean]
   #   A boolean to forcibly set the cascade option for this lookup.
   #
   # @return
   #   Basically anything that can be stored in your messages Hash.
   def lookup(key, locale: nil, cascade: nil)
-    locale = locale.nil? ? @locale : locale
-    cascade = cascade.nil? ? @cascade : cascade
+    locale =
+      if locale.nil?
+        @locale
+      else
+        locale.to_s
+      end
 
-    cached(key, locale, cascade) || begin
-      return nil unless @messages.key?(locale.to_s)
+    cascade = @cascade if cascade.nil?
 
-      path = key.split(SEPARATOR).prepend(locale).map(&:to_s)
+    @cache[locale][cascade][key] ||= begin
+      path = key.split(SEPARATOR)
 
-      message =
-        if cascade
-          while path.length >= 2
-            attempt = @messages.dig(*path)
-
-            break attempt unless attempt.nil?
+      message = @messages[locale].dig(*path)
 
+      if message.nil? && cascade
+        message =
+          while path.length > 1
             path.delete_at(path.length - 2)
+            attempt = @messages[locale].dig(*path)
+
+            break attempt unless attempt.nil?
           end
-        else
-          @messages.dig(*path)
-        end
+      end
 
-      cache(key, locale, cascade, message)
+      message
     end
   end
 
@@ -373,51 +251,140 @@ class Tater
   #   The translated and interpreted string, if found, or any data at the
   #   defined key.
   def translate(key, options = HASH)
-    message =
-      if options.key?(:locales)
-        options[:locales].append(@locale) if @locale && !options[:locales].include?(@locale)
+    if options.empty?
+      message = lookup(key)
 
-        options[:locales].find do |accept|
-          found = lookup(key, locale: accept, cascade: options[:cascade])
-
-          break found unless found.nil?
-        end
+      if message.is_a?(Proc) # rubocop:disable Style/CaseLikeIf
+        message.call(key)
+      elsif message.is_a?(String)
+        message
       else
-        lookup(key, locale: options[:locale], cascade: options[:cascade])
+        "Tater lookup failed: #{ locale }.#{ key }"
       end
+    else
+      message =
+        if options.key?(:locales)
+          options[:locales].append(@locale) if @locale && !options[:locales].include?(@locale)
 
-    # Call procs that should return a string.
-    message = message.call(key, options) if message.is_a?(Proc)
+          options[:locales].find do |accept|
+            found = lookup(key, locale: accept, cascade: options[:cascade])
 
-    Utils.interpolate(message, options) || options[:default] || "Tater lookup failed: #{ options[:locale] || options[:locales] || locale }.#{ key }"
+            break found unless found.nil?
+          end
+        else
+          lookup(key, locale: options[:locale], cascade: options[:cascade])
+        end
+
+      if message.is_a?(Proc) # rubocop:disable Style/CaseLikeIf
+        message.call(key, options.except(:cascade, :default, :locale, :locales))
+      elsif message.is_a?(String)
+        Utils.interpolate(message, options.except(:cascade, :default, :locale, :locales))
+      else
+        options[:default] || "Tater lookup failed: #{ options[:locale] || options[:locales] || locale }.#{ key }"
+      end
+    end
   end
-  alias t translate
 
   private
 
-  # @param key [String]
-  #   The cache key, often in the form "something.nested.like.this"
-  # @param locale [String]
-  #   The locale to store the value for.
-  # @param cascade [Boolean]
-  #   Was this a cascading lookup?
-  # @param message [String]
-  #   The message being cached, often a String.
+  # Localize an Array object.
+  #
+  # @param object [Array<String>]
+  #   The array to localize.
+  # @param options [Hash]
+  #   Options to configure localization.
+  # @return [String]
+  #   The localize array string.
+  def localize_array(object, options)
+    case object.length
+    when 0
+      ''
+    when 1
+      object[0]
+    when 2
+      two_words_connector = options[:two_words_connector] || lookup('array.two_words_connector', locale: options[:locale])
+
+      raise(MissingLocalizationFormat, "Sentence localization connector ('array.two_words_connector') missing or not passed as option :two_words_connector") unless two_words_connector
+
+      "#{ object[0] }#{ two_words_connector }#{ object[1] }"
+    else
+      last_word_connector = options[:last_word_connector] || lookup('array.last_word_connector', locale: options[:locale])
+      words_connector = options[:words_connector] || lookup('array.words_connector', locale: options[:locale])
+
+      raise(MissingLocalizationFormat, "Sentence localization connector ('array.last_word_connector') missing or not passed as option :last_word_connector") unless last_word_connector
+      raise(MissingLocalizationFormat, "Sentence localization connector ('array.words_connector') missing or not passed as option :words_connector") unless words_connector
+
+      "#{ object[0...-1].join(words_connector) }#{ last_word_connector }#{ object[-1] }"
+    end
+  end
+
+  # Localize a Date, DateTime, or Time object.
+  #
+  # @param object [Date, DateTime, Time]
+  #   The date-ish object to localize.
+  # @param options [Hash]
+  #   Options to configure localization.
   # @return [String]
-  #   Whatever value is being cached, often a String.
-  def cache(key, locale, cascade, message)
-    @cache[locale][cascade][key] = message
+  #   The localized date string.
+  def localize_datetime(object, options)
+    frmt = options[:format] || DEFAULT
+    loc = options[:locale]
+    format = lookup("#{ object.class.to_s.downcase }.formats.#{ frmt }", locale: loc) || frmt
+
+    # Heavily cribbed from I18n, many thanks to the people who sorted this out
+    # before I worked on this library.
+    format = format.gsub(SUBSTITUTION_REGEX) do |match|
+      case match
+      when '%a'  then lookup('date.abbreviated_days', locale: loc)[object.wday]
+      when '%^a' then lookup('date.abbreviated_days', locale: loc)[object.wday].upcase
+      when '%A'  then lookup('date.days', locale: loc)[object.wday]
+      when '%^A' then lookup('date.days', locale: loc)[object.wday].upcase
+      when '%b'  then lookup('date.abbreviated_months', locale: loc)[object.mon - 1]
+      when '%^b' then lookup('date.abbreviated_months', locale: loc)[object.mon - 1].upcase
+      when '%B'  then lookup('date.months', locale: loc)[object.mon - 1]
+      when '%^B' then lookup('date.months', locale: loc)[object.mon - 1].upcase
+      when '%p'  then lookup("time.#{ object.hour < 12 ? 'am' : 'pm' }", locale: loc).upcase if object.respond_to?(:hour)
+      when '%P'  then lookup("time.#{ object.hour < 12 ? 'am' : 'pm' }", locale: loc).downcase if object.respond_to?(:hour)
+      end
+    end
+
+    if format.include?('%')
+      object.strftime(format)
+    else
+      format
+    end
   end
 
-  # @param key [String]
-  #   The cache key, often in the form "something.nested.like.this"
-  # @param locale [String]
-  #   The locale to store the value for.
-  # @param cascade [Boolean]
-  #   Was this a cascading lookup?
-  # @return [String, nil]
-  #   The cached message or nil.
-  def cached(key, locale, cascade)
-    @cache.dig(locale, cascade, key)
+  # Localize a Numeric object.
+  #
+  # @param object [Array<String>, Date, Time, DateTime, Numeric]
+  #   The object to localize.
+  # @param options [Hash]
+  #   Options to configure localization.
+  # @return [String]
+  #   The localized numeric string.
+  def localize_numeric(object, options)
+    delimiter = options[:delimiter] || lookup('numeric.delimiter', locale: options[:locale])
+    separator = options[:separator] || lookup('numeric.separator', locale: options[:locale])
+    precision = options[:precision] || 2
+
+    raise(MissingLocalizationFormat, "Numeric localization delimiter ('numeric.delimiter') missing or not passed as option :delimiter") unless delimiter
+    raise(MissingLocalizationFormat, "Numeric localization separator ('numeric.separator') missing or not passed as option :separator") unless separator
+
+    # Break the number up into integer and fraction parts.
+    integer = Utils.string_from_numeric(object)
+    integer, fraction = integer.split('.') unless object.is_a?(Integer)
+
+    if object >= 1_000
+      integer.gsub!(DELIMITING_REGEX) do |number|
+        "#{ number }#{ delimiter }"
+      end
+    end
+
+    if precision.zero? || fraction.nil?
+      integer
+    else
+      "#{ integer }#{ separator }#{ fraction.ljust(precision, '0').slice(0, precision) }"
+    end
   end
 end

data/test/tater_test.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
-require_relative '../lib/tater'
-require 'minitest/autorun'
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+
 require 'date'
+require 'minitest/autorun'
+require 'tater'
 
 describe Tater do
   describe Tater::Utils do
@@ -59,6 +61,20 @@ describe Tater do
         assert_equal '1.0', Tater::Utils.string_from_numeric(BigDecimal('1'))
       end
     end
+
+    describe '#interpolation_string?' do
+      def is?(arg)
+        Tater::Utils.interpolation_string?(arg)
+      end
+
+      it 'checks whether a string contains interpolation placeholders' do
+        assert is?('Hey %{there}!')
+        assert is?('Hey %<there>s!')
+        refute is?('Nah, this is fine')
+        refute is?("<b>HTML shouldn't count")
+        refute is?("A single % shouldn't count")
+      end
+    end
   end
 
   describe '#available?' do
@@ -141,6 +157,10 @@ describe Tater do
       assert_nil i18n.lookup('nope')
     end
 
+    it 'returns arbitrary data at keys' do
+      assert_equal({ 'key' => 'This key is deeper' }, i18n.lookup('deep'))
+    end
+
     it 'cascades' do
       assert_equal 'Delicious', i18n.lookup('cascade.nope.tacos', cascade: true)
       assert_equal 'Whoaa', i18n.lookup('cascade.another.nope.crazy', cascade: true)
@@ -162,8 +182,8 @@ describe Tater do
       assert_equal 'This key is deeper', i18n.translate('deep.key')
     end
 
-    it 'returns a hash for nested keys' do
-      assert_equal({ 'key' => 'This key is deeper' }, i18n.translate('deep'))
+    it 'does not return a hash for nested keys' do
+      assert_equal 'Tater lookup failed: en.deep', i18n.translate('deep')
     end
 
     it 'interpolates additional variables' do
@@ -180,10 +200,6 @@ describe Tater do
       assert_equal 'Tater lookup failed: en.nope', i18n.translate('nope')
     end
 
-    it 'is aliased as t' do
-      assert_equal 'This is a title', i18n.t('title')
-    end
-
     it 'cascades lookups' do
       assert_equal 'Tater lookup failed: en.cascade.another.nope.crazy', i18n.translate('cascade.another.nope.crazy', cascade: false)
       assert_equal 'Tater lookup failed: en.cascade.nope.tacos', i18n.translate('cascade.nope.tacos')
@@ -201,9 +217,12 @@ describe Tater do
       assert_equal 'Tater lookup failed: ["fr", "en"].neither', i18n.translate('neither', locales: %w[fr en])
     end
 
-    it 'finds Ruby files as well' do
+    it 'finds Ruby files' do
       assert_equal 'Hey ruby!', i18n.translate('ruby')
-      assert_equal 'Hey options!', i18n.translate('options', options: 'options')
+    end
+
+    it 'does not interpolate messages returned by procs' do
+      assert_equal 'Hey %{options}!', i18n.translate('options', options: 'options')
     end
   end
 
@@ -314,10 +333,6 @@ describe Tater do
       end
     end
 
-    it 'is aliased l' do
-      assert_equal '1970/1/1', i18n.l(Date.new(1970, 1, 1))
-    end
-
     describe 'month, day, and AM/PM names' do
       let :i18n do
         Tater.new(path: File.expand_path('test/fixtures'), locale: 'fr')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tater
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.1
 platform: ruby
 authors:
 - Evan Lecklider
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -128,8 +142,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/evanleck/tater/issues
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/evanleck/tater
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Minimal internationalization and localization library.
 test_files: