We Are Still Here

Author: meinder-a

.gitignore

@@ -0,0 +1,2 @@
+vendor/
+composer.lock

composer.json

@@ -0,0 +1,40 @@
+{
+    "name": "devmakerlab/laravel-filters",
+    "type": "library",
+    "license": "WTFPL",
+    "autoload": {
+        "psr-4": {
+            "DevMakerLab\\LaravelFilters\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/",
+            "Tests\\Example\\": "tests/Example"
+        }
+    },
+    "authors": [
+        {
+            "name": "Valentin Leguy",
+            "email": "[email protected]"
+        },
+        {
+            "name": "Anthony Meinder",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "illuminate/database": "^8.50"
+    },
+    "require-dev": {
+        "symfony/var-dumper": "^5.3",
+        "phpunit/phpunit": "^9.5",
+        "orchestra/testbench": "^6.19",
+        "devmakerlab/entities": "^3.0.1"
+    },
+    "scripts": {
+        "post-autoload-dump": [
+            "@php ./vendor/bin/testbench package:discover --ansi"
+        ]
+    }
+}

phpunit.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        bootstrap="vendor/autoload.php"
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        colors="true"
+        verbose="true"
+        convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        processIsolation="false"
+        stopOnFailure="false"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+>
+    <coverage>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+    </coverage>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Unit</directory>
+        </testsuite>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="DB_CONNECTION" value="testing"/>
+        <env name="APP_KEY" value="base64:bWVpbmRlci1hL2ZpbHRlcnMKc3RhciBpdCE="/>
+    </php>
+</phpunit>

src/AbstractFilterableRepository.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevMakerLab\LaravelFilters;
+
+use Illuminate\Database\Query\Builder;
+
+abstract class AbstractFilterableRepository
+{
+    protected array $filters;
+
+    protected ?int $limit = null;
+
+    /**
+     * @throws FilterClassNotFound
+     * @throws IncorrectFilterException
+     */
+    public function addFilter(string $filter): self
+    {
+        if (! class_exists($filter)) {
+            throw new FilterClassNotFound();
+        }
+
+        if (! is_subclass_of($filter, FilterInterface::class)) {
+            throw new IncorrectFilterException($filter);
+        }
+
+        $this->filters[] = $filter;
+
+        return $this;
+    }
+
+    public function resetFilters(): self
+    {
+        $this->filters = [];
+
+        return $this;
+    }
+
+    public function limit(int $limit): self
+    {
+        $this->limit = $limit;
+
+        return $this;
+    }
+
+    public function resetLimit(): self
+    {
+        $this->limit = null;
+
+        return $this;
+    }
+
+    public function applyFilters(Builder &$builder, array $args): self
+    {
+        foreach ($this->filters as $filter) {
+            $neededKeys = $filter::neededKeys();
+            $neededArgs = $this->extractNeededArgs($neededKeys, $args);
+
+            if ($filter::isApplicable($neededArgs)) {
+                (new $filter)->apply($builder, $neededArgs);
+            }
+        }
+
+        if ($this->limit) {
+            $builder->limit($this->limit);
+        }
+
+        $this->resetFilters();
+        $this->resetLimit();
+
+        return $this;
+    }
+
+    private function extractNeededArgs(array $neededKeys, array $args): array
+    {
+        return array_intersect_key($args, array_flip($neededKeys));
+    }
+}

src/FilterClassNotFound.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevMakerLab\LaravelFilters;
+
+use Exception;
+
+class FilterClassNotFound extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct();
+    }
+}

src/FilterInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevMakerLab\LaravelFilters;
+
+use Illuminate\Database\Query\Builder;
+
+interface FilterInterface
+{
+    public static function neededKeys(): array;
+
+    public static function isApplicable(... $args): bool;
+
+    public function apply(Builder &$queryBuilder, ... $args): void;
+}

src/IncorrectFilterException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevMakerLab\LaravelFilters;
+
+use Exception;
+
+class IncorrectFilterException extends Exception
+{
+    public function __construct(string $class)
+    {
+        parent::__construct(sprintf('Class `%s` does not extends FilterInterface.', $class));
+    }
+}

tests/Example/Entities/PeopleEntity.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Example\Entities;
+
+use DevMakerLab\Entity;
+
+class PeopleEntity extends Entity
+{
+    public string $name;
+    public int $age;
+    public string $gender;
+}

tests/Example/Entities/PeopleEntityList.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Example\Entities;
+
+use DevMakerLab\EntityList;
+
+class PeopleEntityList extends EntityList
+{
+    protected string $expectedType = PeopleEntity::class;
+}

tests/Example/Filters/OldPeopleFilter.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Example\Filters;
+
+use Illuminate\Database\Query\Builder;
+use DevMakerLab\LaravelFilters\FilterInterface;
+
+class OldPeopleFilter implements FilterInterface
+{
+    public static function neededKeys(): array
+    {
+        return ['age'];
+    }
+
+    public static function isApplicable(...$args): bool
+    {
+        return true;
+    }
+
+    public function apply(Builder &$queryBuilder, ...$args): void
+    {
+        $age = $args[0][self::neededKeys()[0]];
+
+        $queryBuilder->where('age', '>=', $age);
+    }
+}