Ability to add flags to scanned functions

Author: oscarotero

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 Previous releases are documented in [github releases](https://github.com/oscarotero/Gettext/releases)
 
+## [5.6.0] - Unreleased
+### Added
+- New method `addFlag` to `ParsedFunction`, that allows to assign flags by scanners.
+- The `FunctionsHandlersTrait` has an abstract `addFlags` method.
+
 ## [5.5.4] - 2020-12-20
 ### Fixed
 - TypeError in which numeric entries were converted to integers [#265]
@@ -97,6 +102,7 @@ Previous releases are documented in [github releases](https://github.com/oscarot
 [#263]: https://github.com/php-gettext/Gettext/issues/263
 [#265]: https://github.com/php-gettext/Gettext/issues/265
 
+[5.6.0]: https://github.com/php-gettext/Gettext/compare/v5.5.4...HEAD
 [5.5.4]: https://github.com/php-gettext/Gettext/compare/v5.5.3...v5.5.4
 [5.5.3]: https://github.com/php-gettext/Gettext/compare/v5.5.2...v5.5.3
 [5.5.2]: https://github.com/php-gettext/Gettext/compare/v5.5.1...v5.5.2

src/Scanner/CodeScanner.php

@@ -109,6 +109,15 @@ protected function addComments(ParsedFunction $function, ?Translation $translati
         return $translation;
     }
 
+    protected function addFlags(ParsedFunction $function, ?Translation $translation): ?Translation
+    {
+        foreach ($function->getFlags() as $flag) {
+            $translation->getFlags()->add($flag);
+        }
+
+        return $translation;
+    }
+
     protected function checkFunction(ParsedFunction $function, int $minLength): bool
     {
         if ($function->countArguments() < $minLength) {

src/Scanner/FunctionsHandlersTrait.php

@@ -17,10 +17,11 @@ protected function gettext(ParsedFunction $function): ?Translation
         }
         list($original) = $function->getArguments();
 
-        return $this->addComments(
+        $translation = $this->addComments(
             $function,
             $this->saveTranslation(null, null, $original)
         );
+        return $this->addFlags($function, $translation);
     }
 
     protected function ngettext(ParsedFunction $function): ?Translation
@@ -30,10 +31,11 @@ protected function ngettext(ParsedFunction $function): ?Translation
         }
         list($original, $plural) = $function->getArguments();
 
-        return $this->addComments(
+        $translation = $this->addComments(
             $function,
             $this->saveTranslation(null, null, $original, $plural)
         );
+        return $this->addFlags($function, $translation);
     }
 
     protected function pgettext(ParsedFunction $function): ?Translation
@@ -43,10 +45,11 @@ protected function pgettext(ParsedFunction $function): ?Translation
         }
         list($context, $original) = $function->getArguments();
 
-        return $this->addComments(
+        $translation = $this->addComments(
             $function,
             $this->saveTranslation(null, $context, $original)
         );
+        return $this->addFlags($function, $translation);
     }
 
     protected function dgettext(ParsedFunction $function): ?Translation
@@ -56,10 +59,11 @@ protected function dgettext(ParsedFunction $function): ?Translation
         }
         list($domain, $original) = $function->getArguments();
 
-        return $this->addComments(
+        $translation = $this->addComments(
             $function,
             $this->saveTranslation($domain, null, $original)
         );
+        return $this->addFlags($function, $translation);
     }
 
     protected function dpgettext(ParsedFunction $function): ?Translation
@@ -69,10 +73,11 @@ protected function dpgettext(ParsedFunction $function): ?Translation
         }
         list($domain, $context, $original) = $function->getArguments();
 
-        return $this->addComments(
+        $translation = $this->addComments(
             $function,
             $this->saveTranslation($domain, $context, $original)
         );
+        return $this->addFlags($function, $translation);
     }
 
     protected function npgettext(ParsedFunction $function): ?Translation
@@ -82,10 +87,11 @@ protected function npgettext(ParsedFunction $function): ?Translation
         }
         list($context, $original, $plural) = $function->getArguments();
 
-        return $this->addComments(
+        $translation = $this->addComments(
             $function,
             $this->saveTranslation(null, $context, $original, $plural)
         );
+        return $this->addFlags($function, $translation);
     }
 
     protected function dngettext(ParsedFunction $function): ?Translation
@@ -95,10 +101,11 @@ protected function dngettext(ParsedFunction $function): ?Translation
         }
         list($domain, $original, $plural) = $function->getArguments();
 
-        return $this->addComments(
+        $translation = $this->addComments(
             $function,
             $this->saveTranslation($domain, null, $original, $plural)
         );
+        return $this->addFlags($function, $translation);
     }
 
     protected function dnpgettext(ParsedFunction $function): ?Translation
@@ -108,14 +115,17 @@ protected function dnpgettext(ParsedFunction $function): ?Translation
         }
         list($domain, $context, $original, $plural) = $function->getArguments();
 
-        return $this->addComments(
+        $translation = $this->addComments(
             $function,
             $this->saveTranslation($domain, $context, $original, $plural)
         );
+        return $this->addFlags($function, $translation);
     }
 
     abstract protected function addComments(ParsedFunction $function, ?Translation $translation): ?Translation;
 
+    abstract protected function addFlags(ParsedFunction $function, ?Translation $translation): ?Translation;
+
     abstract protected function checkFunction(ParsedFunction $function, int $minLength): bool;
 
     abstract protected function saveTranslation(

src/Scanner/ParsedFunction.php

@@ -14,6 +14,7 @@ final class ParsedFunction
     private $lastLine;
     private $arguments = [];
     private $comments = [];
+    private $flags = [];
 
     public function __construct(string $name, string $filename, int $line, int $lastLine = null)
     {
@@ -37,6 +38,7 @@ public function toArray(): array
             'lastLine' => $this->lastLine,
             'arguments' => $this->arguments,
             'comments' => $this->comments,
+            'flags' => $this->flags,
         ];
     }
 
@@ -75,6 +77,11 @@ public function getComments(): array
         return $this->comments;
     }
 
+    public function getFlags(): array
+    {
+        return $this->flags;
+    }
+
     public function addArgument($argument = null): self
     {
         $this->arguments[] = $argument;
@@ -88,4 +95,11 @@ public function addComment(string $comment): self
 
         return $this;
     }
+
+    public function addFlag(string $flag): self
+    {
+        $this->flags[] = $flag;
+
+        return $this;
+    }
 }

tests/ParsedFunctionsAndCommentsTest.php

@@ -28,5 +28,8 @@ public function testParsedFunction()
 
         $function->addComment('This is other comment');
         $this->assertSame(['This is a comment', 'This is other comment'], $function->getComments());
+
+        $function->addFlag('php-format');
+        $this->assertSame(['php-format'], $function->getFlags());
     }
 }