tater 3.0.4 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1913c7bc9ecb58cbb7ff7c4239978c8401116a954f967e1fd1e557ad30b0e7bd
-  data.tar.gz: cd65a35921e999375affaf4a38717fc14c6938285f3ad1d4258727494a212d40
+  metadata.gz: '08a174e27ecb08955ba15997b8b71995aff8a77cbf82bb08514ba5dcd6e404dd'
+  data.tar.gz: c9f78478bc5f1b7a48b038add4f3c05230dc6083ccada5d1de00974b1dbd08f8
 SHA512:
-  metadata.gz: 8744cffa6df1821728ee83f221899d7b5dae739c9420f0ce40bbd02f9b7a7d1388aeed8f54a3d029663a2843b0fca915cd277dc688b044a559c994630695bfc1
-  data.tar.gz: 4e0cfde2f00feaf6e3ce76aec920b0f56a208dfc59e18f0af0c679fe1f8d733ce6c5343bdafc36df33bb2170b6ac660e36d906161273ddf7a3c9fc0a96cf78aa
+  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/version.rb

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

data/lib/tater.rb

@@ -4,8 +4,9 @@ require 'date'
 require 'time'
 require 'yaml'
 
-require 'tater/utils'
 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.
@@ -22,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
 
@@ -37,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 = {}
@@ -45,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]
@@ -52,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]
@@ -89,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 => {} }
@@ -106,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.

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.4
+  version: 3.0.5
 platform: ruby
 authors:
 - Evan Lecklider
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-22 00:00:00.000000000 Z
+date: 2022-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,7 @@ files:
 - 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
@@ -162,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.