From eb03198d94c890b785ec0e6901293124bc7c685d Mon Sep 17 00:00:00 2001
From: roxblnfk <roxblnfk@ya.ru>
Date: Fri, 14 Jun 2024 14:13:53 +0400
Subject: [PATCH] chore(sender): rename `raw` sender to `file-body`

---
 src/Command/Run.php                                    | 4 ++--
 src/Sender/{RawFileSender.php => BodyToFileSender.php} | 7 +++++--
 src/Sender/{FileSender.php => EventsToFileSender.php}  | 5 ++++-
 3 files changed, 11 insertions(+), 5 deletions(-)
 rename src/Sender/{RawFileSender.php => BodyToFileSender.php} (91%)
 rename src/Sender/{FileSender.php => EventsToFileSender.php} (88%)

diff --git a/src/Command/Run.php b/src/Command/Run.php
index b81a3612..fa72e9cf 100644
--- a/src/Command/Run.php
+++ b/src/Command/Run.php
@@ -80,8 +80,8 @@ public function createRegistry(OutputInterface $output): Sender\SenderRegistry
     {
         $registry = new Sender\SenderRegistry();
         $registry->register('console', Sender\ConsoleSender::create($output));
-        $registry->register('file', new Sender\FileSender());
-        $registry->register('raw', new Sender\RawFileSender());
+        $registry->register('file', new Sender\EventsToFileSender());
+        $registry->register('file-body', new Sender\BodyToFileSender());
         $registry->register(
             'server',
             new Sender\RemoteSender(
diff --git a/src/Sender/RawFileSender.php b/src/Sender/BodyToFileSender.php
similarity index 91%
rename from src/Sender/RawFileSender.php
rename to src/Sender/BodyToFileSender.php
index b84af22e..d02a9052 100644
--- a/src/Sender/RawFileSender.php
+++ b/src/Sender/BodyToFileSender.php
@@ -10,14 +10,17 @@
 use Nyholm\Psr7\Stream;
 
 /**
+ * Sends event body stream to file if possible.
+ * It creates a new file for each frame.
+ *
  * @internal
  */
-class RawFileSender implements Sender
+class BodyToFileSender implements Sender
 {
     private readonly string $path;
 
     public function __construct(
-        string $path = 'runtime/raw',
+        string $path = 'runtime/body',
     ) {
         $this->path = \rtrim($path, '/\\');
         if (!\is_dir($path) && !\mkdir($path, 0o777, true) && !\is_dir($path)) {
diff --git a/src/Sender/FileSender.php b/src/Sender/EventsToFileSender.php
similarity index 88%
rename from src/Sender/FileSender.php
rename to src/Sender/EventsToFileSender.php
index 180df480..b99daa2c 100644
--- a/src/Sender/FileSender.php
+++ b/src/Sender/EventsToFileSender.php
@@ -8,9 +8,12 @@
 use Buggregator\Trap\Sender;
 
 /**
+ * Store event groups to files.
+ * JSON format is used for serialization of each event.
+ *
  * @internal
  */
-class FileSender implements Sender
+class EventsToFileSender implements Sender
 {
     private readonly string $path;