Keep scopes and other builder properties from base query (#33)

Initialize scopes, macro's, onDelete callback and eager loads from base query on QueryBuilder

Author: AlexVanderbist

src/QueryBuilder.php

@@ -28,13 +28,9 @@ class QueryBuilder extends Builder
 
     public function __construct(Builder $builder, ?Request $request = null)
     {
-        parent::__construct($builder->getQuery());
+        parent::__construct(clone $builder->getQuery());
 
-        $this->setModel($builder->getModel());
-
-        foreach ($this->getModel()->getGlobalScopes() as $identifier => $scope) {
-            $this->withGlobalScope($identifier, $scope);
-        }
+        $this->initializeFromBuilder($builder);
 
         $this->request = $request ?? request();
 
@@ -43,6 +39,28 @@ public function __construct(Builder $builder, ?Request $request = null)
         }
     }
 
+    /**
+     * Add the model, scopes, eager loaded relationships, local macro's and onDelete callback
+     * from the $builder to this query builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     */
+    protected function initializeFromBuilder(Builder $builder)
+    {
+        $this->setModel($builder->getModel())
+            ->setEagerLoads($builder->getEagerLoads());
+
+        $builder->macro('getProtected', function (Builder $builder, string $property) {
+            return $builder->{$property};
+        });
+
+        $this->scopes = $builder->getProtected('scopes');
+
+        $this->localMacros = $builder->getProtected('localMacros');
+
+        $this->onDelete = $builder->getProtected('onDelete');
+    }
+
     /**
      * Create a new QueryBuilder for a request and model.
      *

tests/Models/RelatedModel.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 class RelatedModel extends Model
 {

tests/QueryBuilderTest.php

@@ -50,15 +50,53 @@ public function it_can_query_soft_deletes()
     /** @test */
     public function it_can_query_global_scopes()
     {
-        $queryBuilder = QueryBuilder::for(ScopeModel::class);
-
         ScopeModel::create(['name' => 'John Doe']);
         ScopeModel::create(['name' => 'test']);
 
-        // Global scope ignores models with name "test"
-        $this->assertCount(1, $queryBuilder->get());
+        // Global scope on ScopeModel excludes models named 'test'
+        $this->assertCount(1, QueryBuilder::for(ScopeModel::class)->get());
+
+        $this->assertCount(2, QueryBuilder::for(ScopeModel::query()->withoutGlobalScopes())->get());
+
+        $this->assertCount(2, QueryBuilder::for(ScopeModel::class)->withoutGlobalScopes()->get());
+    }
+
+    /** @test */
+    public function it_keeps_eager_loaded_relationships_from_the_base_query()
+    {
+        TestModel::create(['name' => 'John Doe']);
+
+        $baseQuery = TestModel::with('relatedModels');
+        $queryBuilder = QueryBuilder::for($baseQuery);
+
+        $this->assertTrue($baseQuery->first()->relationLoaded('relatedModels'));
+        $this->assertTrue($queryBuilder->first()->relationLoaded('relatedModels'));
+    }
+
+    /** @test */
+    public function it_keeps_local_macros_added_to_the_base_query()
+    {
+        $baseQuery = TestModel::query();
+
+        $baseQuery->macro('customMacro', function ($builder) {
+            return $builder->where('name', 'Foo');
+        });
+
+        $queryBuilder = QueryBuilder::for($baseQuery);
+
+        $this->assertEquals($baseQuery->customMacro()->toSql(), $queryBuilder->customMacro()->toSql());
+    }
+
+    /** @test */
+    public function it_keeps_the_on_delete_callback_added_to_the_base_query()
+    {
+        $baseQuery = TestModel::query();
+
+        $baseQuery->onDelete(function () {
+            return 'onDelete called';
+        });
 
-        $this->assertCount(2, $queryBuilder->withoutGlobalScopes()->get());
+        $this->assertEquals('onDelete called', QueryBuilder::for($baseQuery)->delete());
     }
 
     /** @test */