symfony · DRaichev · Sep 2, 2024
diff --git a/src/TurboStreamRender/src/Core/TurboStream.php b/src/TurboStreamRender/src/Core/TurboStream.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+
+namespace src\Core;
+
+use src\Enum\TurboAction;
+
+readonly class TurboStream
+{
+    public function __construct(
+        public string $target,
+        public TurboAction $action,
+        public string $view,
+        public array $parameters,
+    ) {
+    }
+}
diff --git a/src/TurboStreamRender/src/Core/TurboStreamCollection.php b/src/TurboStreamRender/src/Core/TurboStreamCollection.php
@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+
+namespace src\Core;
+
+use src\Enum\TurboAction;
+
+class TurboStreamCollection
+{
+
+    /**
+     * @param TurboStream[] $streams
+     */
+    public function __construct(private array $streams = [])
+    {
+    }
+
+    public function add(string $target, TurboAction $action, $view, array $parameters = [])
+    {
+        return $this->addStream(new TurboStream($target, $action, $view, $parameters));
+    }
+
+    public function addStream(TurboStream $stream): self
+    {
+        $this->streams[] = $stream;
+
+        return $this;
+    }
+
+    /**
+     * @return TurboStream[]
+     */
+    public function all(): array
+    {
+        return $this->streams;
+    }
+}
diff --git a/src/TurboStreamRender/src/Core/TurboStreamRenderer.php b/src/TurboStreamRender/src/Core/TurboStreamRenderer.php
@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace src\Core;
+
+use src\Enum\TurboAction;
+use TurboStreamRendererInterface;
+
+class TurboStreamRenderer implements TurboStreamRendererInterface
+{
+    /**
+     * This is a hacky way to reuse the code of renderView form AbstractController - just pass the method as a callable to the renderer constructor.
+     * @var callable $renderer
+     */
+    protected $renderer = null;
+
+    public function __construct(callable $renderer)
+    {
+        $this->renderer = $renderer;
+    }
+
+    /**
+     * @throws \InvalidRendererException
+     */
+    public function renderView(string $view, array $parameters = []): string
+    {
+        try {
+            $renderer = $this->renderer;
+            return $renderer($view, $parameters);
+        }catch (\Throwable $e) {
+            throw new \InvalidRendererException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    public function renderAsStreamView(string $target, TurboAction $action, string $view, array $parameters = []): string
+    {
+        $streams = (new TurboStreamCollection())->add($target, $action, $view, $parameters);
+
+        return $this->renderTurboStreamsView($streams->all());
+    }
+
+    /**
+     * @throws \InvalidRendererException
+     */
+    public function renderTurboStreamsView(array $streams): string
+    {
+        $response = "";
+        foreach ($streams as $stream) {
+            $content = $this->renderView($stream['view'], $stream['parameters']);
+            $response .= $this->wrapWithTurboStream($stream['target'], $stream['action'], $content);
+            $response .= "\n";
+        }
+
+        return $response;
+    }
+
+    private function wrapWithTurboStream(string $target, TurboAction $action, string $content): string
+    {
+        return <<<HTML
+        <turbo-stream action="$action->value" target="$target">
+            <template>
+                $content
+            </template>
+        </turbo-stream>
+        HTML;
+    }
+}
diff --git a/src/TurboStreamRender/src/Enum/TurboAction.php b/src/TurboStreamRender/src/Enum/TurboAction.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace src\Enum;
+
+enum TurboAction: string
+{
+    case APPEND = 'append';
+    case PREPEND = 'prepend';
+    case REPLACE = 'replace';
+    case UPDATE = 'update';
+    case REMOVE = 'remove';
+    case BEFORE = 'before';
+    case AFTER = 'after';
+    case REFRESH = 'refresh';
+}
diff --git a/src/TurboStreamRender/src/Exception/InvalidRendererException.php b/src/TurboStreamRender/src/Exception/InvalidRendererException.php
@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+
+class InvalidRendererException extends \Exception
+{
+}
diff --git a/src/TurboStreamRender/src/Interface/TurboStreamRendererInterface.php b/src/TurboStreamRender/src/Interface/TurboStreamRendererInterface.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use src\Core\TurboStream;
+use src\Enum\TurboAction;
+
+interface TurboStreamRendererInterface
+{
+    function renderAsStreamView(string $target, TurboAction $action, string$view, array $parameters = []): string;
+
+    /**
+     * @param TurboStream[] $streams
+     */
+    function renderTurboStreamsView(array $streams): string;
+}
diff --git a/src/TurboStreamRender/src/Trait/TurboRenderTrait.php b/src/TurboStreamRender/src/Trait/TurboRenderTrait.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace src\Trait;
+
+use src\Core\TurboStream;
+use src\Core\TurboStreamCollection;
+use src\Enum\TurboAction;
+use TurboStreamRendererInterface;
+
+// This needs Symfony\Component\HttpFoundation\Response so it won't work as part of the turbo bundle, unless there is another way to keep it decoupled.
+// An alternative would be to have this as a separate bundle.
+
+
+trait TurboRenderTrait
+{
+    abstract protected function getTurboStreamRenderer(): TurboStreamRendererInterface;
+
+    protected function renderAsStreamView(string $target, TurboAction $action, $view, array $parameters = []): string
+    {
+        $streams = (new TurboStreamCollection())->add($target, $action, $view, $parameters);
+
+        return $this->renderTurboStreamsView($streams->all());
+    }
+
+    /**
+     * @param TurboStream[] $streams
+     */
+    protected function renderTurboStreamsView(array $streams): string
+    {
+        return $this->getTurboStreamRenderer()->renderTurboStreamsView($streams);
+    }
+
+    private function wrapWithTurboStream(string $target, TurboAction $action, string $content): string
+    {
+        return <<<HTML
+        <turbo-stream action="$action->value" target="$target">
+            <template>
+                $content
+            </template>
+        </turbo-stream>
+        HTML;
+    }
+}
diff --git a/src/TurboStreamResponse/src/Trait/TurboResponseTrait.php b/src/TurboStreamResponse/src/Trait/TurboResponseTrait.php
@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace src\Trait;
+
+use src\Core\TurboStream;
+use src\Enum\TurboAction;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\UX\Turbo\TurboBundle;
+
+// This needs Symfony\Component\HttpFoundation\Response so it won't work as part of the turbo bundle, unless there is another way to keep it decoupled.
+// An alternative would be to have this as a separate bundle.
+
+
+trait TurboResponseTrait
+{
+
+    use TurboRenderTrait;
+
+    protected function renderAsStream(string $target, TurboAction $action, $view, array $parameters = []): Response
+    {
+       return $this->renderTurboStreams([new TurboStream($target, $action, $view, $parameters)]);
+    }
+
+    /**
+     * @param TurboStream[] $streams
+     */
+    protected function renderTurboStreams(array $streams): Response
+    {
+        $content = $this->renderTurboStreamsView($streams);
+        $response ??= new Response();
+
+        // I would like to keep this part of the standard AbstractController, but I don't really like the idea of duplication the code.
+        // Any suggestions for a way to reuse it?
+
+        foreach ($streams as $stream) {
+            if (200 === $response->getStatusCode()) {
+                $parameters = $stream->getParameters();
+                foreach ($parameters as $v) {
+                    if ($v instanceof FormInterface && $v->isSubmitted() && !$v->isValid()) {
+                        $response->setStatusCode(422);
+                        break 2;
+                    }
+                }
+            }
+        }
+
+        $response->setContent($content);
+        $response->headers->set('Content-Type', TurboBundle::STREAM_MEDIA_TYPE);
+
+        return $response;
+    }
+
+    private function wrapWithTurboStream(string $target, TurboAction $action, string $content): string
+    {
+        return <<<HTML
+        <turbo-stream action="$action->value" target="$target">
+            <template>
+                $content
+            </template>
+        </turbo-stream>
+        HTML;
+    }
+}
diff --git a/ux.symfony.com/templates/components/TurboStream.html.twig b/ux.symfony.com/templates/components/TurboStream.html.twig
@@ -0,0 +1,5 @@
+<turbo-stream action="{{ action }}" target="{{ target }}">
+    <template>
+        {% block content %}{% endblock %}
+    </template>
+</turbo-stream>