Merge pull request #1 from BinarCode/docs

Docs

Author: binaryk

.github/workflows/run-tests.yml

@@ -8,10 +8,10 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest]
         php: [8.0, 7.4]
         laravel: [8.*]
-        stability: [prefer-lowest, prefer-stable]
+        stability: [prefer-stable]
         include:
           - laravel: 8.*
             testbench: 6.*
@@ -28,7 +28,7 @@ jobs:
           php-version: ${{ matrix.php }}
           extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
           coverage: none
-          
+
       - name: Setup problem matchers
         run: |
           echo "::add-matcher::${{ runner.tool_cache }}/php.json"

README.md

@@ -56,14 +56,31 @@ return [
 
 ## Usage
 
+### Send exception to slack
+
 The simplies way to use the package is to send an exception to the slack:
 
 ```php
+use Binarcode\LaravelDeveloper\LaravelDeveloper;
+
 LaravelDeveloper::exceptionToDevSlack(
     new \Exception('wew')
 );
 ```
 
+### Send anything to slack
+
+Obviously, you can send any kind of message to the slack channel. The `toDevSlack` method accept an instance of `DevNotificationDto`:
+
+```php
+use Binarcode\LaravelDeveloper\LaravelDeveloper;
+use Binarcode\LaravelDeveloper\Dtos\DevNotificationDto;
+
+LaravelDeveloper::toDevSlack(
+    DevNotificationDto::makeWithMessage('hey')
+);
+```
+
 ### Persist exception
 
 If you want to persist the exception into the database, in any place you want to catch and log an exception, you can do something like this: 

composer.json

@@ -23,7 +23,7 @@
     "require-dev": {
         "orchestra/testbench": "^6.0",
         "phpunit/phpunit": "^9.3",
-        "vimeo/psalm": "^3.11"
+        "vimeo/psalm": "^4.3"
     },
     "autoload": {
         "psr-4": {

src/Dtos/DevNotificationDto.php

@@ -49,14 +49,21 @@ public function getAttachmentContent(): ?string
         return $this->attachment_content ?? $this->attachment_title;
     }
 
-    public static function makeFromException(Throwable $t)
+    public static function makeWithMessage(string $message): self
+    {
+        return new static([
+            'message' => $message,
+        ]);
+    }
+
+    public static function makeFromException(Throwable $t): self
     {
         return new static([
             'message' => $t->getMessage(),
         ]);
     }
 
-    public static function makeFromExceptionLog(ExceptionLog $log)
+    public static function makeFromExceptionLog(ExceptionLog $log): self
     {
         return new static([
             'message' => $log->name,

src/LaravelDeveloper.php

@@ -27,8 +27,23 @@ public static function notifyDev(Notification $notification)
         );
     }
 
+    public static function toDevSlack(DevNotificationDto $dto)
+    {
+        /**
+         * @var string $class
+         */
+        $class = config('developer.notification', DevNotification::class);
+
+        static::notifyDev(new $class(
+            $dto
+        ));
+    }
+
     public static function exceptionToDevSlack(Throwable $t)
     {
+        /**
+         * @var string $class
+         */
         $class = config('developer.notification', DevNotification::class);
 
         static::notifyDev(new $class(
@@ -38,6 +53,9 @@ public static function exceptionToDevSlack(Throwable $t)
 
     public static function exceptionLogToDevSlack(ExceptionLog $log)
     {
+        /**
+         * @var string $class
+         */
         $class = config('developer.notification', DevNotification::class);
 
         static::notifyDev(new $class(

src/Models/ExceptionLog.php

@@ -18,7 +18,7 @@
  * @property-read string $identifier
  * @property string $name
  * @property array $exception
- * @property array $payload
+ * @property array|mixed $payload
  * @package App\Models
  */
 class ExceptionLog extends Model

tests/Models/LaravelDeveloperTest.php

@@ -2,6 +2,7 @@
 
 namespace Binarcode\LaravelDeveloper\Tests\Models;
 
+use Binarcode\LaravelDeveloper\Dtos\DevNotificationDto;
 use Binarcode\LaravelDeveloper\LaravelDeveloper;
 use Binarcode\LaravelDeveloper\Models\ExceptionLog;
 use Binarcode\LaravelDeveloper\Notifications\DevNotification;
@@ -40,4 +41,15 @@ public function test_can_notify_any_exception()
 
         Notification::assertSentTo(new AnonymousNotifiable, DevNotification::class);
     }
+
+    public function test_can_notify_any_dto()
+    {
+        Notification::fake();
+
+        LaravelDeveloper::toDevSlack(
+            DevNotificationDto::makeWithMessage('hey')
+        );
+
+        Notification::assertSentTo(new AnonymousNotifiable, DevNotification::class);
+    }
 }