Release v1.1.2

lazy require fs

.travis.yml

@@ -1,6 +1,5 @@
 language: node_js
 node_js:
-  - "0.10"
+  - "node"
-  - "0.11"
 before_install:
   - npm install -g grunt-cli

Gruntfile.coffee

@@ -53,7 +53,7 @@ module.exports = (grunt) ->
 
         bump:
             options:
-                files: ['package.json', 'bower.json']
+                files: ['package.json', 'package-lock.json', 'bower.json']
                 commitFiles: ['-a']
                 pushTo: 'origin'
 

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "pofile",
-  "version": "1.0.4",
+  "version": "1.1.2",
   "authors": [
     "Ruben Vermeersch <ruben@rocketeer.be>"
   ],

dist/pofile.js

@@ -1,8 +1,6 @@
-require=(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
+require=(function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
 
 },{}],"pofile":[function(require,module,exports){
-var fs = require('fs');
-
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
 }
@@ -11,11 +9,12 @@ var PO = function () {
     this.comments = [];
     this.extractedComments = [];
     this.headers = {};
+    this.headerOrder = [];
     this.items = [];
 };
 
 PO.prototype.save = function (filename, callback) {
-    fs.writeFile(filename, this.toString(), callback);
+    require('fs').writeFile(filename, this.toString(), callback);
 };
 
 PO.prototype.toString = function () {
@@ -23,21 +22,36 @@ PO.prototype.toString = function () {
 
     if (this.comments) {
         this.comments.forEach(function (comment) {
-            lines.push('# ' + comment);
+            lines.push(('# ' + comment).trim());
         });
     }
     if (this.extractedComments) {
         this.extractedComments.forEach(function (comment) {
-            lines.push('#. ' + comment);
+            lines.push(('#. ' + comment).trim());
         });
     }
 
     lines.push('msgid ""');
     lines.push('msgstr ""');
 
-    var keys = Object.keys(this.headers);
     var self = this;
+    var headerOrder = [];
+
+    this.headerOrder.forEach(function (key) {
+        if (key in self.headers) {
+            headerOrder.push(key);
+        }
+    });
+
+    var keys = Object.keys(this.headers);
+
     keys.forEach(function (key) {
+        if (headerOrder.indexOf(key) === -1) {
+            headerOrder.push(key);
+        }
+    });
+
+    headerOrder.forEach(function (key) {
         lines.push('"' + key + ': ' + self.headers[key] + '\\n"');
     });
 
@@ -52,7 +66,7 @@ PO.prototype.toString = function () {
 };
 
 PO.load = function (filename, callback) {
-    fs.readFile(filename, 'utf-8', function (err, data) {
+    require('fs').readFile(filename, 'utf-8', function (err, data) {
         if (err) {
             return callback(err);
         }
@@ -69,7 +83,7 @@ PO.parse = function (data) {
     var headers = [];
     //everything until the first 'msgid ""' is considered header
     while (sections[0] && (headers.length === 0 || headers[headers.length - 1].indexOf('msgid ""') < 0)) {
-        if (sections[0].match(/msgid "[^"]/)) {
+        if (sections[0].match(/msgid\s+"[^"]/)) {
             //found first real string, adding a dummy header item
             headers.push('msgid ""');
         } else {
@@ -91,6 +105,7 @@ PO.parse = function (data) {
         'Content-Transfer-Encoding': '',
         'Plural-Forms': '',
     };
+    po.headerOrder = [];
 
     headers.split(/\n/).reduce(function (acc, line) {
         if (acc.merge) {
@@ -114,10 +129,13 @@ PO.parse = function (data) {
             var name = p.shift().trim();
             var value = p.join(':').trim();
             po.headers[name] = value;
+            po.headerOrder.push(name);
         }
     });
 
-    var item = new PO.Item();
+    var parsedPluralForms = PO.parsePluralForms(po.headers['Plural-Forms']);
+    var nplurals = parsedPluralForms.nplurals;
+    var item = new PO.Item({ nplurals: nplurals });
     var context = null;
     var plural = 0;
     var obsoleteCount = 0;
@@ -131,7 +149,7 @@ PO.parse = function (data) {
             obsoleteCount = 0;
             noCommentLineCount = 0;
             po.items.push(item);
-            item = new PO.Item();
+            item = new PO.Item({ nplurals: nplurals });
         }
     }
 
@@ -213,6 +231,7 @@ PO.parse = function (data) {
         } else if (line.match(/^msgctxt/)) { // Context
             finish();
             item.msgctxt = extract(line);
+            context = 'msgctxt';
             noCommentLineCount++;
         } else { // Probably multiline string or blank
             if (line.length > 0) {
@@ -223,6 +242,8 @@ PO.parse = function (data) {
                     item.msgid += extract(line);
                 } else if (context === 'msgid_plural') {
                     item.msgid_plural += extract(line);
+                } else if (context === 'msgctxt') {
+                    item.msgctxt += extract(line);
                 }
             }
         }
@@ -237,7 +258,26 @@ PO.parse = function (data) {
     return po;
 };
 
-PO.Item = function () {
+PO.parsePluralForms = function (pluralFormsString) {
+    var results = (pluralFormsString || '')
+        .split(';')
+        .reduce(function (acc, keyValueString) {
+            var trimmedString = keyValueString.trim();
+            var equalsIndex = trimmedString.indexOf('=');
+            var key = trimmedString.substring(0, equalsIndex).trim();
+            var value = trimmedString.substring(equalsIndex + 1).trim();
+            acc[key] = value;
+            return acc;
+        }, {});
+    return {
+        nplurals: results.nplurals,
+        plural: results.plural
+    };
+};
+
+PO.Item = function (options) {
+    var nplurals = options && options.nplurals;
+
     this.msgid = '';
     this.msgctxt = null;
     this.references = [];
@@ -247,6 +287,8 @@ PO.Item = function () {
     this.extractedComments = [];
     this.flags = {};
     this.obsolete = false;
+    var npluralsNumber = Number(nplurals);
+    this.nplurals = (isNaN(npluralsNumber)) ? 2 : npluralsNumber;
 };
 
 PO.Item.prototype.toString = function () {
@@ -293,6 +335,15 @@ PO.Item.prototype.toString = function () {
         return lines;
     };
 
+    //handle \n in single-line texts (can not be handled in _escape)
+    var _processLineBreak = function (keyword, text, index) {
+        var processed = _process(keyword, text, index);
+        for (var i = 1; i < processed.length - 1; i++) {
+            processed[i] = processed[i].slice(0, -1) + '\\n"';
+        }
+        return processed;
+    };
+
     // https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html
     // says order is translator-comments, extracted-comments, references, flags
 
@@ -319,20 +370,28 @@ PO.Item.prototype.toString = function () {
     ['msgctxt', 'msgid', 'msgid_plural', 'msgstr'].forEach(function (keyword) {
         var text = self[keyword];
         if (text != null) {
+            var hasTranslation = false;
+            if (Array.isArray(text)) {
+                hasTranslation = text.some(function (text) {
+                    return text;
+                });
+            }
+
             if (Array.isArray(text) && text.length > 1) {
                 text.forEach(function (t, i) {
-                    lines = lines.concat(mkObsolete + _process(keyword, t, i));
+                    var processed = _processLineBreak(keyword, t, i);
+                    lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
                 });
+            } else if (self.msgid_plural && keyword === 'msgstr' && !hasTranslation) {
+                for (var pluralIndex = 0; pluralIndex < self.nplurals; pluralIndex++) {
+                    lines = lines.concat(mkObsolete + _process(keyword, '', pluralIndex));
+                }
             } else {
                 var index = (self.msgid_plural && Array.isArray(text)) ?
                     0 :
                     undefined;
                 text = Array.isArray(text) ? text.join() : text;
-                var processed = _process(keyword, text, index);
+                var processed = _processLineBreak(keyword, text, index);
-                //handle \n in single-line texts (can not be handled in _escape)
-                for (var i = 1; i < processed.length - 1; i++) {
-                    processed[i] = processed[i].slice(0, -1) + '\\n"';
-                }
                 lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
             }
         }

lib/po.js

@@ -1,5 +1,3 @@
-var fs = require('fs');
-
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
 }
@@ -8,11 +6,12 @@ var PO = function () {
     this.comments = [];
     this.extractedComments = [];
     this.headers = {};
+    this.headerOrder = [];
     this.items = [];
 };
 
 PO.prototype.save = function (filename, callback) {
-    fs.writeFile(filename, this.toString(), callback);
+    require('fs').writeFile(filename, this.toString(), callback);
 };
 
 PO.prototype.toString = function () {
@@ -20,21 +19,36 @@ PO.prototype.toString = function () {
 
     if (this.comments) {
         this.comments.forEach(function (comment) {
-            lines.push('# ' + comment);
+            lines.push(('# ' + comment).trim());
         });
     }
     if (this.extractedComments) {
         this.extractedComments.forEach(function (comment) {
-            lines.push('#. ' + comment);
+            lines.push(('#. ' + comment).trim());
         });
     }
 
     lines.push('msgid ""');
     lines.push('msgstr ""');
 
-    var keys = Object.keys(this.headers);
     var self = this;
+    var headerOrder = [];
+
+    this.headerOrder.forEach(function (key) {
+        if (key in self.headers) {
+            headerOrder.push(key);
+        }
+    });
+
+    var keys = Object.keys(this.headers);
+
     keys.forEach(function (key) {
+        if (headerOrder.indexOf(key) === -1) {
+            headerOrder.push(key);
+        }
+    });
+
+    headerOrder.forEach(function (key) {
         lines.push('"' + key + ': ' + self.headers[key] + '\\n"');
     });
 
@@ -49,7 +63,7 @@ PO.prototype.toString = function () {
 };
 
 PO.load = function (filename, callback) {
-    fs.readFile(filename, 'utf-8', function (err, data) {
+    require('fs').readFile(filename, 'utf-8', function (err, data) {
         if (err) {
             return callback(err);
         }
@@ -66,7 +80,7 @@ PO.parse = function (data) {
     var headers = [];
     //everything until the first 'msgid ""' is considered header
     while (sections[0] && (headers.length === 0 || headers[headers.length - 1].indexOf('msgid ""') < 0)) {
-        if (sections[0].match(/msgid "[^"]/)) {
+        if (sections[0].match(/msgid\s+"[^"]/)) {
             //found first real string, adding a dummy header item
             headers.push('msgid ""');
         } else {
@@ -88,6 +102,7 @@ PO.parse = function (data) {
         'Content-Transfer-Encoding': '',
         'Plural-Forms': '',
     };
+    po.headerOrder = [];
 
     headers.split(/\n/).reduce(function (acc, line) {
         if (acc.merge) {
@@ -111,10 +126,13 @@ PO.parse = function (data) {
             var name = p.shift().trim();
             var value = p.join(':').trim();
             po.headers[name] = value;
+            po.headerOrder.push(name);
         }
     });
 
-    var item = new PO.Item();
+    var parsedPluralForms = PO.parsePluralForms(po.headers['Plural-Forms']);
+    var nplurals = parsedPluralForms.nplurals;
+    var item = new PO.Item({ nplurals: nplurals });
     var context = null;
     var plural = 0;
     var obsoleteCount = 0;
@@ -128,7 +146,7 @@ PO.parse = function (data) {
             obsoleteCount = 0;
             noCommentLineCount = 0;
             po.items.push(item);
-            item = new PO.Item();
+            item = new PO.Item({ nplurals: nplurals });
         }
     }
 
@@ -210,6 +228,7 @@ PO.parse = function (data) {
         } else if (line.match(/^msgctxt/)) { // Context
             finish();
             item.msgctxt = extract(line);
+            context = 'msgctxt';
             noCommentLineCount++;
         } else { // Probably multiline string or blank
             if (line.length > 0) {
@@ -220,6 +239,8 @@ PO.parse = function (data) {
                     item.msgid += extract(line);
                 } else if (context === 'msgid_plural') {
                     item.msgid_plural += extract(line);
+                } else if (context === 'msgctxt') {
+                    item.msgctxt += extract(line);
                 }
             }
         }
@@ -234,7 +255,26 @@ PO.parse = function (data) {
     return po;
 };
 
-PO.Item = function () {
+PO.parsePluralForms = function (pluralFormsString) {
+    var results = (pluralFormsString || '')
+        .split(';')
+        .reduce(function (acc, keyValueString) {
+            var trimmedString = keyValueString.trim();
+            var equalsIndex = trimmedString.indexOf('=');
+            var key = trimmedString.substring(0, equalsIndex).trim();
+            var value = trimmedString.substring(equalsIndex + 1).trim();
+            acc[key] = value;
+            return acc;
+        }, {});
+    return {
+        nplurals: results.nplurals,
+        plural: results.plural
+    };
+};
+
+PO.Item = function (options) {
+    var nplurals = options && options.nplurals;
+
     this.msgid = '';
     this.msgctxt = null;
     this.references = [];
@@ -244,6 +284,8 @@ PO.Item = function () {
     this.extractedComments = [];
     this.flags = {};
     this.obsolete = false;
+    var npluralsNumber = Number(nplurals);
+    this.nplurals = (isNaN(npluralsNumber)) ? 2 : npluralsNumber;
 };
 
 PO.Item.prototype.toString = function () {
@@ -290,6 +332,15 @@ PO.Item.prototype.toString = function () {
         return lines;
     };
 
+    //handle \n in single-line texts (can not be handled in _escape)
+    var _processLineBreak = function (keyword, text, index) {
+        var processed = _process(keyword, text, index);
+        for (var i = 1; i < processed.length - 1; i++) {
+            processed[i] = processed[i].slice(0, -1) + '\\n"';
+        }
+        return processed;
+    };
+
     // https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html
     // says order is translator-comments, extracted-comments, references, flags
 
@@ -316,20 +367,28 @@ PO.Item.prototype.toString = function () {
     ['msgctxt', 'msgid', 'msgid_plural', 'msgstr'].forEach(function (keyword) {
         var text = self[keyword];
         if (text != null) {
+            var hasTranslation = false;
+            if (Array.isArray(text)) {
+                hasTranslation = text.some(function (text) {
+                    return text;
+                });
+            }
+
             if (Array.isArray(text) && text.length > 1) {
                 text.forEach(function (t, i) {
-                    lines = lines.concat(mkObsolete + _process(keyword, t, i));
+                    var processed = _processLineBreak(keyword, t, i);
+                    lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
                 });
+            } else if (self.msgid_plural && keyword === 'msgstr' && !hasTranslation) {
+                for (var pluralIndex = 0; pluralIndex < self.nplurals; pluralIndex++) {
+                    lines = lines.concat(mkObsolete + _process(keyword, '', pluralIndex));
+                }
             } else {
                 var index = (self.msgid_plural && Array.isArray(text)) ?
                     0 :
                     undefined;
                 text = Array.isArray(text) ? text.join() : text;
-                var processed = _process(keyword, text, index);
+                var processed = _processLineBreak(keyword, text, index);
-                //handle \n in single-line texts (can not be handled in _escape)
-                for (var i = 1; i < processed.length - 1; i++) {
-                    processed[i] = processed[i].slice(0, -1) + '\\n"';
-                }
                 lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
             }
         }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pofile",
   "description": "Parse and serialize Gettext PO files.",
-  "version": "1.0.4",
+  "version": "1.1.2",
   "author": {
     "name": "Ruben Vermeersch",
     "email": "ruben@savanne.be",
@@ -20,6 +20,7 @@
     "url": "http://github.com/rubenv/pofile.git"
   },
   "main": "./lib/po",
+  "types": "./pofile.d.ts",
   "keywords": [
     "i18n",
     "l10n",

pofile.d.ts

@@ -0,0 +1,45 @@
+declare interface IHeaders {
+    'Project-Id-Version': string;
+    'Report-Msgid-Bugs-To': string;
+    'POT-Creation-Date': string;
+    'PO-Revision-Date': string;
+    'Last-Translator': string;
+    'Language': string;
+    'Language-Team': string;
+    'Content-Type': string;
+    'Content-Transfer-Encoding': string;
+    'Plural-Forms': string;
+    [name: string]: string;
+}
+
+declare class Item {
+    public msgid: string;
+    public msgctxt?: string;
+    public references: string[];
+    public msgid_plural?: string;
+    public msgstr: string[];
+    public comments: string[];
+    public extractedComments: string[];
+    public flags: Record<string, boolean | undefined>;
+    private nplurals: number;
+    private obsolete: boolean;
+
+    public toString(): string;
+}
+
+declare class PO {
+    public comments: string[];
+    public extractedComments: string[];
+    public items: Item[];
+    public headers: Partial<IHeaders>
+
+    public static parse(data: string): PO;
+    public static parsePluralForms(forms: string): PO;
+    public static load(fileName: string, callback: (err: NodeJS.ErrnoException, po: PO) => void): void;
+    public static Item: typeof Item;
+
+    public save(fileName: string, callback: (err: NodeJS.ErrnoException) => void): void;
+    public toString(): string;
+}
+
+export = PO

test/fixtures/big.po

@@ -296,3 +296,9 @@ msgstr "This folder is empty."
 msgctxt "folder action"
 msgid "Empty folder"
 msgstr "Make this folder empty."
+
+msgctxt ""
+"folder "
+"meta"
+msgid "Created Date"
+msgstr "Date de création"

test/fixtures/c-strings.po

@@ -57,3 +57,17 @@ msgid ""
 msgstr ""
 "\a\b\t\n"
 "\v\f\r"
+
+# plural text must suport \n
+msgid ""
+"Test.\n"
+" multiline."
+msgid_plural ""
+"Test\n"
+" multiline plural."
+msgstr[0] ""
+"Test.\n"
+" mehrzeilig."
+msgstr[1] ""
+"Test.\n"
+" mehrzeilig Plural."

test/fixtures/no_header_extra_spaces.po

@@ -0,0 +1,8 @@
+# some comment
+
+msgid   "First id, no header"
+msgstr  ""
+
+msgid   "A second string"
+msgstr  ""
+

test/fixtures/plurals/messages.po

@@ -0,0 +1,30 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-02-13 09:59-0500\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=CHARSET\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+
+# correct plurals
+msgid "1 thing"
+msgid_plural "{{$count}} things"
+msgstr[0] ""
+msgstr[1] ""
+
+# incorrect plurals
+msgid "1 mistake"
+msgid_plural "{{$count}} mistakes"
+msgstr ""

test/fixtures/plurals/nplurals-1.po

@@ -0,0 +1,37 @@
+# Chinese translation of Link (6.x-2.9)
+# Copyright (c) 2011 by the Chinese translation team
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Link (6.x-2.9)\n"
+"POT-Creation-Date: 2011-12-31 23:39+0000\n"
+"PO-Revision-Date: 2013-12-17 14:59+0100\n"
+"Language-Team: Chinese\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\n"
+"Language: zh_CN\n"
+"X-Generator: Poedit 1.6.2\n"
+
+# correct plurals, with translation
+msgid "1 thing"
+msgid_plural "{{$count}} things"
+msgstr[0] "{{$count}} thing"
+
+# correct plurals, with no translation
+msgid "1 other thing"
+msgid_plural "{{$count}} other things"
+msgstr[0] ""
+
+# incorrect plurals, with translation
+msgid "1 mistake"
+msgid_plural "{{$count}} mistakes"
+msgstr[0] "1 mistake"
+msgstr[1] "{{$count}} mistakes"
+
+# incorrect plurals, with no translation
+msgid "1 other mistake"
+msgid_plural "{{$count}} other mistakes"
+msgstr ""

test/fixtures/plurals/nplurals-2.po

@@ -16,17 +16,23 @@ msgstr ""
 "X-Generator: Poedit 1.6.2\n"
 
 # correct plurals, with translation
-msgid "1 source"
+msgid "1 thing"
-msgid_plural "{{$count}} sources"
+msgid_plural "{{$count}} things"
-msgstr[0] "1 source"
+msgstr[0] "1 thing"
-msgstr[1] "{{$count}} sources"
+msgstr[1] "{{$count}} things"
 
 # correct plurals, with no translation
-msgid "1 destination"
+msgid "1 other thing"
-msgid_plural "{{$count}} destinations"
+msgid_plural "{{$count}} other things"
 msgstr[0] ""
+msgstr[1] ""
 
-# incorrect plurals, with no translation
+# incorrect plurals, with translation
 msgid "1 mistake"
 msgid_plural "{{$count}} mistakes"
+msgstr[0] "1 mistake"
+
+# incorrect plurals, with no translation
+msgid "1 other mistake"
+msgid_plural "{{$count}} other mistakes"
 msgstr ""

test/fixtures/plurals/nplurals-3.po

@@ -0,0 +1,41 @@
+# Polish translation of Link (6.x-2.9)
+# Copyright (c) 2011 by the Polish translation team
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Link (6.x-2.9)\n"
+"POT-Creation-Date: 2011-12-31 23:39+0000\n"
+"PO-Revision-Date: 2013-12-17 14:59+0100\n"
+"Language-Team: Polish\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=3; plural=(n==1 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);\n"
+"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\n"
+"Language: pl_PL\n"
+"X-Generator: Poedit 1.6.2\n"
+
+# correct plurals, with translation
+msgid "1 thing"
+msgid_plural "{{$count}} things"
+msgstr[0] "1 thing"
+msgstr[1] "{{$count}} things"
+msgstr[2] "{{$count}} things"
+
+# correct plurals, with no translation
+msgid "1 other thing"
+msgid_plural "{{$count}} other things"
+msgstr[0] ""
+msgstr[1] ""
+msgstr[2] ""
+
+# incorrect plurals, with translation
+msgid "1 mistake"
+msgid_plural "{{$count}} mistakes"
+msgstr[0] "1 mistake"
+msgstr[1] "{{$count}} mistakes"
+
+# incorrect plurals, with no translation
+msgid "1 other mistake"
+msgid_plural "{{$count}} other mistakes"
+msgstr ""

test/fixtures/plurals/nplurals-6.po

@@ -0,0 +1,49 @@
+# Arabic translation of Link (6.x-2.9)
+# Copyright (c) 2011 by the Arabic translation team
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Link (6.x-2.9)\n"
+"POT-Creation-Date: 2011-12-31 23:39+0000\n"
+"PO-Revision-Date: 2013-12-17 14:59+0100\n"
+"Language-Team: Arabic\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=6; plural=(n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 "
+"&& n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5);\n"
+"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\n"
+"Language: ar\n"
+"X-Generator: Poedit 1.6.2\n"
+
+# correct plurals, with translation
+msgid "1 thing"
+msgid_plural "{{$count}} things"
+msgstr[0] "1 thing"
+msgstr[1] "{{$count}} things"
+msgstr[2] "{{$count}} things"
+msgstr[3] "{{$count}} things"
+msgstr[4] "{{$count}} things"
+msgstr[5] "{{$count}} things"
+
+# correct plurals, with no translation
+msgid "1 other thing"
+msgid_plural "{{$count}} other things"
+msgstr[0] ""
+msgstr[1] ""
+msgstr[2] ""
+msgstr[3] ""
+msgstr[4] ""
+msgstr[5] ""
+
+# incorrect plurals, with translation
+msgid "1 mistake"
+msgid_plural "{{$count}} mistakes"
+msgstr[0] "1 mistake"
+msgstr[1] "{{$count}} mistakes"
+msgstr[2] "{{$count}} mistakes"
+
+# incorrect plurals, with no translation
+msgid "1 other mistake"
+msgid_plural "{{$count}} other mistakes"
+msgstr ""

test/fixtures/plurals/nplurals-missing.po

@@ -0,0 +1,37 @@
+# Chinese translation of Link (6.x-2.9)
+# Copyright (c) 2011 by the Chinese translation team
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Link (6.x-2.9)\n"
+"POT-Creation-Date: 2011-12-31 23:39+0000\n"
+"PO-Revision-Date: 2013-12-17 14:59+0100\n"
+"Language-Team: Chinese\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\n"
+"Language: zh_CN\n"
+"X-Generator: Poedit 1.6.2\n"
+
+# correct plurals, with translation
+msgid "1 thing"
+msgid_plural "{{$count}} things"
+msgstr[0] "1 thing"
+msgstr[1] "{{$count}} things"
+
+# correct plurals, with no translation
+msgid "1 other thing"
+msgid_plural "{{$count}} other things"
+msgstr[0] ""
+msgstr[1] ""
+
+# incorrect plurals, with translation
+msgid "1 mistake"
+msgid_plural "{{$count}} mistakes"
+msgstr[0] "1 mistake"
+
+# incorrect plurals, with no translation
+msgid "1 other mistake"
+msgid_plural "{{$count}} other mistakes"
+msgstr ""

test/headers.js

@@ -70,4 +70,24 @@ describe('PO files with no headers', function () {
             assert.equal(po.items.length, 2);
         });
     });
+
+    describe('advanced example with extra spaces', function () {
+        var po;
+
+        before(function (done) {
+            PO.load(__dirname + '/fixtures/no_header_extra_spaces.po', function (err, result) {
+                assert.equal(err, null);
+                po = result;
+                done();
+            });
+        });
+
+        it('Parses the po file', function () {
+            assert.notEqual(po, null);
+        });
+
+        it('Finds all items', function () {
+            assert.equal(po.items.length, 2);
+        });
+    });
 });

test/parse-plural-forms.js

@@ -0,0 +1,52 @@
+var assert = require('assert');
+var fs = require('fs');
+var PO = require('..');
+
+describe('.parsePluralForms()', function () {
+    it('should return an object with empty nplurals and plural expression when there is no plural forms header', function () {
+        var expected = {
+            nplurals: undefined,
+            plural: undefined
+        };
+        assert.deepEqual(PO.parsePluralForms(), expected);
+        assert.deepEqual(PO.parsePluralForms(null), expected);
+        assert.deepEqual(PO.parsePluralForms(''), expected);
+    });
+
+    it('should return an object with nplurals and plural set to xgettext\'s default output', function () {
+        var pluralForms = 'nplurals=INTEGER; plural=EXPRESSION;';
+
+        var expected = {
+            nplurals: 'INTEGER',
+            plural: 'EXPRESSION'
+        };
+        var actual = PO.parsePluralForms(pluralForms);
+        assert.deepEqual(actual, expected);
+    });
+
+    it('should return an object with nplurals and plural set to typical string', function () {
+        var pluralForms = 'nplurals=3; plural=(n==1 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);';
+
+        var expected = {
+            nplurals: '3',
+            plural: '(n==1 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)'
+        };
+        var actual = PO.parsePluralForms(pluralForms);
+        assert.deepEqual(actual, expected);
+    });
+
+    // node-gettext stores plural forms strings with spaces. They don't appear
+    // to write PO files at all, but it seems prudent to handle this case
+    // anyway. See
+    // https://github.com/alexanderwallin/node-gettext/blob/v1.1.0/lib/plurals.js#L14
+    it('should handle spaces around assignments in plural forms string', function () {
+        var pluralForms = 'nplurals = 3; plural = (n==1 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);';
+
+        var expected = {
+            nplurals: '3',
+            plural: '(n==1 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)'
+        };
+        var actual = PO.parsePluralForms(pluralForms);
+        assert.deepEqual(actual, expected);
+    });
+});

test/parse.js

@@ -6,7 +6,7 @@ describe('Parse', function () {
     it('Parses the big po file', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8'));
         assert.notEqual(po, null);
-        assert.equal(po.items.length, 69);
+        assert.equal(po.items.length, 70);
 
         var item = po.items[0];
         assert.equal(item.msgid, 'Title');
@@ -121,6 +121,17 @@ describe('Parse', function () {
         assert.equal(ambiguousItems[1].msgctxt, 'folder action');
     });
 
+    it('Parses item multiline context', function () {
+        var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8'));
+
+        var item = po.items.find(function (item) {
+            return item.msgid === 'Created Date' && item.msgctxt === 'folder meta';
+        });
+
+        assert.notEqual(item, undefined);
+        assert.equal(item.msgctxt, 'folder meta');
+    });
+
     it('Handles obsolete items', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/commented.po', 'utf8'));
 

test/write.js

@@ -2,12 +2,13 @@ var assert = require('assert');
 var fs = require('fs');
 var PO = require('..');
 
-function assertHasLine(str, line) {
+function assertHasLine(str, line, doNotTrim) {
     var lines = str.split('\n');
     var found = false;
 
     for (var i = 0; i < lines.length; i++) {
-        if (lines[i].trim() === line) {
+        var lineToCompare = doNotTrim ? lines[i] : lines[i].trim();
+        if (lineToCompare === line) {
             found = true;
             break;
         }
@@ -53,6 +54,13 @@ describe('Write', function () {
         assertHasLine(str, '#, fuzzy');
     });
 
+    it('write empty comment without an unecessary space', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
+        var po = PO.parse(input);
+        var str = po.toString();
+        assertHasLine(str, '#', true);
+    });
+
     it('write flags only when true', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
         var po = PO.parse(input);
@@ -119,34 +127,323 @@ describe('Write', function () {
     });
 
     describe('plurals', function () {
-        it('should write multiple msgstrs', function () {
+        describe('nplurals INTEGER', function () {
-            var input = fs.readFileSync(__dirname + '/fixtures/plural.po', 'utf8');
+            it('should write 2 msgstrs when formatted correctly', function () {
-            var po = PO.parse(input);
+                var input = fs.readFileSync(
-            var str = po.toString();
+                    __dirname + '/fixtures/plurals/messages.po', 'utf8'
-            assertHasContiguousLines(str, [
+                );
-                'msgstr[0] "1 source"',
+                var po = PO.parse(input);
-                'msgstr[1] "{{$count}} sources"'
+                var str = po.toString();
-            ]);
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} things"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""'
+                ]);
+            });
+
+            it('should write 2 msgstrs when formatted incorrectly', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/messages.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} mistakes"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""'
+                ]);
+            });
         });
 
-        it('should write msgstr[0] when there is no translation', function () {
+        describe('nplurals missing', function () {
-            var input = fs.readFileSync(__dirname + '/fixtures/plural.po', 'utf8');
+            it('should write 2 msgstrs when formatted correctly with translation', function () {
-            var po = PO.parse(input);
+                var input = fs.readFileSync(
-            var str = po.toString();
+                    __dirname + '/fixtures/plurals/nplurals-missing.po', 'utf8'
-            assertHasContiguousLines(str, [
+                );
-                'msgid_plural "{{$count}} destinations"',
+                var po = PO.parse(input);
-                'msgstr[0] ""'
+                var str = po.toString();
-            ]);
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} things"',
+                    'msgstr[0] "1 thing"',
+                    'msgstr[1] "{{$count}} things"'
+                ]);
+            });
+
+            it('should write 2 msgstrs when formatted correctly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-missing.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other things"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""',
+                ]);
+            });
+
+            it('should keep same number of msgstrs when formatted incorrectly with translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-missing.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} mistakes"',
+                    'msgstr[0] "1 mistake"',
+                    '',
+                    '# incorrect plurals, with no translation'
+                ]);
+            });
+
+            it('should write 2 msgstrs when formatted incorrectly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-missing.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other mistakes"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""'
+                ]);
+            });
         });
 
-        it('should write msgstr[0] when there is no translation and empty plural translation is stored in msgstr ""', function () {
+        describe('nplurals=1', function () {
-            var input = fs.readFileSync(__dirname + '/fixtures/plural.po', 'utf8');
+            it('should write 1 msgstr when formatted correctly with translation', function () {
-            var po = PO.parse(input);
+                var input = fs.readFileSync(
-            var str = po.toString();
+                    __dirname + '/fixtures/plurals/nplurals-1.po', 'utf8'
-            assertHasContiguousLines(str, [
+                );
-                'msgid_plural "{{$count}} mistakes"',
+                var po = PO.parse(input);
-                'msgstr[0] ""'
+                var str = po.toString();
-            ]);
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} things"',
+                    'msgstr[0] "{{$count}} thing"'
+                ]);
+            });
+
+            it('should write 1 msgstr when formatted correctly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-1.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other things"',
+                    'msgstr[0] ""',
+                    '',
+                    '# incorrect plurals, with translation'
+                ]);
+            });
+
+            it('should keep same number of msgstrs when formatted incorrectly with translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-1.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} mistakes"',
+                    'msgstr[0] "1 mistake"',
+                    'msgstr[1] "{{$count}} mistakes"'
+                ]);
+            });
+
+            it('should write 1 msgstr when formatted incorrectly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-1.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other mistakes"',
+                    'msgstr[0] ""'
+                ]);
+            });
+        });
+
+        describe('nplurals=2', function () {
+            it('should write 2 msgstrs when formatted correctly with translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-2.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} things"',
+                    'msgstr[0] "1 thing"',
+                    'msgstr[1] "{{$count}} things"'
+                ]);
+            });
+
+            it('should write 2 msgstrs when formatted correctly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-2.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other things"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""',
+                ]);
+            });
+
+            it('should keep same number of msgstrs when formatted incorrectly with translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-2.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} mistakes"',
+                    'msgstr[0] "1 mistake"',
+                    '',
+                    '# incorrect plurals, with no translation'
+                ]);
+            });
+
+            it('should write 2 msgstrs when formatted incorrectly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-2.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other mistakes"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""'
+                ]);
+            });
+        });
+
+        describe('nplurals=3', function () {
+            it('should write 3 msgstrs when formatted correctly with translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-3.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} things"',
+                    'msgstr[0] "1 thing"',
+                    'msgstr[1] "{{$count}} things"',
+                    'msgstr[2] "{{$count}} things"'
+                ]);
+            });
+
+            it('should write 3 msgstrs when formatted correctly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-3.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other things"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""',
+                    'msgstr[2] ""'
+                ]);
+            });
+
+            it('should keep same number of msgstrs when formatted incorrectly with translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-3.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} mistakes"',
+                    'msgstr[0] "1 mistake"',
+                    'msgstr[1] "{{$count}} mistakes"',
+                    '',
+                    '# incorrect plurals, with no translation'
+                ]);
+            });
+
+            it('should write 3 msgstrs when formatted incorrectly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-3.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other mistakes"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""',
+                    'msgstr[2] ""'
+                ]);
+            });
+        });
+
+        describe('nplurals=6', function () {
+            it('should write 6 msgstrs when formatted correctly with translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-6.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} things"',
+                    'msgstr[0] "1 thing"',
+                    'msgstr[1] "{{$count}} things"',
+                    'msgstr[2] "{{$count}} things"',
+                    'msgstr[3] "{{$count}} things"',
+                    'msgstr[4] "{{$count}} things"',
+                    'msgstr[5] "{{$count}} things"'
+                ]);
+            });
+
+            it('should write 6 msgstrs when formatted correctly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-6.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other things"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""',
+                    'msgstr[2] ""',
+                    'msgstr[3] ""',
+                    'msgstr[4] ""',
+                    'msgstr[5] ""'
+                ]);
+            });
+
+            it('should keep same number of msgstrs when formatted incorrectly with translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-6.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} mistakes"',
+                    'msgstr[0] "1 mistake"',
+                    'msgstr[1] "{{$count}} mistakes"',
+                    'msgstr[2] "{{$count}} mistakes"',
+                    '',
+                    '# incorrect plurals, with no translation'
+                ]);
+            });
+
+            it('should write 6 msgstrs when formatted incorrectly with no translation', function () {
+                var input = fs.readFileSync(
+                    __dirname + '/fixtures/plurals/nplurals-6.po', 'utf8'
+                );
+                var po = PO.parse(input);
+                var str = po.toString();
+                assertHasContiguousLines(str, [
+                    'msgid_plural "{{$count}} other mistakes"',
+                    'msgstr[0] ""',
+                    'msgstr[1] ""',
+                    'msgstr[2] ""',
+                    'msgstr[3] ""',
+                    'msgstr[4] ""',
+                    'msgstr[5] ""'
+                ]);
+            });
         });
     });
 
@@ -207,4 +504,26 @@ describe('Write', function () {
             assert.ok(po.toString().indexOf('msgctxt') >= 0);
         });
     });
+
+    it('should keep the header order', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8');
+        var po = PO.parse(input);
+        var str = po.toString();
+
+        assertHasContiguousLines(str, [
+            'msgid ""',
+            'msgstr ""',
+            '"Project-Id-Version: Link (6.x-2.9)\\n"',
+            '"POT-Creation-Date: 2011-12-31 23:39+0000\\n"',
+            '"PO-Revision-Date: 2013-12-17 14:21+0100\\n"',
+            '"Language-Team: French\\n"',
+            '"MIME-Version: 1.0\\n"',
+            '"Content-Type: text/plain; charset=UTF-8\\n"',
+            '"Content-Transfer-Encoding: 8bit\\n"',
+            '"Plural-Forms: nplurals=2; plural=(n > 1);\\n"',
+            '"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\\n"',
+            '"Language: fr\\n"',
+            '"X-Generator: Poedit 1.6.2\\n"',
+        ]);
+    });
 });