Remove obsolete LegacyDebugTemplate

Author: emodric

bundle/Templating/Twig/BaseDebugTemplate.php

@@ -4,10 +4,75 @@
 
 namespace Netgen\Bundle\SiteBundle\Templating\Twig;
 
+use Symfony\Component\Filesystem\Filesystem;
 use Twig\Source;
+use Twig\Template;
 
-class DebugTemplate extends BaseDebugTemplate
+use function dirname;
+use function getcwd;
+use function implode;
+use function mb_stripos;
+use function mb_substr;
+use function mb_trim;
+use function preg_replace;
+use function str_contains;
+use function str_ends_with;
+
+/**
+ * Meant to be used as a Twig base template class.
+ *
+ * Wraps the yield method to:
+ * - Inject debug info into template to be able to see in the markup which one is used
+ */
+class DebugTemplate extends Template
 {
+    private Filesystem $fileSystem;
+
+    public function yield(array $context, array $blocks = []): iterable
+    {
+        $this->fileSystem = $this->fileSystem ?? new Filesystem();
+
+        // Get parent result to be able to insert template name as HTML comments if applicable.
+        // Layout template name will only appear at the end, to avoid potential quirks with old browsers
+        // when comments appear before doctype declaration.
+        $templateResult = implode('', [...parent::yield($context, $blocks)]);
+
+        $templateName = mb_trim($this->fileSystem->makePathRelative($this->getSourceContext()->getPath(), dirname((string) getcwd())), '/');
+        $isHtmlTemplate = str_ends_with($templateName, 'html.twig');
+        $templateName = $isHtmlTemplate ? $templateName . ' (' . $this->getSourceContext()->getName() . ')' : $templateName;
+
+        // Display start template comment, if applicable.
+        if ($isHtmlTemplate) {
+            if (str_contains(mb_trim($templateResult), '<!doctype')) {
+                $templateResult = (string) preg_replace(
+                    '#(<!doctype[^>]+>)#im',
+                    "$1\n<!-- START " . $templateName . ' -->',
+                    $templateResult,
+                );
+            } else {
+                yield "\n<!-- START " . $templateName . " -->\n";
+            }
+        }
+
+        // Display stop template comment after result, if applicable.
+        if ($isHtmlTemplate) {
+            if (str_contains($templateResult, '</body>')) {
+                $bodyPos = (int) mb_stripos($templateResult, '</body>');
+
+                // Add layout template name before </body>, to avoid display quirks in some browsers.
+                yield mb_substr($templateResult, 0, $bodyPos)
+                     . "\n<!-- STOP " . $templateName . " -->\n"
+                     . mb_substr($templateResult, $bodyPos);
+            } else {
+                yield $templateResult;
+
+                yield "\n<!-- STOP " . $templateName . " -->\n";
+            }
+        } else {
+            yield $templateResult;
+        }
+    }
+
     public function getTemplateName(): string
     {
         return '';

bundle/Templating/Twig/DebugTemplate.php

@@ -4,13 +4,11 @@
 
 namespace Netgen\Bundle\SiteBundle\Templating\Twig;
 
-use Composer\InstalledVersions;
 use Twig\Environment as BaseEnvironment;
 use Twig\Source;
 
 use function sprintf;
 use function str_replace;
-use function version_compare;
 
 final class Environment extends BaseEnvironment
 {
@@ -22,14 +20,9 @@ public function compileSource(Source $source): string
             return $compiledSource;
         }
 
-        $className = DebugTemplate::class;
-        if (version_compare(InstalledVersions::getVersion('twig/twig') ?? '', '3.12.0', '<')) {
-            $className = LegacyDebugTemplate::class;
-        }
-
         return str_replace(
             ' extends Template',
-            sprintf(' extends %s', $className),
+            sprintf(' extends %s', DebugTemplate::class),
             $compiledSource,
         );
     }