Release v0.2.6

add reverse method of extract(string)

.travis.yml

@@ -3,5 +3,5 @@ node_js:
   - "0.8"
   - "0.10"
   - "0.11"
-before_script:
+before_install:
   - npm install -g grunt-cli

bower.json

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

dist/pofile.js

@@ -182,6 +182,12 @@ PO.Item.prototype.toString = function () {
     var lines = [],
         that = this;
 
+    // reverse what extract(string) method during PO.parse does
+    var _escape = function (string) {
+        string = string.replace(/\\/g, '\\\\');
+        return string.replace(/"/g, '\\"');
+    };
+
     var _process = function (keyword, text, i) {
         var lines = [],
             parts = text.split(/\n/),
@@ -189,11 +195,11 @@ PO.Item.prototype.toString = function () {
         if (parts.length > 1) {
             lines.push(keyword + index + ' ""');
             parts.forEach(function (part) {
-                lines.push('"' + part + '"');
+                lines.push('"' + _escape(part) + '"');
             });
         }
         else {
-            lines.push(keyword + index + ' "' + text + '"');
+            lines.push(keyword + index + ' "' + _escape(text) + '"');
         }
         return lines;
     };

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,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"]);
+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"]);

lib/po.js

@@ -181,6 +181,12 @@ PO.Item.prototype.toString = function () {
     var lines = [],
         that = this;
 
+    // reverse what extract(string) method during PO.parse does
+    var _escape = function (string) {
+        string = string.replace(/\\/g, '\\\\');
+        return string.replace(/"/g, '\\"');
+    };
+
     var _process = function (keyword, text, i) {
         var lines = [],
             parts = text.split(/\n/),
@@ -188,11 +194,11 @@ PO.Item.prototype.toString = function () {
         if (parts.length > 1) {
             lines.push(keyword + index + ' ""');
             parts.forEach(function (part) {
-                lines.push('"' + part + '"');
+                lines.push('"' + _escape(part) + '"');
             });
         }
         else {
-            lines.push(keyword + index + ' "' + text + '"');
+            lines.push(keyword + index + ' "' + _escape(text) + '"');
         }
         return lines;
     };

package.json

@@ -1,15 +1,18 @@
 {
   "name": "pofile",
   "description": "Parse and serialize Gettext PO files.",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "author": {
     "name": "Ruben Vermeersch",
     "email": "ruben@savanne.be",
     "url": "http://savanne.be/"
   },
   "contributors": [
+    "Eyal Lewinsohn",
+    "Gabe Gorelick",
     "Julian Bäume",
-    "Mike Holly"
+    "Mike Holly",
+    "Sander Houttekier"
   ],
   "homepage": "http://github.com/rubenv/pofile",
   "repository": {

test/fixtures/c-strings.po

@@ -0,0 +1,19 @@
+# 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"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2011-12-31 23:39+0000\n"
+"PO-Revision-Date: 2013-12-17 14:59+0100\n"
+"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\n"
+"Language: fr\n"
+"Language-Team: French\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+"MIME-Version: 1.0\n"
+"X-Generator: Poedit 1.6.2\n"
+
+msgid "The name field must not contain characters like \" or \\"
+msgstr ""

test/parse.js

@@ -84,4 +84,21 @@ describe('Parse', function () {
         assert.equal(ambiguousItems[0].msgctxt, 'folder display');
         assert.equal(ambiguousItems[1].msgctxt, 'folder action');
     });
+
+    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'));
+
+            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 \\');
+        });
+    });
 });

test/write.js

@@ -52,6 +52,30 @@ describe('Write', function () {
         assertHasLine(str, '#. Extracted comment');
     });
 
+    describe('C-Strings', function () {
+        it('should escape "', function () {
+            var item = new PO.Item();
+
+            item.msgid = '" should be written escaped';
+            assertHasLine(item.toString(), 'msgid "\\" should be written escaped"');
+        });
+
+        it('shoudl escape \\', function () {
+            var item = new PO.Item();
+
+            item.msgid = '\\ should be written escaped';
+            assertHasLine(item.toString(), 'msgid "\\\\ should be written escaped"');
+        });
+
+        it('should write identical file after parsing a file', function () {
+            var input = fs.readFileSync(__dirname + '/fixtures/c-strings.po', 'utf8');
+            var po = PO.parse(input);
+            var str = po.toString();
+
+            assert.equal(str, input);
+        });
+    });
+
     describe('msgctxt', function () {
         it('should write context field to file', function () {
             var input = fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8');