Prevent adding the same translator comment to multiple functions

Author: swissspidy

src/Utils/FunctionsScanner.php

@@ -38,6 +38,15 @@ public function saveGettextFunctions($translations, array $options)
         $functions = $options['functions'];
         $file = $options['file'];
 
+        /**
+         * List of source code comments already associated with a function.
+         *
+         * Prevents associating the same comment to multiple functions.
+         *
+         * @var ParsedComment[] $commentsCache
+         */
+        $commentsCache = [];
+
         foreach ($this->getFunctions($options['constants']) as $function) {
             list($name, $line, $args) = $function;
 
@@ -78,8 +87,13 @@ public function saveGettextFunctions($translations, array $options)
             $translation->addReference($file, $line);
 
             if (isset($function[3])) {
+                /* @var ParsedComment $extractedComment */
                 foreach ($function[3] as $extractedComment) {
-                    $translation->addExtractedComment($extractedComment);
+                    if (in_array($extractedComment, $commentsCache, true)) {
+                        continue;
+                    }
+                    $translation->addExtractedComment($extractedComment->getComment());
+                    $commentsCache[] = $extractedComment;
                 }
             }
         }

src/Utils/ParsedFunction.php

@@ -45,7 +45,7 @@ class ParsedFunction
     /**
      * Extracted comments.
      *
-     * @var string[]|null
+     * @var ParsedComment[]|null
      */
     protected $comments;
 
@@ -112,7 +112,7 @@ public function addArgumentChunk($chunk)
     /**
      * Add a comment associated to this function.
      *
-     * @param string $comment
+     * @param ParsedComment $comment
      */
     public function addComment($comment)
     {

src/Utils/PhpFunctionsScanner.php

@@ -129,7 +129,7 @@ public function getFunctions(array $constants = [])
                                 $comment = $bufferComments[0];
 
                                 if ($comment->isRelatedWith($newFunction)) {
-                                    $newFunction->addComment($comment->getComment());
+                                    $newFunction->addComment($comment);
                                 }
                             }
 
@@ -148,7 +148,7 @@ public function getFunctions(array $constants = [])
 
                         // The comment is inside the function call.
                         if (isset($bufferFunctions[0])) {
-                            $bufferFunctions[0]->addComment($comment->getComment());
+                            $bufferFunctions[0]->addComment($comment);
                         }
                     }
                     break;

tests/AssetsTest.php

@@ -308,7 +308,7 @@ public function testPhpCode2()
                 'CONTEXT' => 'my-context',
             ],
         ]);
-        $countTranslations = 14;
+        $countTranslations = 19;
         $countTranslated = 0;
         $countHeaders = 8;
 

tests/assets/phpcode2/Csv.csv

@@ -21,3 +21,8 @@ my-context,"All comments",
 ,foo,
 ,bar,
 ,"foo bar",
+,World,
+,"No comment",
+,"Within printf: %s",
+,placeholder,
+,"After printf",

tests/assets/phpcode2/CsvDictionary.csv

@@ -12,3 +12,8 @@ plain,
 foo,
 bar,
 "foo bar",
+World,
+"No comment",
+"Within printf: %s",
+placeholder,
+"After printf",

tests/assets/phpcode2/Jed.json

@@ -46,6 +46,21 @@
         ],
         "foo bar": [
             ""
+        ],
+        "World": [
+            ""
+        ],
+        "No comment": [
+            ""
+        ],
+        "Within printf: %s": [
+            ""
+        ],
+        "placeholder": [
+            ""
+        ],
+        "After printf": [
+            ""
         ]
     }
 }

tests/assets/phpcode2/Json.json

@@ -44,6 +44,21 @@
             ],
             "foo bar": [
                 ""
+            ],
+            "World": [
+                ""
+            ],
+            "No comment": [
+                ""
+            ],
+            "Within printf: %s": [
+                ""
+            ],
+            "placeholder": [
+                ""
+            ],
+            "After printf": [
+                ""
             ]
         },
         "my-context": {

tests/assets/phpcode2/JsonDictionary.json

@@ -12,5 +12,10 @@
     "i18n tagged %s": "",
     "foo": "",
     "bar": "",
-    "foo bar": ""
+    "foo bar": "",
+    "World": "",
+    "No comment": "",
+    "Within printf: %s": "",
+    "placeholder": "",
+    "After printf": ""
 }

tests/assets/phpcode2/PhpArray.php

@@ -69,6 +69,26 @@
       array (
         0 => '',
       ),
+      'World' => 
+      array (
+        0 => '',
+      ),
+      'No comment' => 
+      array (
+        0 => '',
+      ),
+      'Within printf: %s' => 
+      array (
+        0 => '',
+      ),
+      'placeholder' => 
+      array (
+        0 => '',
+      ),
+      'After printf' => 
+      array (
+        0 => '',
+      ),
     ),
     'my-context' => 
     array (