Release v0.2.9

Fix commented obsolete strings

.jscs.json

@@ -0,0 +1,34 @@
+{
+    "requireCurlyBraces": ["if", "else", "for", "while", "do", "try", "catch"],
+    "requireSpaceAfterKeywords": ["if", "else", "for", "while", "do", "switch", "return", "try", "catch"],
+    "requireParenthesesAroundIIFE": true,
+    "requireSpacesInFunctionExpression": {
+        "beforeOpeningCurlyBrace": true
+    },
+    "requireSpacesInAnonymousFunctionExpression": {
+        "beforeOpeningRoundBrace": true
+    },
+    "disallowSpacesInNamedFunctionExpression": {
+        "beforeOpeningRoundBrace": true
+    },
+    "disallowSpacesInFunctionDeclaration": {
+        "beforeOpeningRoundBrace": true
+    },
+    "disallowMultipleVarDecl": true,
+    "requireSpacesInsideObjectBrackets": "all",
+    "disallowSpaceAfterObjectKeys": true,
+    "requireCommaBeforeLineBreak": true,
+    "disallowSpaceBeforeBinaryOperators": [","],
+    "disallowSpaceAfterPrefixUnaryOperators": ["++", "--", "+", "-", "~", "!"],
+    "disallowSpaceBeforePostfixUnaryOperators": ["++", "--"],
+    "requireSpaceBeforeBinaryOperators": ["+", "-", "/", "*", "=", "==", "===", "!=", "!==", ">", ">=", "<", "<="],
+    "requireSpaceAfterBinaryOperators": [",", "+", "-", "/", "*", "=", "==", "===", "!=", "!==", ">", ">=", "<", "<="],
+    "validateQuoteMarks": true,
+    "validateIndentation": 4,
+    "disallowTrailingWhitespace": true,
+    "disallowKeywordsOnNewLine": ["else"],
+    "requireCapitalizedConstructors": true,
+    "safeContextKeyword": "self",
+    "requireDotNotation": true,
+    "disallowYodaConditions": true
+}

.travis.yml

@@ -1,6 +1,5 @@
 language: node_js
 node_js:
-  - "0.8"
   - "0.10"
   - "0.11"
 before_install:

Gruntfile.coffee

@@ -5,6 +5,7 @@ module.exports = (grunt) ->
     @loadNpmTasks('grunt-contrib-jshint')
     @loadNpmTasks('grunt-contrib-uglify')
     @loadNpmTasks('grunt-contrib-watch')
+    @loadNpmTasks('grunt-jscs-checker')
     @loadNpmTasks('grunt-mocha-cli')
 
     @initConfig
@@ -16,6 +17,13 @@ module.exports = (grunt) ->
             options:
                 jshintrc: '.jshintrc'
 
+        jscs:
+            src:
+                options:
+                    config: '.jscs.json'
+                files:
+                    src: [ 'lib/*.js', 'test/*.js' ]
+
         watch:
             all:
                 options:
@@ -49,5 +57,5 @@ module.exports = (grunt) ->
                 pushTo: 'origin'
 
     @registerTask 'default', ['test']
-    @registerTask 'build', ['clean', 'jshint', 'browserify', 'uglify']
+    @registerTask 'build', ['clean', 'jshint', 'jscs', 'browserify', 'uglify']
     @registerTask 'test', ['build', 'mochacli']

bower.json

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

dist/pofile.js

@@ -1,6 +1,6 @@
 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'),
-    isArray = require('lodash.isarray');
+var fs = require('fs');
+var isArray = require('lodash.isarray');
 
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
@@ -17,8 +17,7 @@ PO.prototype.save = function (filename, callback) {
 };
 
 PO.prototype.toString = function () {
-    var lines = [],
-        that = this;
+    var lines = [];
 
     if (this.comments) {
         this.comments.forEach(function (comment) {
@@ -30,8 +29,9 @@ PO.prototype.toString = function () {
     lines.push('msgstr ""');
 
     var keys = Object.keys(this.headers);
+    var self = this;
     keys.forEach(function (key) {
-        lines.push('"' + key + ': ' + that.headers[key] + '\\n"');
+        lines.push('"' + key + ': ' + self.headers[key] + '\\n"');
     });
 
     lines.push('');
@@ -41,7 +41,7 @@ PO.prototype.toString = function () {
         lines.push('');
     });
 
-    return lines.join("\n");
+    return lines.join('\n');
 };
 
 PO.load = function (filename, callback) {
@@ -57,10 +57,10 @@ PO.load = function (filename, callback) {
 PO.parse = function (data) {
     //support both unix and windows newline formats.
     data = data.replace(/\r\n/g, '\n');
-    var po = new PO(),
-        sections = data.split(/\n\n/),
-        headers = sections.shift(),
-        lines = sections.join("\n").split(/\n/);
+    var po = new PO();
+    var sections = data.split(/\n\n/);
+    var headers = sections.shift();
+    var lines = sections.join('\n').split(/\n/);
 
     po.headers = {
         'Project-Id-Version': '',
@@ -75,25 +75,43 @@ 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*/, ''));
         }
         if (header.match(/^"/)) {
             header = header.trim().replace(/^"/, '').replace(/\\n"$/, '');
-            var p = header.split(/:/),
-                name = p.shift().trim(),
-                value = p.join(':').trim();
+            var p = header.split(/:/);
+            var name = p.shift().trim();
+            var value = p.join(':').trim();
             po.headers[name] = value;
         }
     });
 
-    var item = new PO.Item(),
-        context = null,
-        plural = 0;
+    var item = new PO.Item();
+    var context = null;
+    var plural = 0;
+    var obsoleteCount = 0;
+    var noCommentLineCount = 0;
 
     function finish() {
         if (item.msgid.length > 0) {
+            if (obsoleteCount >= noCommentLineCount) {
+                item.obsolete = true;
+            }
+            obsoleteCount = 0;
+            noCommentLineCount = 0;
             po.items.push(item);
             item = new PO.Item();
         }
@@ -108,59 +126,69 @@ PO.parse = function (data) {
     }
 
     while (lines.length > 0) {
-        var line = trim(lines.shift()),
-            add = false;
+        var line = trim(lines.shift());
+        var lineObsolete = false;
+        var add = false;
+
+        if (line.match(/^#\~/)) { // Obsolete item
+            //only remove the obsolte comment mark, here
+            //might be, this is a new item, so
+            //only remember, this line is marked obsolete, count after line is parsed
+            line = trim(line.substring(2));
+            lineObsolete = true;
+        }
+
         if (line.match(/^#:/)) { // Reference
             finish();
             item.references.push(trim(line.replace(/^#:/, '')));
-        }
-        else if (line.match(/^#,/)) { // Flags
+        } else if (line.match(/^#,/)) { // Flags
             finish();
-            var flags = trim(line.replace(/^#,/, '')).split(",");
+            var flags = trim(line.replace(/^#,/, '')).split(',');
             for (var i = 0; i < flags.length; i++) {
                 item.flags[flags[i]] = true;
             }
-        }
-        else if (line.match(/^#\s+/)) { // Translator comment
+        } else if (line.match(/^#\s+/)) { // Translator comment
             finish();
             item.comments.push(trim(line.replace(/^#\s+/, '')));
-        }
-        else if (line.match(/^#\./)) { // Extracted comment
+        } else if (line.match(/^#\./)) { // Extracted comment
             finish();
             item.extractedComments.push(trim(line.replace(/^#\./, '')));
-        }
-        else if (line.match(/^msgid_plural/)) { // Plural form
+        } else if (line.match(/^msgid_plural/)) { // Plural form
             item.msgid_plural = extract(line);
             context = 'msgid_plural';
-        }
-        else if (line.match(/^msgid/)) { // Original
+            noCommentLineCount++;
+        } else if (line.match(/^msgid/)) { // Original
             finish();
             item.msgid = extract(line);
             context = 'msgid';
-        }
-        else if (line.match(/^msgstr/)) { // Translation
+            noCommentLineCount++;
+        } else if (line.match(/^msgstr/)) { // Translation
             var m = line.match(/^msgstr\[(\d+)\]/);
             plural = m && m[1] ? parseInt(m[1]) : 0;
             item.msgstr[plural] = extract(line);
             context = 'msgstr';
-        }
-        else if (line.match(/^msgctxt/)) { // Context
+            noCommentLineCount++;
+        } else if (line.match(/^msgctxt/)) { // Context
             finish();
             item.msgctxt = extract(line);
-        }
-        else { // Probably multiline string or blank
+            noCommentLineCount++;
+        } else { // Probably multiline string or blank
             if (line.length > 0) {
+                noCommentLineCount++;
                 if (context === 'msgstr') {
                     item.msgstr[plural] += extract(line);
-                }
-                else if (context === 'msgid') {
+                } else if (context === 'msgid') {
                     item.msgid += extract(line);
-                }
-                else if (context === 'msgid_plural') {
+                } else if (context === 'msgid_plural') {
                     item.msgid_plural += extract(line);
                 }
             }
         }
+
+        if (lineObsolete) {
+            // Count obsolete lines for this item
+            obsoleteCount++;
+        }
     }
     finish();
 
@@ -176,11 +204,12 @@ PO.Item = function () {
     this.comments = []; // translator comments
     this.extractedComments = [];
     this.flags = {};
+    this.obsolete = false;
 };
 
 PO.Item.prototype.toString = function () {
-    var lines = [],
-        that = this;
+    var lines = [];
+    var self = this;
 
     // reverse what extract(string) method during PO.parse does
     var _escape = function (string) {
@@ -189,16 +218,15 @@ PO.Item.prototype.toString = function () {
     };
 
     var _process = function (keyword, text, i) {
-        var lines = [],
-            parts = text.split(/\n/),
-            index = typeof i !== 'undefined' ? '[' + i + ']' : '';
+        var lines = [];
+        var parts = text.split(/\n/);
+        var index = typeof i !== 'undefined' ? '[' + i + ']' : '';
         if (parts.length > 1) {
             lines.push(keyword + index + ' ""');
             parts.forEach(function (part) {
                 lines.push('"' + _escape(part) + '"');
             });
-        }
-        else {
+        } else {
             lines.push(keyword + index + ' "' + _escape(text) + '"');
         }
         return lines;
@@ -207,45 +235,39 @@ 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) {
-            lines.push('# ' + c);
-        });
-    }
+    this.comments.forEach(function (c) {
+        lines.push('# ' + c);
+    });
 
-    if (this.extractedComments.length > 0) {
-        this.extractedComments.forEach(function (c) {
-            lines.push('#. ' + c);
-        });
-    }
+    this.extractedComments.forEach(function (c) {
+        lines.push('#. ' + c);
+    });
 
-    if (this.references.length > 0) {
-        this.references.forEach(function (ref) {
-            lines.push('#: ' + ref);
-        });
-    }
+    this.references.forEach(function (ref) {
+        lines.push('#: ' + ref);
+    });
 
     var flags = Object.keys(this.flags);
     if (flags.length > 0) {
-        lines.push('#, ' + flags.join(","));
+        lines.push('#, ' + flags.join(','));
     }
+    var mkObsolete = this.obsolete ? '#~ ' : '';
 
     ['msgctxt', 'msgid', 'msgid_plural', 'msgstr'].forEach(function (keyword) {
-        var text = that[keyword];
+        var text = self[keyword];
         if (text != null) {
             if (isArray(text) && text.length > 1) {
                 text.forEach(function (t, i) {
-                    lines = lines.concat(_process(keyword, t, i));
+                    lines = lines.concat(mkObsolete + _process(keyword, t, i));
                 });
-            }
-            else {
+            } else {
                 text = isArray(text) ? text.join() : text;
-                lines = lines.concat(_process(keyword, text));
+                lines = lines.concat(mkObsolete + _process(keyword, text));
             }
         }
     });
 
-    return lines.join("\n");
+    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=[];this.comments&&this.comments.forEach(function(b){a.push("# "+b)}),a.push('msgid ""'),a.push('msgstr ""');var b=Object.keys(this.headers),c=this;return b.forEach(function(b){a.push('"'+b+": "+c.headers[b]+'\\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&&(m>=n&&(j.obsolete=!0),m=0,n=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/).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=0,n=0;i.length>0;){var o=c(i.shift()),p=!1;if(o.match(/^#\~/)&&(o=c(o.substring(2)),p=!0),o.match(/^#:/))b(),j.references.push(c(o.replace(/^#:/,"")));else if(o.match(/^#,/)){b();for(var q=c(o.replace(/^#,/,"")).split(","),r=0;r<q.length;r++)j.flags[q[r]]=!0}else if(o.match(/^#\s+/))b(),j.comments.push(c(o.replace(/^#\s+/,"")));else if(o.match(/^#\./))b(),j.extractedComments.push(c(o.replace(/^#\./,"")));else if(o.match(/^msgid_plural/))j.msgid_plural=d(o),k="msgid_plural",n++;else if(o.match(/^msgid/))b(),j.msgid=d(o),k="msgid",n++;else if(o.match(/^msgstr/)){var s=o.match(/^msgstr\[(\d+)\]/);l=s&&s[1]?parseInt(s[1]):0,j.msgstr[l]=d(o),k="msgstr",n++}else o.match(/^msgctxt/)?(b(),j.msgctxt=d(o),n++):o.length>0&&(n++,"msgstr"===k?j.msgstr[l]+=d(o):"msgid"===k?j.msgid+=d(o):"msgid_plural"===k&&(j.msgid_plural+=d(o)));p&&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={},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);f.length>0&&a.push("#, "+f.join(","));var g=this.obsolete?"#~ ":"";return["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(g+d(c,b,e))}):(f=e(f)?f.join():f,a=a.concat(g+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

@@ -1,5 +1,5 @@
-var fs = require('fs'),
-    isArray = require('lodash.isarray');
+var fs = require('fs');
+var isArray = require('lodash.isarray');
 
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
@@ -16,8 +16,7 @@ PO.prototype.save = function (filename, callback) {
 };
 
 PO.prototype.toString = function () {
-    var lines = [],
-        that = this;
+    var lines = [];
 
     if (this.comments) {
         this.comments.forEach(function (comment) {
@@ -29,8 +28,9 @@ PO.prototype.toString = function () {
     lines.push('msgstr ""');
 
     var keys = Object.keys(this.headers);
+    var self = this;
     keys.forEach(function (key) {
-        lines.push('"' + key + ': ' + that.headers[key] + '\\n"');
+        lines.push('"' + key + ': ' + self.headers[key] + '\\n"');
     });
 
     lines.push('');
@@ -40,7 +40,7 @@ PO.prototype.toString = function () {
         lines.push('');
     });
 
-    return lines.join("\n");
+    return lines.join('\n');
 };
 
 PO.load = function (filename, callback) {
@@ -56,10 +56,10 @@ PO.load = function (filename, callback) {
 PO.parse = function (data) {
     //support both unix and windows newline formats.
     data = data.replace(/\r\n/g, '\n');
-    var po = new PO(),
-        sections = data.split(/\n\n/),
-        headers = sections.shift(),
-        lines = sections.join("\n").split(/\n/);
+    var po = new PO();
+    var sections = data.split(/\n\n/);
+    var headers = sections.shift();
+    var lines = sections.join('\n').split(/\n/);
 
     po.headers = {
         'Project-Id-Version': '',
@@ -74,25 +74,43 @@ 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*/, ''));
         }
         if (header.match(/^"/)) {
             header = header.trim().replace(/^"/, '').replace(/\\n"$/, '');
-            var p = header.split(/:/),
-                name = p.shift().trim(),
-                value = p.join(':').trim();
+            var p = header.split(/:/);
+            var name = p.shift().trim();
+            var value = p.join(':').trim();
             po.headers[name] = value;
         }
     });
 
-    var item = new PO.Item(),
-        context = null,
-        plural = 0;
+    var item = new PO.Item();
+    var context = null;
+    var plural = 0;
+    var obsoleteCount = 0;
+    var noCommentLineCount = 0;
 
     function finish() {
         if (item.msgid.length > 0) {
+            if (obsoleteCount >= noCommentLineCount) {
+                item.obsolete = true;
+            }
+            obsoleteCount = 0;
+            noCommentLineCount = 0;
             po.items.push(item);
             item = new PO.Item();
         }
@@ -107,59 +125,69 @@ PO.parse = function (data) {
     }
 
     while (lines.length > 0) {
-        var line = trim(lines.shift()),
-            add = false;
+        var line = trim(lines.shift());
+        var lineObsolete = false;
+        var add = false;
+
+        if (line.match(/^#\~/)) { // Obsolete item
+            //only remove the obsolte comment mark, here
+            //might be, this is a new item, so
+            //only remember, this line is marked obsolete, count after line is parsed
+            line = trim(line.substring(2));
+            lineObsolete = true;
+        }
+
         if (line.match(/^#:/)) { // Reference
             finish();
             item.references.push(trim(line.replace(/^#:/, '')));
-        }
-        else if (line.match(/^#,/)) { // Flags
+        } else if (line.match(/^#,/)) { // Flags
             finish();
-            var flags = trim(line.replace(/^#,/, '')).split(",");
+            var flags = trim(line.replace(/^#,/, '')).split(',');
             for (var i = 0; i < flags.length; i++) {
                 item.flags[flags[i]] = true;
             }
-        }
-        else if (line.match(/^#\s+/)) { // Translator comment
+        } else if (line.match(/^#\s+/)) { // Translator comment
             finish();
             item.comments.push(trim(line.replace(/^#\s+/, '')));
-        }
-        else if (line.match(/^#\./)) { // Extracted comment
+        } else if (line.match(/^#\./)) { // Extracted comment
             finish();
             item.extractedComments.push(trim(line.replace(/^#\./, '')));
-        }
-        else if (line.match(/^msgid_plural/)) { // Plural form
+        } else if (line.match(/^msgid_plural/)) { // Plural form
             item.msgid_plural = extract(line);
             context = 'msgid_plural';
-        }
-        else if (line.match(/^msgid/)) { // Original
+            noCommentLineCount++;
+        } else if (line.match(/^msgid/)) { // Original
             finish();
             item.msgid = extract(line);
             context = 'msgid';
-        }
-        else if (line.match(/^msgstr/)) { // Translation
+            noCommentLineCount++;
+        } else if (line.match(/^msgstr/)) { // Translation
             var m = line.match(/^msgstr\[(\d+)\]/);
             plural = m && m[1] ? parseInt(m[1]) : 0;
             item.msgstr[plural] = extract(line);
             context = 'msgstr';
-        }
-        else if (line.match(/^msgctxt/)) { // Context
+            noCommentLineCount++;
+        } else if (line.match(/^msgctxt/)) { // Context
             finish();
             item.msgctxt = extract(line);
-        }
-        else { // Probably multiline string or blank
+            noCommentLineCount++;
+        } else { // Probably multiline string or blank
             if (line.length > 0) {
+                noCommentLineCount++;
                 if (context === 'msgstr') {
                     item.msgstr[plural] += extract(line);
-                }
-                else if (context === 'msgid') {
+                } else if (context === 'msgid') {
                     item.msgid += extract(line);
-                }
-                else if (context === 'msgid_plural') {
+                } else if (context === 'msgid_plural') {
                     item.msgid_plural += extract(line);
                 }
             }
         }
+
+        if (lineObsolete) {
+            // Count obsolete lines for this item
+            obsoleteCount++;
+        }
     }
     finish();
 
@@ -175,11 +203,12 @@ PO.Item = function () {
     this.comments = []; // translator comments
     this.extractedComments = [];
     this.flags = {};
+    this.obsolete = false;
 };
 
 PO.Item.prototype.toString = function () {
-    var lines = [],
-        that = this;
+    var lines = [];
+    var self = this;
 
     // reverse what extract(string) method during PO.parse does
     var _escape = function (string) {
@@ -188,16 +217,15 @@ PO.Item.prototype.toString = function () {
     };
 
     var _process = function (keyword, text, i) {
-        var lines = [],
-            parts = text.split(/\n/),
-            index = typeof i !== 'undefined' ? '[' + i + ']' : '';
+        var lines = [];
+        var parts = text.split(/\n/);
+        var index = typeof i !== 'undefined' ? '[' + i + ']' : '';
         if (parts.length > 1) {
             lines.push(keyword + index + ' ""');
             parts.forEach(function (part) {
                 lines.push('"' + _escape(part) + '"');
             });
-        }
-        else {
+        } else {
             lines.push(keyword + index + ' "' + _escape(text) + '"');
         }
         return lines;
@@ -206,45 +234,39 @@ 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) {
-            lines.push('# ' + c);
-        });
-    }
+    this.comments.forEach(function (c) {
+        lines.push('# ' + c);
+    });
 
-    if (this.extractedComments.length > 0) {
-        this.extractedComments.forEach(function (c) {
-            lines.push('#. ' + c);
-        });
-    }
+    this.extractedComments.forEach(function (c) {
+        lines.push('#. ' + c);
+    });
 
-    if (this.references.length > 0) {
-        this.references.forEach(function (ref) {
-            lines.push('#: ' + ref);
-        });
-    }
+    this.references.forEach(function (ref) {
+        lines.push('#: ' + ref);
+    });
 
     var flags = Object.keys(this.flags);
     if (flags.length > 0) {
-        lines.push('#, ' + flags.join(","));
+        lines.push('#, ' + flags.join(','));
     }
+    var mkObsolete = this.obsolete ? '#~ ' : '';
 
     ['msgctxt', 'msgid', 'msgid_plural', 'msgstr'].forEach(function (keyword) {
-        var text = that[keyword];
+        var text = self[keyword];
         if (text != null) {
             if (isArray(text) && text.length > 1) {
                 text.forEach(function (t, i) {
-                    lines = lines.concat(_process(keyword, t, i));
+                    lines = lines.concat(mkObsolete + _process(keyword, t, i));
                 });
-            }
-            else {
+            } else {
                 text = isArray(text) ? text.join() : text;
-                lines = lines.concat(_process(keyword, text));
+                lines = lines.concat(mkObsolete + _process(keyword, text));
             }
         }
     });
 
-    return lines.join("\n");
+    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.9",
   "author": {
     "name": "Ruben Vermeersch",
     "email": "ruben@savanne.be",
@@ -35,15 +35,16 @@
     "test": "test"
   },
   "devDependencies": {
-    "grunt": "~0.4.2",
-    "grunt-contrib-watch": "~0.5.3",
-    "grunt-contrib-jshint": "~0.7.2",
-    "grunt-mocha-cli": "~1.4.0",
-    "grunt-contrib-uglify": "~0.2.7",
     "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-bump": "0.0.13"
+    "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"
   },
   "dependencies": {
     "lodash.isarray": "~2.4.1"

test/fixtures/commented.po

@@ -0,0 +1,33 @@
+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"
+
+#~ # commented obsolete item
+#~ #, fuzzy
+#~ msgid "Commented item"
+#~ msgstr "not sure"
+
+# commented obsolete item
+#, fuzzy
+#~ msgid "Second commented item"
+#~ msgstr "also not sure"

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

@@ -7,31 +7,39 @@ describe('Parse', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/big.po', 'utf8'));
         assert.notEqual(po, null);
         assert.equal(po.items.length, 69);
-        
+
         var item = po.items[0];
-        assert.equal(item.msgid, "Title");
-        assert.equal(item.msgstr, "Titre");
+        assert.equal(item.msgid, 'Title');
+        assert.equal(item.msgstr, 'Titre');
     });
 
     it('Handles multi-line strings', function () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/multi-line.po', 'utf8'));
         assert.notEqual(po, null);
         assert.equal(po.items.length, 1);
-        
+
         var item = po.items[0];
-        assert.equal(item.msgid, "The following placeholder tokens can be used in both paths and titles. When used in a path or title, they will be replaced with the appropriate values.");
-        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.");
+        assert.equal(item.msgid, 'The following placeholder tokens can be used in both paths and titles. When used in a path or title, they will be replaced with the appropriate values.');
+        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);
         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.comments, ["Translator comment"]);
+        assert.equal(item.msgid, 'Title, as plain text');
+        assert.equal(item.msgstr, 'Attribut title, en tant que texte brut');
+        assert.deepEqual(item.comments, ['Translator comment']);
     });
 
     it('Handles extracted comments', function () {
@@ -40,26 +48,26 @@ describe('Parse', function () {
         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"]);
+        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 () {
         var po = PO.parse(fs.readFileSync(__dirname + '/fixtures/reference.po', 'utf8'));
         assert.notEqual(po, null);
         assert.equal(po.items.length, 2);
-        
+
         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"]);
-        
+        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];
-        assert.equal(item.msgid, "X");
-        assert.equal(item.msgstr, "Y");
-        assert.deepEqual(item.references, ["a", "b"]);
+        assert.equal(item.msgid, 'X');
+        assert.equal(item.msgstr, 'Y');
+        assert.deepEqual(item.references, ['a', 'b']);
     });
 
     it('Parses flags', function () {
@@ -68,8 +76,8 @@ describe('Parse', function () {
         assert.equal(po.items.length, 1);
 
         var item = po.items[0];
-        assert.equal(item.msgid, "Sources");
-        assert.equal(item.msgstr, "Source");
+        assert.equal(item.msgid, 'Sources');
+        assert.equal(item.msgstr, 'Source');
         assert.notEqual(item.flags, null);
         assert.equal(item.flags.fuzzy, true);
     });
@@ -85,6 +93,31 @@ 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, 4);
+        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');
+
+        item = po.items[2];
+        assert.equal(item.obsolete, true);
+        assert.equal(item.msgid, 'Commented item');
+        assert.equal(item.msgstr, 'not sure');
+
+        item = po.items[3];
+        assert.equal(item.obsolete, true);
+        assert.equal(item.msgid, 'Second commented item');
+        assert.equal(item.msgstr, 'also not sure');
+    });
+
     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

@@ -3,7 +3,7 @@ var fs = require('fs');
 var PO = require('..');
 
 function assertHasLine(str, line) {
-    var lines = str.split("\n");
+    var lines = str.split('\n');
     var found = false;
 
     for (var i = 0; i < lines.length; i++) {
@@ -13,7 +13,7 @@ function assertHasLine(str, line) {
         }
     }
 
-    assert(found, "Could not find line: " + line);
+    assert(found, 'Could not find line: ' + line);
 }
 
 describe('Write', function () {
@@ -21,28 +21,28 @@ describe('Write', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
         var po = PO.parse(input);
         var str = po.toString();
-        assertHasLine(str, "#, fuzzy");
+        assertHasLine(str, '#, fuzzy');
     });
 
     it('write msgid', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
         var po = PO.parse(input);
         var str = po.toString();
-        assertHasLine(str, "msgid \"Sources\"");
+        assertHasLine(str, 'msgid "Sources"');
     });
 
     it('write msgstr', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
         var po = PO.parse(input);
         var str = po.toString();
-        assertHasLine(str, "msgstr \"Source\"");
+        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");
+        assertHasLine(str, '# Translator comment');
     });
 
     it('write extracted comment', function () {
@@ -52,6 +52,31 @@ 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"');
+    });
+
+    it('write obsolete items with comment', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/commented.po', 'utf8');
+        var po = PO.parse(input);
+        var str = po.toString();
+
+        //this is what msgcat tool of gettext does: don't print #~ for comments
+        assertHasLine(str, '# commented obsolete item');
+        assertHasLine(str, '#, fuzzy');
+
+        //items made obsolete by commenting every keyword with #~
+        assertHasLine(str, '#~ msgid "Commented item"');
+        assertHasLine(str, '#~ msgstr "not sure"');
+        assertHasLine(str, '#~ msgid "Second commented item"');
+        assertHasLine(str, '#~ msgstr "also not sure"');
+    });
+
     describe('C-Strings', function () {
         it('should escape "', function () {
             var item = new PO.Item();