i18n-js 3.4.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e862238199baf310221642a6913ce7d07b87b2c6934e691bed7bc19a613c09b7
-  data.tar.gz: cdc3db450f6613e82246f2b2ba303ae706bbdaadebee84d34024cd8fb371308c
+  metadata.gz: 8e97276215fc1d53677d4a73d8fa078d476fbb6400047e43b42ea723eb0df22d
+  data.tar.gz: 496f8b37aeaceed790124ddbe359ac11831aa83b9b61a39ae1634ecff2187837
 SHA512:
-  metadata.gz: 2bc681b8e0b8e7260fd5dfdea56c3733234c8c8afedd0e4c6492ef65356e8b7b6d5ee2e959d5ba26751860c89e237813960e5bc4a45cdb7dbd525fe396277718
-  data.tar.gz: 7aaf234e4f39b7f3eeeff50cadd7f6f8625e235477a83d58bbcf17c30ef7e09ab086de27c85fe5c5f802b6e4f935d81a203abccae80bc65c53a6e549eeb989fb
+  metadata.gz: 7ee645b6b5040548d97df6dbccdbcb90f3f8093ed361c5e83abd822de102bbcf963778b60bc7c76a31f6ada69afe20c1422a420ff052f37eb816d1ef3a22155e
+  data.tar.gz: 395386008e73365635030bddb34a6211d0bc7914fd1822184b3a14a92097d3693ee5834a4cca85f41d584f2b7e46ec528b0fc285d63a9fd93925ee3ffe7c5ab5

data/.travis.yml

@@ -34,5 +34,4 @@ matrix:
   allow_failures:
     - rvm: ruby-head
 notifications:
-  webhooks: https://www.travisbuddy.com/
-  on_success: never
+  webhooks: https://www.travisbuddy.com/?insertMode=update

data/CHANGELOG.md

@@ -18,11 +18,19 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [3.4.1] - 2019-11-01
+
+### Fixed
+
+- [Ruby] Fix merging of plural keys to work with fallbacks that aren't overridden  
+  (PR: https://github.com/fnando/i18n-js/pull/551)
+
+
 ## [3.4.0] - 2019-10-15
 
 ### Added
 
-- Allow `prefix` to be added to generated translations files  
+- [Ruby] Allow `prefix` to be added to generated translations files  
   (PR: https://github.com/fnando/i18n-js/pull/549)
 
 
@@ -30,14 +38,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
-- Support for `%P`, `%Z`, and `%l` strftime formats to match Ruby strftime
+- [JS] Support for `%P`, `%Z`, and `%l` strftime formats to match Ruby strftime  
+  (PR: https://github.com/fnando/i18n-js/pull/537)
 
 
 ## [3.2.3] - 2019-05-24
 
 ### Changed
 
-- Allow rails 6 to be used with this gem  
+- [Ruby] Allow rails 6 to be used with this gem  
   (PR: https://github.com/fnando/i18n-js/pull/536)
 
 
@@ -408,7 +417,8 @@ And today is not April Fools' Day
 
 
 
-[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.4.0...HEAD
+[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.4.1...HEAD
+[3.4.1]:      https://github.com/fnando/i18n-js/compare/v3.4.0...v3.4.1
 [3.4.0]:      https://github.com/fnando/i18n-js/compare/v3.3.0...v3.4.0
 [3.3.0]:      https://github.com/fnando/i18n-js/compare/v3.2.3...v3.3.0
 [3.2.3]:      https://github.com/fnando/i18n-js/compare/v3.2.2...v3.2.3

data/README.md

@@ -248,7 +248,7 @@ MyNamespace.translations["en"] = { ... }
 ```
 
 
-### Adding a line at the beggining of the translations file (useful for imports)
+### Adding a line at the beginning of the translations file (useful for imports)
 
 Setting the `prefix: "import I18n from 'i18n-js';\n"` option will add the line at the beggining of the resultant translation file.
 This can be useful to use this gem with the [i18n-js](https://www.npmjs.com/package/i18n-js) npm package, which is quite useful to use it with webpack.

data/lib/i18n/js/utils.rb

@@ -6,17 +6,20 @@ module I18n
       # Based on deep_merge by Stefan Rusterholz, see <http://www.ruby-forum.com/topic/142809>.
       # This method is used to handle I18n fallbacks. Given two equivalent path nodes in two locale trees:
       # 1. If the node in the current locale appears to be an I18n pluralization (:one, :other, etc.),
-      #    use the node as-is without merging. This prevents mixing locales with different pluralization schemes.
-      # 2. Else if both nodes are Hashes, combine (merge) the key-value pairs of the two nodes into one, 
+      #    use the node, but merge in any missing/non-nil keys from the fallback (default) locale.
+      # 2. Else if both nodes are Hashes, combine (merge) the key-value pairs of the two nodes into one,
       #    prioritizing the current locale.
       # 3. Else if either node is nil, use the other node.
+      PLURAL_MERGER = proc do |_key, v1, v2|
+        v1 || v2
+      end
       MERGER = proc do |_key, v1, v2|
         if Hash === v2 && (v2.keys - PLURAL_KEYS).empty?
-          v2
+          slice(v2.merge(v1, &PLURAL_MERGER), v2.keys)
         elsif Hash === v1 && Hash === v2
           v1.merge(v2, &MERGER)
         else
-          v2.nil? ? v1 : v2
+          v2 || v1
         end
       end
 
@@ -24,6 +27,14 @@ module I18n
         v.kind_of?(Hash) ? (v.delete_if(&HASH_NIL_VALUE_CLEANER_PROC); false) : v.nil?
       end
 
+      def self.slice(hash, keys)
+        if hash.respond_to?(:slice) # ruby 2.5 onwards
+          hash.slice(*keys)
+        else
+          hash.select {|key, _| keys.include?(key)}
+        end
+      end
+
       def self.strip_keys_with_nil_values(hash)
         hash.dup.delete_if(&HASH_NIL_VALUE_CLEANER_PROC)
       end

data/lib/i18n/js/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module JS
-    VERSION = "3.4.0"
+    VERSION = "3.4.1"
   end
 end

data/spec/fixtures/locales.yml

@@ -40,6 +40,20 @@ en:
   merge_plurals:
     one: Apple
     other: Apples
+  merge_plurals_with_no_overrides:
+    zero: "No Apple"
+    one: Apple
+    other: Apples
+  merge_plurals_with_partial_overrides:
+    one: Cat
+    other: Cats
+
+ru:
+  merge_plurals_with_no_overrides:
+    one: кот
+    few: кошек
+    many: кошка
+    other: кошек
 
 de:
   fallback_test: "Erfolg"
@@ -89,6 +103,17 @@ fr:
     one: Pomme
     other: Pommes
 
+en-US:
+  merge_plurals_with_no_overrides:
+    zero:
+    one:
+    other:
+  merge_plurals_with_partial_overrides:
+    one: Cat
+    few:
+    many:
+    other:
+
 ja:
   admin:
     show:

data/spec/fixtures/merge_plurals_with_no_overrides.yml

@@ -0,0 +1,4 @@
+translations:
+  - file: "tmp/i18n-js/merge_plurals_with_no_overrides.js"
+    only:
+      - "*.merge_plurals_with_no_overrides"

data/spec/fixtures/merge_plurals_with_partial_overrides.yml

@@ -0,0 +1,4 @@
+translations:
+  - file: "tmp/i18n-js/merge_plurals_with_partial_overrides.js"
+    only:
+      - "*.merge_plurals_with_partial_overrides"

data/spec/ruby/i18n/js_spec.rb

@@ -598,7 +598,7 @@ EOS
         it "exports with the keys sorted" do
           expect(subject).to eq <<EOS
 I18n.translations || (I18n.translations = {});
-I18n.translations["en"] = I18n.extend((I18n.translations["en"] || {}), {"admin":{"edit":{"title":"Edit"},"show":{"note":"more details","title":"Show"}},"date":{"abbr_day_names":["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],"abbr_month_names":[null,"Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],"day_names":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"formats":{"default":"%Y-%m-%d","long":"%B %d, %Y","short":"%b %d"},"month_names":[null,"January","February","March","April","May","June","July","August","September","October","November","December"]},"fallback_test":"Success","foo":"Foo","merge_plurals":{"one":"Apple","other":"Apples"},"null_test":"fallback for null","number":{"currency":{"format":{"delimiter":",","format":"%u%n","precision":2,"separator":".","unit":"$"}},"format":{"delimiter":",","precision":3,"separator":"."}},"time":{"am":"am","formats":{"default":"%a, %d %b %Y %H:%M:%S %z","long":"%B %d, %Y %H:%M","short":"%d %b %H:%M"},"pm":"pm"}});
+I18n.translations["en"] = I18n.extend((I18n.translations["en"] || {}), {"admin":{"edit":{"title":"Edit"},"show":{"note":"more details","title":"Show"}},"date":{"abbr_day_names":["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],"abbr_month_names":[null,"Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],"day_names":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"formats":{"default":"%Y-%m-%d","long":"%B %d, %Y","short":"%b %d"},"month_names":[null,"January","February","March","April","May","June","July","August","September","October","November","December"]},"fallback_test":"Success","foo":"Foo","merge_plurals":{"one":"Apple","other":"Apples"},"merge_plurals_with_no_overrides":{"one":"Apple","other":"Apples","zero":"No Apple"},"merge_plurals_with_partial_overrides":{"one":"Cat","other":"Cats"},"null_test":"fallback for null","number":{"currency":{"format":{"delimiter":",","format":"%u%n","precision":2,"separator":".","unit":"$"}},"format":{"delimiter":",","precision":3,"separator":"."}},"time":{"am":"am","formats":{"default":"%a, %d %b %Y %H:%M:%S %z","long":"%B %d, %Y %H:%M","short":"%d %b %H:%M"},"pm":"pm"}});
 EOS
         end
       end
@@ -658,6 +658,59 @@ EOS
       expect(subject).to eq <<EOS
 I18n.translations || (I18n.translations = {});
 I18n.translations[\"en\"] = I18n.extend((I18n.translations[\"en\"] || {}), {\"merge_plurals\":{\"one\":\"Apple\",\"other\":\"Apples\"}});\nI18n.translations[\"fr\"] = I18n.extend((I18n.translations[\"fr\"] || {}), {\"merge_plurals\":{\"one\":\"Pomme\",\"other\":\"Pommes\",\"zero\":\"Pomme\"}});
+EOS
+    end
+  end
+
+  describe "merging plural keys, with fallbacks" do
+    before do
+      stub_const('I18n::JS::DEFAULT_EXPORT_DIR_PATH', temp_path)
+    end
+
+    subject do
+      File.read(File.join(I18n::JS.export_i18n_js_dir_path, "merge_plurals_with_no_overrides.js"))
+    end
+
+    it "should correctly merge the plural keys" do
+      set_config "merge_plurals_with_no_overrides.yml"
+      I18n::JS.export
+      file_should_exist "merge_plurals_with_no_overrides.js"
+
+      expect(subject).to eq <<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations[\"de\"] = I18n.extend((I18n.translations[\"de\"] || {}), {\"merge_plurals_with_no_overrides\":{\"one\":\"Apple\",\"other\":\"Apples\",\"zero\":\"No Apple\"}});
+I18n.translations[\"en\"] = I18n.extend((I18n.translations[\"en\"] || {}), {\"merge_plurals_with_no_overrides\":{\"one\":\"Apple\",\"other\":\"Apples\",\"zero\":\"No Apple\"}});
+I18n.translations[\"en-US\"] = I18n.extend((I18n.translations[\"en-US\"] || {}), {\"merge_plurals_with_no_overrides\":{\"one\":\"Apple\",\"other\":\"Apples\",\"zero\":\"No Apple\"}});
+I18n.translations[\"fr\"] = I18n.extend((I18n.translations[\"fr\"] || {}), {\"merge_plurals_with_no_overrides\":{\"one\":\"Apple\",\"other\":\"Apples\",\"zero\":\"No Apple\"}});
+I18n.translations[\"ja\"] = I18n.extend((I18n.translations[\"ja\"] || {}), {\"merge_plurals_with_no_overrides\":{\"one\":\"Apple\",\"other\":\"Apples\",\"zero\":\"No Apple\"}});
+I18n.translations[\"ru\"] = I18n.extend((I18n.translations[\"ru\"] || {}), {\"merge_plurals_with_no_overrides\":{\"few\":\"кошек\",\"many\":\"кошка\",\"one\":\"кот\",\"other\":\"кошек\"}});
+EOS
+    end
+  end
+
+  # see discussion @ https://github.com/fnando/i18n-js/pull/551#issuecomment-543205767
+  describe "merging plural keys, with fallbacks, with partial overrides" do
+    before do
+      stub_const('I18n::JS::DEFAULT_EXPORT_DIR_PATH', temp_path)
+    end
+
+    subject do
+      File.read(File.join(I18n::JS.export_i18n_js_dir_path, "merge_plurals_with_partial_overrides.js"))
+    end
+
+    it "should correctly merge the plural keys" do
+      set_config "merge_plurals_with_partial_overrides.yml"
+      I18n::JS.export
+      file_should_exist "merge_plurals_with_partial_overrides.js"
+
+      expect(subject).to eq <<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations[\"de\"] = I18n.extend((I18n.translations[\"de\"] || {}), {\"merge_plurals_with_partial_overrides\":{\"one\":\"Cat\",\"other\":\"Cats\"}});
+I18n.translations[\"en\"] = I18n.extend((I18n.translations[\"en\"] || {}), {\"merge_plurals_with_partial_overrides\":{\"one\":\"Cat\",\"other\":\"Cats\"}});
+I18n.translations[\"en-US\"] = I18n.extend((I18n.translations[\"en-US\"] || {}), {\"merge_plurals_with_partial_overrides\":{\"few\":null,\"many\":null,\"one\":\"Cat\",\"other\":\"Cats\"}});
+I18n.translations[\"fr\"] = I18n.extend((I18n.translations[\"fr\"] || {}), {\"merge_plurals_with_partial_overrides\":{\"one\":\"Cat\",\"other\":\"Cats\"}});
+I18n.translations[\"ja\"] = I18n.extend((I18n.translations[\"ja\"] || {}), {\"merge_plurals_with_partial_overrides\":{\"one\":\"Cat\",\"other\":\"Cats\"}});
+I18n.translations[\"ru\"] = I18n.extend((I18n.translations[\"ru\"] || {}), {\"merge_plurals_with_partial_overrides\":{\"one\":\"Cat\",\"other\":\"Cats\"}});
 EOS
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.4.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -165,6 +165,8 @@ files:
 - spec/fixtures/json_only.yml
 - spec/fixtures/locales.yml
 - spec/fixtures/merge_plurals.yml
+- spec/fixtures/merge_plurals_with_no_overrides.yml
+- spec/fixtures/merge_plurals_with_partial_overrides.yml
 - spec/fixtures/multiple_conditions.yml
 - spec/fixtures/multiple_conditions_per_locale.yml
 - spec/fixtures/multiple_files.yml
@@ -245,6 +247,8 @@ test_files:
 - spec/fixtures/json_only.yml
 - spec/fixtures/locales.yml
 - spec/fixtures/merge_plurals.yml
+- spec/fixtures/merge_plurals_with_no_overrides.yml
+- spec/fixtures/merge_plurals_with_partial_overrides.yml
 - spec/fixtures/multiple_conditions.yml
 - spec/fixtures/multiple_conditions_per_locale.yml
 - spec/fixtures/multiple_files.yml