extract comments of functions precending gettext functions #6

Author: Oscar Otero

src/PhpNodeVisitor.php

@@ -15,7 +15,7 @@ class PhpNodeVisitor implements NodeVisitor
     protected $validFunctions;
     protected $filename;
     protected $functions = [];
-    protected $bufferComments = [];
+    protected $bufferComments;
 
     public function __construct(string $filename, array $validFunctions = null)
     {
@@ -35,21 +35,20 @@ public function enterNode(Node $node)
 
             if ($name && ($this->validFunctions === null || in_array($name, $this->validFunctions))) {
                 $this->functions[] = $this->createFunction($node);
+            } elseif ($node->getComments()) {
+                $this->bufferComments = $node;
             }
-
-            $this->bufferComments = [];
             return null;
         }
 
         switch ($node->getType()) {
             case 'Stmt_Echo':
             case 'Stmt_Return':
             case 'Expr_Print':
-                $this->bufferComments = $node->getComments();
+                $this->bufferComments = $node;
                 return null;
         }
 
-        $this->bufferComments = [];
         return null;
     }
 
@@ -81,10 +80,14 @@ protected function createFunction(FuncCall $node): ParsedFunction
             $function->addComment(static::getComment($comment));
         }
 
-        foreach ($this->bufferComments as $comment) {
-            $function->addComment(static::getComment($comment));
+        if ($this->bufferComments && $this->bufferComments->getStartLine() === $node->getStartLine()) {
+            foreach ($this->bufferComments->getComments() as $comment) {
+                $function->addComment(static::getComment($comment));
+            }
         }
 
+        $this->bufferComments = null;
+
         foreach ($node->args as $argument) {
             $value = $argument->value;
 

tests/PhpScannerTest.php

@@ -42,6 +42,12 @@ public function testPhpCodeScanner()
         $this->assertNotNull($translation);
         $this->assertSame([$file => [66]], $translation->getReferences()->toArray());
         $this->assertCount(1, $translation->getExtractedComments());
+
+        $translation = $domain1->find(null, 'i18n tagged %s');
+        $this->assertNotNull($translation);
+        $this->assertSame([$file => [75]], $translation->getReferences()->toArray());
+        $this->assertCount(1, $translation->getExtractedComments());
+        $this->assertSame(['i18n Tagged comment on the line before'], $translation->getExtractedComments()->toArray());
     }
 
     public function testInvalidFunction()