Merge pull request #7 from Jean-Beru/translation/php-ast-extractor-tests-rework-review-0001

[Translation] Rework PhpAstExtractor tests organization for future improvements - REVIEW0001

Author: welcoMattic

src/Symfony/Component/Translation/Extractor/Visitor/AbstractVisitor.php

@@ -35,7 +35,8 @@ protected function addMessageToCatalogue(string $message, ?string $domain, int $
         $domain ??= 'messages';
         $this->catalogue->set($message, $this->messagePrefix.$message, $domain);
         $metadata = $this->catalogue->getMetadata($message, $domain) ?? [];
-        $metadata['sources'][] = $this->file->getPathname().':'.$line;
+        $normalizedFilename = preg_replace('{[\\\\/]+}', '/', $this->file);
+        $metadata['sources'][] = $normalizedFilename.':'.$line;
         $this->catalogue->setMetadata($message, $metadata, $domain);
     }
 

src/Symfony/Component/Translation/Tests/Extractor/PhpAstExtractorTest.php

@@ -31,7 +31,7 @@ public function testExtractFiles(iterable|string $resource)
         $extractor->extract($resource, $catalogue);
 
         $this->assertEquals(['messages' => ['example' => 'example']], $catalogue->all());
-        $this->assertEquals(['sources' => [self::FIXTURES_FOLDER.'translation.html.php:1']], $catalogue->getMetadata('example'));
+        $this->assertEquals(['sources' => [preg_replace('{[\\\\/]+}', '/', self::FIXTURES_FOLDER).'translation.html.php:1']], $catalogue->getMetadata('example'));
     }
 
     public static function resourcesProvider(): \Generator

src/Symfony/Component/Translation/Tests/Extractor/Visitor/AbstractVisitorTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Symfony\Component\Translation\Tests\Extractor\Visitor;
+
+use PhpParser\NodeVisitor;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Translation\Extractor\PhpAstExtractor;
+use Symfony\Component\Translation\MessageCatalogue;
+
+abstract class AbstractVisitorTestCase extends TestCase
+{
+    /**
+     * @param string|iterable<string> $resource Files, a file or a directory
+     */
+    public function extract(NodeVisitor $visitor, string|iterable $resource): MessageCatalogue
+    {
+        $extractor = new PhpAstExtractor([$visitor]);
+        $extractor->setPrefix('prefix');
+
+        $catalogue = new MessageCatalogue('en');
+
+        $extractor->extract($resource, $catalogue);
+
+        return $catalogue;
+    }
+}

src/Symfony/Component/Translation/Tests/Extractor/Visitor/AbstractVisitorTestCase.php

@@ -2,26 +2,16 @@
 
 namespace Symfony\Component\Translation\Tests\Extractor\Visitor;
 
-use PhpParser\NodeVisitor;
 use Symfony\Component\Translation\Extractor\Visitor\ConstraintVisitor;
-use Symfony\Component\Translation\MessageCatalogue;
 
-class ConstraintVisitorTest extends AbstractVisitorTest
+final class ConstraintVisitorTest extends AbstractVisitorTestCase
 {
     private const FIXTURES_FOLDER = __DIR__ . '/../../Fixtures/extractor-php-ast/constraint-visitor/';
 
-    public function getVisitor(): NodeVisitor
+    public function testExtractMessages()
     {
-        return new ConstraintVisitor(['NotBlank', 'Isbn', 'Length']);
-    }
+        $catalogue = $this->extract(new ConstraintVisitor(['NotBlank', 'Isbn', 'Length']), self::FIXTURES_FOLDER);
 
-    public function getResource(): iterable|string
-    {
-        return self::FIXTURES_FOLDER;
-    }
-
-    public function assertCatalogue(MessageCatalogue $catalogue): void
-    {
         $this->assertEquals(
             [
                 'validators' => [
@@ -42,6 +32,6 @@ public function assertCatalogue(MessageCatalogue $catalogue): void
             $catalogue->all(),
         );
 
-        $this->assertEquals(['sources' => [self::FIXTURES_FOLDER . 'validator-constraints.php:8']], $catalogue->getMetadata('message-in-constraint-attribute', 'validators'));
+        $this->assertEquals(['sources' => [self::FIXTURES_FOLDER . 'validator-constraints.php:7']], $catalogue->getMetadata('message-in-constraint-attribute', 'validators'));
     }
 }

src/Symfony/Component/Translation/Tests/Extractor/Visitor/ConstraintVisitorTest.php

@@ -2,27 +2,17 @@
 
 namespace Symfony\Component\Translation\Tests\Extractor\Visitor;
 
-use PhpParser\NodeVisitor;
 use Symfony\Component\Translation\Extractor\Visitor\TransMethodVisitor;
-use Symfony\Component\Translation\MessageCatalogue;
 
-class TransMethodVisitorTest extends AbstractVisitorTest
+final class TransMethodVisitorTest extends AbstractVisitorTestCase
 {
     private const FIXTURES_FOLDER = __DIR__ . '/../../Fixtures/extractor-php-ast/trans-method-visitor/';
     public const OTHER_DOMAIN = 'not_messages';
 
-    public function getVisitor(): NodeVisitor
+    public function testExtractMessages()
     {
-        return new TransMethodVisitor();
-    }
+        $catalogue = $this->extract(new TransMethodVisitor(), self::FIXTURES_FOLDER);
 
-    public function getResource(): iterable|string
-    {
-        return self::FIXTURES_FOLDER;
-    }
-
-    public function assertCatalogue(MessageCatalogue $catalogue): void
-    {
         $expectedHeredoc = <<<EOF
 heredoc key with whitespace and escaped \$\n sequences
 EOF;

src/Symfony/Component/Translation/Tests/Extractor/Visitor/TransMethodVisitorTest.php

@@ -2,27 +2,16 @@
 
 namespace Symfony\Component\Translation\Tests\Extractor\Visitor;
 
-use PhpParser\NodeVisitor;
 use Symfony\Component\Translation\Extractor\Visitor\TranslatableMessageVisitor;
-use Symfony\Component\Translation\Extractor\Visitor\TransMethodVisitor;
-use Symfony\Component\Translation\MessageCatalogue;
 
-class TranslatableMessageVisitorTest extends AbstractVisitorTest
+final class TranslatableMessageVisitorTest extends AbstractVisitorTestCase
 {
     private const FIXTURES_FOLDER = __DIR__ . '/../../Fixtures/extractor-php-ast/translatable-message-visitor/';
 
-    public function getVisitor(): NodeVisitor
+    public function testExtractMessages()
     {
-        return new TranslatableMessageVisitor();
-    }
+        $catalogue = $this->extract(new TranslatableMessageVisitor(), self::FIXTURES_FOLDER);
 
-    public function getResource(): iterable|string
-    {
-        return self::FIXTURES_FOLDER;
-    }
-
-    public function assertCatalogue(MessageCatalogue $catalogue): void
-    {
         $expectedHeredoc = <<<EOF
 heredoc key with whitespace and escaped \$\n sequences
 EOF;
@@ -72,8 +61,8 @@ public function assertCatalogue(MessageCatalogue $catalogue): void
             $catalogue->all(),
         );
 
-        $this->assertEquals(['sources' => [self::FIXTURES_FOLDER . 'translatable.html.php:2']], $catalogue->getMetadata('translatable single-quoted key'));
-        $this->assertEquals(['sources' => [self::FIXTURES_FOLDER . 'translatable.html.php:37']], $catalogue->getMetadata('translatable other-domain-test-no-params-short-array', 'not_messages'));
+        $this->assertEquals(['sources' => [self::FIXTURES_FOLDER . 'translatable.html.php:3']], $catalogue->getMetadata('translatable single-quoted key'));
+        $this->assertEquals(['sources' => [self::FIXTURES_FOLDER . 'translatable.html.php:38']], $catalogue->getMetadata('translatable other-domain-test-no-params-short-array', 'not_messages'));
 
         $this->assertEquals(['sources' => [self::FIXTURES_FOLDER . 'translatable-fqn.html.php:2']], $catalogue->getMetadata('translatable-fqn single-quoted key'));
         $this->assertEquals(['sources' => [self::FIXTURES_FOLDER . 'translatable-fqn.html.php:37']], $catalogue->getMetadata('translatable-fqn other-domain-test-no-params-short-array', 'not_messages'));

src/Symfony/Component/Translation/Tests/Extractor/Visitor/TranslatableMessageVisitorTest.php

@@ -1,4 +1,3 @@
-This template is used for translation message extraction tests
 <?php
 
 use Symfony\Component\Validator\Constraints as Assert;

src/Symfony/Component/Translation/Tests/Fixtures/extractor-php-ast/constraint-visitor/validator-constraints.php

@@ -1,4 +1,3 @@
-This template is used for translation message extraction tests
 <?php
 // @see https://github.com/php-translation/extractor/blob/master/tests/Resources/Php/Symfony/ExplicitLabelType.php
 

src/Symfony/Component/Translation/Tests/Fixtures/extractor-php-ast/form-type-visitor/form-type.php

@@ -1,4 +1,5 @@
 This template is used for translation message extraction tests
+<?php use Symfony\Component\Translation\TranslatableMessage; ?>
 <?php new TranslatableMessage('translatable single-quoted key'); ?>
 <?php new TranslatableMessage('translatable double-quoted key'); ?>
 <?php new TranslatableMessage(<<<EOF