Release v0.2.5

Include comments in `PO.Item` output

README.md

@@ -88,11 +88,12 @@ The `PO` class exposes the following members:
 * `msgstr`: An array of translated strings. Items that have no plural msgid
   only have one element in this array.
 * `references`: An array of reference strings.
-* `comments`: An array of string comments.
+* `comments`: An array of string translator comments.
+* `extractedComments`: An array of string extracted comments.
 * `flags`: A dictionary of the string flags. Each flag is mapped to a key with
   value true. For instance, a string with the fuzzy flag set will have
   `item.flags.fuzzy == true`.
-* `msgctxt`: context of the message, an arbitrary string, can be used for disambiguation
+* `msgctxt`: Context of the message, an arbitrary string, can be used for disambiguation.
 
 
 ## Contributing

bower.json

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

dist/pofile.js

@@ -121,9 +121,13 @@ PO.parse = function (data) {
                 item.flags[flags[i]] = true;
             }
         }
-        else if (line.match(/^#/)) { // Comment
+        else if (line.match(/^#\s+/)) { // Translator comment
             finish();
-            item.comments.push(trim(line.replace(/^#/, '')));
+            item.comments.push(trim(line.replace(/^#\s+/, '')));
+        }
+        else if (line.match(/^#\./)) { // Extracted comment
+            finish();
+            item.extractedComments.push(trim(line.replace(/^#\./, '')));
         }
         else if (line.match(/^msgid_plural/)) { // Plural form
             item.msgid_plural = extract(line);
@@ -169,7 +173,8 @@ PO.Item = function () {
     this.references = [];
     this.msgid_plural = null;
     this.msgstr = [];
-    this.comments = [];
+    this.comments = []; // translator comments
+    this.extractedComments = [];
     this.flags = {};
 };
 
@@ -193,6 +198,21 @@ PO.Item.prototype.toString = function () {
         return lines;
     };
 
+    // 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) {
+            lines.push('# ' + c);
+        });
+    }
+
+    if (this.extractedComments.length > 0) {
+        this.extractedComments.forEach(function (c) {
+            lines.push('#. ' + c);
+        });
+    }
+
     if (this.references.length > 0) {
         this.references.forEach(function (ref) {
             lines.push('#: ' + ref);

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(/^#/))b(),j.comments.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.flags={}},f.Item.prototype.toString=function(){var a=[],b=this,c=function(a,b,c){var d=[],e=b.split(/\n/),f="undefined"!=typeof c?"["+c+"]":"";return e.length>1?(d.push(a+f+' ""'),e.forEach(function(a){d.push('"'+a+'"')})):d.push(a+f+' "'+b+'"'),d};this.references.length>0&&this.references.forEach(function(b){a.push("#: "+b)});var d=Object.keys(this.flags);return d.length>0&&a.push("#, "+d.join(",")),["msgctxt","msgid","msgid_plural","msgstr"].forEach(function(d){var f=b[d];null!=f&&(e(f)&&f.length>1?f.forEach(function(b,e){a=a.concat(c(d,b,e))}):(f=e(f)?f.join():f,a=a.concat(c(d,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)}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,b,c){var d=[],e=b.split(/\n/),f="undefined"!=typeof c?"["+c+"]":"";return e.length>1?(d.push(a+f+' ""'),e.forEach(function(a){d.push('"'+a+'"')})):d.push(a+f+' "'+b+'"'),d};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 d=Object.keys(this.flags);return d.length>0&&a.push("#, "+d.join(",")),["msgctxt","msgid","msgid_plural","msgstr"].forEach(function(d){var f=b[d];null!=f&&(e(f)&&f.length>1?f.forEach(function(b,e){a=a.concat(c(d,b,e))}):(f=e(f)?f.join():f,a=a.concat(c(d,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"]);

lib/po.js

@@ -120,9 +120,13 @@ PO.parse = function (data) {
                 item.flags[flags[i]] = true;
             }
         }
-        else if (line.match(/^#/)) { // Comment
+        else if (line.match(/^#\s+/)) { // Translator comment
             finish();
-            item.comments.push(trim(line.replace(/^#/, '')));
+            item.comments.push(trim(line.replace(/^#\s+/, '')));
+        }
+        else if (line.match(/^#\./)) { // Extracted comment
+            finish();
+            item.extractedComments.push(trim(line.replace(/^#\./, '')));
         }
         else if (line.match(/^msgid_plural/)) { // Plural form
             item.msgid_plural = extract(line);
@@ -168,7 +172,8 @@ PO.Item = function () {
     this.references = [];
     this.msgid_plural = null;
     this.msgstr = [];
-    this.comments = [];
+    this.comments = []; // translator comments
+    this.extractedComments = [];
     this.flags = {};
 };
 
@@ -192,6 +197,21 @@ PO.Item.prototype.toString = function () {
         return lines;
     };
 
+    // 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) {
+            lines.push('# ' + c);
+        });
+    }
+
+    if (this.extractedComments.length > 0) {
+        this.extractedComments.forEach(function (c) {
+            lines.push('#. ' + c);
+        });
+    }
+
     if (this.references.length > 0) {
         this.references.forEach(function (ref) {
             lines.push('#: ' + ref);

package.json

@@ -1,13 +1,14 @@
 {
   "name": "pofile",
   "description": "Parse and serialize Gettext PO files.",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "author": {
     "name": "Ruben Vermeersch",
     "email": "ruben@savanne.be",
     "url": "http://savanne.be/"
   },
   "contributors": [
+    "Julian Bäume",
     "Mike Holly"
   ],
   "homepage": "http://github.com/rubenv/pofile",
@@ -24,7 +25,8 @@
     "po"
   ],
   "scripts": {
-    "test": "grunt test"
+    "test": "grunt test",
+    "prepublish": "grunt build"
   },
   "directories": {
     "test": "test"

test/fixtures/comment.po

@@ -15,6 +15,7 @@ msgstr ""
 "Language: fr\n"
 "X-Generator: Poedit 1.6.2\n"
 
-# Comment
+# Translator comment
+#. Extracted comment
 msgid "Title, as plain text"
 msgstr "Attribut title, en tant que texte brut"

test/parse.js

@@ -23,7 +23,7 @@ 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 string comments', function () {
+    it('Handles translator comments', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/comment.po', 'utf8'));
         assert.notEqual(po, null);
         assert.equal(po.items.length, 1);
@@ -31,7 +31,18 @@ describe('Parse', 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.comments, ["Translator comment"]);
+    });
+
+    it('Handles extracted comments', function () {
+        var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/comment.po', 'utf8'));
+        assert.notEqual(po, null);
+        assert.equal(po.items.length, 1);
+
+        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 () {

test/write.js

@@ -38,6 +38,20 @@ describe('Write', function () {
         assertHasLine(str, "msgstr \"Source\"");
     });
 
+    it('write translator comment', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/comment.po', 'utf8');
+        var po = PO.parse(input);
+        var str = po.toString();
+        assertHasLine(str, "# Translator comment");
+    });
+
+    it('write extracted comment', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/comment.po', 'utf8');
+        var po = PO.parse(input);
+        var str = po.toString();
+        assertHasLine(str, '#. Extracted comment');
+    });
+
     describe('msgctxt', function () {
         it('should write context field to file', function () {
             var input = fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8');