Adds morph method helper to pending turbo stream responses

tonysm · tonysm · commit 41cd35225600 · 2024-08-22T19:43:39.000-03:00
diff --git a/src/Http/PendingTurboStreamResponse.php b/src/Http/PendingTurboStreamResponse.php
@@ -12,6 +12,7 @@
 use Illuminate\Contracts\Support\Responsable;
 use Illuminate\Contracts\View\View;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Arr;
 use Illuminate\Support\HtmlString;
 use Illuminate\Support\Traits\Macroable;
 
@@ -37,7 +38,7 @@ class PendingTurboStreamResponse implements Htmlable, Renderable, Responsable
 
     public static function forModel(Model $model, ?string $action = null): self
     {
-        $builder = new self();
+        $builder = new self;
 
         // We're treating soft-deleted models as they were deleted. In other words, we
         // will render the remove Turbo Stream. If you need to treat a soft-deleted
@@ -108,6 +109,22 @@ public function attributes(array $attributes): self
         return $this;
     }
 
+    public function morph(): self
+    {
+        return $this->method('morph');
+    }
+
+    public function method(?string $method = null): self
+    {
+        if ($method) {
+            return $this->attributes(array_merge($this->useCustomAttributes, [
+                'method' => $method,
+            ]));
+        }
+
+        return $this->attributes(Arr::except($this->useCustomAttributes, 'method'));
+    }
+
     public function append(Model|string $target, $content = null): self
     {
         return $this->buildAction(
@@ -267,8 +284,7 @@ private function buildActionAll(string $action, Model|string $targets, $content
 
     public function broadcastTo($channel, ?callable $callback = null)
     {
-        $callback = $callback ?? function () {
-        };
+        $callback = $callback ?? function () {};
 
         return tap($this, function () use ($channel, $callback) {
             $callback($this->asPendingBroadcast($channel));
@@ -277,8 +293,7 @@ public function broadcastTo($channel, ?callable $callback = null)
 
     public function broadcastToPrivateChannel($channel, ?callable $callback = null)
     {
-        $callback = $callback ?? function () {
-        };
+        $callback = $callback ?? function () {};
 
         return $this->broadcastTo(null, function (PendingBroadcast $broadcast) use ($channel, $callback) {
             $broadcast->toPrivateChannel($channel);
@@ -288,8 +303,7 @@ public function broadcastToPrivateChannel($channel, ?callable $callback = null)
 
     public function broadcastToPresenceChannel($channel, ?callable $callback = null)
     {
-        $callback = $callback ?? function () {
-        };
+        $callback = $callback ?? function () {};
 
         return $this->broadcastTo(null, function (PendingBroadcast $broadcast) use ($channel, $callback) {
             $callback($broadcast->toPresenceChannel($channel));
diff --git a/tests/FunctionsTest.php b/tests/FunctionsTest.php
@@ -64,6 +64,33 @@ public function namespaced_turbo_stream_fn()
             HTML),
             trim(turbo_stream($this->article)),
         );
+
+        $expected = trim(view('articles._article', [
+            'article' => $this->article,
+        ])->render());
+
+        $this->assertEquals(
+            trim(<<<HTML
+            <turbo-stream target="article_{$this->article->id}" action="replace" method="morph">
+                <template>{$expected}</template>
+            </turbo-stream>
+            HTML),
+            trim(turbo_stream($this->article->fresh())->morph()),
+        );
+
+        // Unsets method
+        $expected = trim(view('articles._article', [
+            'article' => $this->article,
+        ])->render());
+
+        $this->assertEquals(
+            trim(<<<HTML
+            <turbo-stream target="article_{$this->article->id}" action="replace">
+                <template>{$expected}</template>
+            </turbo-stream>
+            HTML),
+            trim(turbo_stream($this->article->fresh())->morph()->method()),
+        );
     }
 
     /** @test */
@@ -105,6 +132,33 @@ public function global_turbo_stream_fn()
             HTML),
             trim(\turbo_stream($this->article)),
         );
+
+        $expected = trim(view('articles._article', [
+            'article' => $this->article,
+        ])->render());
+
+        $this->assertEquals(
+            trim(<<<HTML
+            <turbo-stream target="article_{$this->article->id}" action="replace" method="morph">
+                <template>{$expected}</template>
+            </turbo-stream>
+            HTML),
+            trim(\turbo_stream($this->article->fresh())->morph()),
+        );
+
+        // Unsets method
+        $expected = trim(view('articles._article', [
+            'article' => $this->article,
+        ])->render());
+
+        $this->assertEquals(
+            trim(<<<HTML
+            <turbo-stream target="article_{$this->article->id}" action="replace">
+                <template>{$expected}</template>
+            </turbo-stream>
+            HTML),
+            trim(\turbo_stream($this->article->fresh())->morph()->method()),
+        );
     }
 
     /** @test */
