feat: add field normalizer option to convert incoming field names to lowercase

Author: Abdalrhman Emad Saad

config/filterable.php

@@ -85,6 +85,17 @@
             |
             */
             'ignore_empty_values' => false,
+
+            /*
+            |--------------------------------------------------------------------------
+            | Normalize Field Names
+            |--------------------------------------------------------------------------
+            |
+            | Whether to automatically convert field names to lowercase
+            | for consistency when parsing filters.
+            |
+            */
+            'normalize_keys' => false,
         ],
 
         /*
@@ -153,6 +164,17 @@
             |
             */
             'ignore_empty_values' => false,
+
+            /*
+            |--------------------------------------------------------------------------
+            | Normalize Field Names
+            |--------------------------------------------------------------------------
+            |
+            | Whether to automatically convert field names to lowercase
+            | for consistency when parsing filters.
+            |
+            */
+            'normalize_keys' => false,
         ],
 
         /*
@@ -221,6 +243,17 @@
             |
             */
             'default_operator' => 'eq', // =
+
+            /*
+            |--------------------------------------------------------------------------
+            | Normalize Field Names
+            |--------------------------------------------------------------------------
+            |
+            | Whether to automatically convert field names to lowercase
+            | for consistency when parsing filters.
+            |
+            */
+            'normalize_keys' => false,
         ],
 
         /*
@@ -307,7 +340,18 @@
             | If true, the package will throw an exception if a field
             | is not allowed in the allowed fields.
             */
-            'strict' => true
+            'strict' => true,
+
+            /*
+            |--------------------------------------------------------------------------
+            | Normalize Field Names
+            |--------------------------------------------------------------------------
+            |
+            | Whether to automatically convert field names to lowercase
+            | for consistency when parsing filters.
+            |
+            */
+            'normalize_keys' => false,
         ]
     ],
 

src/Engines/Expression.php

@@ -2,6 +2,7 @@
 
 namespace Kettasoft\Filterable\Engines;
 
+use Kettasoft\Filterable\Traits\FieldNormalizer;
 use Kettasoft\Filterable\Engines\Contracts\Engine;
 use Illuminate\Contracts\Database\Eloquent\Builder;
 use Kettasoft\Filterable\Contracts\FilterableContext;
@@ -12,6 +13,8 @@
 
 class Expression implements Engine
 {
+  use FieldNormalizer;
+
   /**
    * Create Engine instance.
    * @param \Kettasoft\Filterable\Contracts\FilterableContext $context
@@ -28,6 +31,9 @@ public function apply(Builder $builder)
     $filters = $this->context->getData();
 
     foreach ($filters as $field => $condition) {
+
+      $field = $this->normalizeField($field);
+
       if (! is_array($condition)) {
         $condition = ConditionNormalizer::normalize($condition, 'eq');
       }
@@ -205,4 +211,13 @@ private function defaultOperator(): string
   {
     return config('filterable.engines.expression.default_operator', 'eq');
   }
+
+  /**
+   * Check if normalize field option is enable in engine.
+   * @return bool
+   */
+  protected function hasNormalizeFieldCondition(): bool
+  {
+    return config('filterable.engines.expression.normalize_keys', false);
+  }
 }

src/Engines/Ruleset.php

@@ -2,6 +2,7 @@
 
 namespace Kettasoft\Filterable\Engines;
 
+use Kettasoft\Filterable\Traits\FieldNormalizer;
 use Kettasoft\Filterable\Engines\Contracts\Engine;
 use Illuminate\Contracts\Database\Eloquent\Builder;
 use Kettasoft\Filterable\Contracts\FilterableContext;
@@ -10,6 +11,8 @@
 
 class Ruleset implements Engine
 {
+  use FieldNormalizer;
+
   /**
    * Create Engine instance.
    * @param \Kettasoft\Filterable\Contracts\FilterableContext $context
@@ -27,6 +30,8 @@ public function apply(Builder $builder): Builder
 
     foreach ($data as $field => $rawValue) {
 
+      $field = $this->normalizeField($field);
+
       if (! in_array($field, $this->getAllowedFields())) {
         if ($this->isStrict()) {
           throw new NotAllowedFieldException($field);
@@ -47,6 +52,15 @@ public function apply(Builder $builder): Builder
     return $builder;
   }
 
+  /**
+   * Check if normalize field option is enable in engine.
+   * @return bool
+   */
+  protected function hasNormalizeFieldCondition(): bool
+  {
+    return config('filterable.engines.ruleset.normalize_keys', false);
+  }
+
   /**
    * Get allowed fields to filtering.
    * @return array

src/Engines/Tree.php

@@ -4,9 +4,10 @@
 
 use Kettasoft\Filterable\Support\TreeNode;
 use Kettasoft\Filterable\Support\OperatorMapper;
+use Kettasoft\Filterable\Traits\FieldNormalizer;
 use Kettasoft\Filterable\Engines\Contracts\Engine;
-use Kettasoft\Filterable\Support\RelationPathParser;
 use Illuminate\Contracts\Database\Eloquent\Builder;
+use Kettasoft\Filterable\Support\RelationPathParser;
 use Kettasoft\Filterable\Contracts\FilterableContext;
 use Kettasoft\Filterable\Support\AllowedFieldChecker;
 use Kettasoft\Filterable\Support\TreeBasedRelationsResolver;
@@ -16,6 +17,8 @@
 
 class Tree implements Engine, HasInteractsWithOperators, HasAllowedFieldChecker
 {
+  use FieldNormalizer;
+
   protected operatorMapper $operatorMapper;
   /**
    * Create Engine instance.
@@ -57,7 +60,7 @@ private function applyNode(Builder $builder, TreeNode $node)
 
       [$relation, $field] = RelationPathParser::resolve($node->field);
 
-      $field = $this->context->getFieldsMap()[$field] ?? $field;
+      $field = $this->normalizeField($this->context->getFieldsMap()[$field] ?? $field);
       $operator = $this->operatorMapper->map($node->operator);
       $value = $this->context->getSanitizerInstance()->handle($field, $node->value);
 
@@ -77,6 +80,15 @@ private function applyNode(Builder $builder, TreeNode $node)
     return $builder;
   }
 
+  /**
+   * Check if normalize field option is enable in engine.
+   * @return bool
+   */
+  protected function hasNormalizeFieldCondition(): bool
+  {
+    return config('filterable.engines.tree.normalize_keys', false);
+  }
+
   /**
    * Get all allowed fields.
    * @return array

src/Traits/FieldNormalizer.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Kettasoft\Filterable\Traits;
+
+trait FieldNormalizer
+{
+  /**
+   * Check if normalize field option is enable in engine.
+   * @return bool
+   */
+  abstract protected function hasNormalizeFieldCondition(): bool;
+
+  /**
+   * Normalize incoming field name to lowercase.
+   * @param mixed $field
+   */
+  public function normalizeField($field)
+  {
+    return $this->hasNormalizeFieldCondition() ? strtolower($field) : $field;
+  }
+}