Release v1.0.3

Write proper plural msgstr[0]

Gruntfile.coffee

@@ -5,7 +5,7 @@ module.exports = (grunt) ->
     @loadNpmTasks('grunt-contrib-jshint')
     @loadNpmTasks('grunt-contrib-uglify')
     @loadNpmTasks('grunt-contrib-watch')
-    @loadNpmTasks('grunt-jscs-checker')
+    @loadNpmTasks('grunt-jscs')
     @loadNpmTasks('grunt-mocha-cli')
 
     @initConfig
@@ -42,8 +42,6 @@ module.exports = (grunt) ->
             dist:
                 files:
                     'dist/pofile.js': ['lib/po.js']
-                options:
-                    alias: 'lib/po.js:pofile'
 
         uglify:
             dist:

README.md

@@ -81,7 +81,7 @@ po.save('out.po', function (err) {
 
 ### The PO.Item class
 
-The `PO` class exposes the following members:
+The `PO.Item` class exposes the following members:
 
 * `msgid`: The message id.
 * `msgid_plural`: The plural message id (null if absent).

bower.json

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

dist/pofile.js

@@ -1,6 +1,5 @@
-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){
+(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);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.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})({1:[function(require,module,exports){
 var fs = require('fs');
-var isArray = require('lodash.isarray');
 
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
@@ -8,6 +7,7 @@ function trim(string) {
 
 var PO = function () {
     this.comments = [];
+    this.extractedComments = [];
     this.headers = {};
     this.items = [];
 };
@@ -24,6 +24,11 @@ PO.prototype.toString = function () {
             lines.push('# ' + comment);
         });
     }
+    if (this.extractedComments) {
+        this.extractedComments.forEach(function (comment) {
+            lines.push('#. ' + comment);
+        });
+    }
 
     lines.push('msgid ""');
     lines.push('msgstr ""');
@@ -59,7 +64,17 @@ PO.parse = function (data) {
     data = data.replace(/\r\n/g, '\n');
     var po = new PO();
     var sections = data.split(/\n\n/);
-    var headers = sections.shift();
+    var headers = [];
+    //everything until the first 'msgid ""' is considered header
+    while (sections[0] && (headers.length === 0 || headers[headers.length - 1].indexOf('msgid ""') < 0)) {
+        if (sections[0].match(/msgid "[^"]/)) {
+            //found first real string, adding a dummy header item
+            headers.push('msgid ""');
+        } else {
+            headers.push(sections.shift());
+        }
+    }
+    headers = headers.join('\n');
     var lines = sections.join('\n').split(/\n/);
 
     po.headers = {
@@ -87,10 +102,11 @@ PO.parse = function (data) {
         acc.push(line);
         return acc;
     }, []).forEach(function (header) {
-        if (header.match(/^#/)) {
+        if (header.match(/^#\./)) {
+            po.extractedComments.push(header.replace(/^#\.\s*/, ''));
+        } else if (header.match(/^#/)) {
             po.comments.push(header.replace(/^#\s*/, ''));
-        }
-        if (header.match(/^"/)) {
+        } else if (header.match(/^"/)) {
             header = header.trim().replace(/^"/, '').replace(/\\n"$/, '');
             var p = header.split(/:/);
             var name = p.shift().trim();
@@ -290,7 +306,9 @@ PO.Item.prototype.toString = function () {
         lines.push('#: ' + ref);
     });
 
-    var flags = Object.keys(this.flags);
+    var flags = Object.keys(this.flags).filter(function (flag) {
+        return !!this.flags[flag];
+    }, this);
     if (flags.length > 0) {
         lines.push('#, ' + flags.join(','));
     }
@@ -299,13 +317,16 @@ PO.Item.prototype.toString = function () {
     ['msgctxt', 'msgid', 'msgid_plural', 'msgstr'].forEach(function (keyword) {
         var text = self[keyword];
         if (text != null) {
-            if (isArray(text) && text.length > 1) {
+            if (Array.isArray(text) && text.length > 1) {
                 text.forEach(function (t, i) {
                     lines = lines.concat(mkObsolete + _process(keyword, t, i));
                 });
             } else {
-                text = isArray(text) ? text.join() : text;
-                var processed = _process(keyword, text);
+                var index = (self.msgid_plural && Array.isArray(text)) ?
+                    0 :
+                    undefined;
+                text = Array.isArray(text) ? text.join() : text;
+                var processed = _process(keyword, text, index);
                 //handle \n in single-line texts (can not be handled in _escape)
                 for (var i = 1; i < processed.length - 1; i++) {
                     processed[i] = processed[i].slice(0, -1) + '\\n"';
@@ -320,91 +341,6 @@ PO.Item.prototype.toString = function () {
 
 module.exports = PO;
 
-},{"fs":3,"lodash.isarray":4}],"pofile":[function(require,module,exports){
-module.exports=require('W8CkM0');
-},{}],3:[function(require,module,exports){
+},{"fs":2}],2:[function(require,module,exports){
 
-},{}],4:[function(require,module,exports){
-/**
- * Lo-Dash 2.4.1 (Custom Build) <http://lodash.com/>
- * Build: `lodash modularize modern exports="npm" -o ./npm/`
- * Copyright 2012-2013 The Dojo Foundation <http://dojofoundation.org/>
- * Based on Underscore.js 1.5.2 <http://underscorejs.org/LICENSE>
- * Copyright 2009-2013 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
- * Available under MIT license <http://lodash.com/license>
- */
-var isNative = require('lodash._isnative');
-
-/** `Object#toString` result shortcuts */
-var arrayClass = '[object Array]';
-
-/** Used for native method references */
-var objectProto = Object.prototype;
-
-/** Used to resolve the internal [[Class]] of values */
-var toString = objectProto.toString;
-
-/* Native method shortcuts for methods with the same name as other `lodash` methods */
-var nativeIsArray = isNative(nativeIsArray = Array.isArray) && nativeIsArray;
-
-/**
- * Checks if `value` is an array.
- *
- * @static
- * @memberOf _
- * @type Function
- * @category Objects
- * @param {*} value The value to check.
- * @returns {boolean} Returns `true` if the `value` is an array, else `false`.
- * @example
- *
- * (function() { return _.isArray(arguments); })();
- * // => false
- *
- * _.isArray([1, 2, 3]);
- * // => true
- */
-var isArray = nativeIsArray || function(value) {
-  return value && typeof value == 'object' && typeof value.length == 'number' &&
-    toString.call(value) == arrayClass || false;
-};
-
-module.exports = isArray;
-
-},{"lodash._isnative":5}],5:[function(require,module,exports){
-/**
- * Lo-Dash 2.4.1 (Custom Build) <http://lodash.com/>
- * Build: `lodash modularize modern exports="npm" -o ./npm/`
- * Copyright 2012-2013 The Dojo Foundation <http://dojofoundation.org/>
- * Based on Underscore.js 1.5.2 <http://underscorejs.org/LICENSE>
- * Copyright 2009-2013 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
- * Available under MIT license <http://lodash.com/license>
- */
-
-/** Used for native method references */
-var objectProto = Object.prototype;
-
-/** Used to resolve the internal [[Class]] of values */
-var toString = objectProto.toString;
-
-/** Used to detect if a method is native */
-var reNative = RegExp('^' +
-  String(toString)
-    .replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
-    .replace(/toString| for [^\]]+/g, '.*?') + '$'
-);
-
-/**
- * Checks if `value` is a native function.
- *
- * @private
- * @param {*} value The value to check.
- * @returns {boolean} Returns `true` if the `value` is a native function, else `false`.
- */
-function isNative(value) {
-  return typeof value == 'function' && reNative.test(value);
-}
-
-module.exports = isNative;
-
-},{}]},{},["W8CkM0"])
+},{}]},{},[1]);

lib/po.js

@@ -1,5 +1,4 @@
 var fs = require('fs');
-var isArray = require('lodash.isarray');
 
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
@@ -7,6 +6,7 @@ function trim(string) {
 
 var PO = function () {
     this.comments = [];
+    this.extractedComments = [];
     this.headers = {};
     this.items = [];
 };
@@ -23,6 +23,11 @@ PO.prototype.toString = function () {
             lines.push('# ' + comment);
         });
     }
+    if (this.extractedComments) {
+        this.extractedComments.forEach(function (comment) {
+            lines.push('#. ' + comment);
+        });
+    }
 
     lines.push('msgid ""');
     lines.push('msgstr ""');
@@ -58,7 +63,17 @@ PO.parse = function (data) {
     data = data.replace(/\r\n/g, '\n');
     var po = new PO();
     var sections = data.split(/\n\n/);
-    var headers = sections.shift();
+    var headers = [];
+    //everything until the first 'msgid ""' is considered header
+    while (sections[0] && (headers.length === 0 || headers[headers.length - 1].indexOf('msgid ""') < 0)) {
+        if (sections[0].match(/msgid "[^"]/)) {
+            //found first real string, adding a dummy header item
+            headers.push('msgid ""');
+        } else {
+            headers.push(sections.shift());
+        }
+    }
+    headers = headers.join('\n');
     var lines = sections.join('\n').split(/\n/);
 
     po.headers = {
@@ -86,10 +101,11 @@ PO.parse = function (data) {
         acc.push(line);
         return acc;
     }, []).forEach(function (header) {
-        if (header.match(/^#/)) {
+        if (header.match(/^#\./)) {
+            po.extractedComments.push(header.replace(/^#\.\s*/, ''));
+        } else if (header.match(/^#/)) {
             po.comments.push(header.replace(/^#\s*/, ''));
-        }
-        if (header.match(/^"/)) {
+        } else if (header.match(/^"/)) {
             header = header.trim().replace(/^"/, '').replace(/\\n"$/, '');
             var p = header.split(/:/);
             var name = p.shift().trim();
@@ -289,7 +305,9 @@ PO.Item.prototype.toString = function () {
         lines.push('#: ' + ref);
     });
 
-    var flags = Object.keys(this.flags);
+    var flags = Object.keys(this.flags).filter(function (flag) {
+        return !!this.flags[flag];
+    }, this);
     if (flags.length > 0) {
         lines.push('#, ' + flags.join(','));
     }
@@ -298,13 +316,16 @@ PO.Item.prototype.toString = function () {
     ['msgctxt', 'msgid', 'msgid_plural', 'msgstr'].forEach(function (keyword) {
         var text = self[keyword];
         if (text != null) {
-            if (isArray(text) && text.length > 1) {
+            if (Array.isArray(text) && text.length > 1) {
                 text.forEach(function (t, i) {
                     lines = lines.concat(mkObsolete + _process(keyword, t, i));
                 });
             } else {
-                text = isArray(text) ? text.join() : text;
-                var processed = _process(keyword, text);
+                var index = (self.msgid_plural && Array.isArray(text)) ?
+                    0 :
+                    undefined;
+                text = Array.isArray(text) ? text.join() : text;
+                var processed = _process(keyword, text, index);
                 //handle \n in single-line texts (can not be handled in _escape)
                 for (var i = 1; i < processed.length - 1; i++) {
                     processed[i] = processed[i].slice(0, -1) + '\\n"';

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pofile",
   "description": "Parse and serialize Gettext PO files.",
-  "version": "0.2.12",
+  "version": "1.0.3",
   "author": {
     "name": "Ruben Vermeersch",
     "email": "ruben@savanne.be",
@@ -35,18 +35,16 @@
     "test": "test"
   },
   "devDependencies": {
-    "browserify": "~3.11.1",
-    "grunt": "~0.4.2",
-    "grunt-browserify": "~1.3.0",
-    "grunt-bump": "0.0.13",
-    "grunt-contrib-clean": "~0.5.0",
-    "grunt-contrib-jshint": "~0.7.2",
-    "grunt-contrib-uglify": "~0.2.7",
-    "grunt-contrib-watch": "~0.5.3",
-    "grunt-jscs-checker": "^0.5.1",
-    "grunt-mocha-cli": "~1.4.0"
+    "browserify": "~14.0.0",
+    "grunt": "~1.0.1",
+    "grunt-browserify": "~5.0.0",
+    "grunt-bump": "0.8.0",
+    "grunt-contrib-clean": "~1.0.0",
+    "grunt-contrib-jshint": "~1.1.0",
+    "grunt-contrib-uglify": "~2.1.0",
+    "grunt-contrib-watch": "~1.0.0",
+    "grunt-jscs": "~3.0.1",
+    "grunt-mocha-cli": "~3.0.0"
   },
-  "dependencies": {
-    "lodash.isarray": "~2.4.1"
-  }
+  "dependencies": {}
 }

test/fixtures/big.po

@@ -1,4 +1,5 @@
 # French translation of Link (6.x-2.9)
+
 # Copyright (c) 2011 by the French translation team
 #
 msgid ""

test/fixtures/comment.po

@@ -1,6 +1,7 @@
 # French translation of Link (6.x-2.9)
 # Copyright (c) 2011 by the French translation team
 #
+#. extracted from test
 msgid ""
 msgstr ""
 "Project-Id-Version: Link (6.x-2.9)\n"

test/fixtures/no_header.po

@@ -0,0 +1,8 @@
+# some comment
+
+msgid "First id, no header"
+msgstr ""
+
+msgid "A second string"
+msgstr ""
+

test/fixtures/plural.po

@@ -0,0 +1,32 @@
+# French translation of Link (6.x-2.9)
+# Copyright (c) 2011 by the French translation team
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Link (6.x-2.9)\n"
+"POT-Creation-Date: 2011-12-31 23:39+0000\n"
+"PO-Revision-Date: 2013-12-17 14:59+0100\n"
+"Language-Team: French\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+"Last-Translator: Ruben Vermeersch <ruben@rocketeer.be>\n"
+"Language: fr\n"
+"X-Generator: Poedit 1.6.2\n"
+
+# correct plurals, with translation
+msgid "1 source"
+msgid_plural "{{$count}} sources"
+msgstr[0] "1 source"
+msgstr[1] "{{$count}} sources"
+
+# correct plurals, with no translation
+msgid "1 destination"
+msgid_plural "{{$count}} destinations"
+msgstr[0] ""
+
+# incorrect plurals, with no translation
+msgid "1 mistake"
+msgid_plural "{{$count}} mistakes"
+msgstr ""

test/fixtures/reference.po

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

test/headers.js

@@ -28,3 +28,46 @@ describe('Headers', function () {
         assert.equal(Object.keys(po.headers).length, 12);
     });
 });
+
+describe('PO files with no headers', function () {
+
+    it('Parses an empty string', function () {
+        var po = PO.parse('');
+        assert.notEqual(po, null);
+        // all headers should be empty
+        for (var key in po.headers) {
+            assert.equal(po.headers[key], '');
+        }
+        assert.equal(po.items.length, 0);
+    });
+
+    it('Parses a minimal example', function () {
+        var po = PO.parse('msgid "minimal PO"\nmsgstr ""');
+        assert.notEqual(po, null);
+        // all headers should be empty
+        for (var key in po.headers) {
+            assert.equal(po.headers[key], '');
+        }
+        assert.equal(po.items.length, 1);
+    });
+
+    describe('advanced example', function () {
+        var po;
+
+        before(function (done) {
+            PO.load(__dirname + '/fixtures/no_header.po', function (err, result) {
+                assert.equal(err, null);
+                po = result;
+                done();
+            });
+        });
+
+        it('Parses the po file', function () {
+            assert.notEqual(po, null);
+        });
+
+        it('Finds all items', function () {
+            assert.equal(po.items.length, 2);
+        });
+    });
+});

test/parse.js

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

test/write.js

@@ -16,6 +16,35 @@ function assertHasLine(str, line) {
     assert(found, 'Could not find line: ' + line);
 }
 
+function assertHasContiguousLines(str, assertedLines) {
+    var assertedLinesJoined = assertedLines.join('\n');
+
+    var trimmedStr = str
+        .split('\n')
+        .map(function (line) {
+            return line.trim();
+        })
+        .join('\n');
+
+    var found = trimmedStr.indexOf(assertedLinesJoined) !== -1;
+
+    assert(found, 'Could not find lines: \n' + assertedLinesJoined);
+}
+
+function assertDoesntHaveLine(str, line) {
+    var lines = str.split('\n');
+    var found = false;
+
+    for (var i = 0; i < lines.length; i++) {
+        if (lines[i].trim() === line) {
+            found = true;
+            break;
+        }
+    }
+
+    assert(!found, 'Shouldn\'t have line: ' + line);
+}
+
 describe('Write', function () {
     it('write flags', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
@@ -24,6 +53,17 @@ describe('Write', function () {
         assertHasLine(str, '#, fuzzy');
     });
 
+    it('write flags only when true', function () {
+        var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
+        var po = PO.parse(input);
+
+        // Flip flag
+        po.items[0].flags.fuzzy = false;
+
+        var str = po.toString();
+        assertDoesntHaveLine(str, '#, fuzzy');
+    });
+
     it('write msgid', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/fuzzy.po', 'utf8');
         var po = PO.parse(input);
@@ -49,6 +89,7 @@ describe('Write', function () {
         var input = fs.readFileSync(__dirname + '/fixtures/comment.po', 'utf8');
         var po = PO.parse(input);
         var str = po.toString();
+        assertHasLine(str, '#. extracted from test');
         assertHasLine(str, '#. Extracted comment');
     });
 
@@ -77,6 +118,38 @@ describe('Write', function () {
         assertHasLine(str, '#~ msgstr "also not sure"');
     });
 
+    describe('plurals', function () {
+        it('should write multiple msgstrs', function () {
+            var input = fs.readFileSync(__dirname + '/fixtures/plural.po', 'utf8');
+            var po = PO.parse(input);
+            var str = po.toString();
+            assertHasContiguousLines(str, [
+                'msgstr[0] "1 source"',
+                'msgstr[1] "{{$count}} sources"'
+            ]);
+        });
+
+        it('should write msgstr[0] when there is no translation', function () {
+            var input = fs.readFileSync(__dirname + '/fixtures/plural.po', 'utf8');
+            var po = PO.parse(input);
+            var str = po.toString();
+            assertHasContiguousLines(str, [
+                'msgid_plural "{{$count}} destinations"',
+                'msgstr[0] ""'
+            ]);
+        });
+
+        it('should write msgstr[0] when there is no translation and empty plural translation is stored in msgstr ""', function () {
+            var input = fs.readFileSync(__dirname + '/fixtures/plural.po', 'utf8');
+            var po = PO.parse(input);
+            var str = po.toString();
+            assertHasContiguousLines(str, [
+                'msgid_plural "{{$count}} mistakes"',
+                'msgstr[0] ""'
+            ]);
+        });
+    });
+
     describe('C-Strings', function () {
         it('should escape "', function () {
             var item = new PO.Item();