Add separator payload

docs/usage/framework-agnostic-php-project.md

@@ -58,6 +58,19 @@ ray(['John', 'Paul', 'George', 'Ringo'])->label('Beatles');
 
 ![screenshot](/docs/ray/v1/images/label.png)
 
+### Showing a separator
+
+Another way to visually separate items in Ray, is to call  `seperator`.
+
+```php
+ray('first item');
+
+ray()->separator();
+
+ray('second item');
+```
+
+![screenshot](/docs/ray/v1/images/separator.png)
 
 
 ### Creating a new screen
@@ -193,7 +206,6 @@ foreach (range(1, 10) as $i) {
 
 If the argument passed to `limit()` is a negative number or zero, limiting is disabled.
 
-
 ### Using a rate limiter
 
 A rate limiter can help to reduce the amount of sent messages. This would avoid spamming the desktop app, which can be helpful when using Ray in loops.
@@ -213,7 +225,6 @@ Ray::rateLimiter()->clear();
 
 A message to the desktop app will be sent once to notify the user the rate limit has been reached.
 
-
 ### Sending a payload once
 
 To only send a payload once, use the `once` function.  This is useful for debugging loops.

docs/usage/reference.md

@@ -75,6 +75,7 @@ To display something in Ray use the `ray()` function. It accepts everything: str
 | `ray()->rateLimiter()->clear()` | Clears the rate limits |
 | `ray()->raw($value)` | Send raw output of a value to Ray without fancy formatting |
 | `ray(…)->red()` | Output in red |
+| `ray()->separator()` | Add a visual separator |
 | `ray()->showApp()` | Bring the app to the foreground |
 | `ray(…)->small()` | Output text smaller |
 | `ray()->table($array, $label)` | Format an associative array with optional label  |

src/Payloads/SeparatorPayload.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Spatie\Ray\Payloads;
+
+class SeparatorPayload extends Payload
+{
+    public function getType(): string
+    {
+        return 'separator';
+    }
+}

src/Ray.php

@@ -34,6 +34,7 @@
 use Spatie\Ray\Payloads\NotifyPayload;
 use Spatie\Ray\Payloads\PhpInfoPayload;
 use Spatie\Ray\Payloads\RemovePayload;
+use Spatie\Ray\Payloads\SeparatorPayload;
 use Spatie\Ray\Payloads\ShowAppPayload;
 use Spatie\Ray\Payloads\SizePayload;
 use Spatie\Ray\Payloads\TablePayload;
@@ -497,6 +498,13 @@ public function pause(): self
         return $this;
     }
 
+    public function separator(): self
+    {
+        $payload = new SeparatorPayload();
+
+        return $this->sendRequest($payload);
+    }
+
     public function html(string $html = ''): self
     {
         $payload = new HtmlPayload($html);

tests/RayTest.php

@@ -1286,6 +1286,14 @@ public function it_can_dump_a_string_with_a_global_function_name()
         $this->assertMatchesOsSafeSnapshot($this->client->sentPayloads());
     }
 
+    /** @test */
+    public function it_can_send_a_separator()
+    {
+        $this->ray->send('separator');
+
+        $this->assertMatchesOsSafeSnapshot($this->client->sentPayloads());
+    }
+
     protected function getNewRay(): Ray
     {
         return Ray::create($this->client, 'fakeUuid');

tests/__snapshots__/RayTest__it_can_send_a_separator__1.json

@@ -0,0 +1,21 @@
+[
+    {
+        "uuid": "fakeUuid",
+        "payloads": [
+            {
+                "type": "log",
+                "content": {
+                    "values": [
+                        "separator"
+                    ]
+                },
+                "origin": {
+                    "file": "\/tests\/RayTest.php",
+                    "line_number": "xxx",
+                    "hostname": "fake-hostname"
+                }
+            }
+        ],
+        "meta": []
+    }
+]