Merge pull request #16 from ivinteractive/main

iv-craig · web-flow · commit 3e793a3a9436 · 2024-04-02T17:45:58.000-04:00
Add PHP 8.3 &amp; Laravel 11 support;  Use PHP attributes in tests
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -7,23 +7,40 @@ on:
 jobs:
   phpstan:
     runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        php: [8.3]
+
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout code
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.2
+          php-version: ${{ matrix.php }}
           tools: composer:v2
           coverage: none
 
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: /tmp/composer-cache
+          key: ${{ runner.os }}-${{ matrix.php }}-composer-${{ hashFiles('composer.lock', '*/composer.lock') }}
+
       - name: Install dependencies
-        run: composer update --prefer-source --no-interaction --no-progress
+        uses: php-actions/composer@v6
+        with:
+          php_version: ${{ matrix.php }}
+          php_extensions: gd
+          command: update
 
       - name: PHPStan Static Analysis
         uses: php-actions/phpstan@v3
         with:
           path: src/
           configuration: phpstan.neon
-          php_version: 8.2
+          php_version: ${{ matrix.php }}
           php_extensions: gd
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -10,13 +10,13 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [8.0, 8.1, 8.2]
+        php: [8.1, 8.2, 8.3]
 
     name: Tests on PHP ${{ matrix.php }} - ${{ matrix.stability }}
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -25,8 +25,21 @@ jobs:
           tools: composer:v2
           coverage: none
 
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: /tmp/composer-cache
+          key: ${{ runner.os }}-${{ matrix.php }}-composer-${{ hashFiles('composer.lock', '*/composer.lock') }}
+
       - name: Install dependencies
-        run: composer update --prefer-source --no-interaction --no-progress
+        uses: php-actions/composer@v6
+        with:
+          php_version: ${{ matrix.php }}
+          php_extensions: gd
+          command: update
+
+      - name: Set ownership of vendor directory
+        run: sudo chown -R $(id -u):$(id -g) ./vendor
 
       - name: Execute tests
         run: vendor/bin/phpunit --no-coverage
diff --git a/composer.json b/composer.json
@@ -12,18 +12,18 @@
         }
     ],
     "require": {
-        "php": "^8.0",
-        "illuminate/notifications": "^9.0|^10.0",
-        "illuminate/support": "^9.0|^10.0",
+        "php": "^8.1",
+        "illuminate/notifications": "^10.0|^11.0",
+        "illuminate/support": "^10.0|^11.0",
         "interfax/interfax": "^2.0",
         "psr/log": "^2.0"
     },
     "require-dev": {
         "mockery/mockery": "^1.0",
         "mpdf/mpdf": "^8.0",
-        "orchestra/testbench": "^7.0|^8.0",
+        "orchestra/testbench": "^8.0|^9.0",
         "phpstan/phpstan": "^1.9",
-        "phpunit/phpunit": "^9.5.10|^10.0"
+        "phpunit/phpunit": "^10.0|^11.0"
     },
     "autoload": {
         "psr-4": {
diff --git a/tests/CouldNotSendNotificationExceptionTest.php b/tests/CouldNotSendNotificationExceptionTest.php
@@ -19,8 +19,7 @@ public function setUp(): void
                             ->file('test-file.pdf');
     }
 
-    /** @test */
-    public function it_can_get_the_exception_user()
+    public function test_get_the_exception_user()
     {
         $exception = CouldNotSendNotification::serviceRespondedWithAnError($this->message, [
             'status' => 500,
@@ -30,8 +29,7 @@ public function it_can_get_the_exception_user()
         $this->assertInstanceOf(TestNotifiable::class, $exception->getUser());
     }
 
-    /** @test */
-    public function it_can_get_the_exception_metadata()
+    public function test_get_the_exception_metadata()
     {
         $exception = CouldNotSendNotification::serviceRespondedWithAnError($this->message, [
             'status' => 500,
@@ -41,8 +39,7 @@ public function it_can_get_the_exception_metadata()
         $this->assertSame('Some sample metadata.', $exception->getMetadata()['key']);
     }
 
-    /** @test */
-    public function it_can_get_the_default_exception_message()
+    public function test_get_the_default_exception_message()
     {
         $exception = CouldNotSendNotification::serviceRespondedWithAnError($this->message, [
             'status' => 500,
@@ -52,8 +49,7 @@ public function it_can_get_the_default_exception_message()
         $this->assertSame('The fax failed to send via InterFAX.', $exception->getMessage());
     }
 
-    /** @test */
-    public function it_can_get_a_custom_exception_message()
+    public function test_get_a_custom_exception_message()
     {
         $exceptionMessage = 'This is a test.';
 
@@ -65,8 +61,7 @@ public function it_can_get_a_custom_exception_message()
         $this->assertSame($exceptionMessage, $exception->getMessage());
     }
 
-    /** @test */
-    public function it_can_get_the_exception_attributes()
+    public function test_get_the_exception_attributes()
     {
         $exception = CouldNotSendNotification::serviceRespondedWithAnError($this->message, [
             'status' => 500,
diff --git a/tests/InterfaxChannelTest.php b/tests/InterfaxChannelTest.php
@@ -35,8 +35,7 @@ public function setUp(): void
         $this->channel = new InterfaxChannel($this->interfax);
     }
 
-    /** @test */
-    public function it_can_send_notification_with_a_single_file()
+    public function test_send_notification_with_a_single_file()
     {
         $this->interfax->expects('deliver')
             ->once()
@@ -55,8 +54,7 @@ public function it_can_send_notification_with_a_single_file()
         $this->channel->send(new TestNotifiable, new TestNotificationWithSingleFile);
     }
 
-    /** @test */
-    public function it_can_send_notification_with_files()
+    public function test_send_notification_with_files()
     {
         $this->interfax->expects('deliver')
             ->once()
@@ -81,8 +79,7 @@ public function it_can_send_notification_with_files()
         $this->channel->send(new TestNotifiable, new TestNotificationWithFiles);
     }
 
-    /** @test */
-    public function it_can_send_notification_pdf_as_stream()
+    public function test_send_notification_pdf_as_stream()
     {
         $this->interfax->expects('deliver')
             ->with(Mockery::on(function ($output) {
@@ -110,8 +107,7 @@ public function it_can_send_notification_pdf_as_stream()
         $this->channel->send(new TestNotifiable, new TestNotificationAsStreamPdf);
     }
 
-    /** @test */
-    public function it_can_send_notification_html_as_stream()
+    public function test_send_notification_html_as_stream()
     {
         $filename = 'test-file.html';
         $this->addFile($filename);
@@ -144,14 +140,12 @@ public function it_can_send_notification_html_as_stream()
         $this->channel->send(new TestNotifiable, new TestNotificationAsStreamHtml);
     }
 
-    /** @test */
-    public function it_can_return_early_when_no_fax_number_provided()
+    public function test_return_early_when_no_fax_number_provided()
     {
         $this->assertNull($this->channel->send(new TestNotifiableNotSendable, new TestNotificationWithFiles));
     }
 
-    /** @test */
-    public function it_can_refresh_the_file_response()
+    public function test_refresh_the_file_response()
     {
         $this->resource
              ->expects('refresh')
@@ -169,8 +163,7 @@ public function it_can_refresh_the_file_response()
         $this->channel->send(new TestNotifiable, new TestNotificationWithRefresh);
     }
 
-    /** @test */
-    public function it_can_throw_the_exception()
+    public function test_throw_the_exception()
     {
         $this->expectException(CouldNotSendNotification::class);
 
diff --git a/tests/InterfaxMessageTest.php b/tests/InterfaxMessageTest.php
@@ -6,8 +6,7 @@
 
 class InterfaxMessageTest extends TestCase
 {
-    /** @test */
-    public function it_should_check_the_status_via_refresh()
+    public function test_check_the_status_via_refresh()
     {
         $message = (new InterfaxMessage)
                         ->checkStatus()
@@ -17,8 +16,7 @@ public function it_should_check_the_status_via_refresh()
         $this->assertTrue($message->shouldCheckStatus());
     }
 
-    /** @test */
-    public function it_should_not_check_the_status_via_refresh_manual()
+    public function test_not_check_the_status_via_refresh_manual()
     {
         $message = (new InterfaxMessage)
                         ->checkStatus(false)
@@ -28,8 +26,7 @@ public function it_should_not_check_the_status_via_refresh_manual()
         $this->assertFalse($message->shouldCheckStatus());
     }
 
-    /** @test */
-    public function it_should_not_check_the_status_via_refresh_default()
+    public function test_not_check_the_status_via_refresh_default()
     {
         $message = (new InterfaxMessage)
                         ->user(new TestNotifiable)
@@ -38,8 +35,7 @@ public function it_should_not_check_the_status_via_refresh_default()
         $this->assertFalse($message->shouldCheckStatus());
     }
 
-    /** @test */
-    public function it_should_set_the_file_chunk_size_filename()
+    public function test_set_the_file_chunk_size_filename()
     {
         $this->increaseChunkSize();
 
@@ -53,8 +49,7 @@ public function it_should_set_the_file_chunk_size_filename()
         $this->assertSame($this->chunkSize, $this->getChunkSize($delivery));
     }
 
-    /** @test */
-    public function it_should_set_the_file_chunk_size_file_array()
+    public function test_set_the_file_chunk_size_file_array()
     {
         $this->increaseChunkSize();
 
@@ -68,8 +63,7 @@ public function it_should_set_the_file_chunk_size_file_array()
         $this->assertSame($this->chunkSize, $this->getChunkSize($delivery));
     }
 
-    /** @test */
-    public function it_should_set_the_file_chunk_size_file_object()
+    public function test_set_the_file_chunk_size_file_object()
     {
         $this->increaseChunkSize();
         $client = new \Interfax\Client;

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,7 @@ public function setUp(): void`
`19`	`19`	`->file('test-file.pdf');`
`20`	`20`	`}`
`21`	`21`
`22`		`- /** @test */`
`23`		`- public function it_can_get_the_exception_user()`
	`22`	`+ public function test_get_the_exception_user()`
`24`	`23`	`{`
`25`	`24`	`$exception = CouldNotSendNotification::serviceRespondedWithAnError($this->message, [`
`26`	`25`	`'status' => 500,`
`@@ -30,8 +29,7 @@ public function it_can_get_the_exception_user()`
`30`	`29`	`$this->assertInstanceOf(TestNotifiable::class, $exception->getUser());`
`31`	`30`	`}`
`32`	`31`
`33`		`- /** @test */`
`34`		`- public function it_can_get_the_exception_metadata()`
	`32`	`+ public function test_get_the_exception_metadata()`
`35`	`33`	`{`
`36`	`34`	`$exception = CouldNotSendNotification::serviceRespondedWithAnError($this->message, [`
`37`	`35`	`'status' => 500,`
`@@ -41,8 +39,7 @@ public function it_can_get_the_exception_metadata()`
`41`	`39`	`$this->assertSame('Some sample metadata.', $exception->getMetadata()['key']);`
`42`	`40`	`}`
`43`	`41`
`44`		`- /** @test */`
`45`		`- public function it_can_get_the_default_exception_message()`
	`42`	`+ public function test_get_the_default_exception_message()`
`46`	`43`	`{`
`47`	`44`	`$exception = CouldNotSendNotification::serviceRespondedWithAnError($this->message, [`
`48`	`45`	`'status' => 500,`
`@@ -52,8 +49,7 @@ public function it_can_get_the_default_exception_message()`
`52`	`49`	`$this->assertSame('The fax failed to send via InterFAX.', $exception->getMessage());`
`53`	`50`	`}`
`54`	`51`
`55`		`- /** @test */`
`56`		`- public function it_can_get_a_custom_exception_message()`
	`52`	`+ public function test_get_a_custom_exception_message()`
`57`	`53`	`{`
`58`	`54`	`$exceptionMessage = 'This is a test.';`
`59`	`55`
`@@ -65,8 +61,7 @@ public function it_can_get_a_custom_exception_message()`
`65`	`61`	`$this->assertSame($exceptionMessage, $exception->getMessage());`
`66`	`62`	`}`
`67`	`63`
`68`		`- /** @test */`
`69`		`- public function it_can_get_the_exception_attributes()`
	`64`	`+ public function test_get_the_exception_attributes()`
`70`	`65`	`{`
`71`	`66`	`$exception = CouldNotSendNotification::serviceRespondedWithAnError($this->message, [`
`72`	`67`	`'status' => 500,`
Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,7 @@ public function setUp(): void`
`35`	`35`	`$this->channel = new InterfaxChannel($this->interfax);`
`36`	`36`	`}`
`37`	`37`
`38`		`- /** @test */`
`39`		`- public function it_can_send_notification_with_a_single_file()`
	`38`	`+ public function test_send_notification_with_a_single_file()`
`40`	`39`	`{`
`41`	`40`	`$this->interfax->expects('deliver')`
`42`	`41`	`->once()`
`@@ -55,8 +54,7 @@ public function it_can_send_notification_with_a_single_file()`
`55`	`54`	`$this->channel->send(new TestNotifiable, new TestNotificationWithSingleFile);`
`56`	`55`	`}`
`57`	`56`
`58`		`- /** @test */`
`59`		`- public function it_can_send_notification_with_files()`
	`57`	`+ public function test_send_notification_with_files()`
`60`	`58`	`{`
`61`	`59`	`$this->interfax->expects('deliver')`
`62`	`60`	`->once()`
`@@ -81,8 +79,7 @@ public function it_can_send_notification_with_files()`
`81`	`79`	`$this->channel->send(new TestNotifiable, new TestNotificationWithFiles);`
`82`	`80`	`}`
`83`	`81`
`84`		`- /** @test */`
`85`		`- public function it_can_send_notification_pdf_as_stream()`
	`82`	`+ public function test_send_notification_pdf_as_stream()`
`86`	`83`	`{`
`87`	`84`	`$this->interfax->expects('deliver')`
`88`	`85`	`->with(Mockery::on(function ($output) {`
`@@ -110,8 +107,7 @@ public function it_can_send_notification_pdf_as_stream()`
`110`	`107`	`$this->channel->send(new TestNotifiable, new TestNotificationAsStreamPdf);`
`111`	`108`	`}`
`112`	`109`
`113`		`- /** @test */`
`114`		`- public function it_can_send_notification_html_as_stream()`
	`110`	`+ public function test_send_notification_html_as_stream()`
`115`	`111`	`{`
`116`	`112`	`$filename = 'test-file.html';`
`117`	`113`	`$this->addFile($filename);`
`@@ -144,14 +140,12 @@ public function it_can_send_notification_html_as_stream()`
`144`	`140`	`$this->channel->send(new TestNotifiable, new TestNotificationAsStreamHtml);`
`145`	`141`	`}`
`146`	`142`
`147`		`- /** @test */`
`148`		`- public function it_can_return_early_when_no_fax_number_provided()`
	`143`	`+ public function test_return_early_when_no_fax_number_provided()`
`149`	`144`	`{`
`150`	`145`	`$this->assertNull($this->channel->send(new TestNotifiableNotSendable, new TestNotificationWithFiles));`
`151`	`146`	`}`
`152`	`147`
`153`		`- /** @test */`
`154`		`- public function it_can_refresh_the_file_response()`
	`148`	`+ public function test_refresh_the_file_response()`
`155`	`149`	`{`
`156`	`150`	`$this->resource`
`157`	`151`	`->expects('refresh')`
`@@ -169,8 +163,7 @@ public function it_can_refresh_the_file_response()`
`169`	`163`	`$this->channel->send(new TestNotifiable, new TestNotificationWithRefresh);`
`170`	`164`	`}`
`171`	`165`
`172`		`- /** @test */`
`173`		`- public function it_can_throw_the_exception()`
	`166`	`+ public function test_throw_the_exception()`
`174`	`167`	`{`
`175`	`168`	`$this->expectException(CouldNotSendNotification::class);`
`176`	`169`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,7 @@`
`6`	`6`
`7`	`7`	`class InterfaxMessageTest extends TestCase`
`8`	`8`	`{`
`9`		`- /** @test */`
`10`		`- public function it_should_check_the_status_via_refresh()`
	`9`	`+ public function test_check_the_status_via_refresh()`
`11`	`10`	`{`
`12`	`11`	`$message = (new InterfaxMessage)`
`13`	`12`	`->checkStatus()`
`@@ -17,8 +16,7 @@ public function it_should_check_the_status_via_refresh()`
`17`	`16`	`$this->assertTrue($message->shouldCheckStatus());`
`18`	`17`	`}`
`19`	`18`
`20`		`- /** @test */`
`21`		`- public function it_should_not_check_the_status_via_refresh_manual()`
	`19`	`+ public function test_not_check_the_status_via_refresh_manual()`
`22`	`20`	`{`
`23`	`21`	`$message = (new InterfaxMessage)`
`24`	`22`	`->checkStatus(false)`
`@@ -28,8 +26,7 @@ public function it_should_not_check_the_status_via_refresh_manual()`
`28`	`26`	`$this->assertFalse($message->shouldCheckStatus());`
`29`	`27`	`}`
`30`	`28`
`31`		`- /** @test */`
`32`		`- public function it_should_not_check_the_status_via_refresh_default()`
	`29`	`+ public function test_not_check_the_status_via_refresh_default()`
`33`	`30`	`{`
`34`	`31`	`$message = (new InterfaxMessage)`
`35`	`32`	`->user(new TestNotifiable)`
`@@ -38,8 +35,7 @@ public function it_should_not_check_the_status_via_refresh_default()`
`38`	`35`	`$this->assertFalse($message->shouldCheckStatus());`
`39`	`36`	`}`
`40`	`37`
`41`		`- /** @test */`
`42`		`- public function it_should_set_the_file_chunk_size_filename()`
	`38`	`+ public function test_set_the_file_chunk_size_filename()`
`43`	`39`	`{`
`44`	`40`	`$this->increaseChunkSize();`
`45`	`41`
`@@ -53,8 +49,7 @@ public function it_should_set_the_file_chunk_size_filename()`
`53`	`49`	`$this->assertSame($this->chunkSize, $this->getChunkSize($delivery));`
`54`	`50`	`}`
`55`	`51`
`56`		`- /** @test */`
`57`		`- public function it_should_set_the_file_chunk_size_file_array()`
	`52`	`+ public function test_set_the_file_chunk_size_file_array()`
`58`	`53`	`{`
`59`	`54`	`$this->increaseChunkSize();`
`60`	`55`
`@@ -68,8 +63,7 @@ public function it_should_set_the_file_chunk_size_file_array()`
`68`	`63`	`$this->assertSame($this->chunkSize, $this->getChunkSize($delivery));`
`69`	`64`	`}`
`70`	`65`
`71`		`- /** @test */`
`72`		`- public function it_should_set_the_file_chunk_size_file_object()`
	`66`	`+ public function test_set_the_file_chunk_size_file_object()`
`73`	`67`	`{`
`74`	`68`	`$this->increaseChunkSize();`
`75`	`69`	`$client = new \Interfax\Client;`