Ability to provide channel to formatters. (#16)

gmponos · Feb 28, 2020 · 8711aae · 8711aae
1 parent 7a14db7
commit 8711aae
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 4 deletions.
diff --git a/src/Formatter/AbstractSlackAttachmentFormatter.php b/src/Formatter/AbstractSlackAttachmentFormatter.php
@@ -35,17 +35,28 @@ abstract class AbstractSlackAttachmentFormatter extends NormalizerFormatter impl
      */
     private $includeContextAndExtra;
 
+    /**
+     * @var string|null
+     */
+    private $channel;
+
     /**
      * @param string|null $username The username of the bot.
      * @param string|null $emoji
      * @param bool $includeContextAndExtra
+     * @param string|null $channel
      */
-    public function __construct(?string $username = null, ?string $emoji = null, bool $includeContextAndExtra = true)
-    {
+    public function __construct(
+        ?string $username = null,
+        ?string $emoji = null,
+        bool $includeContextAndExtra = true,
+        ?string $channel = null
+    ) {
         parent::__construct();
         $this->username = $username;
         $this->emoji = $emoji !== null ? trim($emoji, ':') : null;
         $this->includeContextAndExtra = $includeContextAndExtra;
+        $this->channel = $channel;
     }
 
     /**
@@ -64,6 +75,10 @@ public function format(array $record): array
             $data['icon_emoji'] = sprintf(':%s:', $this->emoji);
         }
 
+        if ($this->channel !== null) {
+            $data['channel'] = $this->channel;
+        }
+
         $attachment = [
             'fallback' => $record['message'],
             'text' => $record['message'],

diff --git a/src/Formatter/SlackLineFormatter.php b/src/Formatter/SlackLineFormatter.php
@@ -33,18 +33,29 @@ final class SlackLineFormatter extends NormalizerFormatter implements SlackForma
      */
     private $lineFormatter;
 
+    /**
+     * @var string|null
+     */
+    private $channel;
+
     /**
      * @param string|null $username
      * @param string|null $emoji
      * @param string|null $format
+     * @param string|null $channel
      */
-    public function __construct(?string $username = null, ?string $emoji = null, ?string $format = null)
-    {
+    public function __construct(
+        ?string $username = null,
+        ?string $emoji = null,
+        ?string $format = null,
+        ?string $channel = null
+    ) {
         parent::__construct();
         $format = $format ?: '%channel%.%level_name%: %message% %context% %extra%';
         $this->lineFormatter = new LineFormatter($format, null, false, true);
         $this->username = $username;
         $this->emoji = $emoji !== null ? trim($emoji, ':') : null;
+        $this->channel = $channel;
     }
 
     /**
@@ -63,6 +74,10 @@ public function format(array $record): array
             $data['icon_emoji'] = sprintf(':%s:', $this->emoji);
         }
 
+        if ($this->channel !== null) {
+            $data['channel'] = $this->channel;
+        }
+
         return $data;
     }
 }
diff --git a/tests/Unit/Formatter/SlackLineFormatterTest.php b/tests/Unit/Formatter/SlackLineFormatterTest.php
@@ -76,4 +76,21 @@ public function correctEmojiProvider()
             [':warning:', ':warning:'],
         ];
     }
+
+    public function testNoChannel()
+    {
+        $formatter = new SlackLineFormatter(null, null, null);
+        $data = $formatter->format($this->getRecord());
+
+        $this->assertArrayNotHasKey('channel', $data);
+    }
+
+    public function testHasChannel()
+    {
+        $formatter = new SlackLineFormatter(null, null, null, 'my-slack-channel');
+        $data = $formatter->format($this->getRecord());
+
+        $this->assertArrayHasKey('channel', $data);
+        $this->assertSame('my-slack-channel', $data['channel']);
+    }
 }
diff --git a/tests/Unit/Formatter/SlackLongAttachmentFormatterTest.php b/tests/Unit/Formatter/SlackLongAttachmentFormatterTest.php
@@ -170,6 +170,23 @@ public function testAddsInternalFieldDoesNotExceed2000Characters()
         $this->assertStringEndsWith('... (truncated)```', $data['attachments'][0]['fields'][0]['value']);
     }
 
+    public function testAddsCustomChannel()
+    {
+        $formatter = new SlackLongAttachmentFormatter(null, null, true, 'my-slack-channel');
+        $data = $formatter->format($this->getRecord());
+
+        $this->assertArrayHasKey('channel', $data);
+        $this->assertSame('my-slack-channel', $data['channel']);
+    }
+
+    public function testChannelIsNotAddedByDefault()
+    {
+        $formatter = new SlackLongAttachmentFormatter();
+        $data = $formatter->format($this->getRecord());
+
+        $this->assertArrayNotHasKey('channel', $data);
+    }
+
     /**
      * @param string|null $username
      * @param string $userIcon