first commit

Author: rust17

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.gitignore

@@ -0,0 +1,11 @@
+/.phpunit.cache
+/vendor
+composer.phar
+composer.lock
+.DS_Store
+Thumbs.db
+/phpunit.xml
+/.idea
+/.fleet
+/.vscode
+.phpunit.result.cache

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) circle33 <newnash13@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,241 @@
+When using Laravel, the current approach to testing batched jobs, as shown below, is somewhat unconventional:
+
+```
+Bus::assertBatched(fn (PendingBatchFake $batchedCollection) =>
+    $batchedCollection->jobs->count() === 1 && $batchedCollection->jobs->first()->value === 'hello';
+);
+```
+
+This package introduces some helper functions to enhance the testability of batched jobs. Inspired by [fluent JSON testing](https://laravel.com/docs/11.x/http-tests#fluent-json-testing), these methods provide a more streamlined and readable approach to testing job batches within the Laravel application. The goal is to improve developer experience by offering clear, concise methods with illustrative examples.
+
+## Documentation
+
+### `has`
+
+Assert that the batch contains a job of the given type. You can also pass an integer to assert that the batch contains the exact number of jobs.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    new AJob(1, 2),
+    new BJob,
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->has(2)
+        ->has(AJob::class, [1, 2])
+);
+```
+
+### `missing`
+
+Assert that the batch does not contain a job of the given type.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    new BJob,
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->missing(AJob::class)
+);
+```
+
+### `hasAll`
+
+Assert that the batch contains all of the given jobs.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    new AJob,
+    new BJob,
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->hasAll([AJob::class, BJob::class])
+);
+```
+
+### `missingAll`
+
+Assert that the batch does not contain any of the given jobs.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    new AJob,
+    new BJob,
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->missingAll([CJob::class, DJob::class])
+);
+```
+
+### `hasAny`
+
+Assert that the batch contains any of the given jobs.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    new AJob(1, 2),
+    new BJob,
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->hasAny(AJob::class, CJob::class)
+);
+```
+
+### `first`
+
+Assert that the first job in the batch matches the given callback.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    [
+        new AJob(1, 2),
+        new BJob,
+    ],
+    new CJob,
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->first(fn (PendingBatchFake $firstBatch) =>
+        $firstBatch->has(AJob::class, [1, 2])
+            ->has(BJob::class)
+    )
+);
+```
+
+### `nth`
+
+Assert that the nth job in the batch matches the given callback or type and parameters.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    [
+        new AJob(1, 2),
+        new BJob
+    ],
+    new CJob::class(1)
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->nth(0, fn (PendingBatchFake $batch) =>
+        $batch->has(AJob::class, [1, 2])
+            ->has(BJob::class)
+    )->nth(1, CJob::class, [1])
+);
+```
+
+### `equal`
+
+Assert that the batch contains exactly the given jobs with the specified parameters.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    [
+        new AJob(1, 2),
+        new BJob
+    ],
+    new CJob::class(1)
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->equal([
+        [
+            AJob::class => [1, 2],
+            BJob::class
+        ],
+        CJob::class => [1]
+    ])
+);
+```
+
+### `etc`
+
+Assert that the batch has unexpected jobs beyond those checked.
+
+**Example:**
+
+```php
+use Circle33\LaravelBusFluentable\Bus as BusFacade;
+
+Bus::fake();
+
+Bus::batch([
+    new AJob(1, 2),
+    new BJob,
+    new CJob::class(1)
+])->dispatch();
+
+BusFacade::assertPendingBatched(fn (PendingBatchFake $batch) =>
+    $batch->has(AJob::class, [1, 2])
+        ->has(BJob::class)
+        ->etc()
+);
+```
+
+# Contributing
+
+Thank you for considering contributing to this project! We welcome and appreciate your help.
+
+## How to Contribute
+
+### Fork the Repository
+
+1. Fork the repository to your GitHub account.
+2. Clone your forked repository to your local machine:
+    ```sh
+    git clone https://github.com/your-username/laravel-bus-fluentable.git
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,27 @@
+{
+    "name": "circle33/laravel-bus-fluentable",
+    "description": "Make Laravel testing batched jobs more fluent.",
+    "keywords" : [
+        "laravel",
+        "laravel-bus-fluentable"
+    ],
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Circle33\\LaravelBusFluentable\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "circle33",
+            "email": "newnash13@gmail.com"
+        }
+    ],
+    "minimum-stability": "stable",
+    "require-dev": {
+        "laravel/framework": "^11.35",
+        "phpunit/phpunit": "^11.5",
+        "orchestra/testbench-core": "^9.8"
+    }
+}

src/Bus.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Circle33\LaravelBusFluentable;
+
+use Circle33\LaravelBusFluentable\FluentPendingBatch;
+
+class Bus
+{
+    public static function assertPendingBatched(callable $callback)
+    {
+        $dispatcher = app(\Illuminate\Contracts\Bus\Dispatcher::class);
+
+        return collect($dispatcher->dispatchedBatches())
+            ->filter(fn ($batch) => $callback(new FluentPendingBatch($dispatcher, $batch->jobs)));
+    }
+}