Release v1.0.8

Avoid putting a space in empty comments

.travis.yml

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

Gruntfile.coffee

@@ -5,7 +5,7 @@ module.exports = (grunt) ->
     @loadNpmTasks('grunt-contrib-jshint')
     @loadNpmTasks('grunt-contrib-uglify')
     @loadNpmTasks('grunt-contrib-watch')
-    @loadNpmTasks('grunt-jscs-checker')
+    @loadNpmTasks('grunt-jscs')
     @loadNpmTasks('grunt-mocha-cli')
 
     @initConfig
@@ -43,7 +43,8 @@ module.exports = (grunt) ->
                 files:
                     'dist/pofile.js': ['lib/po.js']
                 options:
-                    alias: 'lib/po.js:pofile'
+                    alias:
+                        pofile: './lib/po.js'
 
         uglify:
             dist:

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2013-2014 Ruben Vermeersch
+Copyright (C) 2013-2017 Ruben Vermeersch
 Copyright (C) 2012 Michael Holly
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of

README.md

@@ -81,7 +81,7 @@ po.save('out.po', function (err) {
 
 ### The PO.Item class
 
-The `PO` class exposes the following members:
+The `PO.Item` class exposes the following members:
 
 * `msgid`: The message id.
 * `msgid_plural`: The plural message id (null if absent).
@@ -143,7 +143,7 @@ PO.load('text.po', function (err, po) {
 
     (The MIT License)
 
-    Copyright (C) 2013-2014 by Ruben Vermeersch <ruben@rocketeer.be>
+    Copyright (C) 2013-2017 by Ruben Vermeersch <ruben@rocketeer.be>
     Copyright (C) 2012 by Michael Holly
 
     Permission is hereby granted, free of charge, to any person obtaining a copy

bower.json

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

dist/pofile.js

@@ -1,6 +1,7 @@
-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);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.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})({"W8CkM0":[function(require,module,exports){
+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){
+
+},{}],"pofile":[function(require,module,exports){
 var fs = require('fs');
-var isArray = require('lodash.isarray');
 
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
@@ -8,6 +9,7 @@ function trim(string) {
 
 var PO = function () {
     this.comments = [];
+    this.extractedComments = [];
     this.headers = {};
     this.items = [];
 };
@@ -21,7 +23,12 @@ 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).trim());
         });
     }
 
@@ -59,7 +66,17 @@ PO.parse = function (data) {
     data = data.replace(/\r\n/g, '\n');
     var po = new PO();
     var sections = data.split(/\n\n/);
-    var headers = sections.shift();
+    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 "[^"]/)) {
+            //found first real string, adding a dummy header item
+            headers.push('msgid ""');
+        } else {
+            headers.push(sections.shift());
+        }
+    }
+    headers = headers.join('\n');
     var lines = sections.join('\n').split(/\n/);
 
     po.headers = {
@@ -87,10 +104,11 @@ PO.parse = function (data) {
         acc.push(line);
         return acc;
     }, []).forEach(function (header) {
-        if (header.match(/^#/)) {
+        if (header.match(/^#\./)) {
+            po.extractedComments.push(header.replace(/^#\.\s*/, ''));
+        } else if (header.match(/^#/)) {
             po.comments.push(header.replace(/^#\s*/, ''));
-        }
-        if (header.match(/^"/)) {
+        } else if (header.match(/^"/)) {
             header = header.trim().replace(/^"/, '').replace(/\\n"$/, '');
             var p = header.split(/:/);
             var name = p.shift().trim();
@@ -99,7 +117,9 @@ PO.parse = function (data) {
         }
     });
 
-    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;
@@ -113,7 +133,7 @@ PO.parse = function (data) {
             obsoleteCount = 0;
             noCommentLineCount = 0;
             po.items.push(item);
-            item = new PO.Item();
+            item = new PO.Item({ nplurals: nplurals });
         }
     }
 
@@ -219,7 +239,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 = [];
@@ -229,6 +268,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 () {
@@ -301,13 +342,27 @@ PO.Item.prototype.toString = function () {
     ['msgctxt', 'msgid', 'msgid_plural', 'msgstr'].forEach(function (keyword) {
         var text = self[keyword];
         if (text != null) {
-            if (isArray(text) && text.length > 1) {
+            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));
                 });
+            } else if (self.msgid_plural && keyword === 'msgstr' && !hasTranslation) {
+                for (var pluralIndex = 0; pluralIndex < self.nplurals; pluralIndex++) {
+                    lines = lines.concat(mkObsolete + _process(keyword, '', pluralIndex));
+                }
             } else {
-                text = isArray(text) ? text.join() : text;
-                var processed = _process(keyword, text);
+                var index = (self.msgid_plural && Array.isArray(text)) ?
+                    0 :
+                    undefined;
+                text = Array.isArray(text) ? text.join() : text;
+                var processed = _process(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"';
@@ -322,91 +377,4 @@ PO.Item.prototype.toString = function () {
 
 module.exports = PO;
 
-},{"fs":3,"lodash.isarray":4}],"pofile":[function(require,module,exports){
-module.exports=require('W8CkM0');
-},{}],3:[function(require,module,exports){
-
-},{}],4:[function(require,module,exports){
-/**
- * Lo-Dash 2.4.1 (Custom Build) <http://lodash.com/>
- * Build: `lodash modularize modern exports="npm" -o ./npm/`
- * Copyright 2012-2013 The Dojo Foundation <http://dojofoundation.org/>
- * Based on Underscore.js 1.5.2 <http://underscorejs.org/LICENSE>
- * Copyright 2009-2013 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
- * Available under MIT license <http://lodash.com/license>
- */
-var isNative = require('lodash._isnative');
-
-/** `Object#toString` result shortcuts */
-var arrayClass = '[object Array]';
-
-/** Used for native method references */
-var objectProto = Object.prototype;
-
-/** Used to resolve the internal [[Class]] of values */
-var toString = objectProto.toString;
-
-/* Native method shortcuts for methods with the same name as other `lodash` methods */
-var nativeIsArray = isNative(nativeIsArray = Array.isArray) && nativeIsArray;
-
-/**
- * Checks if `value` is an array.
- *
- * @static
- * @memberOf _
- * @type Function
- * @category Objects
- * @param {*} value The value to check.
- * @returns {boolean} Returns `true` if the `value` is an array, else `false`.
- * @example
- *
- * (function() { return _.isArray(arguments); })();
- * // => false
- *
- * _.isArray([1, 2, 3]);
- * // => true
- */
-var isArray = nativeIsArray || function(value) {
-  return value && typeof value == 'object' && typeof value.length == 'number' &&
-    toString.call(value) == arrayClass || false;
-};
-
-module.exports = isArray;
-
-},{"lodash._isnative":5}],5:[function(require,module,exports){
-/**
- * Lo-Dash 2.4.1 (Custom Build) <http://lodash.com/>
- * Build: `lodash modularize modern exports="npm" -o ./npm/`
- * Copyright 2012-2013 The Dojo Foundation <http://dojofoundation.org/>
- * Based on Underscore.js 1.5.2 <http://underscorejs.org/LICENSE>
- * Copyright 2009-2013 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
- * Available under MIT license <http://lodash.com/license>
- */
-
-/** Used for native method references */
-var objectProto = Object.prototype;
-
-/** Used to resolve the internal [[Class]] of values */
-var toString = objectProto.toString;
-
-/** Used to detect if a method is native */
-var reNative = RegExp('^' +
-  String(toString)
-    .replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
-    .replace(/toString| for [^\]]+/g, '.*?') + '$'
-);
-
-/**
- * Checks if `value` is a native function.
- *
- * @private
- * @param {*} value The value to check.
- * @returns {boolean} Returns `true` if the `value` is a native function, else `false`.
- */
-function isNative(value) {
-  return typeof value == 'function' && reNative.test(value);
-}
-
-module.exports = isNative;
-
-},{}]},{},["W8CkM0"])
+},{"fs":1}]},{},["pofile"]);

lib/po.js

@@ -1,5 +1,4 @@
 var fs = require('fs');
-var isArray = require('lodash.isarray');
 
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
@@ -7,6 +6,7 @@ function trim(string) {
 
 var PO = function () {
     this.comments = [];
+    this.extractedComments = [];
     this.headers = {};
     this.items = [];
 };
@@ -20,7 +20,12 @@ 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).trim());
         });
     }
 
@@ -58,7 +63,17 @@ PO.parse = function (data) {
     data = data.replace(/\r\n/g, '\n');
     var po = new PO();
     var sections = data.split(/\n\n/);
-    var headers = sections.shift();
+    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 "[^"]/)) {
+            //found first real string, adding a dummy header item
+            headers.push('msgid ""');
+        } else {
+            headers.push(sections.shift());
+        }
+    }
+    headers = headers.join('\n');
     var lines = sections.join('\n').split(/\n/);
 
     po.headers = {
@@ -86,10 +101,11 @@ PO.parse = function (data) {
         acc.push(line);
         return acc;
     }, []).forEach(function (header) {
-        if (header.match(/^#/)) {
+        if (header.match(/^#\./)) {
+            po.extractedComments.push(header.replace(/^#\.\s*/, ''));
+        } else if (header.match(/^#/)) {
             po.comments.push(header.replace(/^#\s*/, ''));
-        }
-        if (header.match(/^"/)) {
+        } else if (header.match(/^"/)) {
             header = header.trim().replace(/^"/, '').replace(/\\n"$/, '');
             var p = header.split(/:/);
             var name = p.shift().trim();
@@ -98,7 +114,9 @@ PO.parse = function (data) {
         }
     });
 
-    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;
@@ -112,7 +130,7 @@ PO.parse = function (data) {
             obsoleteCount = 0;
             noCommentLineCount = 0;
             po.items.push(item);
-            item = new PO.Item();
+            item = new PO.Item({ nplurals: nplurals });
         }
     }
 
@@ -218,7 +236,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 = [];
@@ -228,6 +265,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 () {
@@ -300,13 +339,27 @@ PO.Item.prototype.toString = function () {
     ['msgctxt', 'msgid', 'msgid_plural', 'msgstr'].forEach(function (keyword) {
         var text = self[keyword];
         if (text != null) {
-            if (isArray(text) && text.length > 1) {
+            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));
                 });
+            } else if (self.msgid_plural && keyword === 'msgstr' && !hasTranslation) {
+                for (var pluralIndex = 0; pluralIndex < self.nplurals; pluralIndex++) {
+                    lines = lines.concat(mkObsolete + _process(keyword, '', pluralIndex));
+                }
             } else {
-                text = isArray(text) ? text.join() : text;
-                var processed = _process(keyword, text);
+                var index = (self.msgid_plural && Array.isArray(text)) ?
+                    0 :
+                    undefined;
+                text = Array.isArray(text) ? text.join() : text;
+                var processed = _process(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"';

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pofile",
   "description": "Parse and serialize Gettext PO files.",
-  "version": "0.3.0",
+  "version": "1.0.8",
   "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",
@@ -35,18 +36,16 @@
     "test": "test"
   },
   "devDependencies": {
-    "browserify": "~3.11.1",
-    "grunt": "~0.4.2",
-    "grunt-browserify": "~1.3.0",
-    "grunt-bump": "0.0.13",
-    "grunt-contrib-clean": "~0.5.0",
-    "grunt-contrib-jshint": "~0.7.2",
-    "grunt-contrib-uglify": "~0.2.7",
-    "grunt-contrib-watch": "~0.5.3",
-    "grunt-jscs-checker": "^0.5.1",
-    "grunt-mocha-cli": "~1.4.0"
+    "browserify": "~14.0.0",
+    "grunt": "~1.0.1",
+    "grunt-browserify": "~5.0.0",
+    "grunt-bump": "0.8.0",
+    "grunt-contrib-clean": "~1.0.0",
+    "grunt-contrib-jshint": "~1.1.0",
+    "grunt-contrib-uglify": "~2.1.0",
+    "grunt-contrib-watch": "~1.0.0",
+    "grunt-jscs": "~3.0.1",
+    "grunt-mocha-cli": "~3.0.0"
   },
-  "dependencies": {
-    "lodash.isarray": "~2.4.1"
-  }
+  "dependencies": {}
 }

pofile.d.ts

@@ -0,0 +1,44 @@
+declare module pofile {
+    function parse(data: string): PO;
+    function load(fileName: string, callback: (err: NodeJS.ErrnoException | null, po: PO) => void): void;
+
+    class PO {
+        public comments: string[];
+        public extractedComments: string[];
+        public items: Item[];
+        public headers: Partial<IHeaders>
+
+        public save(filename: string, callback: (err?: NodeJS.ErrnoException) => void): void;
+        public toString(): string;
+    }
+
+    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;
+    }
+
+    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: { [flag: string]: boolean | undefined }
+        private nplurals: number;
+        private obsolete: boolean;
+
+        public toString(): string;
+    }
+}
+
+export = pofile

test/fixtures/big.po

@@ -1,4 +1,5 @@
 # French translation of Link (6.x-2.9)
+
 # Copyright (c) 2011 by the French translation team
 #
 msgid ""

test/fixtures/comment.po

@@ -1,6 +1,7 @@
 # French translation of Link (6.x-2.9)
 # Copyright (c) 2011 by the French translation team
 #
+#. extracted from test
 msgid ""
 msgstr ""
 "Project-Id-Version: Link (6.x-2.9)\n"

test/fixtures/no_header.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

@@ -0,0 +1,38 @@
+# French translation of Link (6.x-2.9)
+# Copyright (c) 2011 by the French 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: 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"
+
+# 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/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

@@ -28,3 +28,46 @@ describe('Headers', function () {
         assert.equal(Object.keys(po.headers).length, 12);
     });
 });
+
+describe('PO files with no headers', function () {
+
+    it('Parses an empty string', function () {
+        var po = PO.parse('');
+        assert.notEqual(po, null);
+        // all headers should be empty
+        for (var key in po.headers) {
+            assert.equal(po.headers[key], '');
+        }
+        assert.equal(po.items.length, 0);
+    });
+
+    it('Parses a minimal example', function () {
+        var po = PO.parse('msgid "minimal PO"\nmsgstr ""');
+        assert.notEqual(po, null);
+        // all headers should be empty
+        for (var key in po.headers) {
+            assert.equal(po.headers[key], '');
+        }
+        assert.equal(po.items.length, 1);
+    });
+
+    describe('advanced example', function () {
+        var po;
+
+        before(function (done) {
+            PO.load(__dirname + '/fixtures/no_header.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

@@ -61,6 +61,9 @@ describe('Parse', function () {
         assert.notEqual(po, null);
         assert.equal(po.items.length, 2);
 
+        assert.equal(po.extractedComments.length, 1);
+        assert.equal(po.extractedComments[0], 'extracted from test');
+
         var item = po.items[0];
         assert.equal(item.msgid, 'Title, as plain text');
         assert.equal(item.msgstr, 'Attribut title, en tant que texte brut');

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;
         }
@@ -16,6 +17,21 @@ function assertHasLine(str, line) {
     assert(found, 'Could not find line: ' + line);
 }
 
+function assertHasContiguousLines(str, assertedLines) {
+    var assertedLinesJoined = assertedLines.join('\n');
+
+    var trimmedStr = str
+        .split('\n')
+        .map(function (line) {
+            return line.trim();
+        })
+        .join('\n');
+
+    var found = trimmedStr.indexOf(assertedLinesJoined) !== -1;
+
+    assert(found, 'Could not find lines: \n' + assertedLinesJoined);
+}
+
 function assertDoesntHaveLine(str, line) {
     var lines = str.split('\n');
     var found = false;
@@ -38,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);
@@ -74,6 +97,7 @@ describe('Write', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/comment.po', 'utf8');
         var po = PO.parse(input);
         var str = po.toString();
+        assertHasLine(str, '#. extracted from test');
         assertHasLine(str, '#. Extracted comment');
     });
 
@@ -102,6 +126,327 @@ describe('Write', function () {
         assertHasLine(str, '#~ msgstr "also not sure"');
     });
 
+    describe('plurals', function () {
+        describe('nplurals INTEGER', function () {
+            it('should write 2 msgstrs when formatted correctly', 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}} 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] ""'
+                ]);
+            });
+        });
+
+        describe('nplurals missing', function () {
+            it('should write 2 msgstrs when formatted correctly 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}} 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] ""'
+                ]);
+            });
+        });
+
+        describe('nplurals=1', function () {
+            it('should write 1 msgstr when formatted correctly 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}} 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] ""'
+                ]);
+            });
+        });
+    });
+
     describe('C-Strings', function () {
         it('should escape "', function () {
             var item = new PO.Item();