Allow constants in gettext functions #116

Author: oscarotero

src/Extractors/JsCode.php

@@ -11,6 +11,8 @@
 class JsCode extends Extractor implements ExtractorInterface
 {
     public static $options = [
+        'constants' => [],
+
         'functions' => [
             'gettext' => 'gettext',
             '__' => 'gettext',

src/Extractors/PhpCode.php

@@ -16,6 +16,8 @@ class PhpCode extends Extractor implements ExtractorInterface
          // - non-empty string: to extract comments that start with that string
         'extractComments' => false,
 
+        'constants' => [],
+
         'functions' => [
             'gettext' => 'gettext',
             '__' => 'gettext',

src/Utils/FunctionsScanner.php

@@ -10,9 +10,11 @@ abstract class FunctionsScanner
     /**
      * Scan and returns the functions and the arguments.
      *
+     * @param array $constants Constants used in the code to replace
+     *
      * @return array
      */
-    abstract public function getFunctions();
+    abstract public function getFunctions(array $constants = []);
 
     /**
      * Search for specific functions and create translations.
@@ -25,7 +27,7 @@ public function saveGettextFunctions(Translations $translations, array $options)
         $functions = $options['functions'];
         $file = $options['file'];
 
-        foreach ($this->getFunctions() as $function) {
+        foreach ($this->getFunctions($options['constants']) as $function) {
             list($name, $line, $args) = $function;
 
             if (!isset($functions[$name])) {

src/Utils/JsFunctionsScanner.php

@@ -20,7 +20,7 @@ public function __construct($code)
     /**
      * {@inheritdoc}
      */
-    public function getFunctions()
+    public function getFunctions(array $constants = [])
     {
         $length = strlen($this->code);
         $line = 1;

src/Utils/PhpFunctionsScanner.php

@@ -58,7 +58,7 @@ function ($token) {
     /**
      * {@inheritdoc}
      */
-    public function getFunctions()
+    public function getFunctions(array $constants = [])
     {
         $count = count($this->tokens);
         $bufferFunctions = [];
@@ -95,8 +95,13 @@ public function getFunctions()
                         $bufferFunctions[0]->addArgumentChunk(PhpCode::convertString($value[1]));
                     }
                     break;
+
                 case T_STRING:
                     if (isset($bufferFunctions[0])) {
+                        if (isset($constants[$value[1]])) {
+                            $bufferFunctions[0]->addArgumentChunk($constants[$value[1]]);
+                            break;
+                        }
                         $bufferFunctions[0]->stopArgument();
                     }
                     //new function found
@@ -119,6 +124,7 @@ public function getFunctions()
                         break;
                     }
                     break;
+
                 case T_COMMENT:
                     if (isset($bufferFunctions[0])) {
                         $comment = $this->parsePhpComment($value[1]);
@@ -127,6 +133,7 @@ public function getFunctions()
                         }
                     }
                     break;
+
                 default:
                     if (isset($bufferFunctions[0])) {
                         $bufferFunctions[0]->stopArgument();

tests/AbstractTest.php

@@ -30,7 +30,7 @@ protected static function asset($file)
         return './tests/assets/'.$file;
     }
 
-    protected static function get($file, $format = null)
+    protected static function get($file, $format = null, array $options = [])
     {
         if ($format === null) {
             $format = basename($file);
@@ -39,7 +39,7 @@ protected static function get($file, $format = null)
         $method = "from{$format}File";
         $file = static::asset($file.'.'.static::$ext[$format]);
 
-        return Translations::$method($file);
+        return Translations::$method($file, $options);
     }
 
     protected function assertContent(Translations $translations, $file, $format = null)
@@ -51,7 +51,7 @@ protected function assertContent(Translations $translations, $file, $format = nu
         $method = "to{$format}String";
         $content = file_get_contents(static::asset($file.'.'.static::$ext[$format]));
 
-        $this->assertSame($content, $translations->$method());
+        $this->assertSame($content, $translations->$method(), $file);
     }
 
     protected static function saveContent(Translations $translations, $file, $format = null)

tests/AssetsTest.php

@@ -278,7 +278,11 @@ public function testPhpCode()
 
     public function testPhpCode2()
     {
-        $translations = static::get('phpcode2/input', 'PhpCode');
+        $translations = static::get('phpcode2/input', 'PhpCode', [
+            'constants' => [
+                'CONTEXT' => 'my-context'
+            ]
+        ]);
         $countTranslations = 9;
         $countHeaders = 8;
 

tests/assets/phpcode2/Csv.csv

@@ -13,6 +13,6 @@ Report-Msgid-Bugs-To:
 ,"text concatenated with 'comments'",
 ,"Stop at the variable",
 ,"No comments",
-,"All comments",
+my-context,"All comments",
 ,"i18n Tagged comment",
 ,"i18n Tagged comment inside",

tests/assets/phpcode2/Jed.json

@@ -23,7 +23,7 @@
         "No comments": [
             ""
         ],
-        "All comments": [
+        "my-context\\u0004All comments": [
             ""
         ],
         "i18n Tagged comment": [

tests/assets/phpcode2/Json.json

@@ -24,15 +24,17 @@
             "No comments": [
                 ""
             ],
-            "All comments": [
-                ""
-            ],
             "i18n Tagged comment": [
                 ""
             ],
             "i18n Tagged comment inside": [
                 ""
             ]
+        },
+        "my-context": {
+            "All comments": [
+                ""
+            ]
         }
     }
 }