Optimization

Author: meinder-a

readme.md

@@ -82,24 +82,15 @@ OldPeopleFilter.php
 declare(strict_types=1);
 
 use Illuminate\Database\Query\Builder;
+use DevMakerLab\LaravelFilters\AbstractFilter;
 
-class OldPeopleFilter implements FilterInterface
+class OldPeopleFilter extends AbstractFilter
 {
-    public static function neededKeys(): array
-    {
-        return ['age'];
-    }
-
-    public static function isApplicable(...$args): bool
-    {
-        return true;
-    }
+    public int $age;
 
-    public function apply(Builder &$queryBuilder, ...$args): void
+    public function apply(Builder &$queryBuilder): void
     {
-        $age = $args[0][self::neededKeys()[0]];
-
-        $queryBuilder->where('age', '>=', $age);
+        $queryBuilder->where('age', '>=', $this->age);
     }
 }
 ```

src/AbstractFilter.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevMakerLab\LaravelFilters;
+
+use Illuminate\Database\Query\Builder;
+
+abstract class AbstractFilter
+{
+    public function __construct(array $args = [])
+    {
+        $this->setAttributes($args);
+    }
+
+    protected function setAttributes(array $attributes): void
+    {
+        foreach (get_class_vars(static::class) as $key => $value) {
+            if (isset($attributes[$key])) {
+                $this->$key = $attributes[$key];
+            }
+        }
+    }
+
+    public static function isApplicable(... $args): bool
+    {
+        return true;
+    }
+
+    /**
+     * @throws NoApplyFilterRuleException
+     */
+    public function apply(Builder &$queryBuilder): void
+    {
+        throw new NoApplyFilterRuleException(self::class);
+    }
+}

src/AbstractFilterableRepository.php

@@ -22,7 +22,7 @@ public function addFilter(string $filter): self
             throw new FilterClassNotFound();
         }
 
-        if (! is_subclass_of($filter, FilterInterface::class)) {
+        if (! is_subclass_of($filter, AbstractFilter::class)) {
             throw new IncorrectFilterException($filter);
         }
 
@@ -55,11 +55,11 @@ public function resetLimit(): self
     public function applyFilters(Builder &$builder, array $args): self
     {
         foreach ($this->filters as $filter) {
-            $neededKeys = $filter::neededKeys();
-            $neededArgs = $this->extractNeededArgs($neededKeys, $args);
+            $neededArgs = $this->extractNeededArgs($filter, $args);
 
             if ($filter::isApplicable($neededArgs)) {
-                (new $filter)->apply($builder, $neededArgs);
+                $filterInstance = new $filter($neededArgs);
+                $filterInstance->apply($builder);
             }
         }
 
@@ -73,8 +73,8 @@ public function applyFilters(Builder &$builder, array $args): self
         return $this;
     }
 
-    private function extractNeededArgs(array $neededKeys, array $args): array
+    private function extractNeededArgs(string $class, array $args): array
     {
-        return array_intersect_key($args, array_flip($neededKeys));
+        return array_intersect_key($args, array_flip(array_keys(get_class_vars($class))));
     }
 }

src/FilterInterface.php

@@ -10,6 +10,6 @@ class IncorrectFilterException extends Exception
 {
     public function __construct(string $class)
     {
-        parent::__construct(sprintf('Class `%s` does not extends FilterInterface.', $class));
+        parent::__construct(sprintf('Class `%s` does not extends AbstractFilter.', $class));
     }
 }

src/IncorrectFilterException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevMakerLab\LaravelFilters;
+
+use Exception;
+
+class NoApplyFilterRuleException extends Exception
+{
+    public function __construct(string $class)
+    {
+        parent::__construct(sprintf('Filter class `%s` has no apply function.', $class));
+    }
+}

src/NoApplyFilterRuleException.php

@@ -5,24 +5,14 @@
 namespace Tests\Example\Filters;
 
 use Illuminate\Database\Query\Builder;
-use DevMakerLab\LaravelFilters\FilterInterface;
+use DevMakerLab\LaravelFilters\AbstractFilter;
 
-class OldPeopleFilter implements FilterInterface
+class OldPeopleFilter extends AbstractFilter
 {
-    public static function neededKeys(): array
-    {
-        return ['age'];
-    }
-
-    public static function isApplicable(...$args): bool
-    {
-        return true;
-    }
+    public int $age;
 
-    public function apply(Builder &$queryBuilder, ...$args): void
+    public function apply(Builder &$queryBuilder): void
     {
-        $age = $args[0][self::neededKeys()[0]];
-
-        $queryBuilder->where('age', '>=', $age);
+        $queryBuilder->where('age', '>=', $this->age);
     }
 }

tests/Example/Filters/OldPeopleFilter.php

@@ -4,6 +4,7 @@
 
 namespace Tests\Example;
 
+use Tests\Example\Entities\PeopleEntity;
 use Tests\Example\Entities\PeopleEntityList;
 use DevMakerLab\LaravelFilters\AbstractFilterableRepository;
 
@@ -31,11 +32,11 @@ public function get(array $args): PeopleEntityList
     public function transform(\Illuminate\Support\Collection $people): PeopleEntityList
     {
         $people->transform(function ($person) {
-            return [
+            return new PeopleEntity([
                 'name' => sprintf('%s %s', $person->lastname, $person->firstname),
                 'age' => $person->age,
                 'gender' => $person->gender,
-            ];
+            ]);
         });
 
         return new PeopleEntityList($people->toArray());

tests/Example/PeopleRepository.php

@@ -20,11 +20,28 @@ public function can_get_old_people()
     {
         $peopleRepository = $this->instantiatePeopleRepository();
 
+        $this->createPeople([
+                [
+                    'firstname' => 'Snoop',
+                    'lastname' => 'Dogg',
+                    'gender' => 'male',
+                    'age' => 49,
+                ],
+                [
+                    'firstname' => 'Danielle',
+                    'lastname' => 'Studio',
+                    'gender' => 'female',
+                    'age' => 67,
+                ]
+            ]);
+
         $people = $peopleRepository
             ->addFilter(OldPeopleFilter::class)
             ->get(['age' => 60]);
 
         $this->assertInstanceOf(PeopleEntityList::class, $people);
+        $this->assertCount(1, $people);
+        $this->assertInstanceOf(\Tests\Example\Entities\PeopleEntity::class, $people[0]);
     }
 }
 

tests/Feature/AbstractFilterableRepositoryTest.php

@@ -29,4 +29,11 @@ public function instantiatePeopleRepository(): PeopleRepository
     {
         return new PeopleRepository($this->app['db']);
     }
+
+    public function createPeople(array $peoples)
+    {
+        $this->app['db']
+            ->table('people')
+            ->insert($peoples);
+    }
 }