Merge pull request #2 from phug-php/enable-renderer

Fix pug-php compatibility

Author: kylekatarnls

src/Phug/Component/ComponentExtension.php

@@ -5,9 +5,11 @@
 use Closure;
 use Phug\AbstractPlugin;
 use Phug\Ast\NodeInterface;
+use Phug\Compiler\Event\ElementEvent;
 use Phug\Compiler\Event\NodeEvent;
 use Phug\Compiler\Event\OutputEvent;
 use Phug\CompilerEvent;
+use Phug\Formatter\Element\CodeElement;
 use Phug\Parser\NodeInterface as ParserNodeInterface;
 use Phug\Parser\Node\CodeNode;
 use Phug\Parser\Node\KeywordNode;
@@ -89,6 +91,8 @@ protected function getCodeNode(NodeInterface $linkedNode, ParserNodeInterface $p
             $code->setValue($value);
         }
 
+        $code->noTransform = true;
+
         return $code;
     }
 
@@ -116,29 +120,21 @@ public function handleNodeEvent(NodeEvent $event): void
 
     public function handleOutputEvent(OutputEvent $event): void
     {
-        $event->setOutput(
-            implode("\n", [
-                '<?php',
-                '$firstMixin = function (string ...$names) use (&$__pug_mixins) {',
-                '  foreach ($names as $name) {',
-                '    if (isset($__pug_mixins[$name])) {',
-                '      return $name;',
-                '    }',
-                '  }',
-                '  throw new \\InvalidArgumentException("No defined mixin/component in [".implode(", ", $names)."]");',
-                '};',
-                '$firstComponent = $firstMixin;',
-                '?>',
-            ]).
-            $event->getOutput()
-        );
+        $event->setOutput($this->parseOutput($event->getOutput()));
     }
 
     public function attachEvents(): void
     {
         $compiler = $this->getCompiler();
         $compiler->attach(CompilerEvent::NODE, [$this, 'handleNodeEvent']);
         $compiler->attach(CompilerEvent::OUTPUT, [$this, 'handleOutputEvent']);
+        $compiler->attach(CompilerEvent::ELEMENT, function (ElementEvent $event) {
+            $code = $event->getElement();
+
+            if ($code instanceof CodeElement && ($node = $code->getOriginNode()) && ($node->noTransform ?? false)) {
+                $code->preventFromTransformation();
+            }
+        });
     }
 
     public function detachEvents(): void
@@ -147,4 +143,27 @@ public function detachEvents(): void
         $compiler->detach(CompilerEvent::NODE, [$this, 'handleNodeEvent']);
         $compiler->detach(CompilerEvent::OUTPUT, [$this, 'handleOutputEvent']);
     }
+
+    private function parseOutput(string $output): string
+    {
+        $mixinFunctionsCode = implode("\n", [
+            '',
+            '$firstMixin = function (string ...$names) use (&$__pug_mixins) {',
+            '  foreach ($names as $name) {',
+            '    if (isset($__pug_mixins[$name])) {',
+            '      return $name;',
+            '    }',
+            '  }',
+            '  throw new \\InvalidArgumentException("No defined mixin/component in [".implode(", ", $names)."]");',
+            '};',
+            '$firstComponent = $firstMixin;',
+            '',
+        ]);
+
+        if (preg_match('/^(<\?(?:php)?\s+namespace\s\S.*)((\n[\s\S]*)?)$/U', $output, $matches)) {
+            return $matches[1].$mixinFunctionsCode.$matches[2];
+        }
+
+        return "<?php$mixinFunctionsCode?>$output";
+    }
 }

tests/Phug/Component/ComponentExtensionTest.php

@@ -32,16 +32,8 @@ class ComponentExtensionTest extends TestCase
      */
     protected $readme = null;
 
-    /**
-     * @var Formatter
-     */
-    protected $htmlFormatter;
-
     protected function setUp(): void
     {
-        $this->htmlFormatter = new Formatter;
-        $this->htmlFormatter->setSpacesIndentationMethod(2);
-
         preg_match(
             '/```php\n(?<php>[\s\S]+)\n```/U',
             $this->getReadmeContents(),
@@ -58,7 +50,9 @@ protected function renderAndFormat(string $code): string
 
     protected function format(string $html): string
     {
-        $html = trim($this->htmlFormatter->format($html));
+        $htmlFormatter = new Formatter;
+        $htmlFormatter->setSpacesIndentationMethod(2);
+        $html = trim($htmlFormatter->format($html));
         $html = preg_replace('/\s+<em>\s*(.*\S)\s*<\/em>\s+/', ' <em>$1</em>', $html);
         $html = preg_replace('/<p>\s*(.*\S)\s*<\/p>/', '<p>$1</p>', $html);
 
@@ -375,4 +369,57 @@ public function testWithPug()
             '    | Content',
         ]))));
     }
+
+    public function getPugPhpTestsTemplates(): array
+    {
+        return array_map(function ($file) {
+            return [$file, substr($file, 0, -5).'.pug'];
+        }, glob(__DIR__.'/../../templates/*.html'));
+    }
+
+    /**
+     * @dataProvider getPugPhpTestsTemplates
+     *
+     * @covers ::attachEvents
+     * @covers ::parseOutput
+     *
+     * @param string $htmlFile Expected output template file
+     * @param string $pugFile  Input template file
+     *
+     * @throws Exception
+     */
+    public function testPugPhpTestsTemplates(string $htmlFile, string $pugFile)
+    {
+        $pug = new Pug([
+            'debug' => false,
+            'pretty' => true,
+        ]);
+        ComponentExtension::enable($pug);
+
+        $this->assertSame(
+            $this->rawHtml(file_get_contents($htmlFile)),
+            $this->rawHtml($pug->renderFile($pugFile, [])),
+            basename($pugFile)
+        );
+    }
+
+    private function rawHtml($html)
+    {
+        $html = strtr($html, [
+            "'" => '"',
+            "\r" => '',
+        ]);
+        $html = preg_replace('`\n{2,}`', "\n", $html);
+        $html = preg_replace('`(?<!\n) {2,}`', ' ', $html);
+        $html = preg_replace('` *$`m', '', $html);
+        $html = $this->format($html);
+        $html = preg_replace_callback('`(<(?:style|script)(?:[^>]*)>)([\s\S]+)(</(?:style|script)>)`', function ($matches) {
+            [, $start, $content, $end] = $matches;
+            $content = trim(preg_replace('`^ *`m', '', $content));
+
+            return "$start\n$content\n$end";
+        }, $html);
+
+        return $html;
+    }
 }

tests/templates/attr.parenthesis.html

@@ -0,0 +1 @@
+<a b=')'></a>

tests/templates/attr.parenthesis.pug

@@ -0,0 +1 @@
+a(b=')')

tests/templates/attrs-data.complex.html

@@ -0,0 +1,5 @@
+<foo data-items="{&quot;foo&quot;:&quot;bar&quot;,&quot;yah&quot;:42,&quot;yoh&quot;:&quot;yah: 42&quot;,&quot;bar&quot;:&quot;a'a\&quot;\\\&quot;\\'\\\\&quot;}"></foo>
+<foo data-items="{&quot;foo&quot;:&quot;#{foo}, \\#{foo}&quot;,&quot;bar&quot;:&quot;#{foo}, \\#{foo}&quot;}"></foo>
+<foo data-items="[&quot;#{foo} [a]&quot;,&quot;#{foo} =&gt;&quot;]"></foo>
+<foo data-items="{&quot;a\\\&quot;\\&quot;:&quot;a&quot;}"></foo>
+<foo a'="'a"></foo>

tests/templates/attrs-data.complex.pug

@@ -0,0 +1,6 @@
+- foo = 42
+foo(data-items={ foo: 'bar', yah: 42, "yoh": "yah: 42", bar :'a\'a"\"\\\'\\\\' })
+foo(data-items={ foo: '#{foo}, \#{foo}', bar: "#{foo}, \#{foo}" })
+foo(data-items=['#{foo} [a]', "#{foo} =>"])
+foo(data-items={"a\\\"\\": "a"})
+foo('a\''='\'a')

tests/templates/attrs-data.html

@@ -0,0 +1,5 @@
+<foo data-user="{&quot;name&quot;:&quot;tobi&quot;}"></foo>
+<foo data-items="[1,2,3]"></foo>
+<foo data-username="tobi"></foo>
+<foo data-username="tobi"></foo>
+<foo data-username="tobi"></foo>

tests/templates/attrs-data.pug

@@ -0,0 +1,6 @@
+- user = {name: 'tobi'}
+foo(data-user=user)
+foo(data-items=[1,2,3])
+foo(data-username='tobi')
+foo("data-username"='tobi')
+foo('data-username'='tobi')

tests/templates/attrs.expressions.html

@@ -0,0 +1,5 @@
+<p answear="42"></p>
+<p answear="42"></p>
+<p answear="bar"></p>
+<p answear="bar"></p>
+<p answear="bar"></p>

tests/templates/attrs.expressions.pug

@@ -0,0 +1,14 @@
+:php
+    class FooClass {
+        public function met() {
+            return 42;
+        }
+    }
+    $ob = (object) array('foo' => array());
+    $ob->foo['bar'] = new FooClass();
+    $foo = 'bar';
+p(answear=ob.foo.bar.met())
+p(answear=(ob.foo.bar.met()))
+p(answear=substr("foo-bar", strlen("foo") + 1))
+p(answear=substr("foo-bar", strlen(strtoupper("F") + "oo") + 1))
+p(answear=foo[0] + (substr(foo, 1 / 3 * (strlen(foo)))))