archtechx/jobpipeline
1
0
Fork 0
mirror of https://github.com/archtechx/jobpipeline.git synced 2025-12-12 08:04:04 +00:00
Code Activity

Add missing return type (2.x) (#24)

Browse source 
* Add missing return type

This adds the `self` return type to `JobPipeline::shouldBeQueued()` so that static analyzers won't get confused and treat its return value as `mixed`.

* Change return types to `static`

* Fix tests not running

---------

Co-authored-by: Samuel Štancl <samuel.stancl@gmail.com>
This commit is contained in:
Zarunet 2025-07-29 22:16:31 +02:00 • committed by GitHub
parent a908fcf4db
commit 4a8f566a5e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 15 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/JobPipeline.php
View file

@ -39,19 +39,19 @@ class JobPipeline implements ShouldQueue
} }
/** @param callable[]|string[] $jobs */ /** @param callable[]|string[] $jobs */
public static function make(array $jobs): self public static function make(array $jobs): static
{ {
return new static($jobs); return new static($jobs);
} }
public function send(callable $send): self public function send(callable $send): static
{ {
$this->send = $send; $this->send = $send;
return $this; return $this;
} }
public function shouldBeQueued(bool $shouldBeQueued = true, ?string $queue = null) public function shouldBeQueued(bool $shouldBeQueued = true, string|null $queue = null): static
{ {
$this->shouldBeQueued = $shouldBeQueued; $this->shouldBeQueued = $shouldBeQueued;
@ -106,7 +106,7 @@ class JobPipeline implements ShouldQueue
/** /**
* Return a serializable version of the current object. * Return a serializable version of the current object.
*/ */
public function executable($listenerArgs): self public function executable($listenerArgs): static
{ {
$clone = clone $this; $clone = clone $this;

21
tests/JobPipelineTest.php
View file

@ -7,6 +7,7 @@ use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Event; use Illuminate\Support\Facades\Event;
use Illuminate\Support\Facades\Queue; use Illuminate\Support\Facades\Queue;
use Orchestra\Testbench\TestCase; use Orchestra\Testbench\TestCase;
use PHPUnit\Framework\Attributes\Test;
use Spatie\Valuestore\Valuestore; use Spatie\Valuestore\Valuestore;
use Stancl\JobPipeline\JobPipeline; use Stancl\JobPipeline\JobPipeline;
@ -26,7 +27,7 @@ class JobPipelineTest extends TestCase
$this->valuestore = Valuestore::make(__DIR__ . '/tmp/jobpipelinetest.json')->flush(); $this->valuestore = Valuestore::make(__DIR__ . '/tmp/jobpipelinetest.json')->flush();
} }
/** @test */ #[Test]
public function job_pipeline_can_listen_to_any_event() public function job_pipeline_can_listen_to_any_event()
{ {
Event::listen(TestEvent::class, JobPipeline::make([ Event::listen(TestEvent::class, JobPipeline::make([
@ -42,7 +43,7 @@ class JobPipelineTest extends TestCase
$this->assertSame('bar', $this->valuestore->get('foo')); $this->assertSame('bar', $this->valuestore->get('foo'));
} }
/** @test */ #[Test]
public function job_pipeline_can_be_queued() public function job_pipeline_can_be_queued()
{ {
Queue::fake(); Queue::fake();
@ -63,7 +64,7 @@ class JobPipelineTest extends TestCase
}); });
} }
/** @test */ #[Test]
public function job_pipelines_run_when_queued() public function job_pipelines_run_when_queued()
{ {
Event::listen(TestEvent::class, JobPipeline::make([ Event::listen(TestEvent::class, JobPipeline::make([
@ -81,7 +82,7 @@ class JobPipelineTest extends TestCase
$this->assertSame('bar', $this->valuestore->get('foo')); $this->assertSame('bar', $this->valuestore->get('foo'));
} }
/** @test */ #[Test]
public function job_pipelines_can_use_a_specific_queue() public function job_pipelines_can_use_a_specific_queue()
{ {
Event::listen(TestEvent::class, JobPipeline::make([ Event::listen(TestEvent::class, JobPipeline::make([
@ -107,7 +108,7 @@ class JobPipelineTest extends TestCase
$this->assertSame('bar', $this->valuestore->get('foo')); $this->assertSame('bar', $this->valuestore->get('foo'));
} }
/** @test */ #[Test]
public function job_pipeline_executes_jobs_and_passes_the_object_sequentially() public function job_pipeline_executes_jobs_and_passes_the_object_sequentially()
{ {
Event::listen(TestEvent::class, JobPipeline::make([ Event::listen(TestEvent::class, JobPipeline::make([
@ -124,7 +125,7 @@ class JobPipelineTest extends TestCase
$this->assertSame('first job changed property', $this->valuestore->get('foo')); $this->assertSame('first job changed property', $this->valuestore->get('foo'));
} }
/** @test */ #[Test]
public function send_can_return_multiple_arguments() public function send_can_return_multiple_arguments()
{ {
Event::listen(TestEvent::class, JobPipeline::make([ Event::listen(TestEvent::class, JobPipeline::make([
@ -140,7 +141,7 @@ class JobPipelineTest extends TestCase
$this->assertSame(['a', 'b'], app('test_args')); $this->assertSame(['a', 'b'], app('test_args'));
} }
/** @test */ #[Test]
public function the_pipeline_can_be_canceled_by_returning_false_from_any_job() public function the_pipeline_can_be_canceled_by_returning_false_from_any_job()
{ {
Event::listen(TestEvent::class, JobPipeline::make([ Event::listen(TestEvent::class, JobPipeline::make([
@ -161,7 +162,7 @@ class JobPipelineTest extends TestCase
$this->assertFalse($this->valuestore->has('foo')); $this->assertFalse($this->valuestore->has('foo'));
} }
/** @test */ #[Test]
public function the_pipeline_can_execute_failed_method_on_job() public function the_pipeline_can_execute_failed_method_on_job()
{ {
Event::listen(TestEvent::class, JobPipeline::make([ Event::listen(TestEvent::class, JobPipeline::make([
@ -177,7 +178,7 @@ class JobPipelineTest extends TestCase
$this->assertEquals($this->valuestore->get('exeception'), 'pipeline exception'); $this->assertEquals($this->valuestore->get('exeception'), 'pipeline exception');
} }
/** @test */ #[Test]
public function closures_can_be_used_as_jobs() public function closures_can_be_used_as_jobs()
{ {
$passes = false; $passes = false;
@ -195,7 +196,7 @@ class JobPipelineTest extends TestCase
$this->assertTrue($passes); $this->assertTrue($passes);
} }
/** @test */ #[Test]
public function failures_in_closures_will_throw_correctly() public function failures_in_closures_will_throw_correctly()
{ {
$this->expectExceptionMessage('foobar'); $this->expectExceptionMessage('foobar');