Merge pull request #6 from tehbeard/tehbeard-nested-embed-support

Add support for embed tags.

Author: oscarotero

src/TwigFunctionsScanner.php

@@ -13,8 +13,9 @@
 namespace Gettext\Scanner;
 
 use Twig\Environment;
-use Twig\Source;
 use Twig\Node\Expression\FunctionExpression;
+use Twig\Node\ModuleNode;
+use Twig\Source;
 
 class TwigFunctionsScanner implements FunctionsScannerInterface
 {
@@ -31,7 +32,7 @@ private function createFunction(FunctionExpression $node, string $filename): ?Pa
     {
         $name = $node->getAttribute('name');
 
-        if (! in_array($name, $this->functions, true)) {
+        if (!in_array($name, $this->functions, true)) {
             return null;
         }
 
@@ -66,6 +67,13 @@ private function extractGettextFunctions($token, string $filename, array &$funct
         foreach ($token->getIterator() as $subToken) {
             $this->extractGettextFunctions($subToken, $filename, $functions);
         }
+
+        if ($token instanceof ModuleNode) {
+            $embeddedTemplates = $token->getAttribute('embedded_templates');
+            foreach ($embeddedTemplates as $embed) {
+                $this->extractGettextFunctions($embed, $filename, $functions);
+            }
+        }
     }
 
     public function scan(string $code, string $filename): array

tests/TimberFunctionsScannerTest.php

@@ -62,7 +62,7 @@ public function testTwigFunctionsExtractor()
         $file = __DIR__ . '/assets/input.html.twig';
         $code = file_get_contents($file);
         $functions = $scanner->scan($code, $file);
-        $this->assertCount(11, $functions);
+        $this->assertCount(12, $functions);
 
         // text 1
         $function = array_shift($functions);
@@ -74,7 +74,7 @@ public function testTwigFunctionsExtractor()
 
         // text 3
         $function = array_shift($functions);
-        $this->cmp($function, $file, 7, '__', [ 'text 3 (with parenthesis)']);
+        $this->cmp($function, $file, 7, '__', ['text 3 (with parenthesis)']);
 
         // text 4
         $function = array_shift($functions);

tests/TimberScannerTest.php

@@ -36,10 +36,12 @@ public function testTwigCodeScanner()
         $scanner = new TimberScanner(Translations::create());
         list('' => $translations) = $this->initAndGetTranslations($scanner);
 
-        $this->assertCount(8, $translations);
+        $this->assertCount(9, $translations);
         $this->assertCount(0, $translations->getHeaders());
 
         $file = __DIR__ . '/assets/default-domain.po';
+        // Note: This test can fail due to `git config core.autocrlf` converting line endings to CRLF
+        // Double check any test error output for `#Warning: Strings contain different line endings!`
         $this->assertSame(
             file_get_contents($file),
             (new PoGenerator())->generateString($translations),
@@ -59,6 +61,8 @@ public function testTwigCodeScannerOtherDomains()
         $this->assertCount(1, $tr1);
         $this->assertCount(1, $tr1->getHeaders());
         $file1 = __DIR__ . '/assets/text-domain1.po';
+        // Note: This test can fail due to `git config core.autocrlf` converting line endings to CRLF
+        // Double check any test error output for `#Warning: Strings contain different line endings!`
         $this->assertSame(
             file_get_contents($file1),
             (new PoGenerator())->generateString($tr1),
@@ -68,6 +72,8 @@ public function testTwigCodeScannerOtherDomains()
         $this->assertCount(2, $tr2);
         $this->assertCount(1, $tr2->getHeaders());
         $file2 = __DIR__ . '/assets/text-domain2.po';
+        // Note: This test can fail due to `git config core.autocrlf` converting line endings to CRLF
+        // Double check any test error output for `#Warning: Strings contain different line endings!`
         $this->assertSame(
             file_get_contents($file2),
             (new PoGenerator())->generateString($tr2),

tests/assets/default-domain.po

@@ -36,3 +36,7 @@ msgstr ""
 msgid "text 11 with plural"
 msgid_plural "The plural form"
 msgstr[0] ""
+
+#: ./tests/assets/input.html.twig:26
+msgid "text 12 content inside a block in a embed template"
+msgstr ""

tests/assets/embed.html.twig

@@ -0,0 +1,5 @@
+<div class="embedded-content">
+        <h2>{{ __("text 13 header in the embed template, this should be scanned only if the file containing it is.") }}</h2>
+        {% block main %}
+        {% endblock %}
+</div>

tests/assets/input.html.twig

@@ -21,3 +21,8 @@
     </p>
     <p>
 </div>
+{% embed 'embed.html.twig' %}
+    {% block main %}
+        <p>{{ __("text 12 content inside a block in a embed template") }}</p>
+    {% endblock %}
+{% endembed %}