Release v1.0.4

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
@@ -43,7 +43,8 @@ module.exports = (grunt) ->
                 files:
                     'dist/pofile.js': ['lib/po.js']
                 options:
-                    alias: 'lib/po.js:pofile'
+                    alias:
+                        pofile: './lib/po.js'
 
         uglify:
             dist:

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2013-2014 Ruben Vermeersch
+Copyright (C) 2013-2017 Ruben Vermeersch
 Copyright (C) 2012 Michael Holly
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of

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).
@@ -143,7 +143,7 @@ PO.load('text.po', function (err, po) {
 
     (The MIT License)
 
-    Copyright (C) 2013-2014 by Ruben Vermeersch <ruben@rocketeer.be>
+    Copyright (C) 2013-2017 by Ruben Vermeersch <ruben@rocketeer.be>
     Copyright (C) 2012 by Michael Holly
 
     Permission is hereby granted, free of charge, to any person obtaining a copy

bower.json

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

dist/pofile.js

@@ -1,6 +1,7 @@
-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){
+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);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){
+
+},{}],"pofile":[function(require,module,exports){
 var fs = require('fs');
-var isArray = require('lodash.isarray');
 
 function trim(string) {
     return string.replace(/^\s+|\s+$/g, '');
@@ -65,10 +66,15 @@ 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 (headers[headers.length - 1].indexOf('msgid ""') < 0) {
+    while (sections[0] && (headers.length === 0 || headers[headers.length - 1].indexOf('msgid ""') < 0)) {
-        headers.push(sections.shift());
+        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/);
@@ -313,13 +319,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 index = (self.msgid_plural && Array.isArray(text)) ?
-                var processed = _process(keyword, 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"';
@@ -334,91 +343,4 @@ PO.Item.prototype.toString = function () {
 
 module.exports = PO;
 
-},{"fs":3,"lodash.isarray":4}],"pofile":[function(require,module,exports){
+},{"fs":1}]},{},["pofile"]);
-module.exports=require('W8CkM0');
-},{}],3:[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"])

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, '');
@@ -64,10 +63,15 @@ 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 (headers[headers.length - 1].indexOf('msgid ""') < 0) {
+    while (sections[0] && (headers.length === 0 || headers[headers.length - 1].indexOf('msgid ""') < 0)) {
-        headers.push(sections.shift());
+        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/);
@@ -312,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 index = (self.msgid_plural && Array.isArray(text)) ?
-                var processed = _process(keyword, 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": "1.0.1",
+  "version": "1.0.4",
   "author": {
     "name": "Ruben Vermeersch",
     "email": "ruben@savanne.be",
@@ -35,18 +35,16 @@
     "test": "test"
   },
   "devDependencies": {
-    "browserify": "~3.11.1",
+    "browserify": "~14.0.0",
-    "grunt": "~0.4.2",
+    "grunt": "~1.0.1",
-    "grunt-browserify": "~1.3.0",
+    "grunt-browserify": "~5.0.0",
-    "grunt-bump": "0.0.13",
+    "grunt-bump": "0.8.0",
-    "grunt-contrib-clean": "~0.5.0",
+    "grunt-contrib-clean": "~1.0.0",
-    "grunt-contrib-jshint": "~0.7.2",
+    "grunt-contrib-jshint": "~1.1.0",
-    "grunt-contrib-uglify": "~0.2.7",
+    "grunt-contrib-uglify": "~2.1.0",
-    "grunt-contrib-watch": "~0.5.3",
+    "grunt-contrib-watch": "~1.0.0",
-    "grunt-jscs-checker": "^0.5.1",
+    "grunt-jscs": "~3.0.1",
-    "grunt-mocha-cli": "~1.4.0"
+    "grunt-mocha-cli": "~3.0.0"
   },
-  "dependencies": {
+  "dependencies": {}
-    "lodash.isarray": "~2.4.1"
-  }
 }

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/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/write.js

@@ -16,6 +16,21 @@ 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;
@@ -103,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();