Clean up and test plural forms (closes #3)

Author: vphantom

README.md

@@ -1,4 +1,4 @@
-# gettext-pythonic
+# gettext-pythonic v1.0.0
 
 [![Build Status](https://travis-ci.org/vphantom/gettext-pythonic.svg?branch=master)](https://travis-ci.org/vphantom/gettext-pythonic) [![Coverage Status](https://coveralls.io/repos/github/vphantom/gettext-pythonic/badge.svg?branch=master)](https://coveralls.io/github/vphantom/gettext-pythonic?branch=master)
 
@@ -39,7 +39,7 @@ In Node.JS, you can choose whichever name you'd like, although keep in mind that
 
 ```js
 var gettext = require('gettext-pythonic');
-var __ = gettext;
+var __ = gettext.gettext;
 var n_ = gettext.ngettext;
 ...
 gettext.load(require('locales/fr.json'));

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "gettext-pythonic",
-  "version": "0.5.2",
+  "version": "1.0.0",
   "description": "Tiny po2json-compatible gettext with variable substitution",
   "main": "gettext-pythonic.js",
   "authors": [

gettext-pythonic.js

@@ -1,5 +1,6 @@
-/*! gettext-pythonic
- * Copyright 2016 Stéphane Lavergne <http://www.imars.com/>
+/*! gettext-pythonic v1.0.0
+ * <https://github.com/vphantom/gettext-pythonic>
+ * Copyright 2016 Stéphane Lavergne
  * Free software under <http://www.gnu.org/licenses/lgpl-3.0.txt> */
 
 /**
@@ -15,32 +16,33 @@
 
 "use strict";
 
-(function(window) {
+(function(context) {
   var gt;
 
   gt = function(target, args) {
+    // Browser-side needs this redundancy with gt.gettext()
     return gt.ngettext(target, null, null, args);
   };
 
   gt._formatRE = /%\{([^}]+)\}/g;
   gt._pluralRE = /nplurals=(\d+);\s+plural=([^;]+);/;
-  gt._lang = null;
-  gt._nplurals = 2;  // Not currently used
-  gt._plural = function(n) {
-    return +(n != 1);  // eslint-disable-line eqeqeq
-  };
 
   gt.ngettext = function(singular, plural, count, args) {
+    // Our target is singular or its translation (possibly an array)
     var res = (
       gt._lang !== null && singular in gt._lang
       ? (gt._lang[singular] || singular)
       : singular
     );
 
+    // Plural: choose right form from array or plural argument
     if (typeof res === "object") {
       res = res[gt._plural(count) + 1] || res[1] || singular;
+    } else if (typeof plural === "string" && gt._plural(count)) {
+      res = plural;
     }
 
+    // Pythonic substitutions
     if (args !== null && typeof args === "object") {
       res = res.replace(gt._formatRE, function(z, key) {
         return (key in args ? args[key] : "");
@@ -50,25 +52,36 @@
     return res;
   };
 
+  gt.gettext = function(target, args) {
+    return gt.ngettext(target, null, null, args);
+  };
+
   gt.load = function(newLang) {
     var src = [];
 
-    gt._lang = newLang;
-    if ("" in newLang && "plural-forms" in newLang[""]) {
-      src = newLang[""]["plural-forms"].match(gt._pluralRE);
+    gt._lang = (typeof newLang === "object" ? newLang : {});
+
+    if ("" in gt._lang && "plural-forms" in gt._lang[""]) {
+      src = gt._lang[""]["plural-forms"].match(gt._pluralRE);
       gt._nplurals = src[1];
-      gt._plural = new Function("n", "return +(" + src[2] + ")");
+      gt._plural = new Function(
+        "n",
+        "n = Math.abs(n); return +(" + src[2] + ")"
+      );
+    } else {
+      gt._nplurals = 2;  // Not currently used
+      gt._plural = function(n) {
+        return +(Math.abs(n) != 1);  // eslint-disable-line eqeqeq
+      };
     }
   };
+  gt.load();  // Initialize implicitly
 
-  if (
-      typeof module === "object"
-      && module
-      && typeof module.exports === "object"
-  ) {
-    module.exports = gt;
+  if (typeof context.exports === "object") {
+    context.exports = gt;
   } else {
-    window.gettext = (window.__ = gt);
-    window.ngettext = (window.n_ = gt.ngettext);
+    // Browser-side, gettext is global so it needs to be gt, not gt.gettext
+    context.gettext = (context.__ = gt);
+    context.ngettext = (context.n_ = gt.ngettext);
   }
-})(this);
+})(module || this);

gettext-pythonic.min.js

@@ -1,6 +1,6 @@
 {
   "name": "gettext-pythonic",
-  "version": "0.5.2",
+  "version": "1.0.0",
   "description": "Tiny po2json-compatible gettext with variable substitution",
   "main": "gettext-pythonic.js",
   "scripts": {
@@ -18,9 +18,9 @@
   "homepage": "https://github.com/vphantom/gettext-pythonic#readme",
   "devDependencies": {
     "coveralls": "^2.11.9",
-    "eslint": "^2.6.0",
+    "eslint": "^2.7.0",
     "faucet": "0.0.1",
-    "istanbul": "^0.4.2",
+    "istanbul": "^0.4.3",
     "tape": "^4.5.1",
     "uglifyjs": "^2.4.10"
   }

gettext-pythonic.min.js.map

@@ -1,6 +1,8 @@
 var test = require("tape");
 
-var __ = require("./gettext-pythonic.js");
+var gettext = require("./gettext-pythonic.js");
+var __ = gettext.gettext;
+var n_ = gettext.ngettext;
 
 test("Missing key returns itself", function(t) {
   t.equal(__("foobar"), "foobar");
@@ -95,10 +97,22 @@ test("Named pythonic variable substitution", function(t) {
     "graceful with unknown name"
   );
 
+  t.equal(
+    __("...%{foo...", args),
+    "...%{foo...",
+    "graceful with missing closing brace"
+  );
+
+  t.equal(
+    __("...%{weird key+name_also-very.long[indeed]=etc}...", args),
+    "......",
+    "graceful with special characters in valid brace"
+  );
+
   t.equal(
     __("Hi, %{one} this is %{three} or %{two}...", args),
     "Hi, first this is third or second...",
-    ""
+    "performs substitution"
   );
 
   t.end();
@@ -114,16 +128,30 @@ test("Load a language", function(t) {
     "This is convenient"   : "Ceci est pratique"
   };
 
-  __.load(lang);
+  gettext.load("invalid language data");
 
-  t.deepEqual(__._lang, lang, "loaded to _lang property");
+  t.equal(
+    __("foobar", {a: 1}),
+    "foobar",
+    "unaffected by loading a string instead of a PO object"
+  );
+
+  gettext.load(lang);
+
+  t.deepEqual(gettext._lang, lang, "loaded to _lang property");
 
   t.equal(
     __("This is a test"),
     "Ceci est un test",
     "look up key in language"
   );
 
+  t.equal(
+    gettext("This is a test"),
+    "Ceci est un test",
+    "look up key in language using root object function shortcut"
+  );
+
   t.equal(
     __("Non-existent string"),
     "Non-existent string",
@@ -175,26 +203,109 @@ test("Plural forms", function(t) {
     ]
   };
 
-  __.load(fr);
+  t.equal(
+    n_("%{count} result", "%{count} results", 0, {count: 0}),
+    "0 results",
+    "Default with 0"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", 1, {count: 1}),
+    "1 result",
+    "Default with 1"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", 23, {count: 23}),
+    "23 results",
+    "Default with 23"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", -1, {count: -1}),
+    "-1 result",
+    "Default with -1"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", -23, {count: -23}),
+    "-23 results",
+    "Default with -23"
+  );
+
+  gettext.load(fr);
 
   t.equal(
-    __.ngettext("%{count} result", "%{count} results", 0, {count: 0}),
+    n_("%{count} result", "%{count} results", 0, {count: 0}),
     "0 résultat",
     "French with 0"
   );
 
   t.equal(
-    __.ngettext("%{count} result", "%{count} results", 1, {count: 1}),
+    n_("%{count} result", "%{count} results", 1, {count: 1}),
     "1 résultat",
     "French with 1"
   );
 
   t.equal(
-    __.ngettext("%{count} result", "%{count} results", 23, {count: 23}),
+    n_("%{count} result", "%{count} results", 23, {count: 23}),
     "23 résultats",
     "French with 23"
   );
 
+  t.equal(
+    n_("%{count} result", "%{count} results", -1, {count: -1}),
+    "-1 résultat",
+    "French with -1"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", -23, {count: -23}),
+    "-23 résultats",
+    "French with -23"
+  );
+
+  gettext.load(23);
+
+  t.equal(
+    n_("%{count} result", "%{count} results", 0, {count: 0}),
+    "0 results",
+    "Default with 0 after French then invalid language"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", 1, {count: 1}),
+    "1 result",
+    "Default with 1 after French then invalid language"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", 23, {count: 23}),
+    "23 results",
+    "Default with 23 after French then invalid language"
+  );
+
+  gettext.load(fr);
+  gettext.load({});
+
+  t.equal(
+    n_("%{count} result", "%{count} results", 0, {count: 0}),
+    "0 results",
+    "Default with 0 after French then empty object"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", 1, {count: 1}),
+    "1 result",
+    "Default with 1 after French then empty object"
+  );
+
+  t.equal(
+    n_("%{count} result", "%{count} results", 23, {count: 23}),
+    "23 results",
+    "Default with 23 after French then empty object"
+  );
+
   t.end();
 });