Merge pull request #1 from phug-php/prototype

Prototype

Author: kylekatarnls

README.md

@@ -1,8 +1,8 @@
 # Phug Component
 
-Extension for pug-php and phug to use components in templates
+Extension for Pug-php and Phug to use components in templates
 
-## Install
+## Installation
 
 ```
 composer require phug/component
@@ -37,7 +37,7 @@ component alert
 
 section
   //- Somewhere later in your template
-  @alert
+  +alert
     slot title
       | Hello #[em world]!
 
@@ -57,3 +57,38 @@ Output:
   </div>
 </section>
 ```
+
+### Default slots
+
+```pug
+component page
+  header
+    slot header
+      | Default header
+
+  slot
+
+  footer
+    slot footer
+      | Default footer
+
++page
+  | My page content
+
+  slot footer
+    | Custom footer
+```
+
+Output:
+
+```html
+<header>
+  Default header
+</header>
+
+My page content
+
+<footer>
+  Custom footer
+</footer>
+```

composer.json

@@ -25,7 +25,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^8",
-        "pug-php/pug": "^3"
+        "pug-php/pug": "^3",
+        "machy8/xhtml-formatter": "^1.0"
     },
     "autoload": {
         "psr-4": {

src/Phug/Component/ComponentExtension.php

@@ -2,6 +2,146 @@
 
 namespace Phug\Component;
 
-class ComponentExtension
+use Closure;
+use Phug\AbstractExtension;
+use Phug\Ast\NodeInterface;
+use Phug\Compiler\Event\NodeEvent;
+use Phug\CompilerEvent;
+use Phug\Formatter\Element\KeywordElement;
+use Phug\Formatter\Element\MixinElement;
+use Phug\Parser\NodeInterface as ParserNodeInterface;
+use Phug\Parser\Node\CodeNode;
+use Phug\Parser\Node\KeywordNode;
+use Phug\Parser\Node\MixinCallNode;
+use Phug\Parser\Node\TextNode;
+use Phug\Phug;
+use Phug\Renderer;
+use Phug\RendererModuleInterface;
+use Phug\Util\Partial\OptionTrait;
+
+class ComponentExtension extends AbstractExtension implements RendererModuleInterface
 {
+    use OptionTrait;
+
+    const PUG_SLOT_NAME_VARIABLE = 'pug_component_slot';
+
+    /**
+     * @var Renderer
+     */
+    private $renderer;
+
+    public function __construct(Renderer $renderer)
+    {
+        $this->renderer = $renderer->setOptions([
+            'keywords' => $this->getKeywords(),
+        ]);
+    }
+
+    public function getContainer(): Renderer
+    {
+        return $this->renderer;
+    }
+
+    public static function enable(): void
+    {
+        Phug::addExtension(static::class);
+    }
+
+    public static function disable(): void
+    {
+        Phug::removeExtension(static::class);
+    }
+
+    public static function slot(string $name, array $definedVariables)
+    {
+        $children = $definedVariables['__pug_children'] ?? null;
+        $callbackName = static::PUG_SLOT_NAME_VARIABLE.'_'.$name;
+
+        if (is_object($children) && $children instanceof Closure) {
+            $called = false;
+            $children(array_merge([
+                static::PUG_SLOT_NAME_VARIABLE => $name ?: '__main__',
+                $callbackName => static function () use (&$called) {
+                    $called = true;
+                }
+            ], $definedVariables));
+
+            return !$called;
+        }
+
+        if (($definedVariables[static::PUG_SLOT_NAME_VARIABLE] ?? null) === $name) {
+            $callback = $definedVariables[$callbackName] ?? null;
+
+            if ($callback && $callback instanceof Closure) {
+                $callback();
+            }
+
+            return true;
+        }
+
+        return false;
+    }
+
+    public function getKeywords(): array
+    {
+        return [
+            'component' => function (string $name, KeywordElement $keyword): string {
+                $mixin = new MixinElement;
+                $mixin->setName($name);
+                $mixin->setChildren($keyword->getChildren());
+                $keyword->removeChildren();
+
+                return $this->renderer->getCompiler()->getFormatter()->format($mixin);
+            },
+            'slot' => static function (string $name, KeywordElement $keyword): array {
+                return [
+                    'begin' => '<?php if ('.static::class.'::slot('.var_export($name, true).', get_defined_vars())) { ?>',
+                    'end' => '<?php } ?>',
+                ];
+            },
+        ];
+    }
+
+    protected function getCodeNode(NodeInterface $linkedNode, ParserNodeInterface $parentNode = null, $value = null, array $children = null)
+    {
+        $code = new CodeNode($linkedNode->getToken(), null, $linkedNode->getLevel(), $parentNode, $children);
+
+        if ($value !== null) {
+            $code->setValue($value);
+        }
+
+        return $code;
+    }
+
+    public function handleNodeEvent(NodeEvent $event): void
+    {
+        $call = $event->getNode();
+
+        if ($call instanceof MixinCallNode) {
+            $call->setChildren(array_merge(
+                [$this->getCodeNode($call, $call, '$'.static::PUG_SLOT_NAME_VARIABLE.' = null')],
+                array_map(function (NodeInterface $node) use ($call) {
+                    if ($node instanceof KeywordNode && $node->getName() === 'slot') {
+                        return $node;
+                    }
+
+                    return $this->getCodeNode($node, $call, null, [
+                        (new TextNode($node->getToken(), null, $node->getLevel()))->setValue('if (!isset($'.static::PUG_SLOT_NAME_VARIABLE.') || $'.static::PUG_SLOT_NAME_VARIABLE.' === "__main__")'),
+                        $this->getCodeNode($node, null, '// main slot'),
+                        $node,
+                    ]);
+                }, $call->getChildren())
+            ));
+        }
+    }
+
+    public function attachEvents(): void
+    {
+        $this->renderer->getCompiler()->attach(CompilerEvent::NODE, [$this, 'handleNodeEvent']);
+    }
+
+    public function detachEvents(): void
+    {
+        $this->renderer->getCompiler()->detach(CompilerEvent::NODE, [$this, 'handleNodeEvent']);
+    }
 }

src/Phug/Component/equiv.pug

@@ -0,0 +1,21 @@
+mixin a(b)
+    - ob_start()
+    p=b
+    __pug_slot_1
+        span Slot
+    foo
+        block
+    - contents = ob_get_contents()
+    - ob_end_clean()
+    - preg_match_all('/<__pug_slot_1>([\s\S]*)<\/__pug_slot_1>/U', contents, pug_slot_1, PREG_SET_ORDER)
+    - pug_slot_1 = end(pug_slot_1)
+    !=preg_replace_callback('/<__pug_slot_1>([\s\S]*)<\/__pug_slot_1>/U', function () {
+        code = pug_slot_1[1];
+        pug_slot_1[1] = '';
+            return code;
+        }, contents)
+
++a(4)
+    __pug_slot_1
+        b OverSlot
+    div