i18n-js 3.7.1 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8b0336b575e1fcbf19bc557cb7fd709db85f8831a842970c03f34517baa90c2
-  data.tar.gz: 4f86f0c6d7e05b0aeb4b8f7898d5947b6a06dd402593d34c068f98da28ed09ff
+  metadata.gz: b219edefbe002f4d278f6677a3d1b25a313392e9bcef34f5a6c6ac3ac4a2dd90
+  data.tar.gz: 8aa014849035847f081f9ef53f1824d1405feedb5d2eb61a979885bf3d8b4d06
 SHA512:
-  metadata.gz: 20f3d107d1e745c7948ff2fa10173712e84bf58894cab7f1d21f58b5c647bf17fb0a664cc2bb4363d3def74898c0a85dda1a8de6c64161400bd1044663a61cc0
-  data.tar.gz: bc0fa3a90ff5ef2a23c4f084845238564b6c66d9deb96abb79478f719e37e065744cd775b3d8de33765f1d72a266325672b8bcfe95fc1dbd9c0aceb507538d5c
+  metadata.gz: e75a5ebff4ca0a1572376a816185c42e21ee343b4a44c8b3a4a2c7831241bc5af77a79522b1ce541e86773bce39ae3088365c67fdd8dfe245af522c808ecebaa
+  data.tar.gz: dceaa789df1e2712849300687afcabbbc73a3f4557d2cb3f08bafda30f357ea9b9d794cf914240398cec8798a102f54d9839bdc92d53327e3124715eddcf1c8f

data/CHANGELOG.md

@@ -18,6 +18,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [3.8.0] - 2020-10-15
+
+### Added
+
+- [JS] Add option `scope` for `toHumanSize()`  
+  (PR: https://github.com/fnando/i18n-js/pull/583)
+
+
 ## [3.7.1] - 2020-06-30
 
 ### Fixed
@@ -465,7 +473,8 @@ And today is not April Fools' Day
 
 
 
-[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.7.1...HEAD
+[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.8.0...HEAD
+[3.8.0]:      https://github.com/fnando/i18n-js/compare/v3.7.1...v3.8.0
 [3.7.1]:      https://github.com/fnando/i18n-js/compare/v3.7.0...v3.7.1
 [3.7.0]:      https://github.com/fnando/i18n-js/compare/v3.6.0...v3.7.0
 [3.6.0]:      https://github.com/fnando/i18n-js/compare/v3.5.1...v3.6.0

data/README.md

@@ -37,6 +37,18 @@ Add the gem to your Gemfile.
 gem "i18n-js"
 ```
 
+#### Rails with [webpacker](https://github.com/rails/webpacker)
+
+If you're using `webpacker`, you may need to add the dependencies to your client with:
+
+```
+yarn add i18n-js
+# or, if you're using npm,
+npm install i18n-js
+```
+
+For more details, see [this gist](https://gist.github.com/bazzel/ecdff4718962e57c2d5569cf01d332fe).
+
 #### Rails app with [Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html)
 
 If you're using the [asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html),
@@ -325,7 +337,7 @@ var i18n = require("i18n-js");
 
 ### Setting up
 
-You **don't** need to set up a thing. The default settings will work just okay. But if you want to split translations into several files or specify specific contexts, you can follow the rest of this setting up section.
+You **don't** need to set up a thing. The default settings will work just okay. But if you want to split translations into several files or specify contexts, you can follow the rest of this setting up section.
 
 Set your locale is easy as
 ```javascript
@@ -393,7 +405,7 @@ I18n.t("some.missing.scope", {defaults: [{scope: "some.existing.scope"}]});
 I18n.t("some.missing.scope", {defaults: [{message: "Some message"}]});
 ```
 
-Default values must be provided as an array of hashs where the key is the
+Default values must be provided as an array of hashes where the key is the
 type of translation desired, a `scope` or a `message`. The translation returned
 will be either the first scope recognized, or the first message defined.
 
@@ -492,7 +504,7 @@ I18n.pluralization["ru"] = function (count) {
 };
 ```
 
-You can find all rules on <http://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html>.
+You can find all rules on <https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.html>.
 
 If you're using the same scope over and over again, you may use the `scope` option.
 
@@ -574,6 +586,7 @@ The `toHumanSize` function accepts the following options:
 - `delimiter`: defaults to `""`
 - `strip_insignificant_zeros`: defaults to `false`
 - `format`: defaults to `%n%u`
+- `scope`: defaults to `""`
 
 <!---->
 
@@ -728,7 +741,7 @@ This method is useful for very large apps where a single contained translations.
 
 To use this with require.js we are only going to change a few things from above.
 
-1. In your `config/i18n-js.yml` we need to add a better location for the i18n to be exported. You want to use this location so that it can be properly precompiled by r.js.
+1. In your `config/i18n-js.yml` we need to add a better location for the i18n to be exported to. You want to use this location so that it can be properly precompiled by r.js.
 
   ```yaml
   export_i18n_js: "app/assets/javascript/nls"
@@ -772,7 +785,7 @@ To use this with require.js we are only going to change a few things from above.
       // ...
   });
   ```
-4. (optional) As an additional configuration we can make a task to be run before the requirejs optimizer. This will allow any automated scripts that run the requirejs optimizer to export the strings before we run r.js
+4. (optional) As an additional configuration we can make a task to be run before the requirejs optimizer. This will allow any automated scripts that run the requirejs optimizer to export the strings before we run r.js.
 
   ```rake
   # lib/tasks/i18n.rake
@@ -833,7 +846,7 @@ These commands will remove *all* fingerprinted assets, and you will have to reco
 $ rake assets:precompile
 ```
 
-or similar commands.  If you are precompiling assets on the target machine(s), cached pages may be broken by this, so they will need to be refreshed.
+or similar commands. If you are precompiling assets on the target machine(s), cached pages may be broken by this, so they will need to be refreshed.
 
 2. You can change something in a different locale file.
 
@@ -844,9 +857,9 @@ or similar commands.  If you are precompiling assets on the target machine(s), c
 ### Translations in JS are not updated when Sprockets not loaded before this gem
 
 The "rails engine" declaration will try to detect existence of "sprockets" before adding the initailizer
-If sprockets is loaded after this gem, the preprocessor for 
+If sprockets is loaded after this gem, the preprocessor for
 making JS translations file cache to depend on content of locale files will not be hooked.
-So ensure sprockets is loaded before this gem like moving entry of sprockets in Gemfile or adding "require" statements for sprockets somewhere.
+So ensure sprockets is loaded before this gem by moving the entry of sprockets in the Gemfile or adding "require" statements for sprockets somewhere.
 
 **Note:** See issue [#404](https://github.com/fnando/i18n-js/issues/404) for more details and discussion of this issue.
 

data/app/assets/javascripts/i18n.js

@@ -402,7 +402,7 @@
 
     while (locales.length) {
       locale = locales.shift();
-      scopes = fullScope.split(this.defaultSeparator);
+      scopes = fullScope.split(options.separator || this.defaultSeparator);
       translations = this.translations[locale];
 
       if (!translations) {
@@ -459,7 +459,7 @@
 
     while (locales.length) {
       locale = locales.shift();
-      scopes = scope.split(this.defaultSeparator);
+      scopes = scope.split(options.separator || this.defaultSeparator);
       translations = this.translations[locale];
 
       if (!translations) {
@@ -685,7 +685,7 @@
 
     var localeForTranslation = (options != null && options.locale != null) ? options.locale : this.currentLocale();
     var fullScope           = this.getFullScope(scope, options);
-    var fullScopeWithLocale = [localeForTranslation, fullScope].join(this.defaultSeparator);
+    var fullScopeWithLocale = [localeForTranslation, fullScope].join(options.separator || this.defaultSeparator);
 
     return '[missing "' + fullScopeWithLocale + '" translation]';
   };
@@ -1025,6 +1025,7 @@
       , iterations = 0
       , unit
       , precision
+      , fullScope
     ;
 
     while (size >= kb && iterations < 4) {
@@ -1033,10 +1034,12 @@
     }
 
     if (iterations === 0) {
-      unit = this.t("number.human.storage_units.units.byte", {count: size});
+      fullScope = this.getFullScope("number.human.storage_units.units.byte", options);
+      unit = this.t(fullScope, {count: size});
       precision = 0;
     } else {
-      unit = this.t("number.human.storage_units.units." + SIZE_UNITS[iterations]);
+      fullScope = this.getFullScope("number.human.storage_units.units." + SIZE_UNITS[iterations], options);
+      unit = this.t(fullScope);
       precision = (size - Math.floor(size) === 0) ? 0 : 1;
     }
 
@@ -1053,7 +1056,7 @@
 
     // Deal with the scope as an array.
     if (isArray(scope)) {
-      scope = scope.join(this.defaultSeparator);
+      scope = scope.join(options.separator || this.defaultSeparator);
     }
 
     // Deal with the scope option provided through the second argument.
@@ -1061,7 +1064,7 @@
     //    I18n.t('hello', {scope: 'greetings'});
     //
     if (options.scope) {
-      scope = [options.scope, scope].join(this.defaultSeparator);
+      scope = [options.scope, scope].join(options.separator || this.defaultSeparator);
     }
 
     return scope;

data/lib/i18n/js/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module JS
-    VERSION = "3.7.1"
+    VERSION = "3.8.0"
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18n-js",
-  "version": "3.7.1",
+  "version": "3.8.0",
   "description": "A javascript library similar to Ruby on Rails i18n gem",
   "author": "Nando Vieira",
   "license": "MIT",

data/spec/js/numbers.spec.js

@@ -150,6 +150,10 @@ describe("Numbers", function(){
     expect(I18n.toHumanSize(1024 * 1.6, {precision: 0})).toEqual("2KB");
   });
 
+  it("returns number as human size using custom scope", function(){
+    expect(I18n.toHumanSize(1024 * 1024, {scope: "extended"})).toEqual("1Megabyte");
+  });
+
   it("formats numbers with strip insignificant zero", function() {
     options = {separator: ".", delimiter: ",", strip_insignificant_zeros: true};
 

data/spec/js/translate.spec.js

@@ -296,4 +296,9 @@ describe("Translate", function(){
       {foo: "bar"}
     ]);
   });
+
+
+  it("returns value with key containing dot but different separator specified", function() {
+    expect(I18n.t(["A implies B means something."], {scope: "sentences_with_dots", separator: "|"})).toEqual("A implies B means that when A is true, B must be true.");
+  });
 });

data/spec/js/translations.js

@@ -58,6 +58,18 @@
           }
         }
 
+      , extended: {
+          number: {
+            human: {
+              storage_units: {
+                  units: {
+                    "mb": "Megabyte"
+                }
+              }
+            }
+          }
+        }
+
       , arrayWithParams: [
         null,
         "An item with a param of {{value}}",
@@ -67,7 +79,11 @@
         {foo: "bar"}
       ]
 
-      , null_key: null
+      , null_key: null,
+
+      sentences_with_dots: {
+          "A implies B means something.": "A implies B means that when A is true, B must be true."
+      }
     };
 
     Translations["en-US"] = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.8.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n