From c4ba5ef04c99176eb000abb05fc81fb0f44f5d9c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Samuel=20=C5=A0tancl?= <samuel@archte.ch>
Date: Tue, 29 Jul 2025 22:21:17 +0200
Subject: [PATCH] Add return typehint to shouldBeQueued(), @test -> #[Test],
 migrate phpunit configuration

---
 .gitignore                |  1 +
 phpunit.xml               | 18 +++++++++---------
 src/JobPipeline.php       |  2 +-
 tests/JobPipelineTest.php | 21 +++++++++++----------
 4 files changed, 22 insertions(+), 20 deletions(-)

diff --git a/.gitignore b/.gitignore
index 7b37592..856a8f3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
 /vendor/
+.phpunit.cache/
 composer.lock
 .phpunit.result.cache
 .php-cs-fixer.cache
diff --git a/phpunit.xml b/phpunit.xml
index 40b645f..c307a10 100644
--- a/phpunit.xml
+++ b/phpunit.xml
@@ -1,13 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
-  <coverage>
-    <include>
-      <directory suffix=".php">./src</directory>
-    </include>
-    <exclude>
-      <file>./src/routes.php</file>
-    </exclude>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/12.2/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
   <testsuites>
     <testsuite name="Unit">
       <directory suffix="Test.php">./tests</directory>
@@ -24,4 +16,12 @@
     <env name="DB_DATABASE" value=":memory:"/>
     <env name="AWS_DEFAULT_REGION" value="us-west-2"/>
   </php>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+    <exclude>
+      <file>./src/routes.php</file>
+    </exclude>
+  </source>
 </phpunit>
diff --git a/src/JobPipeline.php b/src/JobPipeline.php
index 414d7f8..8ec0789 100644
--- a/src/JobPipeline.php
+++ b/src/JobPipeline.php
@@ -50,7 +50,7 @@ class JobPipeline implements ShouldQueue
         return $this;
     }
 
-    public function shouldBeQueued(bool $shouldBeQueued = true)
+    public function shouldBeQueued(bool $shouldBeQueued = true): self
     {
         $this->shouldBeQueued = $shouldBeQueued;
 
diff --git a/tests/JobPipelineTest.php b/tests/JobPipelineTest.php
index 7724a6b..d878b20 100644
--- a/tests/JobPipelineTest.php
+++ b/tests/JobPipelineTest.php
@@ -7,6 +7,7 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Queue;
 use Orchestra\Testbench\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 use Spatie\Valuestore\Valuestore;
 use Stancl\JobPipeline\JobPipeline;
 
@@ -26,7 +27,7 @@ class JobPipelineTest extends TestCase
         $this->valuestore = Valuestore::make(__DIR__ . '/tmp/jobpipelinetest.json')->flush();
     }
 
-    /** @test */
+    #[Test]
     public function job_pipeline_can_listen_to_any_event()
     {
         Event::listen(TestEvent::class, JobPipeline::make([
@@ -42,7 +43,7 @@ class JobPipelineTest extends TestCase
         $this->assertSame('bar', $this->valuestore->get('foo'));
     }
 
-    /** @test */
+    #[Test]
     public function job_pipeline_can_be_queued()
     {
         Queue::fake();
@@ -63,7 +64,7 @@ class JobPipelineTest extends TestCase
         });
     }
 
-    /** @test */
+    #[Test]
     public function job_pipelines_run_when_queued()
     {
         Event::listen(TestEvent::class, JobPipeline::make([
@@ -81,7 +82,7 @@ class JobPipelineTest extends TestCase
         $this->assertSame('bar', $this->valuestore->get('foo'));
     }
 
-    /** @test */
+    #[Test]
     public function job_pipeline_executes_jobs_and_passes_the_object_sequentially()
     {
         Event::listen(TestEvent::class, JobPipeline::make([
@@ -98,7 +99,7 @@ class JobPipelineTest extends TestCase
         $this->assertSame('first job changed property', $this->valuestore->get('foo'));
     }
 
-    /** @test */
+    #[Test]
     public function send_can_return_multiple_arguments()
     {
         Event::listen(TestEvent::class, JobPipeline::make([
@@ -114,7 +115,7 @@ class JobPipelineTest extends TestCase
         $this->assertSame(['a', 'b'], app('test_args'));
     }
 
-    /** @test */
+    #[Test]
     public function the_pipeline_can_be_canceled_by_returning_false_from_any_job()
     {
         Event::listen(TestEvent::class, JobPipeline::make([
@@ -134,8 +135,8 @@ class JobPipelineTest extends TestCase
         // Foo job is not excuted
         $this->assertFalse($this->valuestore->has('foo'));
     }
-    
-    /** @test */
+
+    #[Test]
     public function the_pipeline_can_execute_failed_method_on_job()
     {
         Event::listen(TestEvent::class, JobPipeline::make([
@@ -151,7 +152,7 @@ class JobPipelineTest extends TestCase
         $this->assertEquals($this->valuestore->get('exeception'), 'pipeline exception');
     }
 
-    /** @test */
+    #[Test]
     public function closures_can_be_used_as_jobs()
     {
         $passes = false;
@@ -169,7 +170,7 @@ class JobPipelineTest extends TestCase
         $this->assertTrue($passes);
     }
 
-    /** @test */
+    #[Test]
     public function failures_in_closures_will_throw_correctly()
     {
         $this->expectExceptionMessage('foobar');