Laravel ModelsThat - Aaron Francis Inspired

HasEmbedding.php

<?php

namespace App\Traits;

use Illuminate\Database\Eloquent\Builder;

trait HasEmbedding
{
    public function scopeNeedsEmbedding(Builder $query): Builder
    {
        return $query->whereNull('embedded_at'); // or a relevant field check
    }

    public function scopeReserveFor(Builder $query, string $key, string $duration): Builder
    {
        // Assuming a 'reserved_until' datetime column
        return $query->where(function ($q) {
            $q->whereNull('reserved_until')
              ->orWhere('reserved_until', '<', now());
        })->tap(function ($query) use ($duration) {
            $query->update(['reserved_until' => now()->add(strtotime($duration) - time())]);
        });
    }
}

HasEmbeddingTraitTests.php

<?php

use App\Models\TestHasEmbeddingModel;
use Illuminate\Support\Carbon;

test('it filters models needing embedding', function () {
    TestHasEmbeddingModel::factory()->create(['embedded_at' => null]);
    TestHasEmbeddingModel::factory()->create(['embedded_at' => now()]);

    $results = TestHasEmbeddingModel::needsEmbedding()->get();

    expect($results)->toHaveCount(1);
});

test('it reserves models for a given time', function () {
    $model = TestHasEmbeddingModel::factory()->create(['reserved_until' => null]);

    TestHasEmbeddingModel::reserveFor('embeddings:create', '+2 hours')->get();

    $model->refresh();
    expect($model->reserved_until)->toBeInstanceOf(Carbon::class);
    expect($model->reserved_until->gt(now()))->toBeTrue();
});

ModelsThat.php

<?php

namespace App\Helpers;

use Illuminate\Support\Str;
use Illuminate\Support\Facades\File;
use ReflectionClass;

class ModelsThat
{
    public static function useTrait(string $trait): \Illuminate\Support\Collection
    {
        $modelsPath = app_path('Models');
        $modelsNamespace = 'App\\Models\\';

        return collect(File::allFiles($modelsPath))
            ->filter(fn ($file) => Str::endsWith($file->getFilename(), '.php'))
            ->map(function ($file) use ($modelsNamespace) {
                $class = $modelsNamespace . $file->getBasename('.php');
                if (! class_exists($class)) {
                    require_once $file->getPathname();
                }
                return $class;
            })
            ->filter(function ($class) use ($trait) {
                return in_array($trait, class_uses_recursive($class));
            });
    }
}

ModelsThatUseTraitTest.php

<?php

use App\Helpers\ModelsThat;
use App\Models\TestHasEmbeddingModel;
use App\Traits\HasEmbedding;
use Illuminate\Support\Collection;

beforeEach(function () {
    // Simulate autoloading
    require_once app_path('Models/TestHasEmbeddingModel.php');
});

test('it returns models using the HasEmbedding trait', function () {
    $models = ModelsThat::useTrait(HasEmbedding::class);

    expect($models)->toBeInstanceOf(Collection::class);
    expect($models)->toContain(TestHasEmbeddingModel::class);
});