tater 3.0.2 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b543d8ed6a28b2f4059b2c1fc63593bc2f7ced7b2cc9d62e786c78263b97ec35
-  data.tar.gz: 0042276af4078a436e7f34e1f50500e5dd92649ae060b24921a98f5dfc859789
+  metadata.gz: '08a174e27ecb08955ba15997b8b71995aff8a77cbf82bb08514ba5dcd6e404dd'
+  data.tar.gz: c9f78478bc5f1b7a48b038add4f3c05230dc6083ccada5d1de00974b1dbd08f8
 SHA512:
-  metadata.gz: cd927d5425f5a8b7356fafb72db449d57494042369eb9ba0018a2ba7d68893fe24c0d633d75a93ab8ff1d3e8f2367d148e87c5bc068ec1717afa27d1168cec8c
-  data.tar.gz: 4f0a917429aef2c443288f9c338a0471f86fb608585e29e5fdc8b3f04b8ecfe654ecdc7e09daed29e99b19ddb3bf1a4175057d6db77c64b495b25a232f2c6eb7
+  metadata.gz: 27b9c2ad757cb5a51bf0ce3a792a92912bc3d8a2f9e82c761621396417480b6c82088222cd9e2c552d2309381d8feb0399466cade27b75fd2fb29d6eab2552b0
+  data.tar.gz: baf324c10b838927b0aedc2ac5babafed538acbdaeb7a4f7a5e6aebf8731d53037ec2dad4870d459a90056c9b9c2442d59ed6efaf5d94dbb74341f6a6ae3c14d

data/README.org

@@ -1,6 +1,7 @@
 * Tater
 
 [[https://badge.fury.io/rb/tater][https://badge.fury.io/rb/tater.svg]]
+[[https://github.com/evanleck/tater/actions/workflows/main.yml][https://github.com/evanleck/tater/actions/workflows/main.yml/badge.svg]]
 
 Tater is an internationalization (i18n) and localization (l10n) library designed
 for simplicity. It doesn't do everything that other libraries do, but that's by
@@ -238,7 +239,7 @@ Tater.new.translate('nope', default: 'Yep!') # => 'Yep!'
 ** Procs and messages in Ruby
 
 Ruby files can be used to store messages in addition to YAML, so long as the
-Ruby file returns a =Hash= when evalled.
+Ruby file returns a =Hash= when evaluated.
 
 #+begin_src ruby
 {
@@ -281,7 +282,7 @@ Locales will be tried in order and whichever one matches first will be returned.
 
 ** Limitations
 
-- It is not pluggable, it does what it does and that's it.
+- It is not plug-able, it does what it does and that's it.
 - It doesn't handle pluralization yet, though it may in the future.
 
 ** Why?
@@ -292,6 +293,6 @@ file that handles the basics of lookup and interpolation.
 
 ** Trivia
 
-I was orininally going to call this library "Translator" but with a [[https://en.wikipedia.org/wiki/Numeronym][numeronym]]
+I was originally going to call this library "Translator" but with a [[https://en.wikipedia.org/wiki/Numeronym][numeronym]]
 like I18n: "t8r".  I looked at it for a while but I read it as "tater" instead
 of "tee-eight-arr" so I figured I'd just name it Tater. Tater the translator.

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+class Tater
+  VERSION = '3.0.5'
+end

data/lib/tater.rb

@@ -3,8 +3,10 @@ require 'bigdecimal'
 require 'date'
 require 'time'
 require 'yaml'
-require_relative 'tater/utils'
-require_relative 'tater/hash' unless Hash.method_defined?(:except)
+
+require 'tater/hash' unless Hash.method_defined?(:except)
+require 'tater/utils'
+require 'tater/version'
 
 # Tater is a internationalization (i18n) and localization (l10n) library
 # designed for speed and simplicity.
@@ -21,6 +23,11 @@ class Tater
   # Needed for Ruby < 3.
   using HashExcept unless Hash.method_defined?(:except)
 
+  # An array of the available locale codes found in loaded messages.
+  #
+  # @return [Array<String>]
+  attr_reader :available
+
   # @return [String]
   attr_reader :locale
 
@@ -36,6 +43,8 @@ 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)
+    @available = []
+    @cache = {}
     @cascade = cascade
     @locale = locale
     @messages = {}
@@ -44,6 +53,11 @@ class Tater
     load(messages: messages) if messages
   end
 
+  # @return [String]
+  def inspect
+    %(#<Tater:#{ object_id } @cascade=#{ @cascade } @locale="#{ @locale }" @available=#{ @available }>)
+  end
+
   # Do lookups cascade by default?
   #
   # @return [Boolean]
@@ -51,13 +65,6 @@ class Tater
     @cascade
   end
 
-  # An array of the available locale codes found in loaded messages.
-  #
-  # @return [Array]
-  def available
-    @available ||= messages.keys
-  end
-
   # Is this locale available in our current set of messages?
   #
   # @return [Boolean]
@@ -88,12 +95,12 @@ class Tater
     @messages = Utils.deep_merge(@messages, Utils.deep_stringify_keys(messages)) if messages
     @messages = Utils.deep_freeze(@messages)
 
-    # Gotta recalculate available locales after updating.
-    remove_instance_variable(:@available) if instance_variable_defined?(:@available)
+    # Update our available locales.
+    @available.replace(@messages.keys.map(&:to_s).sort)
 
     # Not only does this clear our cache but it establishes the basic structure
     # that we rely on in other methods.
-    @cache = {}
+    @cache.clear
 
     @messages.each_key do |key|
       @cache[key] = { false => {}, true => {} }
@@ -105,7 +112,8 @@ class Tater
   # @param locale [String]
   #   The locale code to set as our default.
   def locale=(locale)
-    @locale = locale.to_s if available?(locale)
+    str = locale.to_s
+    @locale = str if available?(str)
   end
 
   # Localize an Array, Date, Time, DateTime, or Numeric object.
@@ -209,20 +217,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.

data/test/tater_test.rb

@@ -455,4 +455,32 @@ describe Tater do
       refute i18n.includes?('cascade.nope.tacos', cascade: false)
     end
   end
+
+  describe '#inspect' do
+    it 'returns a stringified version of the object' do
+      obj = Tater.new(path: File.expand_path('test/fixtures'), locale: 'en')
+      assert_equal %(#<Tater:#{ obj.object_id } @cascade=#{ obj.cascades? } @locale="#{ obj.locale }" @available=#{ obj.available }>), obj.inspect
+    end
+  end
+
+  describe '#freeze' do
+    it 'can be frozen' do
+      obj = Tater.new(path: File.expand_path('test/fixtures'), locale: 'en')
+      obj.freeze
+
+      assert obj.includes?('deep')
+      assert_equal 'This key is deeper', obj.translate('deep.key')
+      assert_equal %w[delimiter_only en fr separator_only], obj.available
+
+      assert obj.frozen?
+    end
+
+    it 'throws an error if modified after being frozen' do
+      obj = Tater.new(path: File.expand_path('test/fixtures'), locale: 'en')
+      obj.freeze
+
+      assert_raises(FrozenError) { obj.locale = 'en' }
+      assert_raises(FrozenError) { obj.load(messages: { more: 'Messages' }) }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tater
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.5
 platform: ruby
 authors:
 - Evan Lecklider
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-19 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,10 @@ files:
 - LICENSE.txt
 - README.org
 - lib/tater.rb
+- lib/tater/aliases.rb
+- lib/tater/hash.rb
+- lib/tater/utils.rb
+- lib/tater/version.rb
 - test/fixtures/another.yml
 - test/fixtures/fixtures.yml
 - test/fixtures/messages/more.yml
@@ -159,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Minimal internationalization and localization library.