Fix + Test Sprunje with Relation Query

userfrosting · Dec 27, 2023 · a429064 · a429064
1 parent e2970d6
commit a429064
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 4 deletions.
diff --git a/app/src/Sprunje/Sprunje.php b/app/src/Sprunje/Sprunje.php
@@ -128,8 +128,11 @@ public function __construct(array $options = [])
         $this->setOptions($options);
 
         // Start a new query on any Model instances
-        if (is_a($query = $this->baseQuery(), Model::class)) {
+        $query = $this->baseQuery();
+        if (is_a($query, Model::class)) {
             $this->query = $query->newQuery();
+        } elseif (is_a($query, Relation::class)) {
+            $this->query = $query->getQuery();
         } else {
             $this->query = $query;
         }
@@ -633,7 +636,7 @@ protected function applyTransformations(Collection $collection): Collection
     /**
      * Set the initial query used by your Sprunje.
      *
-     * @return EloquentBuilder|QueryBuilder|Model
+     * @return EloquentBuilder|QueryBuilder|Model|Relation
      */
     abstract protected function baseQuery();
 

diff --git a/app/tests/Integration/Sprunje/SprunjeTest.php b/app/tests/Integration/Sprunje/SprunjeTest.php
@@ -13,6 +13,7 @@
 namespace UserFrosting\Sprinkle\Core\Tests\Integration\Sprunje;
 
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Query\Builder as QueryBuilder;
 use Illuminate\Database\Schema\Blueprint;
@@ -53,6 +54,8 @@ public function setUp(): void
         $builder = $this->ci->get(Builder::class);
         $migration = new TestTableMigration($builder);
         $migration->up();
+        $migration = new TestRelationTableMigration($builder);
+        $migration->up();
 
         // Insert some data
         $this->createData();
@@ -65,6 +68,8 @@ public function tearDown(): void
         $builder = $this->ci->get(Builder::class);
         $migration = new TestTableMigration($builder);
         $migration->down();
+        $migration = new TestRelationTableMigration($builder);
+        $migration->down();
 
         parent::tearDown();
     }
@@ -92,6 +97,12 @@ protected function createData(): void
             'type'        => 1,
             'active'      => true
         ]))->save();
+
+        (new TestSprunjeRelationModel([
+            'id'              => 1,
+            'name'            => 'Relation with 2',
+            'test_sprunje_id' => 2,
+        ]))->save();
     }
 
     public function testBaseSprunje(): void
@@ -451,6 +462,21 @@ public function testToResponseWithJson(): void
         ], $response);
         $this->assertSame('application/json', $response->getHeaderLine('Content-Type'));
     }
+
+    /** Sprunje were the base query is a relation */
+    public function testRelationSprunje(): void
+    {
+        $sprunje = new RelationTestSprunje();
+
+        $this->assertEquals([
+            'count'          => 1,
+            'count_filtered' => 1,
+            'rows'           => [
+                ['id' => 2, 'name' => 'bar', 'description' => 'Le Bar', 'type' => 2, 'active' => false],
+            ],
+            'listable'       => [],
+        ], $sprunje->getArray());
+    }
 }
 
 class TestSprunje extends Sprunje
@@ -495,12 +521,12 @@ protected function applyTransformations(Collection $collection): Collection
         return $collection;
     }
 
-    protected function sortName(EloquentBuilder|QueryBuilder|Relation $query, string $direction): static
+    protected function sortName(EloquentBuilder|QueryBuilder $query, string $direction): static
     {
         return $this;
     }
 
-    protected function filterName(EloquentBuilder|QueryBuilder|Relation $query, string $value): static
+    protected function filterName(EloquentBuilder|QueryBuilder $query, string $value): static
     {
         return $this;
     }
@@ -535,6 +561,19 @@ protected function applyTransformations(Collection $collection): Collection
     }
 }
 
+/** Sprunje were the base query is a relation. Will return the same as TestSprunje */
+class RelationTestSprunje extends Sprunje
+{
+    protected function baseQuery()
+    {
+        /** @var TestSprunjeRelationModel */
+        $query = TestSprunjeRelationModel::findOrFail(1);
+        $query = $query->testSprunje();
+
+        return $query;
+    }
+}
+
 class TestSprunjeModel extends UfModel
 {
     protected $table = 'test_sprunje';
@@ -557,6 +596,25 @@ class TestSprunjeModel extends UfModel
     ];
 }
 
+class TestSprunjeRelationModel extends UfModel
+{
+    protected $table = 'test_sprunje_relation';
+
+    protected $fillable = [
+        'id',
+        'test_sprunje_id',
+        'name',
+    ];
+
+    /** @var bool */
+    public $timestamps = false;
+
+    public function testSprunje(): BelongsTo
+    {
+        return $this->belongsTo(TestSprunjeModel::class);
+    }
+}
+
 /**
  * Custom migration for testing.
  */
@@ -578,3 +636,20 @@ public function down(): void
         $this->schema->drop('test_sprunje');
     }
 }
+
+class TestRelationTableMigration extends Migration
+{
+    public function up(): void
+    {
+        $this->schema->create('test_sprunje_relation', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('name');
+            $table->integer('test_sprunje_id')->unsigned();
+        });
+    }
+
+    public function down(): void
+    {
+        $this->schema->drop('test_sprunje_relation');
+    }
+}