README

Fully queueable, with a testing API that makes you like writing tests more than the actual code.

Read the full documentation at docs.havn.nl.

Installation

composer require havn/laravel-executable

Requirements: PHP 8.3+ | Laravel 12+

Quick Example

A plain PHP class with a trait and an execute() method:

use Havn\Executable\QueueableExecutable;

class ProcessPayment
{
    use QueueableExecutable;

    public function __construct(
        private PaymentGateway $gateway,
    ) {}

    public function execute(Payment $payment): void
    {
        $this->gateway->charge($payment);
        
        $payment->update(['status' => 'completed']);
    }
}

Four execution modes:

// Sync — runs immediately, returns the result
ProcessPayment::sync()->execute($payment);

// Queue — dispatches to the queue
ProcessPayment::onQueue()->execute($payment);

// Prepare — returns a job without dispatching (for chains and batches)
$job = ProcessPayment::prepare()->execute($payment);

// Test — runs the real code in a testable context
ProcessPayment::test()->execute($payment);

Queue configuration at dispatch time:

ProcessPayment::onQueue('high-priority')
    ->delay(60)
    ->tries(3)
    ->execute($payment);

Testing

Mock, spy, or assert. All built in:

// Mock
ProcessPayment::mock()
    ->shouldExecute()
    ->with($payment)
    ->once();

// Spy
ProcessPayment::spy();
ProcessPayment::sync()->execute($payment);
ProcessPayment::assert()->executed()->with($payment);

// Queue assertions
Queue::fake();
ProcessPayment::onQueue()->execute($payment);
ProcessPayment::assert()->queued()->on('high-priority')->with($payment)->once();

Contributing

Contributions are welcome. Please see CONTRIBUTING for details.

Security

Please review our security policy for reporting security vulnerabilities.

License

The MIT License (MIT). See License File for details.

Credits

• Henk Koop
• All Contributors

Made with care by Havn