tater 2.0.3 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e5ec34021f3488e2ef8ef3365abc37258813e5d9a79b8dbd0a49fb8254c946a
-  data.tar.gz: 8613b2a54d59d0b4a64f84790e60f55316447714d6013a6751041a2aa9dada6a
+  metadata.gz: b543d8ed6a28b2f4059b2c1fc63593bc2f7ced7b2cc9d62e786c78263b97ec35
+  data.tar.gz: 0042276af4078a436e7f34e1f50500e5dd92649ae060b24921a98f5dfc859789
 SHA512:
-  metadata.gz: f65062d798ace02b68084b1a9189f09c092e32f2a819bd88909d651038a205a36b60816f8c6e890614c9aaea1a17e074b89a7f3a5163969bf10c6f35a8eac56e
-  data.tar.gz: cf3ae7da9a2d911f90aa93dd1f2e088425becf21d2b5558c485d86002bcccf09a4bdccfed39385442a7865a27e76196aa68bf90b259ea30f5b8beeda8eb1807c
+  metadata.gz: cd927d5425f5a8b7356fafb72db449d57494042369eb9ba0018a2ba7d68893fe24c0d633d75a93ab8ff1d3e8f2367d148e87c5bc068ec1717afa27d1168cec8c
+  data.tar.gz: 4f0a917429aef2c443288f9c338a0471f86fb608585e29e5fdc8b3f04b8ecfe654ecdc7e09daed29e99b19ddb3bf1a4175057d6db77c64b495b25a232f2c6eb7

data/README.org

@@ -212,8 +212,8 @@ i18n.translate('login.special.description', cascade: true) # => 'Normal descript
 With cascade, the final key stays the same, but pieces of the scope get lopped
 off. In this case, lookups will be tried in this order:
 
-1. ='login.special.description'=
-2. ='login.description'=
+1. =login.special.description=
+2. =login.description=
 
 This can be useful when you want to override some messages but don't want to
 have to copy all of the other, non-overwritten messages.

data/lib/tater.rb

@@ -3,97 +3,24 @@ require 'bigdecimal'
 require 'date'
 require 'time'
 require 'yaml'
+require_relative 'tater/utils'
+require_relative '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
 
@@ -109,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 = {}
@@ -155,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
 
@@ -167,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
 
@@ -219,41 +147,48 @@ class Tater
       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
-
-    cached(key, locale, cascade) || begin
-      return nil unless @messages.key?(locale.to_s)
+    locale =
+      if locale.nil?
+        @locale
+      else
+        locale.to_s
+      end
 
-      path = key.split(SEPARATOR).prepend(locale).map(&:to_s)
+    cascade = @cascade if cascade.nil?
 
-      message =
-        if cascade
-          while path.length >= 2
-            attempt = @messages.dig(*path)
+    @cache[locale][cascade][key] ||= begin
+      path = key.split(SEPARATOR)
 
-            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
 
@@ -316,53 +251,41 @@ 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)
-
-    Utils.interpolate(message, options) || options[:default] || "Tater lookup failed: #{ options[:locale] || options[:locales] || locale }.#{ key }"
-  end
-  alias t translate
+          options[:locales].find do |accept|
+            found = lookup(key, locale: accept, cascade: options[:cascade])
 
-  private
+            break found unless found.nil?
+          end
+        else
+          lookup(key, locale: options[:locale], cascade: options[:cascade])
+        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?
-  # @param message [String]
-  #   The message being cached, often a String.
-  # @return [String]
-  #   Whatever value is being cached, often a String.
-  def cache(key, locale, cascade, message)
-    @cache[locale][cascade][key] = message
+      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
 
-  # @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)
-  end
+  private
 
   # Localize an Array object.
   #

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.3
+  version: 3.0.2
 platform: ruby
 authors:
 - Evan Lecklider
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2021-12-19 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: