Revisions query builder

composer.json

@@ -25,7 +25,7 @@
     },
     "require": {
         "php": "^8.2",
-        "statamic/cms": "^6.0"
+        "statamic/cms": "dev-master"
     },
     "require-dev": {
         "doctrine/dbal": "^3.8",

src/Commands/ImportRevisions.php

@@ -45,7 +45,7 @@ public function handle(): int
 
     private function importRevisions(): void
     {
-        $this->withProgressBar(File::allFiles(config('statamic.revisions.path')), function ($file) {
+        $this->withProgressBar(File::allFiles(config('statamic.stache.stores.revisions.directory')), function ($file) {
             $yaml = YAML::file($file->getPathname())->parse();
 
             $revision = (new Revision)

src/Revisions/Revision.php

@@ -3,11 +3,7 @@
 namespace Statamic\Eloquent\Revisions;
 
 use Illuminate\Database\Eloquent\Model;
-use Statamic\Events\RevisionDeleted;
-use Statamic\Events\RevisionSaved;
-use Statamic\Events\RevisionSaving;
 use Statamic\Revisions\Revision as FileEntry;
-use Statamic\Revisions\WorkingCopy;
 
 class Revision extends FileEntry
 {
@@ -33,11 +29,10 @@ public static function fromModel(Model $model)
     {
         return (new static)
             ->key($model->key)
-            ->action($model->action ?? false)
-            ->id($model->created_at->timestamp)
+            ->action($model->action ?? null)
             ->date($model->created_at)
-            ->user($model->user ?? false)
-            ->message($model->message ?? '')
+            ->user($model->user ?? null)
+            ->message($model->message ?? null)
             ->attributes($model->attributes ?? [])
             ->model($model);
     }
@@ -59,10 +54,10 @@ public function fromRevisionOrWorkingCopy($item)
     {
         return (new static)
             ->key($item->key())
-            ->action($item instanceof WorkingCopy ? 'working' : $item->action())
+            ->action($item->isWorkingCopy() ? 'working' : $item->action())
             ->date($item->date())
-            ->user($item->user()?->id() ?? false)
-            ->message($item->message() ?? '')
+            ->user($item->user()?->id() ?? null)
+            ->message($item->message() ?? null)
             ->attributes($item->attributes() ?? []);
     }
 
@@ -76,22 +71,4 @@ public function model($model = null)
 
         return $this;
     }
-
-    public function save()
-    {
-        if (RevisionSaving::dispatch($this) === false) {
-            return false;
-        }
-
-        $this->model->save();
-
-        RevisionSaved::dispatch($this);
-    }
-
-    public function delete()
-    {
-        $this->model->delete();
-
-        RevisionDeleted::dispatch($this);
-    }
 }

src/Revisions/RevisionQueryBuilder.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Statamic\Eloquent\Revisions;
+
+use Illuminate\Support\Collection as IlluminateCollection;
+use Illuminate\Support\Str;
+use Statamic\Contracts\Revisions\Revision as RevisionContract;
+use Statamic\Contracts\Revisions\RevisionQueryBuilder as QueryBuilderContract;
+use Statamic\Query\EloquentQueryBuilder;
+
+class RevisionQueryBuilder extends EloquentQueryBuilder implements QueryBuilderContract
+{
+    private $selectedQueryColumns;
+
+    const COLUMNS = [
+        'id', 'key', 'action', 'user', 'message', 'attributes',
+    ];
+
+    protected function transform($items, $columns = [])
+    {
+        return IlluminateCollection::make($items)->map(function ($model) use ($columns) {
+            return app(RevisionContract::class)::fromModel($model)
+                ->selectedQueryColumns($this->selectedQueryColumns ?? $columns);
+        });
+    }
+
+    protected function column($column)
+    {
+        if (! is_string($column)) {
+            return $column;
+        }
+
+        if (! in_array($column, self::COLUMNS)) {
+            if (! Str::startsWith($column, 'attributes->')) {
+                $column = 'attributes->'.$column;
+            }
+        }
+
+        return $column;
+    }
+
+    public function with($relations, $callback = null)
+    {
+        return $this;
+    }
+}

src/Revisions/RevisionRepository.php

@@ -3,28 +3,11 @@
 namespace Statamic\Eloquent\Revisions;
 
 use Statamic\Contracts\Revisions\Revision as RevisionContract;
+use Statamic\Contracts\Revisions\RevisionQueryBuilder as QueryBuilderContract;
 use Statamic\Revisions\RevisionRepository as StacheRepository;
-use Statamic\Revisions\WorkingCopy;
 
 class RevisionRepository extends StacheRepository
 {
-    public function make(): RevisionContract
-    {
-        return new (app('statamic.eloquent.revisions.model'));
-    }
-
-    public function whereKey($key)
-    {
-        return app('statamic.eloquent.revisions.model')::where('key', $key)
-            ->orderBy('created_at')
-            ->get()
-            ->map(function ($revision) use ($key) {
-                return $this->makeRevisionFromFile($key, $revision);
-            })->keyBy(function ($revision) {
-                return $revision->date()->timestamp;
-            });
-    }
-
     public function findWorkingCopyByKey($key)
     {
         $class = app('statamic.eloquent.revisions.model');
@@ -37,7 +20,7 @@ public function findWorkingCopyByKey($key)
 
     public function save(RevisionContract $copy)
     {
-        if ($copy instanceof WorkingCopy) {
+        if ($copy->isWorkingCopy()) {
             app('statamic.eloquent.revisions.model')::where([
                 'key'    => $copy->key(),
                 'action' => 'working',
@@ -52,7 +35,7 @@ public function save(RevisionContract $copy)
 
     public function delete(RevisionContract $revision)
     {
-        if ($revision instanceof WorkingCopy) {
+        if ($revision->isWorkingCopy()) {
             $this->findWorkingCopyByKey($revision->key())?->delete();
 
             return;
@@ -70,6 +53,7 @@ public static function bindings(): array
     {
         return [
             RevisionContract::class => Revision::class,
+            QueryBuilderContract::class => RevisionQueryBuilder::class,
         ];
     }
 }

src/ServiceProvider.php

@@ -33,6 +33,7 @@
 use Statamic\Eloquent\Forms\SubmissionRepository;
 use Statamic\Eloquent\Globals\GlobalRepository;
 use Statamic\Eloquent\Globals\GlobalVariablesRepository;
+use Statamic\Eloquent\Revisions\RevisionQueryBuilder;
 use Statamic\Eloquent\Revisions\RevisionRepository;
 use Statamic\Eloquent\Structures\CollectionTreeRepository;
 use Statamic\Eloquent\Structures\NavigationRepository;
@@ -466,6 +467,12 @@ private function registerRevisions()
             return config('statamic.eloquent-driver.revisions.model');
         });
 
+        $this->app->bind(RevisionQueryBuilder::class, function ($app) {
+            return new RevisionQueryBuilder(
+                $app['statamic.eloquent.revisions.model']::query()
+            );
+        });
+
         Statamic::repository(RevisionRepositoryContract::class, RevisionRepository::class);
     }
 

tests/Commands/ImportRevisionsTest.php

@@ -22,10 +22,9 @@ protected function setUp(): void
 
         config()->set('statamic.revisions', [
             'enabled' => true,
-            'path' => __DIR__.'/tmp',
         ]);
 
-        mkdir(__DIR__.'/tmp');
+        config()->set('statamic.stache.stores.revisions.directory', __DIR__.'/../__fixtures__/dev-null/storage/statamic/revisions');
 
         Facade::clearResolvedInstance(RevisionRepositoryContract::class);
 
@@ -35,7 +34,7 @@ protected function setUp(): void
 
     protected function tearDown(): void
     {
-        app('files')->deleteDirectory(__DIR__.'/tmp');
+        app('files')->deleteDirectory(config('statamic.stache.stores.revisions.directory'));
 
         parent::tearDown();
     }

tests/Repositories/RevisionRepositoryTest.php

@@ -0,0 +1,110 @@
+<?php
+
+namespace Repositories;
+
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Collection;
+use PHPUnit\Framework\Attributes\Test;
+use Statamic\Eloquent\Revisions\Revision;
+use Statamic\Eloquent\Revisions\RevisionQueryBuilder;
+use Statamic\Eloquent\Revisions\RevisionRepository;
+use Statamic\Facades\User;
+use Statamic\Stache\Stache;
+use Tests\TestCase;
+
+class RevisionRepositoryTest extends TestCase
+{
+    use RefreshDatabase;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $stache = (new Stache)->sites(['en', 'fr']);
+        $this->app->instance(Stache::class, $stache);
+        $this->repo = new RevisionRepository($stache);
+
+        \Statamic\Facades\Revision::make()
+            ->key('123')
+            ->action('working')
+            ->date(now())
+            ->save();
+
+        \Statamic\Facades\Revision::make()
+            ->key('123')
+            ->action('other')
+            ->date(now()->subHour())
+            ->save();
+
+        \Statamic\Facades\Revision::make()
+            ->key('123')
+            ->action('other')
+            ->date(now()->subHours(2))
+            ->save();
+
+        \Statamic\Facades\Revision::make()
+            ->key('456')
+            ->action('working')
+            ->date(now())
+            ->save();
+
+        \Statamic\Facades\Revision::make()
+            ->key('456')
+            ->action('other')
+            ->date(now()->subHour())
+            ->save();
+    }
+
+    #[Test]
+    public function it_gets_revisions_and_excludes_working_copies()
+    {
+        $revisions = $this->repo->whereKey('123');
+
+        $this->assertInstanceOf(Collection::class, $revisions);
+        $this->assertCount(2, $revisions);
+        $this->assertContainsOnlyInstancesOf(Revision::class, $revisions);
+    }
+
+    #[Test]
+    public function it_can_call_to_array_on_a_revision_collection()
+    {
+        User::shouldReceive('find')->andReturnNull();
+
+        $revisions = $this->repo->whereKey('123');
+
+        $this->assertIsArray($revisions->toArray());
+    }
+
+    #[Test]
+    public function it_returns_a_query_builder()
+    {
+        $builder = $this->repo->query();
+
+        $this->assertInstanceOf(RevisionQueryBuilder::class, $builder);
+    }
+
+    #[Test]
+    public function it_gets_and_filters_items_using_query_builder()
+    {
+        $builder = $this->repo->query();
+
+        $revisions = $builder->get();
+        $this->assertInstanceOf(Collection::class, $revisions);
+        $this->assertCount(5, $revisions);
+        $this->assertContainsOnlyInstancesOf(Revision::class, $revisions);
+
+        $revisions = $builder->where('key', '123')->get();
+        $this->assertInstanceOf(Collection::class, $revisions);
+        $this->assertCount(3, $revisions);
+        $this->assertContainsOnlyInstancesOf(Revision::class, $revisions);
+
+        $revisions = $builder->where('key', '123')->where('action', '!=', 'working')->get();
+        $this->assertInstanceOf(Collection::class, $revisions);
+        $this->assertCount(2, $revisions);
+        $this->assertContainsOnlyInstancesOf(Revision::class, $revisions);
+
+        $revisions = $builder->where('key', '1234')->get();
+        $this->assertInstanceOf(Collection::class, $revisions);
+        $this->assertCount(0, $revisions);
+    }
+}