tater 1.1.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bce1afa07abcf6f94618ca249808f14d4a16b107c112bc074b4f0e6e2703b86d
-  data.tar.gz: 3f481fbb8e9551fee057472c3bef0fbc2420c9e267a37e09bf353a19e9877130
+  metadata.gz: d41ee7aa6cc55a97ad00ee6b96ccbb6127344f9b3e85c4cf3b162f72f3d115d8
+  data.tar.gz: 2fe1b6c5aff5fdfcc48dbd8212ddbbf0903f9af071c42ff1178c1f20752f536a
 SHA512:
-  metadata.gz: 9096e096441db2696735213dd21c313aa333877062f3094680a2ff7bbb14c5e3e699d817a8df59626f570eff345b5b69a942ec99cd19ab3bc74cbdee0cb9b398
-  data.tar.gz: 8511e008cf509bd76869aef9957e98e7f73bb60b50649abe811f09ad4ee01447553689ffe52451f8073110d1338ad430ef7848f25a4e3fce1614c22d60153dc3
+  metadata.gz: d686b81192264e1f78f17c0decf0ac3811582e0fe464d2f5f44281481351abca8bd3906fe218a2ae9309a3d84177382f5de7348f63ae3967b7d2af2dc452bcb6
+  data.tar.gz: 942fd8b6a433b65778f3d7a78f07a8d99c902c5483eec105e0c75689d40db7d0664170963e514d5e78928450b6c0499dce8c3afd63f0eaded6d9843cf3e703a8

data/README.md

@@ -56,6 +56,25 @@ i18n.translate('some.key') # => 'This here string!'
 i18n.translate('interpolated', you: 'world') # => 'Hello world!'
 ```
 
+
+## Array Localization
+
+Given an array, Tater will do it's best to join the elements of the array into a
+sentence based on how many elements there are.
+
+```yaml
+en:
+  array:
+    last_word_connector: ", and "
+    two_words_connector: " and "
+    words_connector: ", "
+```
+
+```ruby
+i18n.localize(%w[tacos enchiladas burritos]) # => "tacos, enchiladas, and burritos"
+```
+
+
 ## Numeric Localization
 
 Numeric localization (`Numeric`, `Integer`, `Float`, and `BigDecimal`) require

data/lib/tater.rb

@@ -51,6 +51,7 @@ class Tater
     # @return [String]
     def self.interpolate(string, options = {})
       return string unless string.is_a?(String)
+      return string if options.empty?
 
       format(string, options)
     end
@@ -91,6 +92,8 @@ class Tater
     load(messages: messages) if messages
   end
 
+  # Do lookups cascade by default?
+  #
   # @return [Boolean]
   def cascades?
     @cascade
@@ -114,7 +117,7 @@ class Tater
   # files or a collection of messages.
   #
   # @param path [String]
-  #   A path to search for YAML files to load messages from.
+  #   A path to search for YAML or Ruby files to load messages from.
   # @param messages [Hash]
   #   A hash of messages ready to be loaded in.
   def load(path: nil, messages: nil)
@@ -124,7 +127,7 @@ class Tater
       end
 
       Dir.glob(File.join(path, '**', '*.rb')).each do |file|
-        Utils.deep_merge!(@messages, Utils.deep_stringify_keys!(eval(IO.read(file), binding, file)))
+        Utils.deep_merge!(@messages, Utils.deep_stringify_keys!(eval(IO.read(file), binding, file))) # rubocop:disable Security/Eval
       end
     end
 
@@ -139,10 +142,28 @@ class Tater
     @locale = locale.to_s if available?(locale)
   end
 
-  # Localize a Date, Time, DateTime, or Numeric object.
+  # Localize an Array, Date, Time, DateTime, or Numeric object.
   #
   # @param object [Date, Time, DateTime, Numeric]
   #   The object to localize.
+  # @param options [Hash]
+  #   Options to configure localization.
+  #
+  # @option options [String] :format
+  #   The key or format string to use for localizing the current object.
+  # @option options [String] :locale
+  #   The locale to use in lieu of the current default.
+  # @option options [String] :delimiter
+  #   The delimiter to use when localizing numberic values.
+  # @option options [String] :separator
+  #   The separator to use when localizing numberic values.
+  # @option options [String] :two_words_connector
+  #   The string used to join two array elements together e.g. " and ".
+  # @option options [String] :words_connector
+  #   The string used to connect multiple array elements e.g. ", ".
+  # @option options [String] :last_word_connector
+  #   The string used to connect the final element with preceding array elements
+  #   e.g. ", and ".
   #
   # @return [String]
   #   A localized version of the object passed in.
@@ -156,10 +177,10 @@ class Tater
     when Numeric
       delimiter = options.delete(:delimiter) || lookup('numeric.delimiter', locale_override)
       separator = options.delete(:separator) || lookup('numeric.separator', locale_override)
-      precision = options.fetch(:precision) { 2 }
+      precision = options.delete(:precision) || 2
 
-      raise(MissingLocalizationFormat, "Numeric localization delimiter ('numeric.delimiter') missing") unless delimiter
-      raise(MissingLocalizationFormat, "Numeric localization separator ('numeric.separator') missing") unless separator
+      raise(MissingLocalizationFormat, "Numeric localization delimiter ('numeric.delimiter') missing or not passed as option :delimiter") unless delimiter
+      raise(MissingLocalizationFormat, "Numeric localization separator ('numeric.separator') missing or not passed as option :separator") unless separator
 
       # Heavily cribbed from Rails.
       integer, fraction = Utils.string_from_numeric(object).split('.')
@@ -194,6 +215,27 @@ class Tater
       end
 
       object.strftime(format)
+    when Array
+      case object.length
+      when 0
+        ''
+      when 1
+        object[0]
+      when 2
+        two_words_connector = options.delete(:two_words_connector) || lookup('array.two_words_connector', locale_override)
+
+        raise(MissingLocalizationFormat, "Sentence localization connector ('array.two_words_connector') missing or not passed as option :two_words_connector") unless two_words_connector
+
+        "#{ object[0] }#{ two_words_connector }#{ object[1] }"
+      else
+        last_word_connector = options.delete(:last_word_connector) || lookup('array.last_word_connector', locale_override)
+        words_connector = options.delete(:words_connector) || lookup('array.words_connector', locale_override)
+
+        raise(MissingLocalizationFormat, "Sentence localization connector ('array.last_word_connector') missing or not passed as option :last_word_connector") unless last_word_connector
+        raise(MissingLocalizationFormat, "Sentence localization connector ('array.words_connector') missing or not passed as option :words_connector") unless words_connector
+
+        "#{ object[0...-1].join(words_connector) }#{ last_word_connector }#{ object[-1] }"
+      end
     else
       raise(UnLocalizableObject, "The object class #{ object.class } cannot be localized by Tater.")
     end
@@ -205,6 +247,8 @@ class Tater
   # @param key [String]
   # @param locale_override [String]
   #   A locale to use instead of our current one.
+  # @param cascade_override [Boolean]
+  #   A boolean to forcibly set the cascade option for this lookup.
   #
   # @return
   #   Basically anything that can be stored in YAML, including nil.
@@ -212,20 +256,53 @@ class Tater
     path = key.split(SEPARATOR).prepend(locale_override || locale).map(&:to_s)
 
     if cascade_override.nil? ? @cascade : cascade_override
-      while path.length >= 2 do
+      while path.length >= 2
         attempt = @messages.dig(*path)
 
-        if attempt
-          break attempt
-        else
-          path.delete_at(path.length - 2)
-        end
+        break attempt if attempt
+
+        path.delete_at(path.length - 2)
       end
     else
       @messages.dig(*path)
     end
   end
 
+  # Check that there's a key at the given path.
+  #
+  # @param key [String]
+  #   The period-separated key path to look within our messages for.
+  # @param options [Hash]
+  #   Options to pass to the #lookup method, including locale overrides.
+  #
+  # @option options [Boolean] :cascade
+  #   Should this lookup cascade or not? Can override @cascade.
+  # @option options [String] :locale
+  #   A specific locale to lookup within. This will take precedence over the
+  #   :locales option.
+  # @option options [Array<String>] :locales
+  #   An array of locales to look within.
+  #
+  # @return [Boolean]
+  def includes?(key, options = {})
+    cascade_override = options.delete(:cascade)
+    locale_override = options.delete(:locale)
+    locales = options.delete(:locales)
+
+    message =
+      if locale_override || !locales
+        lookup(key, locale_override, cascade_override)
+      else
+        locales.find do |accept|
+          found = lookup(key, accept, cascade_override)
+
+          break found if found
+        end
+      end
+
+    !message.nil?
+  end
+
   # Translate a key path and optional interpolation arguments into a string.
   # It's effectively a combination of #lookup and #interpolate.
   #
@@ -234,23 +311,31 @@ class Tater
   #
   # @param key [String]
   #   The period-separated key path to look within our messages for.
+  # @param options [Hash]
+  #   Options, including values to interpolate to any found string.
+  #
   # @option options [Boolean] :cascade
+  #   Should this lookup cascade or not? Can override @cascade.
   # @option options [String] :default
+  #   A default string to return, should lookup fail.
   # @option options [String] :locale
+  #   A specific locale to lookup within. This will take precedence over the
+  #   :locales option.
+  # @option options [Array<String>] :locales
+  #   An array of locales to look within.
   #
   # @return [String]
   #   The translated and interpreted string, if found, or any data at the
   #   defined key.
   def translate(key, options = {})
     cascade_override = options.delete(:cascade)
-    default = options.delete(:default)
     locale_override = options.delete(:locale)
     locales = options.delete(:locales)
 
     message =
       if locale_override || !locales
         lookup(key, locale_override, cascade_override)
-      elsif locales
+      else
         locales.find do |accept|
           found = lookup(key, accept, cascade_override)
 
@@ -263,7 +348,7 @@ class Tater
       message = message.call(key, options)
     end
 
-    Utils.interpolate(message, options) || default || "Tater lookup failed: #{ locale_override || locales || locale }.#{ key }"
+    Utils.interpolate(message, options) || options.delete(:default) { "Tater lookup failed: #{ locale_override || locales || locale }.#{ key }" }
   end
   alias t translate
 end

data/test/fixtures/fixtures.yml

@@ -8,6 +8,11 @@ en:
   deep:
     key: 'This key is deeper'
 
+  array:
+    last_word_connector: ", and "
+    two_words_connector: " and "
+    words_connector: ", "
+
   date:
     formats:
       default: '%Y/%-m/%-d'

data/test/fixtures/ruby.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 {
   en: {
-    ruby: proc do |key, options = {}|
+    ruby: proc do |key, _options = {}|
       "Hey #{ key }!"
     end,
-    options: proc do |_key, options = {}|
-      "Hey %{options}!"
+    options: proc do |_key, _options = {}|
+      'Hey %{options}!'
     end
   }
 }

data/test/tater_test.rb

@@ -31,11 +31,15 @@ describe Tater do
         assert_equal 'this thing', Tater::Utils.interpolate('this %{what}', what: 'thing')
       end
 
-      it 'raises a KeyError when an argument is missing' do
+      it 'raises a KeyError when an argument is missing (but options are passed)' do
         assert_raises(KeyError) do
-          Tater::Utils.interpolate('this %{what}')
+          Tater::Utils.interpolate('this %{what}', nope: 'thing')
         end
       end
+
+      it 'returns the string unchanged when options are empty (does not raise a KeyError)' do
+        assert_equal 'this %{what}', Tater::Utils.interpolate('this %{what}')
+      end
     end
 
     describe '#string_from_numeric' do
@@ -116,6 +120,7 @@ describe Tater do
     it 'cascades' do
       assert_equal 'Delicious', i18n.lookup('cascade.nope.tacos', nil, true)
       assert_equal 'Whoaa', i18n.lookup('cascade.another.nope.crazy', nil, true)
+      assert_nil i18n.lookup('cascade.another.nope.crazy', nil, false)
       assert_nil i18n.lookup('cascade.nahhhhhh')
     end
   end
@@ -156,6 +161,7 @@ describe Tater do
     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')
       assert_equal 'Delicious', i18n.translate('cascade.nope.tacos', cascade: true)
     end
@@ -182,6 +188,35 @@ describe Tater do
       Tater.new(path: File.expand_path('test/fixtures'))
     end
 
+    let :fr do
+      Tater.new(path: File.expand_path('test/fixtures'), locale: 'fr')
+    end
+
+    it 'localizes arrays' do
+      assert_equal 'tacos and burritos', i18n.localize(%w[tacos burritos])
+      assert_equal 'tacos', i18n.localize(%w[tacos])
+      assert_equal 'tacos, enchiladas, and burritos', i18n.localize(%w[tacos enchiladas burritos])
+
+      assert_equal 'tacos + enchiladas ++ burritos', fr.localize(%w[tacos enchiladas burritos], words_connector: ' + ', last_word_connector: ' ++ ')
+      assert_equal 'tacostwoburritos', fr.localize(%w[tacos burritos], two_words_connector: 'two')
+
+      assert_raises(Tater::MissingLocalizationFormat) do
+        fr.localize(%w[tacos burritos])
+      end
+
+      assert_raises(Tater::MissingLocalizationFormat) do
+        fr.localize(%w[tacos burritos], last_word_connector: 'last', words_connector: 'words')
+      end
+
+      assert_raises(Tater::MissingLocalizationFormat) do
+        fr.localize(%w[tacos burritos], last_word_connector: 'last')
+      end
+
+      assert_raises(Tater::MissingLocalizationFormat) do
+        fr.localize(%w[tacos burritos], words_connector: 'words')
+      end
+    end
+
     it 'localizes Dates' do
       assert_equal '1970/1/1', i18n.localize(Date.new(1970, 1, 1))
     end
@@ -332,4 +367,29 @@ describe Tater do
       assert cascade.cascades?
     end
   end
+
+  describe '#includes?' do
+    let :i18n do
+      Tater.new(path: File.expand_path('test/fixtures'))
+    end
+
+    it 'tells you if you have a translation' do
+      assert i18n.includes?('deep')
+      assert i18n.includes?('deep.key')
+      refute i18n.includes?('deep.nope')
+      refute i18n.includes?('nope')
+    end
+
+    it 'allows overriding the locale' do
+      assert i18n.includes?('french', locale: 'fr')
+      assert i18n.includes?('french', locales: %w[en fr])
+      refute i18n.includes?('french', locales: %w[en])
+      refute i18n.includes?('french')
+    end
+
+    it 'allows cascading' do
+      assert i18n.includes?('cascade.nope.tacos', cascade: true)
+      refute i18n.includes?('cascade.nope.tacos', cascade: false)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tater
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Evan Lecklider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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'
 description: Minimal internationalization and localization library.
 email:
 - evan@lecklider.com
@@ -74,13 +102,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '2.0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Minimal internationalization and localization library.
 test_files:
-- test/fixtures/messages/more.yml
 - test/fixtures/ruby.rb
-- test/fixtures/fixtures.yml
 - test/fixtures/another.yml
+- test/fixtures/fixtures.yml
+- test/fixtures/messages/more.yml
 - test/tater_test.rb