add extractor for form field titles

phpstan-baseline.neon

@@ -14,8 +14,3 @@ parameters:
             message: "#^Access to an undefined property PhpParser\\\\Node\\:\\:\\$args\\.$#"
             count: 1
             path: src/Visitor/Php/Symfony/AbstractFormType.php
-
-        -
-            message: "#^Access to an undefined property PhpParser\\\\Node\\\\Expr\\:\\:\\$value\\.$#"
-            count: 1
-            path: src/Visitor/Php/Symfony/FormTypePlaceholder.php

src/Visitor/Php/Symfony/FormTypePlaceholder.php

@@ -55,6 +55,9 @@ public function enterNode(Node $node): ?Node
                 $placeholderNode = $item;
             } elseif ('attr' === $item->key->value && $item->value instanceof Node\Expr\Array_) {
                 foreach ($item->value->items as $attrValue) {
+                    if (!$attrValue->key instanceof Node\Scalar\String_) {
+                        continue;
+                    }
                     if ('placeholder' === $attrValue->key->value) {
                         $placeholderNode = $attrValue;
 

src/Visitor/Php/Symfony/FormTypeTitle.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the PHP Translation package.
+ *
+ * (c) PHP Translation team <tobias.nyholm@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Translation\Extractor\Visitor\Php\Symfony;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitor;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class FormTypeTitle extends AbstractFormType implements NodeVisitor
+{
+    use FormTrait;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function enterNode(Node $node): ?Node
+    {
+        if (!$this->isFormType($node)) {
+            return null;
+        }
+
+        parent::enterNode($node);
+
+        if (!$node instanceof Node\Expr\Array_) {
+            return null;
+        }
+
+        $titleNode = null;
+        $domain = null;
+        foreach ($node->items as $item) {
+            if (!$item->key instanceof Node\Scalar\String_) {
+                continue;
+            }
+            if ('translation_domain' === $item->key->value) {
+                // Try to find translation domain
+                if ($item->value instanceof Node\Scalar\String_) {
+                    $domain = $item->value->value;
+                } elseif ($item->value instanceof Node\Expr\ConstFetch && 'false' === $item->value->name->toString()) {
+                    $domain = false;
+                }
+            } elseif ('attr' === $item->key->value && $item->value instanceof Node\Expr\Array_) {
+                foreach ($item->value->items as $attrValue) {
+                    if (!$attrValue->key instanceof Node\Scalar\String_) {
+                        continue;
+                    }
+                    if ('title' === $attrValue->key->value) {
+                        $titleNode = $attrValue;
+
+                        break;
+                    }
+                }
+            }
+        }
+
+        if (null === $titleNode) {
+            return null;
+        }
+
+        if ($titleNode->value instanceof Node\Scalar\String_) {
+            $line = $titleNode->value->getAttribute('startLine');
+            if (null !== $location = $this->getLocation($titleNode->value->value, $line, $titleNode, ['domain' => $domain])) {
+                $this->lateCollect($location);
+            }
+        } else {
+            $this->addError($titleNode, 'Form field title is not a scalar string');
+        }
+
+        return null;
+    }
+}

tests/Functional/Visitor/Php/Symfony/FormTypeLabelTest.php

@@ -19,6 +19,7 @@
 use Translation\Extractor\Visitor\Php\Symfony\FormTypeLabelExplicit;
 use Translation\Extractor\Visitor\Php\Symfony\FormTypeLabelImplicit;
 use Translation\Extractor\Visitor\Php\Symfony\FormTypePlaceholder;
+use Translation\Extractor\Visitor\Php\Symfony\FormTypeTitle;
 
 /**
  * @author Rein Baarsma <rein@solidwebcode.com>
@@ -36,6 +37,7 @@ public function __construct()
             new FormTypeLabelExplicit(),
             new FormTypeLabelImplicit(),
             new FormTypePlaceholder(),
+            new FormTypeTitle(),
         ];
 
         parent::__construct();

tests/Functional/Visitor/Php/Symfony/FormTypeTitleTest.php

@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of the PHP Translation package.
+ *
+ * (c) PHP Translation team <tobias.nyholm@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Translation\Extractor\Tests\Functional\Visitor\Php\Symfony;
+
+use Translation\Extractor\Tests\Functional\Visitor\Php\BasePHPVisitorTest;
+use Translation\Extractor\Tests\Resources;
+use Translation\Extractor\Visitor\Php\Symfony\ContainerAwareTrans;
+use Translation\Extractor\Visitor\Php\Symfony\FormTypeTitle;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class FormTypeTitleTest extends BasePHPVisitorTest
+{
+    public function testExtract()
+    {
+        $collection = $this->getSourceLocations(new FormTypeTitle(),
+            Resources\Php\Symfony\TitleFormType::class);
+
+        $this->assertCount(1, $collection);
+        $this->assertEquals('form.title.text', $collection->get(0)->getMessage());
+    }
+
+    public function testExtractError()
+    {
+        $collection = $this->getSourceLocations(new FormTypeTitle(),
+            Resources\Php\Symfony\TitleFormErrorType::class);
+
+        $errors = $collection->getErrors();
+        $this->assertCount(1, $errors);
+    }
+
+    public function testChildVisitationNotBlocked()
+    {
+        $collection = $this->getSourceLocations(
+            [
+                new FormTypeTitle(),
+                new ContainerAwareTrans(),
+            ],
+            Resources\Php\Symfony\ContainerAwareTrans::class
+        );
+
+        $this->assertCount(6, $collection);
+
+        $this->assertEquals('trans0', $collection->get(0)->getMessage());
+        $this->assertEquals('trans1', $collection->get(1)->getMessage());
+        $this->assertEquals('trans_line', $collection->get(2)->getMessage());
+        $this->assertEquals('variable', $collection->get(3)->getMessage());
+        $this->assertEquals('my.pdf', $collection->get(4)->getMessage());
+        $this->assertEquals('bar', $collection->get(5)->getMessage());
+    }
+}

tests/Resources/Php/Symfony/TitleFormErrorType.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Translation\Extractor\Tests\Resources\Php\Symfony;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class TitleFormErrorType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $string = 'foo';
+        $builder
+            ->add('field_with_attr_title', 'text', array(
+                'label' => 'field.with.title',
+                'attr' => array('title' => $string)
+            ))
+        ;
+    }
+}

tests/Resources/Php/Symfony/TitleFormType.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Translation\Extractor\Tests\Resources\Php\Symfony;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilderInterface;
+
+class TitleFormType extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add('field_with_attr_title', 'text', array(
+                'label' => 'field.with.title',
+                'attr' => array('title' => 'form.title.text')
+            ))
+        ;
+    }
+}

tests/Smoke/AllExtractorsTest.php

@@ -30,6 +30,7 @@
 use Translation\Extractor\Visitor\Php\Symfony\FormTypeLabelExplicit;
 use Translation\Extractor\Visitor\Php\Symfony\FormTypeLabelImplicit;
 use Translation\Extractor\Visitor\Php\Symfony\FormTypePlaceholder;
+use Translation\Extractor\Visitor\Php\Symfony\FormTypeTitle;
 use Translation\Extractor\Visitor\Php\TranslateAnnotationVisitor;
 use Translation\Extractor\Visitor\Twig\TwigVisitor;
 
@@ -89,7 +90,7 @@ public function testNoException()
          * It is okey to increase the error count if you adding more fixtures/code.
          * We just need to be aware that it changes.
          */
-        $this->assertCount(12, $sc->getErrors(), 'There was an unexpected number of errors. Please investigate.');
+        $this->assertCount(13, $sc->getErrors(), 'There was an unexpected number of errors. Please investigate.');
     }
 
     /**
@@ -149,6 +150,7 @@ private function getPHPFileExtractor(): PHPFileExtractor
         $file->addVisitor(new FormTypeLabelExplicit());
         $file->addVisitor(new FormTypeLabelImplicit());
         $file->addVisitor(new FormTypePlaceholder());
+        $file->addVisitor(new FormTypeTitle());
         $file->addVisitor(new SourceLocationContainerVisitor());
         $file->addVisitor(new TranslateAnnotationVisitor());