Unit testing (#20)

* Config unit tests + CI

* Apply fixes from StyleCI (#14)

* Parser test + minor namespace refactor

* Request parameter tests

* Apply fixes from StyleCI (#15)

* Started callback testing + minor adjustments

* Apply fixes from StyleCI (#16)

* Simplified code

* Minor refactor

* Testing callbacks

* Apply fixes from StyleCI (#17)

* Simplified bool types + added test

* Apply fixes from StyleCI (#18)

* Categorized values test

* Being honest about features

* Apply fixes from StyleCI (#19)

* JSON query testing + doctrine fix

* Apply fixes from StyleCI (#21)

* Replaced constant with abstract

* Apply fixes from StyleCI (#22)

* Test

* Test2

* Added interface to parameter

* Reverted abstract type hints because of PHPStan

* Removed leftovers

* Minor

* Added abstract check

Author: Norgul

.github/workflows/pull_request.yml

@@ -0,0 +1,48 @@
+name: PR pipeline
+
+on:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: Ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          extensions: mbstring, intl
+          ini-values: post_max_size=256M, max_execution_time=180
+          coverage: xdebug
+          tools: php-cs-fixer, phpunit
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v2
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Execute PHPUnit tests
+        run:
+          vendor/phpunit/phpunit/phpunit
+
+      - name: PHP STatic ANalyser (phpstan)
+        uses: chindit/actions-phpstan@1.0.1
+        with:
+          # Arguments to add to PHPStan CLI
+          arguments: --level 0 src

README.md

@@ -171,8 +171,8 @@ Using ``order_by`` key does an 'order by' based on the given key(s). Order of th
 matters!
 
 Arguments are presumed to be in a ``"column": "direction"`` fashion, where `direction`
-MUST be ``asc`` (ascending) or `desc` (descending); everything else will throw an
-exception.
+MUST be ``asc`` (ascending) or `desc` (descending). In case that only column is provided,
+direction will be assumed to be an ascending order. 
 
 Example:
 ```
@@ -519,6 +519,6 @@ You can extend this functionality by adding your own custom parameter. It
 needs to extend ``Asseco\JsonQueryBuilder\RequestParameters\AbstractParameter``
 in order to work.  
 - operators are registered under ``operators`` config key. Those can be 
-extended by adding a class which extends ``Asseco\JsonQueryBuilder\SearchCallbacks\AbstractCallback``
+extended by adding a class which extends ``Asseco\JsonQueryBuilder\SearchCallbacks\AbstractCallback``.
 - types are registered under ``types`` config key. Those can be extended
-by adding a class which extends ``Asseco\JsonQueryBuilder\Types\AbstractType``
+by adding a class which extends ``Asseco\JsonQueryBuilder\Types\AbstractType``.

composer.json

@@ -12,13 +12,20 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.0",
-        "mockery/mockery": "^1.3.1"
+        "mockery/mockery": "^1.3.1",
+        "fakerphp/faker": "^1.9.1",
+        "orchestra/testbench": "^6.0"
     },
     "autoload": {
         "psr-4": {
             "Asseco\\JsonQueryBuilder\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Asseco\\JsonQueryBuilder\\Tests\\": "tests/"
+        }
+    },
     "extra": {
         "laravel": {
             "providers": [

config/asseco-json-query-builder.php

@@ -68,6 +68,7 @@
     ],
 
     /**
+     * TODO: these options are currently disabled and will not work
      * Refined options for a single model.
      * Use if you want to enforce rules on a specific model without affecting globally all models.
      */

phpunit.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true">
+
+    <testsuites>
+        <testsuite name="Feature tests">
+            <directory suffix=".php">./tests/Feature</directory>
+        </testsuite>
+
+        <testsuite name="Unit tests">
+            <directory suffix=".php">./tests/Unit</directory>
+        </testsuite>
+    </testsuites>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./app</directory>
+        </include>
+    </coverage>
+    <php>
+        <server name="APP_ENV" value="testing"/>
+        <server name="CACHE_DRIVER" value="array"/>
+        <server name="DB_CONNECTION" value="testing"/>
+        <server name="QUEUE_CONNECTION" value="sync"/>
+        <server name="SESSION_DRIVER" value="array"/>
+    </php>
+</phpunit>

src/CategorizedValues.php

@@ -2,9 +2,7 @@
 
 namespace Asseco\JsonQueryBuilder;
 
-use Asseco\JsonQueryBuilder\Config\OperatorsConfig;
 use Asseco\JsonQueryBuilder\Config\TypesConfig;
-use Asseco\JsonQueryBuilder\RequestParameters\Models\Search;
 
 class CategorizedValues
 {
@@ -16,8 +14,7 @@ class CategorizedValues
     const IS_NULL = 'null';
     const IS_NOT_NULL = '!null';
 
-    protected OperatorsConfig $operatorsConfig;
-    protected Search          $searchModel;
+    protected SearchParser $searchParser;
 
     public array $and = [];
     public array $andLike = [];
@@ -28,14 +25,12 @@ class CategorizedValues
 
     /**
      * CategorizedValues constructor.
-     * @param OperatorsConfig $operatorsConfig
-     * @param Search $searchModel
+     * @param SearchParser $searchParser
      * @throws Exceptions\JsonQueryBuilderException
      */
-    public function __construct(OperatorsConfig $operatorsConfig, Search $searchModel)
+    public function __construct(SearchParser $searchParser)
     {
-        $this->operatorsConfig = $operatorsConfig;
-        $this->searchModel = $searchModel;
+        $this->searchParser = $searchParser;
 
         $this->prepare();
         $this->categorize();
@@ -46,13 +41,13 @@ public function __construct(OperatorsConfig $operatorsConfig, Search $searchMode
      */
     public function prepare()
     {
-        $type = (new TypesConfig())->getCallbackByTypeName($this->searchModel->type);
-        $this->searchModel->values = $type->prepare($this->searchModel->values);
+        $type = (new TypesConfig())->getTypeClassFromTypeName($this->searchParser->type);
+        $this->searchParser->values = $type->prepare($this->searchParser->values);
     }
 
     public function categorize()
     {
-        foreach ($this->searchModel->values as $value) {
+        foreach ($this->searchParser->values as $value) {
             if ($value === self::IS_NULL) {
                 $this->null = true;
                 continue;

src/Config/ModelConfig.php

@@ -4,10 +4,10 @@
 
 namespace Asseco\JsonQueryBuilder\Config;
 
-use Doctrine\DBAL\DBALException;
+use Exception;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Cache;
-use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
 
@@ -35,19 +35,19 @@ protected function getConfig(): array
         return config('asseco-json-query-builder.model_options.' . get_class($this->model));
     }
 
-    public function getReturns()
+    public function getReturns(): array
     {
         if (array_key_exists('returns', $this->config) && $this->config['returns']) {
-            return $this->config['returns'];
+            return Arr::wrap($this->config['returns']);
         }
 
         return ['*'];
     }
 
-    public function getRelations()
+    public function getRelations(): array
     {
         if (array_key_exists('relations', $this->config) && $this->config['relations']) {
-            return $this->config['relations'];
+            return Arr::wrap($this->config['relations']);
         }
 
         return [];
@@ -82,27 +82,29 @@ public function getForbidden(array $forbiddenKeys)
 
     protected function getEloquentExclusion($forbiddenKeys): array
     {
-        if (array_key_exists('eloquent_exclusion', $this->config) && $this->config['eloquent_exclusion']) {
-            $guarded = $this->model->getGuarded();
-            $fillable = $this->model->getFillable();
-
-            if ($guarded[0] != '*') { // Guarded property is never empty. It is '*' by default.
-                $forbiddenKeys = array_merge($forbiddenKeys, $guarded);
-            } elseif (count($fillable) > 0) {
-                $forbiddenKeys = array_diff(array_keys($this->getModelColumns()), $fillable);
-            }
+        if (!array_key_exists('eloquent_exclusion', $this->config) || !($this->config['eloquent_exclusion'])) {
+            return $forbiddenKeys;
+        }
+
+        $guarded = $this->model->getGuarded();
+        $fillable = $this->model->getFillable();
+
+        if ($guarded[0] != '*') { // Guarded property is never empty. It is '*' by default.
+            $forbiddenKeys = array_merge($forbiddenKeys, $guarded);
+        } elseif (count($fillable) > 0) {
+            $forbiddenKeys = array_diff(array_keys($this->getModelColumns()), $fillable);
         }
 
         return $forbiddenKeys;
     }
 
     protected function getForbiddenColumns(array $forbiddenKeys): array
     {
-        if (array_key_exists('forbidden_columns', $this->config) && $this->config['forbidden_columns']) {
-            $forbiddenKeys = array_merge($forbiddenKeys, $this->config['forbidden_columns']);
+        if (!array_key_exists('forbidden_columns', $this->config) || !($this->config['forbidden_columns'])) {
+            return $forbiddenKeys;
         }
 
-        return $forbiddenKeys;
+        return array_merge($forbiddenKeys, $this->config['forbidden_columns']);
     }
 
     /**
@@ -122,19 +124,36 @@ public function getModelColumns(): array
         $columns = Schema::getColumnListing($table);
         $modelColumns = [];
 
-        // having 'enum' in table definition will throw Doctrine error because it is not defined in their types.
-        // Registering it manually.
-        DB::connection()->getDoctrineSchemaManager()->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
+        $this->registerEnumTypeForDoctrine();
+
         try {
             foreach ($columns as $column) {
                 $modelColumns[$column] = DB::getSchemaBuilder()->getColumnType($table, $column);
             }
-        } catch (DBALException $e) {
+        } catch (Exception $e) {
             // leave model columns as an empty array and cache it.
         }
 
         Cache::put(self::CACHE_PREFIX . $table, $modelColumns, self::CACHE_TTL);
 
         return $modelColumns;
     }
+
+    /**
+     * Having 'enum' in table definition will throw Doctrine error because it is not defined in their types.
+     * Registering it manually.
+     */
+    protected function registerEnumTypeForDoctrine(): void
+    {
+        $connection = DB::connection();
+
+        if (!class_exists('Doctrine\DBAL\Driver\AbstractSQLiteDriver')) {
+            return;
+        }
+
+        $connection
+            ->getDoctrineSchemaManager()
+            ->getDatabasePlatform()
+            ->registerDoctrineTypeMapping('enum', 'string');
+    }
 }

src/Config/OperatorsConfig.php

@@ -9,7 +9,10 @@
 
 class OperatorsConfig extends SearchConfig
 {
-    const CONFIG_KEY = 'operators';
+    protected function configKey(): string
+    {
+        return 'operators';
+    }
 
     protected function operatorCallbackMapping(): array
     {
@@ -19,12 +22,16 @@ protected function operatorCallbackMapping(): array
         return array_combine($operators, $callbacks);
     }
 
-    public function getOperators()
+    /**
+     * Extract operators from registered 'operator' classes.
+     * @return array
+     */
+    public function getOperators(): array
     {
         /**
          * @var AbstractCallback $callback
          */
-        return array_map(fn ($callback) => $callback::getCallbackOperator(), $this->registered);
+        return array_map(fn ($callback) => $callback::operator(), $this->registered);
     }
 
     /**

src/Config/RequestParametersConfig.php

@@ -6,5 +6,8 @@
 
 class RequestParametersConfig extends SearchConfig
 {
-    const CONFIG_KEY = 'request_parameters';
+    protected function configKey(): string
+    {
+        return 'request_parameters';
+    }
 }

src/Config/SearchConfig.php

@@ -5,7 +5,6 @@
 namespace Asseco\JsonQueryBuilder\Config;
 
 use Asseco\JsonQueryBuilder\Exceptions\JsonQueryBuilderException;
-use Illuminate\Support\Facades\Config;
 
 abstract class SearchConfig
 {
@@ -27,13 +26,16 @@ public function __construct()
      *
      * @throws JsonQueryBuilderException
      */
-    public function register(): void
+    protected function register(): void
     {
-        $key = static::CONFIG_KEY;
+        $key = $this->configKey();
+
         if (!array_key_exists($key, $this->config)) {
             throw new JsonQueryBuilderException("Config file is missing '$key'");
         }
 
         $this->registered = $this->config[$key];
     }
+
+    abstract protected function configKey(): string;
 }