Release v1.1.1

lazy require fs

.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.2.11",
+  "version": "1.1.1",
   "authors": [
     "Ruben Vermeersch <ruben@rocketeer.be>"
   ],

dist/pofile.js

@@ -1,19 +1,20 @@
-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){
-var fs = require('fs');
-var isArray = require('lodash.isarray');
+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){
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
 }
 
 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 () {
@@ -21,16 +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).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"');
     });
 
@@ -45,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);
         }
@@ -59,7 +80,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 = {
@@ -74,6 +105,7 @@ PO.parse = function (data) {
         'Content-Transfer-Encoding': '',
         'Plural-Forms': '',
     };
+    po.headerOrder = [];
 
     headers.split(/\n/).reduce(function (acc, line) {
         if (acc.merge) {
@@ -87,19 +119,23 @@ 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();
             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;
@@ -113,15 +149,39 @@ PO.parse = function (data) {
             obsoleteCount = 0;
             noCommentLineCount = 0;
             po.items.push(item);
-            item = new PO.Item();
+            item = new PO.Item({ nplurals: nplurals });
         }
     }
 
     function extract(string) {
         string = trim(string);
         string = string.replace(/^[^"]*"|"$/g, '');
-        string = string.replace(/\\"/g, '"');
-        string = string.replace(/\\\\/g, '\\');
+        string = string.replace(/\\([abtnvfr'"\\?]|([0-7]{3})|x([0-9a-fA-F]{2}))/g, function (match, esc, oct, hex) {
+            if (oct) {
+                return String.fromCharCode(parseInt(oct, 8));
+            }
+            if (hex) {
+                return String.fromCharCode(parseInt(hex, 16));
+            }
+            switch (esc) {
+                case 'a':
+                    return '\x07';
+                case 'b':
+                    return '\b';
+                case 't':
+                    return '\t';
+                case 'n':
+                    return '\n';
+                case 'v':
+                    return '\v';
+                case 'f':
+                    return '\f';
+                case 'r':
+                    return '\r';
+                default:
+                    return esc;
+            }
+        });
         return string;
     }
 
@@ -171,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) {
@@ -181,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);
                 }
             }
         }
@@ -195,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 = [];
@@ -205,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 () {
@@ -213,8 +297,27 @@ PO.Item.prototype.toString = function () {
 
     // reverse what extract(string) method during PO.parse does
     var _escape = function (string) {
-        string = string.replace(/\\/g, '\\\\');
-        return string.replace(/"/g, '\\"');
+        // don't unescape \n, since string can never contain it
+        // since split('\n') is called on it
+        string = string.replace(/[\x07\b\t\v\f\r"\\]/g, function (match) {
+            switch (match) {
+                case '\x07':
+                    return '\\a';
+                case '\b':
+                    return '\\b';
+                case '\t':
+                    return '\\t';
+                case '\v':
+                    return '\\v';
+                case '\f':
+                    return '\\f';
+                case '\r':
+                    return '\\r';
+                default:
+                    return '\\' + match;
+            }
+        });
+        return string;
     };
 
     var _process = function (keyword, text, i) {
@@ -232,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
 
@@ -247,7 +359,9 @@ PO.Item.prototype.toString = function () {
         lines.push('#: ' + ref);
     });
 
-    var flags = Object.keys(this.flags);
+    var flags = Object.keys(this.flags).filter(function (flag) {
+        return !!this.flags[flag];
+    }, this);
     if (flags.length > 0) {
         lines.push('#, ' + flags.join(','));
     }
@@ -256,13 +370,28 @@ 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) {
-                text.forEach(function (t, i) {
-                    lines = lines.concat(mkObsolete + _process(keyword, t, i));
+            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) {
+                    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 {
-                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 = _processLineBreak(keyword, text, index);
                 lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
             }
         }
@@ -273,91 +402,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,18 +1,17 @@
-var fs = require('fs');
-var isArray = require('lodash.isarray');
-
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
 }
 
 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,16 +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).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"');
     });
 
@@ -44,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);
         }
@@ -58,7 +77,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 = {
@@ -73,6 +102,7 @@ PO.parse = function (data) {
         'Content-Transfer-Encoding': '',
         'Plural-Forms': '',
     };
+    po.headerOrder = [];
 
     headers.split(/\n/).reduce(function (acc, line) {
         if (acc.merge) {
@@ -86,19 +116,23 @@ 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();
             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;
@@ -112,15 +146,39 @@ PO.parse = function (data) {
             obsoleteCount = 0;
             noCommentLineCount = 0;
             po.items.push(item);
-            item = new PO.Item();
+            item = new PO.Item({ nplurals: nplurals });
         }
     }
 
     function extract(string) {
         string = trim(string);
         string = string.replace(/^[^"]*"|"$/g, '');
-        string = string.replace(/\\"/g, '"');
-        string = string.replace(/\\\\/g, '\\');
+        string = string.replace(/\\([abtnvfr'"\\?]|([0-7]{3})|x([0-9a-fA-F]{2}))/g, function (match, esc, oct, hex) {
+            if (oct) {
+                return String.fromCharCode(parseInt(oct, 8));
+            }
+            if (hex) {
+                return String.fromCharCode(parseInt(hex, 16));
+            }
+            switch (esc) {
+                case 'a':
+                    return '\x07';
+                case 'b':
+                    return '\b';
+                case 't':
+                    return '\t';
+                case 'n':
+                    return '\n';
+                case 'v':
+                    return '\v';
+                case 'f':
+                    return '\f';
+                case 'r':
+                    return '\r';
+                default:
+                    return esc;
+            }
+        });
         return string;
     }
 
@@ -170,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) {
@@ -180,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);
                 }
             }
         }
@@ -194,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 = [];
@@ -204,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 () {
@@ -212,8 +294,27 @@ PO.Item.prototype.toString = function () {
 
     // reverse what extract(string) method during PO.parse does
     var _escape = function (string) {
-        string = string.replace(/\\/g, '\\\\');
-        return string.replace(/"/g, '\\"');
+        // don't unescape \n, since string can never contain it
+        // since split('\n') is called on it
+        string = string.replace(/[\x07\b\t\v\f\r"\\]/g, function (match) {
+            switch (match) {
+                case '\x07':
+                    return '\\a';
+                case '\b':
+                    return '\\b';
+                case '\t':
+                    return '\\t';
+                case '\v':
+                    return '\\v';
+                case '\f':
+                    return '\\f';
+                case '\r':
+                    return '\\r';
+                default:
+                    return '\\' + match;
+            }
+        });
+        return string;
     };
 
     var _process = function (keyword, text, i) {
@@ -231,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
 
@@ -246,7 +356,9 @@ PO.Item.prototype.toString = function () {
         lines.push('#: ' + ref);
     });
 
-    var flags = Object.keys(this.flags);
+    var flags = Object.keys(this.flags).filter(function (flag) {
+        return !!this.flags[flag];
+    }, this);
     if (flags.length > 0) {
         lines.push('#, ' + flags.join(','));
     }
@@ -255,13 +367,28 @@ 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) {
-                text.forEach(function (t, i) {
-                    lines = lines.concat(mkObsolete + _process(keyword, t, i));
+            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) {
+                    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 {
-                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 = _processLineBreak(keyword, text, index);
                 lines = lines.concat(mkObsolete + processed.join('\n' + mkObsolete));
             }
         }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pofile",
   "description": "Parse and serialize Gettext PO files.",
-  "version": "0.2.11",
+  "version": "1.1.1",
   "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,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

@@ -1,4 +1,5 @@
 # French translation of Link (6.x-2.9)
+
 # Copyright (c) 2011 by the French translation team
 #
 msgid ""
@@ -295,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

@@ -17,3 +17,57 @@ msgstr ""
 
 msgid "The name field must not contain characters like \" or \\"
 msgstr ""
+
+# possibility to reorder items depending on locale
+#. Format of addresses
+#. %1$s is the street
+#. %2$s is the postal code
+#. %3$s is the city
+#. %4$s is the state
+#. %5$s is the country
+msgid ""
+"%1$s\n"
+"%2$s %3$s\n"
+"%4$s\n"
+"%5$s"
+msgstr ""
+
+# "i18"ned code
+#. used in <pre> environment, so don't remove any control sequences
+msgid ""
+"define('some/test/module', function () {\n"
+"\t'use strict';\n"
+"\treturn {};\n"
+"});\n"
+""
+msgstr ""
+"define('random/test/file', function () {\n"
+"\t'use strict';\n"
+"\treturn {};\n"
+"});\n"
+""
+
+# all one-letter escape characters
+# be aware, that \a, \b, \v, \f and \r should not be used
+# in i18ned messages (according to gettext tools)
+# however, they should be properly parsed, anyway
+msgid ""
+"\a\b\t\n"
+"\v\f\r"
+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/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/fixtures/reference.po

@@ -24,3 +24,7 @@ msgstr "Attribut title, en tant que texte brut"
 #: b
 msgid "X"
 msgstr "Y"
+
+#: standard input:12 standard input:17
+msgid "Z"
+msgstr "ZZ"

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

@@ -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');
@@ -61,29 +61,43 @@ 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');
         assert.deepEqual(item.extractedComments, ['Extracted comment']);
     });
 
-    it('Handles string references', function () {
+    describe('Handles string references', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/reference.po', 'utf8'));
         assert.notEqual(po, null);
-        assert.equal(po.items.length, 2);
+        assert.equal(po.items.length, 3);
 
+        it('in simple cases', function () {
             var item = po.items[0];
             assert.equal(item.msgid, 'Title, as plain text');
             assert.equal(item.msgstr, 'Attribut title, en tant que texte brut');
             assert.deepEqual(item.comments, ['Comment']);
             assert.deepEqual(item.references, ['.tmp/crm/controllers/map.js']);
+        });
 
-        item = po.items[1];
+        it('with two different references', function () {
+            var item = po.items[1];
             assert.equal(item.msgid, 'X');
             assert.equal(item.msgstr, 'Y');
             assert.deepEqual(item.references, ['a', 'b']);
         });
 
+        it('and does not process reference items', function () {
+            var item = po.items[2];
+            assert.equal(item.msgid, 'Z');
+            assert.equal(item.msgstr, 'ZZ');
+            assert.deepEqual(item.references, ['standard input:12 standard input:17']);
+        });
+    });
+
     it('Parses flags', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8'));
         assert.notEqual(po, null);
@@ -107,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'));
 
@@ -133,19 +158,29 @@ describe('Parse', function () {
     });
 
     describe('C-Strings', function () {
-        it('should parse the c-strings.po file', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/c-strings.po', 'utf8'));
-
+        it('should parse the c-strings.po file', function () {
             assert.notEqual(po, null);
         });
 
         it('should extract strings containing " and \\ characters', function () {
-            var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/c-strings.po', 'utf8'));
-
             var items = po.items.filter(function (item) {
                 return (/^The name field must not contain/).test(item.msgid);
             });
             assert.equal(items[0].msgid, 'The name field must not contain characters like " or \\');
         });
+
+        it('should handle \\n characters', function () {
+            var item = po.items[1];
+            assert.equal(item.msgid, '%1$s\n%2$s %3$s\n%4$s\n%5$s');
+        });
+
+        it('should handle \\t characters', function () {
+            var item = po.items[2];
+            assert.equal(item.msgid, 'define(\'some/test/module\', function () {\n' +
+                '\t\'use strict\';\n' +
+                '\treturn {};\n' +
+                '});\n');
+        });
     });
 });

test/write.js

@@ -2,7 +2,37 @@ 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++) {
+        var lineToCompare = doNotTrim ? lines[i] : lines[i].trim();
+        if (lineToCompare === line) {
+            found = true;
+            break;
+        }
+    }
+
+    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;
 
@@ -13,7 +43,7 @@ function assertHasLine(str, line) {
         }
     }
 
-    assert(found, 'Could not find line: ' + line);
+    assert(!found, 'Shouldn\'t have line: ' + line);
 }
 
 describe('Write', function () {
@@ -24,6 +54,24 @@ 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);
+
+        // Flip flag
+        po.items[0].flags.fuzzy = false;
+
+        var str = po.toString();
+        assertDoesntHaveLine(str, '#, fuzzy');
+    });
+
     it('write msgid', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
         var po = PO.parse(input);
@@ -49,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');
     });
 
@@ -77,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();
@@ -97,7 +467,7 @@ describe('Write', function () {
 
             item.msgid = '\n should be written escaped';
             assertHasLine(item.toString(), 'msgid ""');
-            assertHasLine(item.toString(), '""');
+            assertHasLine(item.toString(), '"\\n"');
             assertHasLine(item.toString(), '" should be written escaped"');
         });
 
@@ -134,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"',
+        ]);
+    });
 });