Adding support for @desc annotation (#63)

* Adding support for @desc annotation

* style fixes

* Removed strict types

* Added changelog

* Added twig filter

* Applied changes from StyleCI

* Minor

* Test on twig 1

Author: Nyholm

.travis.yml

@@ -35,6 +35,8 @@ matrix:
           env: DEPENDENCIES="dunglas/symfony-lock:^3"
         - php: 7.2
           env: DEPENDENCIES="dunglas/symfony-lock:^4"
+        - php: 5.6
+          env: DEPENDENCIES="twig/twig:^1.30"
 
           # Latest commit to master
         - php: 7.2

Changelog.md

@@ -4,6 +4,15 @@ The change log describes what is "Added", "Removed", "Changed" or "Fixed" betwee
 
 ## UNRELEASED
 
+## 1.3.0
+
+### Added
+
+- Support for passing choice as variable
+- Support for Symfony 4
+- Support for `desc` annotation and twig filter
+- Support for .phtml
+
 ## 1.2.0
 
 ### Added

src/Annotation/Desc.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the PHP Translation package.
+ *
+ * (c) PHP Translation team <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Translation\Extractor\Annotation;
+
+/**
+ * @Annotation
+ */
+final class Desc
+{
+    public $text;
+}

src/Twig/TranslationExtension.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the PHP Translation package.
+ *
+ * (c) PHP Translation team <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Translation\Extractor\Twig;
+
+final class TranslationExtension extends \Twig_Extension
+{
+    public function getFilters()
+    {
+        return [
+            new \Twig_SimpleFilter('desc', [$this, 'runDescFilter']),
+        ];
+    }
+
+    public function runDescFilter($v)
+    {
+        return $v;
+    }
+
+    public function getName()
+    {
+        return 'php-translation';
+    }
+}

src/Visitor/BaseVisitor.php

@@ -14,9 +14,11 @@
 use Doctrine\Common\Annotations\DocParser;
 use PhpParser\Node;
 use Symfony\Component\Finder\SplFileInfo;
+use Translation\Extractor\Annotation\Desc;
 use Translation\Extractor\Annotation\Ignore;
 use Translation\Extractor\Model\Error;
 use Translation\Extractor\Model\SourceCollection;
+use Translation\Extractor\Model\SourceLocation;
 
 /**
  * Base class for any visitor.
@@ -77,6 +79,30 @@ protected function addError(Node $node, $errorMessage)
         $this->collection->addError(new Error($errorMessage, $file, $line));
     }
 
+    /**
+     * @param string    $text
+     * @param int       $line
+     * @param Node|null $node
+     * @param array     $context
+     */
+    protected function addLocation($text, $line, Node $node = null, array $context = [])
+    {
+        $file = $this->getAbsoluteFilePath();
+        if (null !== $node && null !== $docComment = $node->getDocComment()) {
+            $parserContext = 'file '.$file.' near line '.$line;
+            foreach ($this->getDocParser()->parse($docComment->getText(), $parserContext) as $annotation) {
+                if ($annotation instanceof Ignore) {
+                    return;
+                } elseif ($annotation instanceof Desc) {
+                    $context['desc'] = $annotation->text;
+                }
+            }
+        }
+
+        $source = new SourceLocation($text, $file, $line, $context);
+        $this->collection->addLocation($source);
+    }
+
     /**
      * @return DocParser
      */
@@ -87,6 +113,7 @@ private function getDocParser()
 
             $this->docParser->setImports([
                 'ignore' => Ignore::class,
+                'desc' => Desc::class,
             ]);
             $this->docParser->setIgnoreNotImportedAnnotations(true);
         }

src/Visitor/Php/Symfony/ContainerAwareTrans.php

@@ -13,7 +13,6 @@
 
 use PhpParser\Node;
 use PhpParser\NodeVisitor;
-use Translation\Extractor\Model\SourceLocation;
 use Translation\Extractor\Visitor\Php\BasePHPVisitor;
 
 /**
@@ -41,8 +40,7 @@ public function enterNode(Node $node)
             $label = $this->getStringArgument($node, 0);
             $domain = $this->getStringArgument($node, 2);
 
-            $source = new SourceLocation($label, $this->getAbsoluteFilePath(), $node->getAttribute('startLine'), ['domain' => $domain]);
-            $this->collection->addLocation($source);
+            $this->addLocation($label, $node->getAttribute('startLine'), $node, ['domain' => $domain]);
         }
     }
 

src/Visitor/Php/Symfony/ContainerAwareTransChoice.php

@@ -13,7 +13,6 @@
 
 use PhpParser\Node;
 use PhpParser\NodeVisitor;
-use Translation\Extractor\Model\SourceLocation;
 use Translation\Extractor\Visitor\Php\BasePHPVisitor;
 
 /**
@@ -41,8 +40,7 @@ public function enterNode(Node $node)
             $label = $this->getStringArgument($node, 0);
             $domain = $this->getStringArgument($node, 3);
 
-            $source = new SourceLocation($label, $this->getAbsoluteFilePath(), $node->getAttribute('startLine'), ['domain' => $domain]);
-            $this->collection->addLocation($source);
+            $this->addLocation($label, $node->getAttribute('startLine'), $node, ['domain' => $domain]);
         }
     }
 

src/Visitor/Php/Symfony/FlashMessage.php

@@ -13,7 +13,6 @@
 
 use PhpParser\Node;
 use PhpParser\NodeVisitor;
-use Translation\Extractor\Model\SourceLocation;
 use Translation\Extractor\Visitor\Php\BasePHPVisitor;
 
 /**
@@ -48,7 +47,7 @@ public function enterNode(Node $node)
             ('add' === $name && 'getFlashBag' === $callerName && $caller instanceof Node\Expr\MethodCall)
         ) {
             if (null !== $label = $this->getStringArgument($node, 1)) {
-                $this->collection->addLocation(new SourceLocation($label, $this->getAbsoluteFilePath(), $node->getAttribute('startLine')));
+                $this->addLocation($label, $node->getAttribute('startLine'), $node);
             }
         }
     }

src/Visitor/Php/Symfony/FormTypeEmptyValue.php

@@ -14,7 +14,6 @@
 use PhpParser\Node;
 use PhpParser\Node\Stmt;
 use PhpParser\NodeVisitor;
-use Translation\Extractor\Model\SourceLocation;
 use Translation\Extractor\Visitor\Php\BasePHPVisitor;
 
 /**
@@ -71,8 +70,7 @@ private function storeValue(Node $node, $item)
             return;
         }
 
-        $sl = new SourceLocation($label, $this->getAbsoluteFilePath(), $node->getAttribute('startLine'));
-        $this->collection->addLocation($sl);
+        $this->addLocation($label, $node->getAttribute('startLine'), $node);
     }
 
     public function leaveNode(Node $node)

src/Visitor/Php/Symfony/FormTypeInvalidMessage.php

@@ -14,7 +14,6 @@
 use PhpParser\Node;
 use PhpParser\Node\Stmt;
 use PhpParser\NodeVisitor;
-use Translation\Extractor\Model\SourceLocation;
 use Translation\Extractor\Visitor\Php\BasePHPVisitor;
 
 /**
@@ -55,8 +54,7 @@ public function enterNode(Node $node)
                 continue;
             }
 
-            $sl = new SourceLocation($label, $this->getAbsoluteFilePath(), $node->getAttribute('startLine'), ['domain' => 'validators']);
-            $this->collection->addLocation($sl);
+            $this->addLocation($label, $node->getAttribute('startLine'), $node, ['domain' => 'validators']);
         }
     }