i18n-js 3.5.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b0e768392d4f11e954143639a70556e397560dcb9b970b80ffe3082ba288bf2
-  data.tar.gz: f385a60d70b37dc5945692d276aa0fc5ce40b9c4dd61e5123be1a21c859cacb3
+  metadata.gz: 62051e50266fb55f81099456051f21393aba9a4ecabda1bf2739ae181bf64ec6
+  data.tar.gz: 517cc9090a03e060781be401588b00495a18ccf934fd155ec838d1334b349d7c
 SHA512:
-  metadata.gz: 6e9a52a4c632031c4f42554da5e67bd2b138ab42c1a65dc6bca2a8a1aa60184e641c895dac95996d48ad2e285811c47152c5b56d82b4dee40a985607f83b4ec4
-  data.tar.gz: 254934f35ead75fde6842038ca2e4c8fee13492814b56da9a7b7ab080848a02446a9320efc92fd47eebe322ea4845bcbcd86d86396b1e9435e4ce1af63995178
+  metadata.gz: e88fc0e5f91b673a401310c1b8db1bc5f04a3d3cf5379d978fda9a1030cb5bedb897175577301b5cd4ef86cd025f03c17250c1d5953c7779a48a0911339e7307
+  data.tar.gz: b7caf39eff008a7817a512f60edffc515a3baa41ff8c7388d54f8fcd59f42e9247ee28567f58c264a319fd9f7049712fc8d0a76a85ca778dad4d70144fb4124f

data/CHANGELOG.md

@@ -18,6 +18,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [3.5.1] - 2019-12-21
+
+### Changed
+
+- [JS] Bound shortcut functions  
+  (PR: https://github.com/fnando/i18n-js/pull/560)
+
+
 ## [3.5.0] - 2019-11-12
 
 ### Added
@@ -433,7 +441,8 @@ And today is not April Fools' Day
 
 
 
-[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.5.0...HEAD
+[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.5.1...HEAD
+[3.5.1]:      https://github.com/fnando/i18n-js/compare/v3.5.0...v3.5.1
 [3.5.0]:      https://github.com/fnando/i18n-js/compare/v3.4.2...v3.5.0
 [3.4.2]:      https://github.com/fnando/i18n-js/compare/v3.4.1...v3.4.2
 [3.4.1]:      https://github.com/fnando/i18n-js/compare/v3.4.0...v3.4.1

data/app/assets/javascripts/i18n.js

@@ -1084,9 +1084,9 @@
   };
 
   // Set aliases, so we can save some typing.
-  I18n.t = I18n.translate;
-  I18n.l = I18n.localize;
-  I18n.p = I18n.pluralize;
+  I18n.t = I18n.translate.bind(I18n);
+  I18n.l = I18n.localize.bind(I18n);
+  I18n.p = I18n.pluralize.bind(I18n);
 
   return I18n;
 }));

data/app/assets/javascripts/i18n/shims.js

@@ -206,3 +206,35 @@ if (!Array.prototype.map) {
     return A;
   };
 }
+
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/Function/bind
+if (!Function.prototype.bind) (function(){
+  var ArrayPrototypeSlice = Array.prototype.slice;
+  Function.prototype.bind = function(otherThis) {
+    if (typeof this !== 'function') {
+      // closest thing possible to the ECMAScript 5
+      // internal IsCallable function
+      throw new TypeError('Function.prototype.bind - what is trying to be bound is not callable');
+    }
+
+    var baseArgs= ArrayPrototypeSlice .call(arguments, 1),
+        baseArgsLength = baseArgs.length,
+        fToBind = this,
+        fNOP    = function() {},
+        fBound  = function() {
+          baseArgs.length = baseArgsLength; // reset to default base arguments
+          baseArgs.push.apply(baseArgs, arguments);
+          return fToBind.apply(
+                 fNOP.prototype.isPrototypeOf(this) ? this : otherThis, baseArgs
+          );
+        };
+
+    if (this.prototype) {
+      // Function.prototype doesn't have a prototype property
+      fNOP.prototype = this.prototype; 
+    }
+    fBound.prototype = new fNOP();
+
+    return fBound;
+  };
+})();

data/lib/i18n/js/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module JS
-    VERSION = "3.5.0"
+    VERSION = "3.5.1"
   end
 end

data/package.json

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

data/spec/js/localization.spec.js

@@ -10,45 +10,55 @@ describe("Localization", function(){
     I18n.translations = Translations();
   });
 
+  it("sets bound alias", function() {
+    expect(I18n.l).toEqual(jasmine.any(Function));
+    expect(I18n.l).not.toBe(I18n.localize);
+  });
+
   it("localizes number", function(){
-    expect(I18n.l("number", 1234567)).toEqual("1,234,567.000");
+    expect(I18n.localize("number", 1234567)).toEqual("1,234,567.000");
+  });
+
+  it("localizes number with 'l' shortcut", function(){
+    var l = I18n.l;
+    expect(l("number", 1234567)).toEqual("1,234,567.000");
   });
 
   it("localizes currency", function(){
-    expect(I18n.l("currency", 1234567)).toEqual("$1,234,567.00");
+    expect(I18n.localize("currency", 1234567)).toEqual("$1,234,567.00");
   });
 
   it("localizes date strings", function(){
     I18n.locale = "pt-BR";
 
-    expect(I18n.l("date.formats.default", "2009-11-29")).toEqual("29/11/2009");
-    expect(I18n.l("date.formats.short", "2009-01-07")).toEqual("07 de Janeiro");
-    expect(I18n.l("date.formats.long", "2009-01-07")).toEqual("07 de Janeiro de 2009");
+    expect(I18n.localize("date.formats.default", "2009-11-29")).toEqual("29/11/2009");
+    expect(I18n.localize("date.formats.short", "2009-01-07")).toEqual("07 de Janeiro");
+    expect(I18n.localize("date.formats.long", "2009-01-07")).toEqual("07 de Janeiro de 2009");
   });
 
   it("localizes time strings", function(){
     I18n.locale = "pt-BR";
 
-    expect(I18n.l("time.formats.default", "2009-11-29 15:07:59")).toEqual("Domingo, 29 de Novembro de 2009, 15:07 h");
-    expect(I18n.l("time.formats.short", "2009-01-07 09:12:35")).toEqual("07/01, 09:12 h");
-    expect(I18n.l("time.formats.long", "2009-11-29 15:07:59")).toEqual("Domingo, 29 de Novembro de 2009, 15:07 h");
+    expect(I18n.localize("time.formats.default", "2009-11-29 15:07:59")).toEqual("Domingo, 29 de Novembro de 2009, 15:07 h");
+    expect(I18n.localize("time.formats.short", "2009-01-07 09:12:35")).toEqual("07/01, 09:12 h");
+    expect(I18n.localize("time.formats.long", "2009-11-29 15:07:59")).toEqual("Domingo, 29 de Novembro de 2009, 15:07 h");
   });
 
   it("return 'Invalid Date' or original value for invalid input", function(){
-    expect(I18n.l("time.formats.default", "")).toEqual("Invalid Date");
-    expect(I18n.l("time.formats.default", null)).toEqual(null);
-    expect(I18n.l("time.formats.default", undefined)).toEqual(undefined);
+    expect(I18n.localize("time.formats.default", "")).toEqual("Invalid Date");
+    expect(I18n.localize("time.formats.default", null)).toEqual(null);
+    expect(I18n.localize("time.formats.default", undefined)).toEqual(undefined);
   });
 
   it("localizes date/time strings with placeholders", function(){
     I18n.locale = "pt-BR";
 
-    expect(I18n.l("date.formats.short_with_placeholders", "2009-01-07", { p1: "!", p2: "?" })).toEqual("07 de Janeiro ! ?");
-    expect(I18n.l("time.formats.short_with_placeholders", "2009-01-07 09:12:35", { p1: "!" })).toEqual("07/01, 09:12 h !");
+    expect(I18n.localize("date.formats.short_with_placeholders", "2009-01-07", { p1: "!", p2: "?" })).toEqual("07 de Janeiro ! ?");
+    expect(I18n.localize("time.formats.short_with_placeholders", "2009-01-07 09:12:35", { p1: "!" })).toEqual("07/01, 09:12 h !");
   });
 
   it("localizes percentage", function(){
     I18n.locale = "pt-BR";
-    expect(I18n.l("percentage", 123.45)).toEqual("123,45%");
+    expect(I18n.localize("percentage", 123.45)).toEqual("123,45%");
   });
 });

data/spec/js/pluralization.spec.js

@@ -10,8 +10,9 @@ describe("Pluralization", function(){
     I18n.translations = Translations();
   });
 
-  it("sets alias", function() {
-    expect(I18n.p).toEqual(I18n.pluralize);
+  it("sets bound alias", function() {
+    expect(I18n.p).toEqual(jasmine.any(Function));
+    expect(I18n.p).not.toBe(I18n.pluralize);
   });
 
   it("pluralizes scope", function(){
@@ -20,6 +21,13 @@ describe("Pluralization", function(){
     expect(I18n.p(5, "inbox")).toEqual("You have 5 messages");
   });
 
+  it("pluralizes scope with 'p' shortcut", function(){
+    var p = I18n.p;
+    expect(p(0, "inbox")).toEqual("You have no messages");
+    expect(p(1, "inbox")).toEqual("You have 1 message");
+    expect(p(5, "inbox")).toEqual("You have 5 messages");
+  });
+
   it("pluralizes using the 'other' scope", function(){
     I18n.translations["en"]["inbox"]["zero"] = null;
     expect(I18n.p(0, "inbox")).toEqual("You have 0 messages");

data/spec/js/translate.spec.js

@@ -10,35 +10,45 @@ describe("Translate", function(){
     I18n.translations = Translations();
   });
 
+  it("sets bound alias", function() {
+    expect(I18n.t).toEqual(jasmine.any(Function));
+    expect(I18n.t).not.toBe(I18n.translate);
+  });
+
   it("returns translation for single scope", function(){
-    expect(I18n.t("hello")).toEqual("Hello World!");
+    expect(I18n.translate("hello")).toEqual("Hello World!");
+  });
+
+  it("returns translation with 't' shortcut", function(){
+    var t = I18n.t;
+    expect(t("hello")).toEqual("Hello World!");
   });
 
   it("returns translation as object", function(){
-    expect(I18n.t("greetings")).toEqual(I18n.translations.en.greetings);
+    expect(I18n.translate("greetings")).toEqual(I18n.translations.en.greetings);
   });
 
   it("returns missing message translation for valid scope with null", function(){
-    actual = I18n.t("null_key");
+    actual = I18n.translate("null_key");
     expected = '[missing "en.null_key" translation]';
     expect(actual).toEqual(expected);
   });
 
   it("returns missing message translation for invalid scope", function(){
-    actual = I18n.t("invalid.scope");
+    actual = I18n.translate("invalid.scope");
     expected = '[missing "en.invalid.scope" translation]';
     expect(actual).toEqual(expected);
   });
 
   it("returns missing message translation with provided locale for invalid scope", function(){
-    actual = I18n.t("invalid.scope", { locale: "ja" });
+    actual = I18n.translate("invalid.scope", { locale: "ja" });
     expected = '[missing "ja.invalid.scope" translation]';
     expect(actual).toEqual(expected);
   });
 
   it("returns guessed translation if missingBehaviour is set to guess", function(){
     I18n.missingBehaviour = 'guess'
-    actual = I18n.t("invalid.thisIsAutomaticallyGeneratedTranslation");
+    actual = I18n.translate("invalid.thisIsAutomaticallyGeneratedTranslation");
     expected = 'this is automatically generated translation';
     expect(actual).toEqual(expected);
   });
@@ -46,47 +56,47 @@ describe("Translate", function(){
   it("returns guessed translation with prefix if missingBehaviour is set to guess and prefix is also provided", function(){
     I18n.missingBehaviour = 'guess'
     I18n.missingTranslationPrefix = 'EE: '
-    actual = I18n.t("invalid.thisIsAutomaticallyGeneratedTranslation");
+    actual = I18n.translate("invalid.thisIsAutomaticallyGeneratedTranslation");
     expected = 'EE: this is automatically generated translation';
     expect(actual).toEqual(expected);
   });
 
   it("returns missing message translation for valid scope with scope", function(){
-    actual = I18n.t("monster", {scope: "greetings"});
+    actual = I18n.translate("monster", {scope: "greetings"});
     expected = '[missing "en.greetings.monster" translation]';
     expect(actual).toEqual(expected);
   });
 
   it("returns translation for single scope on a custom locale", function(){
     I18n.locale = "pt-BR";
-    expect(I18n.t("hello")).toEqual("Olá Mundo!");
+    expect(I18n.translate("hello")).toEqual("Olá Mundo!");
   });
 
   it("returns translation for multiple scopes", function(){
-    expect(I18n.t("greetings.stranger")).toEqual("Hello stranger!");
+    expect(I18n.translate("greetings.stranger")).toEqual("Hello stranger!");
   });
 
   it("returns translation with default locale option", function(){
-    expect(I18n.t("hello", {locale: "en"})).toEqual("Hello World!");
-    expect(I18n.t("hello", {locale: "pt-BR"})).toEqual("Olá Mundo!");
+    expect(I18n.translate("hello", {locale: "en"})).toEqual("Hello World!");
+    expect(I18n.translate("hello", {locale: "pt-BR"})).toEqual("Olá Mundo!");
   });
 
   it("fallbacks to the default locale when I18n.fallbacks is enabled", function(){
     I18n.locale = "pt-BR";
     I18n.fallbacks = true;
-    expect(I18n.t("greetings.stranger")).toEqual("Hello stranger!");
+    expect(I18n.translate("greetings.stranger")).toEqual("Hello stranger!");
   });
 
   it("fallbacks to default locale when providing an unknown locale", function(){
     I18n.locale = "fr";
     I18n.fallbacks = true;
-    expect(I18n.t("greetings.stranger")).toEqual("Hello stranger!");
+    expect(I18n.translate("greetings.stranger")).toEqual("Hello stranger!");
   });
 
   it("fallbacks to less specific locale", function(){
     I18n.locale = "de-DE";
     I18n.fallbacks = true;
-    expect(I18n.t("hello")).toEqual("Hallo Welt!");
+    expect(I18n.translate("hello")).toEqual("Hallo Welt!");
   });
 
   describe("when a 3-part locale is used", function(){
@@ -96,15 +106,15 @@ describe("Translate", function(){
     });
 
     it("fallbacks to 2-part locale when absent", function(){
-      expect(I18n.t("cat")).toEqual("貓");
+      expect(I18n.translate("cat")).toEqual("貓");
     });
 
     it("fallbacks to 1-part locale when 2-part missing requested translation", function(){
-      expect(I18n.t("dog")).toEqual("狗");
+      expect(I18n.translate("dog")).toEqual("狗");
     });
 
     it("fallbacks to 2-part for the first time", function(){
-      expect(I18n.t("dragon")).toEqual("龍");
+      expect(I18n.translate("dragon")).toEqual("龍");
     });
   });
 
@@ -115,7 +125,7 @@ describe("Translate", function(){
       return ["nb"];
     };
 
-    expect(I18n.t("hello")).toEqual("Hei Verden!");
+    expect(I18n.translate("hello")).toEqual("Hei Verden!");
   });
 
   it("fallbacks using custom rules (array)", function() {
@@ -123,7 +133,7 @@ describe("Translate", function(){
     I18n.fallbacks = true;
     I18n.locales["no"] = ["no", "nb"];
 
-    expect(I18n.t("hello")).toEqual("Hei Verden!");
+    expect(I18n.translate("hello")).toEqual("Hei Verden!");
   });
 
   it("fallbacks using custom rules (string)", function() {
@@ -131,25 +141,25 @@ describe("Translate", function(){
     I18n.fallbacks = true;
     I18n.locales["no"] = "nb";
 
-    expect(I18n.t("hello")).toEqual("Hei Verden!");
+    expect(I18n.translate("hello")).toEqual("Hei Verden!");
   });
 
   describe("when provided default values", function() {
     it("uses scope provided in defaults if scope doesn't exist", function() {
-      actual = I18n.t("Hello!", {defaults: [{scope: "greetings.stranger"}]});
+      actual = I18n.translate("Hello!", {defaults: [{scope: "greetings.stranger"}]});
       expect(actual).toEqual("Hello stranger!");
     });
 
     it("continues to fallback until a scope is found", function() {
       var defaults = [{scope: "foo"}, {scope: "hello"}];
 
-      actual = I18n.t("foo", {defaults: defaults});
+      actual = I18n.translate("foo", {defaults: defaults});
       expect(actual).toEqual("Hello World!");
     });
 
     it("uses message if specified as a default", function() {
       var defaults = [{message: "Hello all!"}];
-      actual = I18n.t("foo", {defaults: defaults});
+      actual = I18n.translate("foo", {defaults: defaults});
       expect(actual).toEqual("Hello all!");
     });
 
@@ -158,7 +168,7 @@ describe("Translate", function(){
           {scope: "bar"}
         , {message: "Hello all!"}
         , {scope: "hello"}];
-      actual = I18n.t("foo", {defaults: defaults});
+      actual = I18n.translate("foo", {defaults: defaults});
       expect(actual).toEqual("Hello all!");
     });
 
@@ -167,7 +177,7 @@ describe("Translate", function(){
           defaults: [{scope: "bar"}]
         , defaultValue: "Hello all!"
       };
-      actual = I18n.t("foo", options);
+      actual = I18n.translate("foo", options);
       expect(actual).toEqual("Hello all!");
     });
 
@@ -176,7 +186,7 @@ describe("Translate", function(){
           defaults: [{scope: "hello"}]
         , defaultValue: "Hello all!"
       };
-      actual = I18n.t("foo", options);
+      actual = I18n.translate("foo", options);
       expect(actual).toEqual("Hello World!");
     })
 
@@ -187,36 +197,36 @@ describe("Translate", function(){
           return scope.toUpperCase();
         }
       };
-      actual = I18n.t("foo", options);
+      actual = I18n.translate("foo", options);
       expect(actual).toEqual("FOO");
     })
 
     it("pluralizes using the correct scope if translation is found within default scope", function() {
       expect(I18n.translations["en"]["mailbox"]).toEqual(undefined);
-      actual = I18n.t("mailbox.inbox", {count: 1, defaults: [{scope: "inbox"}]});
-      expected = I18n.t("inbox", {count: 1})
+      actual = I18n.translate("mailbox.inbox", {count: 1, defaults: [{scope: "inbox"}]});
+      expected = I18n.translate("inbox", {count: 1})
       expect(actual).toEqual(expected)
     })
   });
 
   it("uses default value for simple translation", function(){
-    actual = I18n.t("warning", {defaultValue: "Warning!"});
+    actual = I18n.translate("warning", {defaultValue: "Warning!"});
     expect(actual).toEqual("Warning!");
   });
 
   it("uses default value for plural translation", function(){
-    actual = I18n.t("message", {defaultValue: { one: '%{count} message', other: '%{count} messages'}, count: 1});
+    actual = I18n.translate("message", {defaultValue: { one: '%{count} message', other: '%{count} messages'}, count: 1});
     expect(actual).toEqual("1 message");
   });
 
   it("uses default value for unknown locale", function(){
     I18n.locale = "fr";
-    actual = I18n.t("warning", {defaultValue: "Warning!"});
+    actual = I18n.translate("warning", {defaultValue: "Warning!"});
     expect(actual).toEqual("Warning!");
   });
 
   it("uses default value with interpolation", function(){
-    actual = I18n.t(
+    actual = I18n.translate(
       "alert",
       {defaultValue: "Attention! {{message}}", message: "You're out of quota!"}
     );
@@ -225,33 +235,33 @@ describe("Translate", function(){
   });
 
   it("ignores default value when scope exists", function(){
-    actual = I18n.t("hello", {defaultValue: "What's up?"});
+    actual = I18n.translate("hello", {defaultValue: "What's up?"});
     expect(actual).toEqual("Hello World!");
   });
 
   it("returns translation for custom scope separator", function(){
     I18n.defaultSeparator = "•";
-    actual = I18n.t("greetings•stranger");
+    actual = I18n.translate("greetings•stranger");
     expect(actual).toEqual("Hello stranger!");
   });
 
   it("returns boolean values", function() {
-    expect(I18n.t("booleans.yes")).toEqual(true);
-    expect(I18n.t("booleans.no")).toEqual(false);
+    expect(I18n.translate("booleans.yes")).toEqual(true);
+    expect(I18n.translate("booleans.no")).toEqual(false);
   });
 
   it("escapes $ when doing substitution (IE)", function(){
     I18n.locale = "en";
 
-    expect(I18n.t("paid", {price: "$0"})).toEqual("You were paid $0");
-    expect(I18n.t("paid", {price: "$0.12"})).toEqual("You were paid $0.12");
-    expect(I18n.t("paid", {price: "$1.35"})).toEqual("You were paid $1.35");
+    expect(I18n.translate("paid", {price: "$0"})).toEqual("You were paid $0");
+    expect(I18n.translate("paid", {price: "$0.12"})).toEqual("You were paid $0.12");
+    expect(I18n.translate("paid", {price: "$1.35"})).toEqual("You were paid $1.35");
   });
 
   it("replaces all occurrences of escaped $", function(){
     I18n.locale = "en";
 
-    expect(I18n.t("paid_with_vat", {
+    expect(I18n.translate("paid_with_vat", {
       price: "$0.12",
       vat: "$0.02"}
     )).toEqual("You were paid $0.12 (incl. VAT $0.02)");
@@ -259,20 +269,20 @@ describe("Translate", function(){
 
   it("sets default scope", function(){
     var options = {scope: "greetings"};
-    expect(I18n.t("stranger", options)).toEqual("Hello stranger!");
+    expect(I18n.translate("stranger", options)).toEqual("Hello stranger!");
   });
 
   it("accepts the scope as an array", function(){
-    expect(I18n.t(["greetings", "stranger"])).toEqual("Hello stranger!");
+    expect(I18n.translate(["greetings", "stranger"])).toEqual("Hello stranger!");
   });
 
   it("accepts the scope as an array using a base scope", function(){
-    expect(I18n.t(["stranger"], {scope: "greetings"})).toEqual("Hello stranger!");
+    expect(I18n.translate(["stranger"], {scope: "greetings"})).toEqual("Hello stranger!");
   });
 
   it("returns an array with values interpolated", function(){
     var options = {value: 314};
-    expect(I18n.t("arrayWithParams", options)).toEqual([
+    expect(I18n.translate("arrayWithParams", options)).toEqual([
       null,
       "An item with a param of " + options.value,
       "Another item with a param of " + options.value,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2019-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.1
 signing_key: 
 specification_version: 4
 summary: It's a small library to provide the Rails I18n translations on the Javascript.