Merge 42f29f9 into 3c29b9d

CHANGELOG.md

@@ -9,6 +9,11 @@ This changelog is initialized in release 1.0.0
 
 ## [Unreleased]
 
+## [v2.6.0] - 2023-02-07
+
+### Added
+* Builder method to repository
+
 ## [v2.5.0] - 2022-08-18
 
 ### Added
@@ -52,7 +57,8 @@ This changelog is initialized in release 1.0.0
 * Columns argument to ModelRepositoryInterface::all to be compatible with the underlying Eloquent model
 * FQN options for contract and repository to ModelRepositoryMakeCommand
 
-[Unreleased]: https://github.com/wimski/laravel-model-repositories/compare/v2.5.0...master
+[Unreleased]: https://github.com/wimski/laravel-model-repositories/compare/v2.6.0...master
+[v2.6.0]: https://github.com/wimski/laravel-model-repositories/compare/v2.5.0...v2.6.0
 [v2.5.0]: https://github.com/wimski/laravel-model-repositories/compare/v2.4.0...v2.5.0
 [v2.4.0]: https://github.com/wimski/laravel-model-repositories/compare/v2.3.0...v2.4.0
 [v2.3.0]: https://github.com/wimski/laravel-model-repositories/compare/v2.2.0...v2.3.0

src/Contracts/Repositories/ModelRepositoryInterface.php

@@ -6,6 +6,7 @@
 
 use Closure;
 use Illuminate\Contracts\Support\Arrayable;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Database\Query\Expression;
@@ -15,6 +16,11 @@
  */
 interface ModelRepositoryInterface
 {
+    /**
+     * @return Builder<T>
+     */
+    public function builder(): Builder;
+
     /**
      * @param int|string $key
      * @param string     ...$column

src/Repositories/AbstractModelRepository.php

@@ -4,6 +4,7 @@
 
 namespace Wimski\ModelRepositories\Repositories;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Wimski\ModelRepositories\Contracts\Repositories\ModelRepositoryInterface;
@@ -19,6 +20,14 @@ abstract class AbstractModelRepository implements ModelRepositoryInterface
      */
     protected $model;
 
+    public function builder(): Builder
+    {
+        /** @var Builder<T> $builder */
+        $builder = $this->model->newQuery();
+
+        return $builder;
+    }
+
     public function find($key, string ...$column)
     {
         /** @var T|null $model */

tests/Integration/AbstractIntegrationTest.php

@@ -4,9 +4,12 @@
 
 namespace Wimski\ModelRepositories\Tests\Integration;
 
+use Illuminate\Contracts\Config\Repository as Config;
+use Illuminate\Foundation\Application as BaseApplication;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use Orchestra\Testbench\Foundation\PackageManifest;
 use Orchestra\Testbench\TestCase;
+use RuntimeException;
 use Wimski\ModelRepositories\Tests\Laravel\App\Providers\ModelRepositoryServiceProvider;
 use Wimski\ModelRepositories\Tests\Laravel\Application;
 
@@ -18,7 +21,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        $this->app['config']->set('model-repositories.namespaces', [
+        $this->getApplication()->make(Config::class)->set('model-repositories.namespaces', [
             [
                 'models'       => 'Wimski\\ModelRepositories\\Tests\\Laravel\\App\\Models',
                 'contracts'    => 'Wimski\\ModelRepositories\\Tests\\Laravel\\App\\Contracts\\Repositories',
@@ -27,6 +30,15 @@ protected function setUp(): void
         ]);
     }
 
+    protected function getApplication(): BaseApplication
+    {
+        if (! $this->app) {
+            throw new RuntimeException('Application should be setup');
+        }
+
+        return $this->app;
+    }
+
     protected function getPackageProviders($app): array
     {
         return [

tests/Integration/Repositories/ModelRepositoryTest.php

@@ -4,6 +4,7 @@
 
 namespace Wimski\ModelRepositories\Tests\Integration\Repositories;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
@@ -49,6 +50,17 @@ protected function setUp(): void
         $this->repository = new ModelWithRepositoryRepository(new ModelWithRepository());
     }
 
+    /**
+     * @test
+     */
+    public function it_returns_an_eloquent_builder(): void
+    {
+        $builder = $this->repository->builder();
+
+        self::assertInstanceOf(Builder::class, $builder);
+        self::assertSame(ModelWithRepository::class, get_class($builder->getModel()));
+    }
+
     /**
      * @test
      */