Refactor pass to argument and added more testing

agungsugiarto · Sep 19, 2020 · d3019da · d3019da
1 parent 661b129
commit d3019da
Show file tree

Hide file tree

Showing 15 changed files with 273 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -372,7 +372,7 @@ https://example.com/news?orderBy=email_desc&begin=2019-01-24&end=2019-01-26
 You can also build your own custom scopes. In your repository override `scope()` method:
 
 ```php
-public function scope($request)
+public function scope(IncomingRequest $request)
 {
     // apply build-in scopes
     parent::scope($request);

diff --git a/src/Contracts/CriterionInterface.php b/src/Contracts/CriterionInterface.php
@@ -2,6 +2,8 @@
 
 namespace Fluent\Repository\Contracts;
 
+use CodeIgniter\Model;
+
 interface CriterionInterface
 {
     /**
@@ -10,5 +12,5 @@ interface CriterionInterface
      * @param \CodeIgniter\Model $entity
      * @return mixed
      */
-    public function apply($entity);
+    public function apply(Model $entity);
 }
diff --git a/src/Contracts/RepositoryInterface.php b/src/Contracts/RepositoryInterface.php
@@ -16,7 +16,7 @@ public function get(array $columns = ['*']);
      * Execute the query and get the first result.
      *
      * @param array $columns
-     * @return array
+     * @return array|object
      */
     public function first($columns = ['*']);
 
@@ -91,7 +91,7 @@ public function updateBatch(array $attributes, $id);
     /**
      * Delete a record by id.
      *
-     * @param int $id
+     * @param mixed $id
      * @return mixed
      */
     public function destroy($id);

diff --git a/src/Contracts/ScopesInterface.php b/src/Contracts/ScopesInterface.php
@@ -2,6 +2,8 @@
 
 namespace Fluent\Repository\Contracts;
 
+use CodeIgniter\HTTP\IncomingRequest;
+
 interface ScopesInterface
 {
     /**
@@ -10,5 +12,5 @@ interface ScopesInterface
      * @param \CodeIgniter\HTTP\IncomingRequest $request
      * @return $this
      */
-    public function scope($request);
+    public function scope(IncomingRequest $request);
 }
diff --git a/src/Criteria/FindWhere.php b/src/Criteria/FindWhere.php
@@ -2,6 +2,7 @@
 
 namespace Fluent\Repository\Criteria;
 
+use CodeIgniter\Model;
 use Fluent\Repository\Contracts\CriterionInterface;
 
 class FindWhere implements CriterionInterface
@@ -23,7 +24,7 @@ public function __construct(array $conditions)
     /**
      * @inheritdoc
      */
-    public function apply($entity)
+    public function apply(Model $entity)
     {
         foreach ($this->conditions as $field => $value) {
             if (is_array($value)) {

diff --git a/src/Eloquent/RepositoryAbstract.php b/src/Eloquent/RepositoryAbstract.php
@@ -2,6 +2,7 @@
 
 namespace Fluent\Repository\Eloquent;
 
+use CodeIgniter\HTTP\IncomingRequest;
 use Fluent\Repository\Scopes\Scopes;
 use Fluent\Repository\Contracts\ScopesInterface;
 use Fluent\Repository\Contracts\CriteriaInterface;
@@ -45,7 +46,7 @@ public function withCriteria(array $criteria)
     /**
      * @inheritdoc
      */
-    public function scope($request)
+    public function scope(IncomingRequest $request)
     {
         $this->entity = (new Scopes($request, $this->searchable))->scope($this->entity);
 

diff --git a/src/Scopes/Scopes.php b/src/Scopes/Scopes.php
@@ -2,6 +2,7 @@
 
 namespace Fluent\Repository\Scopes;
 
+use CodeIgniter\HTTP\IncomingRequest;
 use Fluent\Repository\Scopes\Clauses\WhereScope;
 use Fluent\Repository\Scopes\Clauses\OrderByScope;
 use Fluent\Repository\Scopes\Clauses\OrWhereScope;
@@ -26,7 +27,7 @@ class Scopes extends ScopesAbstract
      * @param  array                             $searchable
      * @return void
      */
-    public function __construct($request, $searchable)
+    public function __construct(IncomingRequest $request, $searchable)
     {
         parent::__construct($request);
 
@@ -45,7 +46,7 @@ public function __construct($request, $searchable)
      * @param  string $key
      * @return string
      */
-    protected function mappings($key)
+    protected function mappings(string $key)
     {
         $mappings = [
             'or' => OrWhereScope::class,

diff --git a/src/Scopes/ScopesAbstract.php b/src/Scopes/ScopesAbstract.php
@@ -2,9 +2,11 @@
 
 namespace Fluent\Repository\Scopes;
 
+use CodeIgniter\HTTP\IncomingRequest;
+
 class ScopesAbstract
 {
-    /** @var \CodeIgniter\HTTP\IncomingRequest $request */
+    /** @var \CodeIgniter\HTTP\IncomingRequest */
     protected $request;
 
     /** @var array $scopes */
@@ -15,15 +17,15 @@ class ScopesAbstract
      *
      * @param \CodeIgniter\HTTP\IncomingRequest $request
      */
-    public function __construct($request)
+    public function __construct(IncomingRequest $request)
     {
         $this->request = $request;
     }
 
     /**
      * In your repository define which fields can be used to scope your queries.
      *
-     * @param \CodeIgniter\Database\BaseBuilder $builder
+     * @param \CodeIgniter\Database\BaseBuilder|\CodeIgniter\Model $builder
      * @return \CodeIgniter\Database\BaseBuilder $builder
      */
     public function scope($builder)
@@ -43,7 +45,7 @@ public function scope($builder)
      * @param string $scope
      * @return object
      */
-    protected function resolveScope($scope)
+    protected function resolveScope(string $scope)
     {
         return new $this->scopes[$scope]();
     }
@@ -56,7 +58,7 @@ protected function resolveScope($scope)
     protected function getScopes()
     {
         return $this->filterScopes(
-            $this->request->getVar(array_keys($this->scopes))
+            $this->request->getGet(array_keys($this->scopes))
         );
     }
 
@@ -66,7 +68,7 @@ protected function getScopes()
      * @param array $scopes
      * @return array
      */
-    protected function filterScopes($scopes)
+    protected function filterScopes(array $scopes)
     {
         return array_filter($scopes, function ($scope) {
             return isset($scope);

diff --git a/tests/Criteria/SampleCriteria.php b/tests/Criteria/SampleCriteria.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Fluent\Repository\Tests\Criteria;
+
+use CodeIgniter\Model;
+use Fluent\Repository\Contracts\CriterionInterface;
+
+class SampleCriteria implements CriterionInterface
+{
+    /** @var array $conditions */
+    protected $conditions;
+
+    /**
+     * Constructor FindWhare.
+     *
+     * @param array $conditions
+     * @return void
+     */
+    public function __construct(array $conditions)
+    {
+        $this->conditions = $conditions;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function apply(Model $entity)
+    {
+        foreach ($this->conditions as $field => $value)
+        {
+            if (is_array($value)) {
+                list($field, $condition, $val) = $value;
+                $entity = $entity->orWhere($field . $condition, $val);
+            } else {
+                $entity = $entity->where($field, $value);
+            }
+
+            return $entity;
+        }
+    }
+}
diff --git a/tests/Models/NewsModel.php b/tests/Models/NewsModel.php
@@ -11,6 +11,8 @@ class NewsModel extends Model
     protected $allowedFields = ['title', 'description'];
     protected $useTimestamps = true;
 
+    public $orderable = ['title'];
+
     /**
      * Faker generator.
      * 

diff --git a/tests/NewsRepositoryRequestTest.php b/tests/NewsRepositoryRequestTest.php
@@ -0,0 +1,133 @@
+<?php
+
+namespace Fluent\Repository\Tests;
+
+use CodeIgniter\Config\Services;
+use CodeIgniter\I18n\Time;
+use CodeIgniter\Test\CIDatabaseTestCase;
+use CodeIgniter\Test\ControllerTester;
+use Fluent\Repository\Tests\Repository\NewsRepositoryScope;
+use Tests\Support\Database\Seeds\NewsSeeder;
+
+class NewsRepositoryRequestTest extends CIDatabaseTestCase
+{
+    protected $refresh = false;
+
+    protected $seed = NewsSeeder::class;
+
+    /** @var NewsRepositoryScope */
+    protected $repository;
+
+    /** @var \CodeIgniter\HTTP\IncomingRequest */
+    protected $request;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        /** @var NewsRepositoryScope */
+        $this->repository = new NewsRepositoryScope();
+
+        $this->request = Services::request();
+    }
+
+    public function testRepositoryMyCustomScope()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'id' => '1',
+            ]
+        );
+
+        $this->assertNotEmpty($this->repository->scope(Services::request())->first());
+    }
+
+    public function testRepositoryMyCustomScopeIsNull()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'id' => '1000',
+            ]
+        );
+
+        $this->assertNull($this->repository->scope(Services::request())->first());
+    }
+
+    public function testRepositoryScopeTitle()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'title' => 'A',
+            ]
+        );
+
+        $this->assertNotEmpty($this->repository->scope(Services::request())->first());
+    }
+
+    public function testRepositoryScopeTitleIsNull()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'title' => 'Aaaaaa',
+            ]
+        );
+
+        $this->assertNull($this->repository->scope(Services::request())->first());
+    }
+
+    public function testRepositoryScopeDescription()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'description' => 'A',
+            ]
+        );
+
+        $this->assertNotEmpty($this->repository->scope(Services::request())->first());
+    }
+
+    public function testRepositoryScopeDescriptionIsNull()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'description' => 'Aaaaaa',
+            ]
+        );
+
+        $this->assertNull($this->repository->scope(Services::request())->first());
+    }
+
+    public function testRepositoryScopeRequestOrderByAsc()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'orderBy' => 'title_asc',
+            ]
+        );
+
+        $this->assertNotEmpty($this->repository->scope(Services::request())->paginate());
+    }
+
+    public function testRepositoryScopeRequestOrderByDesc()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'orderBy' => 'title_desc',
+            ]
+        );
+
+        $this->assertNotEmpty($this->repository->scope(Services::request())->paginate());
+    }
+
+    public function testRepositoryScopeRequestBeginEnd()
+    {
+        $this->request->setMethod('get')
+            ->setGlobal('get', [
+                'begin' => Time::now(),
+                'end'   => Time::now(),
+            ]
+        );
+
+        $this->assertNotNull($this->repository->scope(Services::request())->paginate());
+    }
+}
diff --git a/tests/NewsRepositoryTest.php b/tests/NewsRepositoryTest.php
@@ -3,6 +3,7 @@
 namespace Fluent\Repository\Tests;
 
 use CodeIgniter\Test\CIDatabaseTestCase;
+use Fluent\Repository\Tests\Criteria\SampleCriteria;
 use Fluent\Repository\Tests\Repository\NewsRepository;
 use Tests\Support\Database\Seeds\NewsSeeder;
 
@@ -44,6 +45,19 @@ public function testRepositoryFindWhere()
         );
     }
 
+    public function testRepositoryWithCriteria()
+    {
+        $this->assertNotEmpty(
+            $this->repository->withCriteria([
+                new SampleCriteria([
+                    'id' => 1,
+                    ['id', '=', 2]
+                ]),
+            ])
+            ->get()
+        );
+    }
+
     public function testRepositoryPaginate()
     {
         $this->assertNotEmpty($this->repository->paginate());