tater 3.0.0 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c34d7058c3566313243c4ccb7b99d967c60bf2e00e091d1fbb66dfbd257e853f
-  data.tar.gz: 0a5c1d4df6a34b9953086af0459af4c72cb8d9faf674d3216e1eb9e00aa0e82f
+  metadata.gz: 1913c7bc9ecb58cbb7ff7c4239978c8401116a954f967e1fd1e557ad30b0e7bd
+  data.tar.gz: cd65a35921e999375affaf4a38717fc14c6938285f3ad1d4258727494a212d40
 SHA512:
-  metadata.gz: ac657b28f3e3421def12e3d0b50bcd895c5d1a1b23de7c97da6bf0e20bc5e0a51e20abf7394ec9e99b2137e9b2261392213f0dc85d2d3b0c598c4e73184d8857
-  data.tar.gz: 4b5b32cf7b23a66afcde0a73f129a76d791f62a8efa45a7223204d9e017328796cf528ad8884a2c25a568ea47d3047fff57c4973741aaae20e1e7574350a9068
+  metadata.gz: 8744cffa6df1821728ee83f221899d7b5dae739c9420f0ce40bbd02f9b7a7d1388aeed8f54a3d029663a2843b0fca915cd277dc688b044a559c994630695bfc1
+  data.tar.gz: 4e0cfde2f00feaf6e3ce76aec920b0f56a208dfc59e18f0af0c679fe1f8d733ce6c5343bdafc36df33bb2170b6ac660e36d906161273ddf7a3c9fc0a96cf78aa

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

@@ -3,7 +3,9 @@ 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.
@@ -17,6 +19,9 @@ class Tater
   SEPARATOR = '.'
   SUBSTITUTION_REGEX = /%(|\^)[aAbBpP]/.freeze
 
+  # Needed for Ruby < 3.
+  using HashExcept unless Hash.method_defined?(:except)
+
   # @return [String]
   attr_reader :locale
 
@@ -205,20 +210,24 @@ class Tater
   #
   # @return [Boolean]
   def includes?(key, options = HASH)
-    message =
-      if options.key?(:locales)
-        options[:locales].append(@locale) if @locale && !options[:locales].include?(@locale)
+    if options.empty?
+      !lookup(key).nil?
+    else
+      message =
+        if options.key?(:locales)
+          options[:locales].append(@locale) if @locale && !options[:locales].include?(@locale)
 
-        options[:locales].find do |accept|
-          found = lookup(key, locale: accept, cascade: options[:cascade])
+          options[:locales].find do |accept|
+            found = lookup(key, locale: accept, cascade: options[:cascade])
 
-          break found unless found.nil?
+            break found unless found.nil?
+          end
+        else
+          lookup(key, locale: options[:locale], cascade: options[:cascade])
         end
-      else
-        lookup(key, locale: options[:locale], cascade: options[:cascade])
-      end
 
-    !message.nil?
+      !message.nil?
+    end
   end
 
   # Translate a key path and optional interpolation arguments into a string.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tater
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.4
 platform: ruby
 authors:
 - Evan Lecklider
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2021-12-22 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