Merge pull request #14 from ivinteractive/master

iv-craig · web-flow · commit 2a81465199bf · 2023-02-21T17:27:21.000-05:00
Update PHP versions for GitHub Actions workflows
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -0,0 +1,29 @@
+name: PHPStan
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer:v2
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --prefer-source --no-interaction --no-progress
+
+      - name: PHPStan Static Analysis
+        uses: php-actions/phpstan@v3
+        with:
+          path: src/
+          php_version: 8.2
+          php_extensions: gd
+          level: 5
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.2, 7.3, 7.4, 8.0, 8.1]
+        php: [8.0, 8.1, 8.2]
 
     name: Tests on PHP ${{ matrix.php }} - ${{ matrix.stability }}
 
@@ -29,4 +29,4 @@ jobs:
         run: composer update --prefer-source --no-interaction --no-progress
 
       - name: Execute tests
-        run: vendor/bin/phpunit --verbose
+        run: vendor/bin/phpunit --no-coverage
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ build
 composer.phar
 composer.lock
 .phpunit.result.cache
+.phpunit.cache
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
diff --git a/.styleci.yml b/.styleci.yml
diff --git a/README.md b/README.md
@@ -3,9 +3,6 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/interfax.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/interfax)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
 [![Build Status](https://img.shields.io/travis/laravel-notification-channels/interfax/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/interfax)
-[![StyleCI](https://styleci.io/repos/232441511/shield)](https://styleci.io/repos/232441511)
-[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/interfax.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/interfax)
-[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/laravel-notification-channels/interfax/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/interfax/?branch=master)
 [![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/interfax.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/interfax)
 
 This package makes it easy to send notifications using [InterFAX](https://interfax.net) with Laravel 6.x and above.
@@ -68,8 +65,9 @@ To use this package, you can create a notification class, like `DocumentWasSent`
 <?php
 use NotificationChannels\Interfax\InterfaxChannel;
 use NotificationChannels\Interfax\InterfaxMessage;
+use NotificationChannels\Interfax\Contracts\InterfaxNotificationContract;
 
-class DocumentWasSent extends Notification
+class DocumentWasSent extends Notification implements InterfaxNotificationContract
 {
 
     protected $files;
@@ -90,7 +88,7 @@ class DocumentWasSent extends Notification
         return [InterfaxChannel::class];
     }
 
-    public function toInterfax($notifiable)
+    public function toInterfax($notifiable): InterfaxMessage
     {
         return (new InterfaxMessage)
               ->files($this->files);
diff --git a/composer.json b/composer.json
@@ -22,6 +22,7 @@
         "mockery/mockery": "^1.0",
         "mpdf/mpdf": "^8.0",
         "orchestra/testbench": "^7.0|^8.0",
+        "phpstan/phpstan": "^1.9",
         "phpunit/phpunit": "^9.5.10|^10.0"
     },
     "autoload": {
@@ -38,7 +39,8 @@
         "test": [
             "@putenv XDEBUG_MODE=coverage",
             "vendor/bin/phpunit"
-        ]
+        ],
+        "phpstan": "vendor/bin/phpstan analyse src --level=5"
     },
     "config": {
         "sort-packages": true
diff --git a/src/Contracts/InterfaxNotificationContract.php b/src/Contracts/InterfaxNotificationContract.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace NotificationChannels\Interfax\Contracts;
+
+use NotificationChannels\Interfax\InterfaxMessage;
+
+interface InterfaxNotificationContract
+{
+    public function toInterfax($notifiable): InterfaxMessage;
+}
diff --git a/src/Exceptions/CouldNotSendNotification.php b/src/Exceptions/CouldNotSendNotification.php
@@ -10,7 +10,7 @@ class CouldNotSendNotification extends Exception
     protected $interfaxMessage;
     protected $responseAttributes;
 
-    public function __construct($message, $code, Exception $previous = null, InterfaxMessage $interfaxMessage, array $responseAttributes)
+    final public function __construct(string $message, int $code, Exception $previous = null, InterfaxMessage $interfaxMessage, array $responseAttributes)
     {
         parent::__construct($message, $code, $previous);
 
diff --git a/src/InterfaxChannel.php b/src/InterfaxChannel.php
@@ -2,8 +2,8 @@
 
 namespace NotificationChannels\Interfax;
 
-use Illuminate\Notifications\Notification;
 use Interfax\Client;
+use NotificationChannels\Interfax\Contracts\InterfaxNotificationContract;
 use NotificationChannels\Interfax\Exceptions\CouldNotSendNotification;
 
 class InterfaxChannel
@@ -20,11 +20,11 @@ public function __construct(Client $client)
      * Send the given notification.
      *
      * @param  mixed  $notifiable
-     * @param  \Illuminate\Notifications\Notification  $notification
+     * @param  \NotificationChannels\Interfax\Contracts\InterfaxNotificationContract  $notification
      *
      * @throws \NotificationChannels\Interfax\Exceptions\CouldNotSendNotification
      */
-    public function send($notifiable, Notification $notification)
+    public function send($notifiable, InterfaxNotificationContract $notification)
     {
         if (! $faxNumber = $notifiable->routeNotificationFor('interfax')) {
             return;
diff --git a/src/InterfaxMessage.php b/src/InterfaxMessage.php
@@ -6,13 +6,13 @@
 
 class InterfaxMessage
 {
-    protected $files;
+    protected array $files;
     protected $stream;
-    protected $filename;
-    protected $method;
+    protected string $filename;
+    protected string $method;
     protected $statusCheck = false;
     public $user;
-    public $metadata = [];
+    public array $metadata = [];
 
     const FILES = 'files';
     const STREAM = 'stream';
@@ -30,15 +30,15 @@ public function file(string $file)
         return $this;
     }
 
-    public function files(array $files)
+    public function files(array $files): InterfaxMessage
     {
         $this->files = $files;
         $this->method = static::FILES;
 
         return $this;
     }
 
-    public function stream($stream, string $filename)
+    public function stream($stream, string $filename): InterfaxMessage
     {
         $this->stream = $stream;
         $this->filename = $filename;
@@ -65,7 +65,7 @@ public function shouldCheckStatus(): bool
      * @param  mixed  $notifiable  The user to notify
      * @return InterfaxMessage
      */
-    public function user($notifiable)
+    public function user($notifiable): InterfaxMessage
     {
         $this->user = $notifiable;
 
@@ -78,7 +78,7 @@ public function user($notifiable)
      * @param  array  $data  The data to add to the metadata array
      * @return InterfaxMessage
      */
-    public function addMetadata(array $data)
+    public function addMetadata(array $data): InterfaxMessage
     {
         foreach ($data as $key => $value) {
             $this->metadata[$key] = $value;
diff --git a/tests/InterfaxChannelTest.php b/tests/InterfaxChannelTest.php
@@ -7,6 +7,7 @@
 use Interfax\Resource as InterfaxResource;
 use Mockery;
 use NotificationChannels\Interfax\Exceptions\CouldNotSendNotification;
+use NotificationChannels\Interfax\Contracts\InterfaxNotificationContract;
 use NotificationChannels\Interfax\InterfaxChannel;
 use NotificationChannels\Interfax\InterfaxMessage;
 
@@ -192,47 +193,47 @@ public function it_can_throw_the_exception()
     }
 }
 
-class TestNotificationWithSingleFile extends Notification
+class TestNotificationWithSingleFile extends Notification implements InterfaxNotificationContract
 {
     /**
      * @param $notifiable
      * @return InterfaxMessage
      *
      * @throws CouldNotSendNotification
      */
-    public function toInterfax($notifiable)
+    public function toInterfax($notifiable): InterfaxMessage
     {
         return (new InterfaxMessage)
                     ->user($notifiable)
                     ->file('test-file.pdf');
     }
 }
 
-class TestNotificationWithFiles extends Notification
+class TestNotificationWithFiles extends Notification implements InterfaxNotificationContract
 {
     /**
      * @param $notifiable
      * @return InterfaxMessage
      *
      * @throws CouldNotSendNotification
      */
-    public function toInterfax($notifiable)
+    public function toInterfax($notifiable): InterfaxMessage
     {
         return (new InterfaxMessage)
                     ->user($notifiable)
                     ->files(['test-file-1.pdf', 'test-file-2.pdf']);
     }
 }
 
-class TestNotificationAsStreamPdf extends Notification
+class TestNotificationAsStreamPdf extends Notification implements InterfaxNotificationContract
 {
     /**
      * @param $notifiable
      * @return InterfaxMessage
      *
      * @throws CouldNotSendNotification
      */
-    public function toInterfax($notifiable)
+    public function toInterfax($notifiable): InterfaxMessage
     {
         $path = app('filesystem')->path('test-file.pdf');
 
@@ -242,15 +243,15 @@ public function toInterfax($notifiable)
     }
 }
 
-class TestNotificationAsStreamHtml extends Notification
+class TestNotificationAsStreamHtml extends Notification implements InterfaxNotificationContract
 {
     /**
      * @param $notifiable
      * @return InterfaxMessage
      *
      * @throws CouldNotSendNotification
      */
-    public function toInterfax($notifiable)
+    public function toInterfax($notifiable): InterfaxMessage
     {
         $path = app('filesystem')->path('test-file.html');
 
@@ -260,15 +261,15 @@ public function toInterfax($notifiable)
     }
 }
 
-class TestNotificationWithRefresh extends Notification
+class TestNotificationWithRefresh extends Notification implements InterfaxNotificationContract
 {
     /**
      * @param $notifiable
      * @return InterfaxMessage
      *
      * @throws CouldNotSendNotification
      */
-    public function toInterfax($notifiable)
+    public function toInterfax($notifiable): InterfaxMessage
     {
         return (new InterfaxMessage)
                     ->checkStatus()

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class CouldNotSendNotification extends Exception`
`10`	`10`	`protected $interfaxMessage;`
`11`	`11`	`protected $responseAttributes;`
`12`	`12`
`13`		`- public function __construct($message, $code, Exception $previous = null, InterfaxMessage $interfaxMessage, array $responseAttributes)`
	`13`	`+ final public function __construct(string $message, int $code, Exception $previous = null, InterfaxMessage $interfaxMessage, array $responseAttributes)`
`14`	`14`	`{`
`15`	`15`	`parent::__construct($message, $code, $previous);`
`16`	`16`