Merge pull request #35 from kettasoft/refactor/engine-refactoring

Refactor Engine config access to unified pattern

Author: kettasoft

src/Engines/Expression.php

@@ -3,18 +3,13 @@
 namespace Kettasoft\Filterable\Engines;
 
 use Kettasoft\Filterable\Support\Payload;
-use Kettasoft\Filterable\Traits\FieldNormalizer;
 use Illuminate\Contracts\Database\Eloquent\Builder;
-use Kettasoft\Filterable\Engines\Foundation\Clause;
 use Kettasoft\Filterable\Engines\Foundation\Engine;
 use Kettasoft\Filterable\Support\ConditionNormalizer;
 use Kettasoft\Filterable\Support\ValidateTableColumns;
 use Kettasoft\Filterable\Engines\Foundation\ClauseApplier;
 use Kettasoft\Filterable\Engines\Foundation\ClauseFactory;
-use Kettasoft\Filterable\Engines\Foundation\Enums\Operators;
 use Kettasoft\Filterable\Engines\Foundation\Appliers\Applier;
-use Kettasoft\Filterable\Exceptions\InvalidOperatorException;
-use Kettasoft\Filterable\Exceptions\NotAllowedFieldException;
 use Kettasoft\Filterable\Engines\Foundation\Parsers\Dissector;
 
 class Expression extends Engine
@@ -57,11 +52,6 @@ public function execute(Builder $builder)
     return $builder;
   }
 
-  public function getAllowedFieldsFromConfig(): array
-  {
-    return config('filterable.engines.expression.allowed_fields', []);
-  }
-
   /**
    * Check if the given column is registered in schema. 
    * @param mixed $column
@@ -76,16 +66,6 @@ protected function validateTableColumns($builder, $column)
     return true;
   }
 
-  public function getOperatorsFromConfig(): array
-  {
-    return config('filterable.engines.expression.allowed_operators', []);
-  }
-
-  public function isStrictFromConfig(): bool
-  {
-    return config('filterable.engines.expression.strict', true);
-  }
-
   /**
    * Get engine default operator.
    * @return string
@@ -95,11 +75,6 @@ public function defaultOperator(): string
     return config('filterable.engines.expression.default_operator', 'eq');
   }
 
-  public function isIgnoredEmptyValuesFromConfig(): bool
-  {
-    return config('filterable.engines.expression.ignore_empty_values', false);
-  }
-
   /**
    * Get engine name.
    * @return string

src/Engines/Foundation/Engine.php

@@ -17,15 +17,15 @@ abstract class Engine implements HasInteractsWithOperators, HasFieldMap, Stricta
 {
   /**
    * Create Engine instance.
-   * @param \Kettasoft\Filterable\Contracts\FilterableContext $context
+   * @param Filterable $context
    */
-  public function __construct(protected FilterableContext $context)
-  {
-    $resources = $this->context->getResources()
-      ->setOperators($this->allowedOperators());
+  public function __construct(protected Filterable $context) {}
 
-    $resources->operators->setDefault($this->defaultOperator());
-  }
+  /**
+   * Get engine name.
+   * @return string
+   */
+  abstract public function getEngineName(): string;
 
   /**
    * Apply filters to the query.
@@ -35,16 +35,40 @@ public function __construct(protected FilterableContext $context)
   abstract public function execute(Builder $builder);
 
   /**
-   * Check if the strict mode is enable in an engine config.
-   * @return bool
+   * Get allowed fields to filtering.
+   * @return array
    */
-  abstract protected function isStrictFromConfig(): bool;
+  protected function getAllowedFieldsFromConfig(): array
+  {
+    return config("filterable.engines.{$this->getEngineName()}.allowed_fields", []);
+  }
 
-  abstract protected function getAllowedFieldsFromConfig(): array;
+  /**
+   * Check if empty values are ignored from engine config.
+   * @return bool
+   */
+  protected function isIgnoredEmptyValuesFromConfig(): bool
+  {
+    return config("filterable.engines.{$this->getEngineName()}.ignore_empty_values", false);
+  }
 
-  abstract protected function isIgnoredEmptyValuesFromConfig(): bool;
+  /**
+   * Get allowed operators to filtering.
+   * @return array
+   */
+  public function getOperatorsFromConfig(): array
+  {
+    return config("filterable.engines.{$this->getEngineName()}.allowed_operators", []);
+  }
 
-  abstract public function getEngineName(): string;
+  /**
+   * Check if the strict mode is enable in an engine config.
+   * @return bool
+   */
+  protected function isStrictFromConfig(): bool
+  {
+    return config("filterable.engines.{$this->getEngineName()}.strict", false);
+  }
 
   public function isIgnoredEmptyValues(): bool
   {

src/Engines/Invokable.php

@@ -3,17 +3,16 @@
 namespace Kettasoft\Filterable\Engines;
 
 use Illuminate\Support\Str;
+use Kettasoft\Filterable\Filterable;
 use Illuminate\Database\Eloquent\Builder;
-use Kettasoft\Filterable\Engines\Foundation\Attributes\AttributeRegistry;
 use Kettasoft\Filterable\Support\Payload;
 use Illuminate\Support\Traits\ForwardsCalls;
 use Kettasoft\Filterable\Engines\Foundation\Engine;
-use Kettasoft\Filterable\Engines\Foundation\Attributes\AttributeContext;
-use Kettasoft\Filterable\Engines\Foundation\Attributes\AttributePipeline;
-use Kettasoft\Filterable\Engines\Foundation\Clause;
 use Kettasoft\Filterable\Engines\Foundation\ClauseFactory;
 use Kettasoft\Filterable\Engines\Foundation\Parsers\Dissector;
-use Kettasoft\Filterable\Filterable;
+use Kettasoft\Filterable\Engines\Foundation\Attributes\AttributeContext;
+use Kettasoft\Filterable\Engines\Foundation\Attributes\AttributePipeline;
+use Kettasoft\Filterable\Engines\Foundation\Attributes\AttributeRegistry;
 
 class Invokable extends Engine
 {
@@ -109,45 +108,6 @@ protected function getMethodName(string $filter): string
     return $this->context->getRequest()->has($filter) ? Str::camel($filter) : 'default' . Str::studly($filter);
   }
 
-  /**
-   * Get allowed fields to filtering.
-   * @return array
-   */
-  protected function getAllowedFieldsFromConfig(): array
-  {
-    return config('filterable.engines.invokable.allowed_fields', []);
-  }
-
-  /**
-   * Get allowed operators to filtering.
-   * 
-   * @return array
-   */
-  public function getOperatorsFromConfig(): array
-  {
-    return config('filterable.engines.invokable.allowed_operators', []);
-  }
-
-  /**
-   * Check if filter has strict mode.
-   * 
-   * @return bool
-   */
-  public function isStrictFromConfig(): bool
-  {
-    return config('filterable.engines.invokable.strict', true);
-  }
-
-  /**
-   * Check if empty values are ignored from config.
-   * 
-   * @return bool
-   */
-  public function isIgnoredEmptyValuesFromConfig(): bool
-  {
-    return config('filterable.engines.invokable.ignore_empty_values', false);
-  }
-
   /**
    * Get engine default operator.
    * @return string

src/Engines/Ruleset.php

@@ -5,12 +5,10 @@
 use Illuminate\Database\Eloquent\Builder;
 use Kettasoft\Filterable\Support\Payload;
 use Kettasoft\Filterable\Traits\FieldNormalizer;
-use Kettasoft\Filterable\Engines\Foundation\Clause;
 use Kettasoft\Filterable\Engines\Foundation\Engine;
 use Kettasoft\Filterable\Engines\Foundation\ClauseApplier;
 use Kettasoft\Filterable\Engines\Foundation\ClauseFactory;
 use Kettasoft\Filterable\Engines\Foundation\Appliers\Applier;
-use Kettasoft\Filterable\Exceptions\NotAllowedFieldException;
 use Kettasoft\Filterable\Engines\Foundation\Parsers\Dissector;
 
 class Ruleset extends Engine
@@ -68,30 +66,6 @@ public function defaultOperator(): string
     return config('filterable.engines.ruleset.default_operator', 'eq');
   }
 
-  /**
-   * Get allowed fields to filtering.
-   * @return array
-   */
-  protected function getAllowedFieldsFromConfig(): array
-  {
-    return config('filterable.engines.ruleset.allowed_fields', []);
-  }
-
-  public function getOperatorsFromConfig(): array
-  {
-    return config('filterable.engines.ruleset.allowed_operators', []);
-  }
-
-  public function isStrictFromConfig(): bool
-  {
-    return config('filterable.engines.ruleset.strict', true);
-  }
-
-  protected function isIgnoredEmptyValuesFromConfig(): bool
-  {
-    return config('filterable.engines.ruleset.ignore_empty_values', false);
-  }
-
   /**
    * Get engine name.
    * @return string

src/Engines/Tree.php

@@ -6,18 +6,10 @@
 use Kettasoft\Filterable\Support\Payload;
 use Kettasoft\Filterable\Support\TreeNode;
 use Kettasoft\Filterable\Traits\FieldNormalizer;
-use Kettasoft\Filterable\Engines\Foundation\Clause;
 use Kettasoft\Filterable\Engines\Foundation\Engine;
-use Kettasoft\Filterable\Support\RelationPathParser;
-use Kettasoft\Filterable\Support\AllowedFieldChecker;
 use Kettasoft\Filterable\Engines\Foundation\ClauseApplier;
 use Kettasoft\Filterable\Engines\Foundation\ClauseFactory;
-use Kettasoft\Filterable\Support\TreeBasedRelationsResolver;
 use Kettasoft\Filterable\Engines\Foundation\Appliers\Applier;
-use Kettasoft\Filterable\Engines\Contracts\TreeFilterableContext;
-use Kettasoft\Filterable\Engines\Contracts\HasAllowedFieldChecker;
-use Kettasoft\Filterable\Support\TreeBasedSignelConditionResolver;
-use Kettasoft\Filterable\Engines\Contracts\HasInteractsWithOperators;
 
 class Tree extends Engine
 {
@@ -41,6 +33,12 @@ public function execute(Builder $builder)
     return $this->applyNode($builder, TreeNode::parse($data));
   }
 
+  /**
+   * Apply tree node to the query builder.
+   * @param \Illuminate\Database\Eloquent\Builder $builder
+   * @param \Kettasoft\Filterable\Support\TreeNode $node
+   * @return Builder
+   */
   private function applyNode(Builder $builder, TreeNode $node)
   {
     if ($node->isGroup()) {
@@ -84,24 +82,6 @@ protected function hasNormalizeFieldCondition(): bool
     return config('filterable.engines.tree.normalize_keys', false);
   }
 
-  /**
-   * Get allowed fields to filtering.
-   * @return array
-   */
-  protected function getAllowedFieldsFromConfig(): array
-  {
-    return config('filterable.engines.tree.allowed_fields', []);
-  }
-
-  /**
-   * Get all operators.
-   * @return array
-   */
-  public function operators(): array
-  {
-    return config('filterable.engines.tree.allowed_operators', []);
-  }
-
   /**
    * Default operator for use.
    * @return mixed|\Illuminate\Config\Repository
@@ -111,21 +91,6 @@ public function defaultOperator()
     return config('filterable.engines.tree.default_operator', null);
   }
 
-  public function getOperatorsFromConfig(): array
-  {
-    return config('filterable.engines.tree.allowed_operators', []);
-  }
-
-  public function isStrictFromConfig(): bool
-  {
-    return config('filterable.engines.tree.strict', true);
-  }
-
-  public function isIgnoredEmptyValuesFromConfig(): bool
-  {
-    return config('filterable.engines.tree.ignore_empty_values', false);
-  }
-
   /**
    * Get engine name.
    * @return string