tater 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df91dea484a66a6511be668c7738e1970a588f07e3bb71f25687b0472290117d
-  data.tar.gz: 97966c5fa1ff9db5f1c42b1ed98720892646e8dce07e49d24e058c79c9fc08a7
+  metadata.gz: 6fe610aeeb910795f9f07f52bdbfa529a6f10ac5b807a8252a0d0f50e24ca6a6
+  data.tar.gz: a4154b7803f31babbb012f2f65f36b16f4ea929a43f30a9388b0be10d717f1d7
 SHA512:
-  metadata.gz: e636ba94fb9e1100729adfa4422fa0dc9c0c692bc38915c114a8115c9b711838b448ee49c63653ccdabbbf467c56450aa661240392b61a833061c1e78d1ddd41
-  data.tar.gz: 60bfea0ecab01a4d99fd28789c6cfe9d7bc5f919d430d63eb1f651e58e45166384e244868ccae42246a2668ac4eb6d63964f536d6baee4a7f1b24cfd1953ef8c
+  metadata.gz: e478a0bb35614afcf58b79f4d2511f02a25772decbf5e1ea5f4ccbb574ea1699fb7f13bc7174aca5ee12cb6fe0130f7a5466a069cc1fca0435569a6e5db2c58d
+  data.tar.gz: f7f31381024e298d33cdf53ae6609218ab671d27c2fd3c0f1e4f8595a28d87f2f46b6f9d03b27e2c186aec6fc4c4a707850287ca98420ff2ef7a2444d8c7fef9

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

@@ -141,7 +141,7 @@ 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.
@@ -156,6 +156,13 @@ class Tater
   #   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.
@@ -207,6 +214,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

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

@@ -184,6 +184,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tater
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Evan Lecklider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest