tater 2.0.4 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51644f41d80e87d20ed43b9e8c6b4797fb7aeb4258c94d5d9f9d7a50eb5ee5c6
-  data.tar.gz: 1fe43b99fbc2f24cdc342ec4278ff7140ee6b9579dd51d236fcc713907f1455d
+  metadata.gz: 7176a93dd72c2135f8114c2baed2d4fdda8ffcb7c02312517810d94f9e275dce
+  data.tar.gz: 5dea4c80c2a894063790d2cd4ed2232e8566b3cae4a3ab9a73a2be3c45ffd4f5
 SHA512:
-  metadata.gz: d4c059fdc696d39c489e61d3e53954fe921feaba78055bd5e62c944d45daf10dfa178b76e4e836d326ba61be0dbf7bbec13b63f52b95e13f23da9ca5be4d3b8c
-  data.tar.gz: 6b12ffa8f2a1186f2de92c9c16bb5c2e1027f93ab5ee2c877dbad297777274b9f4f38882255490db3c555a0dafb129ed876bd784d3a872e07a4e7e9f6e0e24ec
+  metadata.gz: b32716e497cc9a2e81eded3bc277450d143ffec829b4accf3b3396b2c1afb28b4c66bab044695cf13bd6b64ff830d4168b181435565864e977f59ce9fcf6df1e
+  data.tar.gz: bd697439d8db3cd1607762bd92adb13e066fb40e16c7db6469a8e2a226774480a4cd1ba19651d45673c6ce819e9f7913af82c0b779c37c5f803e0c72ce3d42ff

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/aliases.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'tater'
+
+class Tater # :nodoc:
+  # Alias to Tater#localize
+  alias l localize
+
+  # Alias to Tater#translate
+  alias t translate
+end

data/lib/tater/hash.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+class Tater
+  # Refine Hash and add the #except method from Ruby 3.
+  module HashExcept
+    refine Hash do
+      # Taken from the excellent backports gem written by Marc-André Lafortune.
+      #   https://github.com/marcandre/backports/blob/master/lib/backports/3.0.0/hash/except.rb
+      def except(*keys)
+        if keys.size > 4 && size > 4 # index if O(m*n) is big
+          h = {}
+          keys.each { |key| h[key] = true }
+          keys = h
+        end
+
+        reject { |key, _value| keys.include?(key) }
+      end
+    end
+  end
+end

data/lib/tater/utils.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+class Tater
+  # Utility methods that require no state.
+  module Utils
+    HASH = {}.freeze
+    FORMAT_CURLY = '%{'
+    FORMAT_NAMED = '%<'
+
+    # 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
+
+    # Format values into a string if appropriate.
+    #
+    # @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 if options.empty?
+      return string unless interpolation_string?(string)
+
+      format(string, options)
+    end
+
+    # Determine whether a string includes any interpolation placeholders e.g.
+    # "%{" or "%<"
+    #
+    # @param string [String]
+    # @return [Boolean]
+    def self.interpolation_string?(string)
+      string.include?(FORMAT_CURLY) || string.include?(FORMAT_NAMED)
+    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
+end

data/lib/tater.rb

@@ -4,96 +4,24 @@ 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
 
@@ -154,7 +82,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
 
@@ -220,7 +148,6 @@ 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.
   #
@@ -325,25 +252,39 @@ 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])
+
+            break found unless found.nil?
+          end
+        else
+          lookup(key, locale: options[:locale], cascade: options[:cascade])
+        end
 
-    Utils.interpolate(message, options) || options[:default] || "Tater lookup failed: #{ options[:locale] || options[:locales] || locale }.#{ key }"
+      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
 

data/test/tater_test.rb

@@ -61,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
@@ -143,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)
@@ -164,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
@@ -182,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')
@@ -203,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
 
@@ -316,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.4
+  version: 3.0.3
 platform: ruby
 authors:
 - Evan Lecklider
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,9 @@ files:
 - LICENSE.txt
 - README.org
 - lib/tater.rb
+- lib/tater/aliases.rb
+- lib/tater/hash.rb
+- lib/tater/utils.rb
 - test/fixtures/another.yml
 - test/fixtures/fixtures.yml
 - test/fixtures/messages/more.yml
@@ -142,8 +145,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
@@ -158,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Minimal internationalization and localization library.
 test_files: