Release v0.2.8

add support for multiline string in headers

bower.json

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

dist/pofile.js

@@ -75,7 +75,18 @@ PO.parse = function (data) {
         'Plural-Forms': '',
     };
 
-    headers.split(/\n/).forEach(function (header) {
+    headers.split(/\n/).reduce(function (acc, line) {
+        if (acc.merge) {
+            //join lines, remove last resp. first "
+            line = acc.pop().slice(0, -1) + line.slice(1);
+            delete acc.merge;
+        }
+        if (/^".*"$/.test(line) && !/^".*\\n"$/.test(line)) {
+            acc.merge = true;
+        }
+        acc.push(line);
+        return acc;
+    }, []).forEach(function (header) {
         if (header.match(/^#/)) {
             po.comments.push(header.replace(/^#\s*/, ''));
         }
@@ -90,12 +101,15 @@ PO.parse = function (data) {
 
     var item = new PO.Item(),
         context = null,
-        plural = 0;
+        plural = 0,
+        obsolete = false;
 
     function finish() {
         if (item.msgid.length > 0) {
             po.items.push(item);
             item = new PO.Item();
+            item.obsolete = obsolete;
+            obsolete = false;
         }
     }
 
@@ -110,6 +124,14 @@ PO.parse = function (data) {
     while (lines.length > 0) {
         var line = trim(lines.shift()),
             add = false;
+
+        if (line.match(/^#\~/)) { // Obsolete item
+            obsolete = true;
+            line = trim(line.substring(2));
+        } else {
+            obsolete = false;
+        }
+
         if (line.match(/^#:/)) { // Reference
             finish();
             item.references.push(trim(line.replace(/^#:/, '')));
@@ -176,6 +198,7 @@ PO.Item = function () {
     this.comments = []; // translator comments
     this.extractedComments = [];
     this.flags = {};
+    this.obsolete = false;
 };
 
 PO.Item.prototype.toString = function () {
@@ -207,23 +230,17 @@ PO.Item.prototype.toString = function () {
     // https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html
     // says order is translator-comments, extracted-comments, references, flags
 
-    if (this.comments.length > 0) {
+    this.comments.forEach(function (c) {
-        this.comments.forEach(function (c) {
+        lines.push('# ' + c);
-            lines.push('# ' + c);
+    });
-        });
-    }
 
-    if (this.extractedComments.length > 0) {
+    this.extractedComments.forEach(function (c) {
-        this.extractedComments.forEach(function (c) {
+        lines.push('#. ' + c);
-            lines.push('#. ' + c);
+    });
-        });
-    }
 
-    if (this.references.length > 0) {
+    this.references.forEach(function (ref) {
-        this.references.forEach(function (ref) {
+        lines.push('#: ' + ref);
-            lines.push('#: ' + ref);
+    });
-        });
-    }
 
     var flags = Object.keys(this.flags);
     if (flags.length > 0) {
@@ -245,7 +262,11 @@ PO.Item.prototype.toString = function () {
         }
     });
 
-    return lines.join("\n");
+    if (this.obsolete) {
+        return "#~ " + lines.join("\n#~ ");
+    } else {
+        return lines.join("\n");
+    }
 };
 
 module.exports = PO;

dist/pofile.min.js

@@ -1 +1 @@
-require=function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g<d.length;g++)e(d[g]);return e}({W8CkM0:[function(a,b){function c(a){return a.replace(/^\s+|\s+$/g,"")}var d=a("fs"),e=a("lodash.isarray"),f=function(){this.comments=[],this.headers={},this.items=[]};f.prototype.save=function(a,b){d.writeFile(a,this.toString(),b)},f.prototype.toString=function(){var a=[],b=this;this.comments&&this.comments.forEach(function(b){a.push("# "+b)}),a.push('msgid ""'),a.push('msgstr ""');var c=Object.keys(this.headers);return c.forEach(function(c){a.push('"'+c+": "+b.headers[c]+'\\n"')}),a.push(""),this.items.forEach(function(b){a.push(b.toString()),a.push("")}),a.join("\n")},f.load=function(a,b){d.readFile(a,"utf-8",function(a,c){if(a)return b(a);var d=f.parse(c);b(null,d)})},f.parse=function(a){function b(){j.msgid.length>0&&(e.items.push(j),j=new f.Item)}function d(a){return a=c(a),a=a.replace(/^[^"]*"|"$/g,""),a=a.replace(/\\"/g,'"'),a=a.replace(/\\\\/g,"\\")}a=a.replace(/\r\n/g,"\n");var e=new f,g=a.split(/\n\n/),h=g.shift(),i=g.join("\n").split(/\n/);e.headers={"Project-Id-Version":"","Report-Msgid-Bugs-To":"","POT-Creation-Date":"","PO-Revision-Date":"","Last-Translator":"",Language:"","Language-Team":"","Content-Type":"","Content-Transfer-Encoding":"","Plural-Forms":""},h.split(/\n/).forEach(function(a){if(a.match(/^#/)&&e.comments.push(a.replace(/^#\s*/,"")),a.match(/^"/)){a=a.trim().replace(/^"/,"").replace(/\\n"$/,"");var b=a.split(/:/),c=b.shift().trim(),d=b.join(":").trim();e.headers[c]=d}});for(var j=new f.Item,k=null,l=0;i.length>0;){var m=c(i.shift());if(m.match(/^#:/))b(),j.references.push(c(m.replace(/^#:/,"")));else if(m.match(/^#,/)){b();for(var n=c(m.replace(/^#,/,"")).split(","),o=0;o<n.length;o++)j.flags[n[o]]=!0}else if(m.match(/^#\s+/))b(),j.comments.push(c(m.replace(/^#\s+/,"")));else if(m.match(/^#\./))b(),j.extractedComments.push(c(m.replace(/^#\./,"")));else if(m.match(/^msgid_plural/))j.msgid_plural=d(m),k="msgid_plural";else if(m.match(/^msgid/))b(),j.msgid=d(m),k="msgid";else if(m.match(/^msgstr/)){var p=m.match(/^msgstr\[(\d+)\]/);l=p&&p[1]?parseInt(p[1]):0,j.msgstr[l]=d(m),k="msgstr"}else m.match(/^msgctxt/)?(b(),j.msgctxt=d(m)):m.length>0&&("msgstr"===k?j.msgstr[l]+=d(m):"msgid"===k?j.msgid+=d(m):"msgid_plural"===k&&(j.msgid_plural+=d(m)))}return b(),e},f.Item=function(){this.msgid="",this.msgctxt=null,this.references=[],this.msgid_plural=null,this.msgstr=[],this.comments=[],this.extractedComments=[],this.flags={}},f.Item.prototype.toString=function(){var a=[],b=this,c=function(a){return a=a.replace(/\\/g,"\\\\"),a.replace(/"/g,'\\"')},d=function(a,b,d){var e=[],f=b.split(/\n/),g="undefined"!=typeof d?"["+d+"]":"";return f.length>1?(e.push(a+g+' ""'),f.forEach(function(a){e.push('"'+c(a)+'"')})):e.push(a+g+' "'+c(b)+'"'),e};this.comments.length>0&&this.comments.forEach(function(b){a.push("# "+b)}),this.extractedComments.length>0&&this.extractedComments.forEach(function(b){a.push("#. "+b)}),this.references.length>0&&this.references.forEach(function(b){a.push("#: "+b)});var f=Object.keys(this.flags);return f.length>0&&a.push("#, "+f.join(",")),["msgctxt","msgid","msgid_plural","msgstr"].forEach(function(c){var f=b[c];null!=f&&(e(f)&&f.length>1?f.forEach(function(b,e){a=a.concat(d(c,b,e))}):(f=e(f)?f.join():f,a=a.concat(d(c,f))))}),a.join("\n")},b.exports=f},{fs:3,"lodash.isarray":4}],pofile:[function(a,b){b.exports=a("W8CkM0")},{}],3:[function(){},{}],4:[function(a,b){var c=a("lodash._isnative"),d="[object Array]",e=Object.prototype,f=e.toString,g=c(g=Array.isArray)&&g,h=g||function(a){return a&&"object"==typeof a&&"number"==typeof a.length&&f.call(a)==d||!1};b.exports=h},{"lodash._isnative":5}],5:[function(a,b){function c(a){return"function"==typeof a&&f.test(a)}var d=Object.prototype,e=d.toString,f=RegExp("^"+String(e).replace(/[.*+?^${}()|[\]\\]/g,"\\$&").replace(/toString| for [^\]]+/g,".*?")+"$");b.exports=c},{}]},{},["W8CkM0"]);
+require=function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g<d.length;g++)e(d[g]);return e}({W8CkM0:[function(a,b){function c(a){return a.replace(/^\s+|\s+$/g,"")}var d=a("fs"),e=a("lodash.isarray"),f=function(){this.comments=[],this.headers={},this.items=[]};f.prototype.save=function(a,b){d.writeFile(a,this.toString(),b)},f.prototype.toString=function(){var a=[],b=this;this.comments&&this.comments.forEach(function(b){a.push("# "+b)}),a.push('msgid ""'),a.push('msgstr ""');var c=Object.keys(this.headers);return c.forEach(function(c){a.push('"'+c+": "+b.headers[c]+'\\n"')}),a.push(""),this.items.forEach(function(b){a.push(b.toString()),a.push("")}),a.join("\n")},f.load=function(a,b){d.readFile(a,"utf-8",function(a,c){if(a)return b(a);var d=f.parse(c);b(null,d)})},f.parse=function(a){function b(){j.msgid.length>0&&(e.items.push(j),j=new f.Item,j.obsolete=m,m=!1)}function d(a){return a=c(a),a=a.replace(/^[^"]*"|"$/g,""),a=a.replace(/\\"/g,'"'),a=a.replace(/\\\\/g,"\\")}a=a.replace(/\r\n/g,"\n");var e=new f,g=a.split(/\n\n/),h=g.shift(),i=g.join("\n").split(/\n/);e.headers={"Project-Id-Version":"","Report-Msgid-Bugs-To":"","POT-Creation-Date":"","PO-Revision-Date":"","Last-Translator":"",Language:"","Language-Team":"","Content-Type":"","Content-Transfer-Encoding":"","Plural-Forms":""},h.split(/\n/).reduce(function(a,b){return a.merge&&(b=a.pop().slice(0,-1)+b.slice(1),delete a.merge),/^".*"$/.test(b)&&!/^".*\\n"$/.test(b)&&(a.merge=!0),a.push(b),a},[]).forEach(function(a){if(a.match(/^#/)&&e.comments.push(a.replace(/^#\s*/,"")),a.match(/^"/)){a=a.trim().replace(/^"/,"").replace(/\\n"$/,"");var b=a.split(/:/),c=b.shift().trim(),d=b.join(":").trim();e.headers[c]=d}});for(var j=new f.Item,k=null,l=0,m=!1;i.length>0;){var n=c(i.shift());if(n.match(/^#\~/)?(m=!0,n=c(n.substring(2))):m=!1,n.match(/^#:/))b(),j.references.push(c(n.replace(/^#:/,"")));else if(n.match(/^#,/)){b();for(var o=c(n.replace(/^#,/,"")).split(","),p=0;p<o.length;p++)j.flags[o[p]]=!0}else if(n.match(/^#\s+/))b(),j.comments.push(c(n.replace(/^#\s+/,"")));else if(n.match(/^#\./))b(),j.extractedComments.push(c(n.replace(/^#\./,"")));else if(n.match(/^msgid_plural/))j.msgid_plural=d(n),k="msgid_plural";else if(n.match(/^msgid/))b(),j.msgid=d(n),k="msgid";else if(n.match(/^msgstr/)){var q=n.match(/^msgstr\[(\d+)\]/);l=q&&q[1]?parseInt(q[1]):0,j.msgstr[l]=d(n),k="msgstr"}else n.match(/^msgctxt/)?(b(),j.msgctxt=d(n)):n.length>0&&("msgstr"===k?j.msgstr[l]+=d(n):"msgid"===k?j.msgid+=d(n):"msgid_plural"===k&&(j.msgid_plural+=d(n)))}return b(),e},f.Item=function(){this.msgid="",this.msgctxt=null,this.references=[],this.msgid_plural=null,this.msgstr=[],this.comments=[],this.extractedComments=[],this.flags={},this.obsolete=!1},f.Item.prototype.toString=function(){var a=[],b=this,c=function(a){return a=a.replace(/\\/g,"\\\\"),a.replace(/"/g,'\\"')},d=function(a,b,d){var e=[],f=b.split(/\n/),g="undefined"!=typeof d?"["+d+"]":"";return f.length>1?(e.push(a+g+' ""'),f.forEach(function(a){e.push('"'+c(a)+'"')})):e.push(a+g+' "'+c(b)+'"'),e};this.comments.forEach(function(b){a.push("# "+b)}),this.extractedComments.forEach(function(b){a.push("#. "+b)}),this.references.forEach(function(b){a.push("#: "+b)});var f=Object.keys(this.flags);return f.length>0&&a.push("#, "+f.join(",")),["msgctxt","msgid","msgid_plural","msgstr"].forEach(function(c){var f=b[c];null!=f&&(e(f)&&f.length>1?f.forEach(function(b,e){a=a.concat(d(c,b,e))}):(f=e(f)?f.join():f,a=a.concat(d(c,f))))}),this.obsolete?"#~ "+a.join("\n#~ "):a.join("\n")},b.exports=f},{fs:3,"lodash.isarray":4}],pofile:[function(a,b){b.exports=a("W8CkM0")},{}],3:[function(){},{}],4:[function(a,b){var c=a("lodash._isnative"),d="[object Array]",e=Object.prototype,f=e.toString,g=c(g=Array.isArray)&&g,h=g||function(a){return a&&"object"==typeof a&&"number"==typeof a.length&&f.call(a)==d||!1};b.exports=h},{"lodash._isnative":5}],5:[function(a,b){function c(a){return"function"==typeof a&&f.test(a)}var d=Object.prototype,e=d.toString,f=RegExp("^"+String(e).replace(/[.*+?^${}()|[\]\\]/g,"\\$&").replace(/toString| for [^\]]+/g,".*?")+"$");b.exports=c},{}]},{},["W8CkM0"]);

lib/po.js

@@ -74,7 +74,18 @@ PO.parse = function (data) {
         'Plural-Forms': '',
     };
 
-    headers.split(/\n/).forEach(function (header) {
+    headers.split(/\n/).reduce(function (acc, line) {
+        if (acc.merge) {
+            //join lines, remove last resp. first "
+            line = acc.pop().slice(0, -1) + line.slice(1);
+            delete acc.merge;
+        }
+        if (/^".*"$/.test(line) && !/^".*\\n"$/.test(line)) {
+            acc.merge = true;
+        }
+        acc.push(line);
+        return acc;
+    }, []).forEach(function (header) {
         if (header.match(/^#/)) {
             po.comments.push(header.replace(/^#\s*/, ''));
         }
@@ -89,12 +100,15 @@ PO.parse = function (data) {
 
     var item = new PO.Item(),
         context = null,
-        plural = 0;
+        plural = 0,
+        obsolete = false;
 
     function finish() {
         if (item.msgid.length > 0) {
             po.items.push(item);
             item = new PO.Item();
+            item.obsolete = obsolete;
+            obsolete = false;
         }
     }
 
@@ -109,6 +123,14 @@ PO.parse = function (data) {
     while (lines.length > 0) {
         var line = trim(lines.shift()),
             add = false;
+
+        if (line.match(/^#\~/)) { // Obsolete item
+            obsolete = true;
+            line = trim(line.substring(2));
+        } else {
+            obsolete = false;
+        }
+
         if (line.match(/^#:/)) { // Reference
             finish();
             item.references.push(trim(line.replace(/^#:/, '')));
@@ -175,6 +197,7 @@ PO.Item = function () {
     this.comments = []; // translator comments
     this.extractedComments = [];
     this.flags = {};
+    this.obsolete = false;
 };
 
 PO.Item.prototype.toString = function () {
@@ -206,23 +229,17 @@ PO.Item.prototype.toString = function () {
     // https://www.gnu.org/software/gettext/manual/html_node/PO-Files.html
     // says order is translator-comments, extracted-comments, references, flags
 
-    if (this.comments.length > 0) {
+    this.comments.forEach(function (c) {
-        this.comments.forEach(function (c) {
+        lines.push('# ' + c);
-            lines.push('# ' + c);
+    });
-        });
-    }
 
-    if (this.extractedComments.length > 0) {
+    this.extractedComments.forEach(function (c) {
-        this.extractedComments.forEach(function (c) {
+        lines.push('#. ' + c);
-            lines.push('#. ' + c);
+    });
-        });
-    }
 
-    if (this.references.length > 0) {
+    this.references.forEach(function (ref) {
-        this.references.forEach(function (ref) {
+        lines.push('#: ' + ref);
-            lines.push('#: ' + ref);
+    });
-        });
-    }
 
     var flags = Object.keys(this.flags);
     if (flags.length > 0) {
@@ -244,7 +261,11 @@ PO.Item.prototype.toString = function () {
         }
     });
 
-    return lines.join("\n");
+    if (this.obsolete) {
+        return "#~ " + lines.join("\n#~ ");
+    } else {
+        return lines.join("\n");
+    }
 };
 
 module.exports = PO;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pofile",
   "description": "Parse and serialize Gettext PO files.",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "author": {
     "name": "Ruben Vermeersch",
     "email": "ruben@savanne.be",

test/fixtures/commented.po

@@ -0,0 +1,23 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: Test\n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: 2014-02-17 14:11+0100\n"
+"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\n"
+"Language-Team: \n"
+"Language: nl\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"
+"X-Generator: Poedit 1.6.4\n"
+"X-Poedit-SourceCharset: UTF-8\n"
+"X-POOTLE-MTIME: 1390921449.000000\n"
+
+
+#: .tmp/ui/settings/views/console-modal.html
+msgid "{{dataLoader.data.length}} results"
+msgstr "{{dataLoader.data.length}} resultaten"
+
+#~ msgid "Add order"
+#~ msgstr "Order toevoegen"

test/fixtures/multi-line.po

@@ -1,6 +1,8 @@
 # French translation of Link (6.x-2.9)
 # Copyright (c) 2011 by the French translation team
 #
+## Plural-Forms by polish translation team to demonstrate multi-line ##
+#
 msgid ""
 msgstr ""
 "Project-Id-Version: Link (6.x-2.9)\n"
@@ -10,7 +12,8 @@ msgstr ""
 "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"
+"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: fr\n"
 "X-Generator: Poedit 1.6.2\n"

test/parse.js

@@ -23,6 +23,14 @@ describe('Parse', function () {
         assert.equal(item.msgstr, "Les ébauches de jetons suivantes peuvent être utilisées à la fois dans les chemins et dans les titres. Lorsqu'elles sont utilisées dans un chemin ou un titre, elles seront remplacées par les valeurs appropriées.");
     });
 
+    it('Handles multi-line headers', function () {
+        var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/multi-line.po', 'utf8'));
+        assert.notEqual(po, null);
+        assert.equal(po.items.length, 1);
+
+        assert.equal(po.headers['Plural-Forms'], 'nplurals=3; plural=n==1 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;');
+    });
+
     it('Handles translator comments', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/comment.po', 'utf8'));
         assert.notEqual(po, null);
@@ -85,6 +93,21 @@ describe('Parse', function () {
         assert.equal(ambiguousItems[1].msgctxt, 'folder action');
     });
 
+    it('Handles obsolete items', function () {
+        var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/commented.po', 'utf8'));
+
+        assert.equal(po.items.length, 2);
+        var item = po.items[0];
+        assert.equal(item.obsolete, false);
+        assert.equal(item.msgid, "{{dataLoader.data.length}} results");
+        assert.equal(item.msgstr, "{{dataLoader.data.length}} resultaten");
+
+        item = po.items[1];
+        assert.equal(item.obsolete, true);
+        assert.equal(item.msgid, "Add order");
+        assert.equal(item.msgstr, "Order toevoegen");
+    });
+
     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'));

test/write.js

@@ -52,6 +52,15 @@ describe('Write', function () {
         assertHasLine(str, '#. Extracted comment');
     });
 
+    it('write obsolete items', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/commented.po', 'utf8');
+        var po = PO.parse(input);
+        var str = po.toString();
+
+        assertHasLine(str, '#~ msgid "Add order"');
+        assertHasLine(str, '#~ msgstr "Order toevoegen"');
+    });
+
     describe('C-Strings', function () {
         it('should escape "', function () {
             var item = new PO.Item();