Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[9.x] Adds closure support to dispatch conditionals. #43784

Merged
merged 3 commits into from
Aug 22, 2022
Merged

[9.x] Adds closure support to dispatch conditionals. #43784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
defbc61
[9.x] Adds closure support to dispatch conditionals.
DarkGhostHunter Aug 19, 2022
18cd09e
Style fixes [skip ci]
DarkGhostHunter Aug 19, 2022
b1e6287
pass entire job
taylorotwell Aug 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions src/Illuminate/Foundation/Bus/Dispatchable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Illuminate\Foundation\Bus;

use Closure;
use Illuminate\Contracts\Bus\Dispatcher;
use Illuminate\Support\Fluent;

Expand All @@ -20,27 +21,43 @@ public static function dispatch(...$arguments)
/**
* Dispatch the job with the given arguments if the given truth test passes.
*
* @param bool $boolean
* @param bool|\Closure $boolean
* @param mixed ...$arguments
* @return \Illuminate\Foundation\Bus\PendingDispatch|\Illuminate\Support\Fluent
*/
public static function dispatchIf($boolean, ...$arguments)
{
return $boolean
if ($boolean instanceof Closure) {
$dispatchable = new static(...$arguments);

return value($boolean, $dispatchable)
? new PendingDispatch($dispatchable)
: new Fluent;
}

return value($boolean)
? new PendingDispatch(new static(...$arguments))
: new Fluent;
}

/**
* Dispatch the job with the given arguments unless the given truth test passes.
*
* @param bool $boolean
* @param bool|\Closure $boolean
* @param mixed ...$arguments
* @return \Illuminate\Foundation\Bus\PendingDispatch|\Illuminate\Support\Fluent
*/
public static function dispatchUnless($boolean, ...$arguments)
{
return ! $boolean
if ($boolean instanceof Closure) {
$dispatchable = new static(...$arguments);

return ! value($boolean, $dispatchable)
? new PendingDispatch($dispatchable)
: new Fluent;
}

return ! value($boolean)
? new PendingDispatch(new static(...$arguments))
: new Fluent;
}
Expand Down
49 changes: 49 additions & 0 deletions tests/Integration/Queue/JobDispatchingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ class JobDispatchingTest extends TestCase
protected function tearDown(): void
{
Job::$ran = false;
Job::$value = null;
}

public function testJobCanUseCustomMethodsAfterDispatch()
Expand All @@ -21,6 +22,54 @@ public function testJobCanUseCustomMethodsAfterDispatch()
$this->assertTrue(Job::$ran);
$this->assertSame('new-test', Job::$value);
}

public function testDispatchesConditionallyWithBoolean()
{
Job::dispatchIf(false, 'test')->replaceValue('new-test');

$this->assertFalse(Job::$ran);
$this->assertNull(Job::$value);

Job::dispatchIf(true, 'test')->replaceValue('new-test');

$this->assertTrue(Job::$ran);
$this->assertSame('new-test', Job::$value);
}

public function testDispatchesConditionallyWithClosure()
{
Job::dispatchIf(fn ($job) => $job instanceof Job ? 0 : 1, 'test')->replaceValue('new-test');

$this->assertFalse(Job::$ran);

Job::dispatchIf(fn ($job) => $job instanceof Job ? 1 : 0, 'test')->replaceValue('new-test');

$this->assertTrue(Job::$ran);
}

public function testDoesNotDispatchesConditionallyWithBoolean()
{
Job::dispatchUnless(true, 'test')->replaceValue('new-test');

$this->assertFalse(Job::$ran);
$this->assertNull(Job::$value);

Job::dispatchUnless(false, 'test')->replaceValue('new-test');

$this->assertTrue(Job::$ran);
$this->assertSame('new-test', Job::$value);
}

public function testDoesNotDispatchesConditionallyWithClosure()
{
Job::dispatchUnless(fn ($job) => $job instanceof Job ? 1 : 0, 'test')->replaceValue('new-test');

$this->assertFalse(Job::$ran);

Job::dispatchUnless(fn ($job) => $job instanceof Job ? 0 : 1, 'test')->replaceValue('new-test');

$this->assertTrue(Job::$ran);
}
}

class Job implements ShouldQueue
Expand Down