Merge pull request #9 from gwa/develop

v0.4.0

Gruntfile.js

@@ -12,18 +12,6 @@ module.exports = function(grunt) {
 
   // Project configuration.
   grunt.initConfig({
-    jshint: {
-      files: {
-        src: [
-          'Gruntfile.js',
-          'tasks/*.js',
-          '<%= nodeunit.tests %>'
-        ]
-      },
-      options: {
-        jshintrc: '.jshintrc'
-      }
-    },
 
     // Before generating any new files, remove any previously-created files.
     clean: {
@@ -40,6 +28,17 @@ module.exports = function(grunt) {
           'tmp/wordpress.php': ['test/fixtures/**/*.twig', 'test/fixtures/wp/*.php']
         }
       },
+
+      wordpress_add_textdomain: {
+        options: {
+            textdomain: 'bar',
+            add_textdomain: true
+        },
+        files: {
+          'tmp/wordpress_add_textdomain.php': ['test/fixtures/**/*.twig', 'test/fixtures/wp/*.php']
+        }
+      },
+
       wordpress_custom_function: {
         options: {
             textdomain: 'bar',
@@ -49,6 +48,7 @@ module.exports = function(grunt) {
           'tmp/wordpress_custom_function.php': ['test/fixtures/**/*.twig', 'test/fixtures/wp/*.php']
         }
       },
+
       drupal: {
         options: {
             style: 'drupal',

LICENSE-MIT.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Great White Ark
+Copyright (c) 2017 Great White Ark
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -92,7 +92,11 @@ Wordpress only: The textdomain to be parsed. gettext calls to other domains will
 
 `gettext` (default)
 
-The function name that is used in the generated php file.
+#### add_textdomain
+
+`false` (default)
+
+Write the textdomain to the php file. Helpful for use with checktextdomain libraries.
 
 ## Contributing
 In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

package.json

@@ -1,7 +1,7 @@
 {
   "name": "grunt-gettext-parser",
-  "description": "Extract gettext calls from WordPress / Timber templates to a single PHP file.",
-  "version": "0.3.2",
+  "description": "Extract gettext calls from Wordpress themes and twig templates to a single PHP file.",
+  "version": "0.4.0",
   "homepage": "https://github.com/groves/gettext-parser",
   "author": {
     "name": "Great White Ark",
@@ -28,7 +28,6 @@
     "test": "grunt test"
   },
   "devDependencies": {
-    "grunt-contrib-jshint": "^0.11.0",
     "grunt-contrib-clean": "^0.5.0",
     "grunt-contrib-nodeunit": "^0.3.3",
     "grunt": "~0.4.5"

tasks/gettext_parser.js

@@ -2,28 +2,27 @@
  * grunt-gettext-parser
  * https://github.com/gwa/grunt-gettext-parser
  *
- * Copyright (c) 2015 Great White Ark
+ * Copyright (c) 2017 Great White Ark
  * Licensed under the MIT license.
  */
 
 'use strict';
 
 module.exports = function(grunt) {
-
     // Please see the Grunt documentation for more information regarding task
     // creation: http://gruntjs.com/creating-tasks
 
-    var PATTERN_WORDPRESS = /_[_e]\((['"])((?:(?!\1).)*)\1,\s?\1((?:(?!\1).)*)\1/g,
+    var PATTERN_WORDPRESS = /_[_e]\(\s?(['"])((?:(?!\1).)*)\1,\s?\1((?:(?!\1).)*\s?)\1/g,
         PATTERN_DRUPAL_TWIG = new RegExp('{{ ?([\'"])((?:(?!\\1).)*)\\1\\|t ?}}', 'g'),
         options = {};
 
     grunt.registerMultiTask('gettext_parser', 'Extract gettext calls to a single file.', function() {
-
         // Merge task-specific and/or target-specific options with these defaults.
         options = this.options({
             style: 'wordpress',
             textdomain: null,
-            output_function: 'gettext'
+            output_function: 'gettext',
+            add_textdomain: false
         });
 
         // Iterate over all specified file groups.
@@ -55,7 +54,6 @@ module.exports = function(grunt) {
             // Print a success message.
             grunt.log.writeln('File "' + f.dest + '" created.');
         });
-
     });
 
     /**
@@ -80,9 +78,9 @@ module.exports = function(grunt) {
         if (!grunt.file.exists(filepath)) {
             grunt.log.warn('Source file "' + filepath + '" not found.');
             return false;
-        } else {
-            return true;
         }
+
+        return true;
     }
 
     /**
@@ -118,15 +116,18 @@ module.exports = function(grunt) {
      * @return {String}
      */
     function formatGettextMatch(match) {
-        return getGettextCall(match[2]);
+        return getGettextCall(match[2], match[3]);
     }
 
     /**
      * @param {String} slug
      * @return {String}
      */
-    function getGettextCall(slug) {
+    function getGettextCall(slug, textdomain) {
+        if (options.add_textdomain) {
+            return options.output_function + "('" + slug + "', '" + textdomain + "')";
+        }
+
         return options.output_function + "('" + slug + "')";
     }
-
 };

test/expected/wordpress_add_textdomain.php

@@ -0,0 +1,5 @@
+<?php
+gettext('foo', 'bar');
+gettext('missing space', 'bar');
+gettext('Double quotes', 'bar');
+gettext('Headline', 'bar');

test/fixtures/wp/wordpress.php

@@ -2,4 +2,4 @@
 
 <h1><?php _e('Headline', 'bar'); ?></h1>
 
-The following call has a different domain: <?php _e('plugin name', 'myplugin'); ?>
+The following call has a different domain: <?php _e( 'plugin name', 'myplugin' ); ?>

test/gettext_parser_test.js

@@ -43,12 +43,22 @@ exports.gettext_parser = {
     test.done();
   },
 
+  add_textdomain: function(test) {
+    test.expect(1);
+
+    var actual = grunt.file.read('tmp/wordpress_add_textdomain.php');
+    var expected = grunt.file.read('test/expected/wordpress_add_textdomain.php');
+    test.equal(actual, expected, 'adds the textdomain to the rendered functions.');
+
+    test.done();
+  },
+
   custom_function_option: function(test) {
     test.expect(1);
 
     var actual = grunt.file.read('tmp/wordpress_custom_function.php');
     var expected = grunt.file.read('test/expected/wordpress_custom_function.php');
-    test.equal(actual, expected, 'writes a custom function call .');
+    test.equal(actual, expected, 'writes a custom function call.');
 
     test.done();
   },