Add possibility to add banner comment to the generated twig templates

Author: Alexander Pape

src/Compiler.php

@@ -26,15 +26,31 @@ class Compiler
     /** @var LoggerInterface */
     protected $logger;
 
+    /** @var string[] */
+    protected $banner;
+
     public function __construct(DOMDocument $document, LoggerInterface $logger)
     {
         $this->logger = $logger;
         $this->document = $document;
         $this->lastCloseIf = null;
+        $this->banner = [];
 
         $this->logger->debug("\n--------- New Compiler Instance ----------\n");
     }
 
+    /**
+     * @param string|string[] $strings
+     */
+    public function setBanner($strings): void
+    {
+        if (!is_array($strings)) {
+            $strings = [$strings];
+        }
+
+        $this->banner = $strings;
+    }
+
     /**
      * @throws Exception
      */
@@ -52,6 +68,10 @@ public function convert(): string
 
         $html = $this->replacePlaceholders($html);
 
+        if (!empty($this->banner)) {
+            $html = $this->addBanner($html);
+        }
+
         return $html;
     }
 
@@ -122,8 +142,8 @@ private function handleAttributeBinding(DOMElement $node)
                         $this->logger->debug('- setAttribute "'.$name.'" with value');
                         $node->setAttribute(
                             $name,
-                            Replacements::getSanitizedConstant('DOUBLE_CURLY_OPEN') .
-                            $value .
+                            Replacements::getSanitizedConstant('DOUBLE_CURLY_OPEN').
+                            $value.
                             Replacements::getSanitizedConstant('DOUBLE_CURLY_CLOSE')
                         );
                     }
@@ -300,7 +320,7 @@ protected function sanitizeCondition(string $condition)
         $condition = str_replace('&&', 'and', $condition);
         $condition = str_replace('||', 'or', $condition);
 
-        foreach(Replacements::getConstants() as $constant => $value) {
+        foreach (Replacements::getConstants() as $constant => $value) {
             $condition = str_replace($value, Replacements::getSanitizedConstant($constant), $condition);
         }
 
@@ -309,10 +329,34 @@ protected function sanitizeCondition(string $condition)
 
     protected function replacePlaceholders(string $string)
     {
-        foreach(Replacements::getConstants() as $constant => $value) {
+        foreach (Replacements::getConstants() as $constant => $value) {
             $string = str_replace(Replacements::getSanitizedConstant($constant), $value, $string);
         }
 
         return $string;
     }
-}
+
+    protected function addSingleLineBanner(string $html)
+    {
+        return '{# '.implode('', $this->banner).' #}'."\n".$html;
+    }
+
+    protected function addBanner(string $html)
+    {
+        if (count($this->banner) === 1) {
+            return $this->addSingleLineBanner($html);
+        }
+
+        $bannerLines = ['{#'];
+
+        foreach ($this->banner as $line) {
+            $bannerLines[] = ' # '.$line;
+        }
+
+        $bannerLines[] = ' #}';
+
+        $html = implode("\n", $bannerLines)."\n".$html;
+
+        return $html;
+    }
+}

tests/AbstractTestCase.php

@@ -15,7 +15,6 @@ protected function createCompiler(string $template): Compiler
         $document = $this->createDocumentWithHtml($template);
         $compiler = new Compiler($document, $this->createLogger());
 
-
         return $compiler;
     }
 

tests/CompilerTest.php

@@ -15,4 +15,41 @@ public function leavesMustacheVariablesIntact()
 
         $this->assertEqualHtml($expected, $actual);
     }
+
+    /** @test */
+    public function setBannerWithSingleLineAddsBannerCommentToTheTopOfTheTwigFile()
+    {
+        $html = '<template><div>{{ someVariable }}</div></template>';
+        $expected = '{# This file was generated using VueToTwig #}<div>{{ someVariable }}</div>';
+        $compiler = $this->createCompiler($html);
+        $compiler->setBanner('This file was generated using VueToTwig');
+
+        $actual = $compiler->convert();
+
+        $this->assertEqualHtml($expected, $actual);
+
+    }
+
+    /** @test */
+    public function setBannerAddsMultipleCommentsToTheTopOfTheTwigFile()
+    {
+        $html = '<template><div>{{ someVariable }}</div></template>';
+        $expected = '
+{#
+ # This file was generated using VueToTwig
+ # Source: assets/js/SomeComponent.vue
+ #}
+<div>{{ someVariable }}</div>';
+
+        $compiler = $this->createCompiler($html);
+        $compiler->setBanner([
+            'This file was generated using VueToTwig',
+            'Source: assets/js/SomeComponent.vue',
+        ]);
+
+        $actual = $compiler->convert();
+
+        $this->assertEqualHtml($expected, $actual);
+
+    }
 }