Add new case_insensitive flag to order filter

stakx-io · Jun 15, 2019 · 29246bc · 29246bc
1 parent e65cc1b
commit 29246bc
Show file tree

Hide file tree

Showing 2 changed files with 144 additions and 2 deletions.
diff --git a/src/allejo/stakx/Templating/Twig/Extension/OrderFilter.php b/src/allejo/stakx/Templating/Twig/Extension/OrderFilter.php
@@ -12,17 +12,23 @@
 
 class OrderFilter extends AbstractTwigExtension implements TwigFilterInterface
 {
-    public function __invoke($array, $key, $order = 'ASC')
+    public function __invoke($array, $key, $order = 'ASC', $case_insensitive = false)
     {
         if (!is_array($array))
         {
             return $array;
         }
 
-        usort($array, function ($a, $b) use ($key, $order) {
+        usort($array, function ($a, $b) use ($key, $order, $case_insensitive) {
             $aValue = __::get($a, $key);
             $bValue = __::get($b, $key);
 
+            if ($case_insensitive)
+            {
+                $aValue = strtolower($aValue);
+                $bValue = strtolower($bValue);
+            }
+
             if ($aValue == $bValue)
             {
                 return 0;

diff --git a/tests/allejo/stakx/Test/Templating/Twig/Extension/OrderFilterTest.php b/tests/allejo/stakx/Test/Templating/Twig/Extension/OrderFilterTest.php
@@ -29,6 +29,10 @@ public static function dataProvider_singleLevelArray()
                         'name' => 'Side order of fries',
                         'sort' => 3,
                     ],
+                    [
+                        'name' => 'super size me',
+                        'sort' => 10,
+                    ],
                 ],
             ],
         ];
@@ -52,6 +56,10 @@ public function testOrderFilterAscOnArray($dataset)
                 'name' => 'Side order of fries',
                 'sort' => 3,
             ],
+            [
+                'name' => 'super size me',
+                'sort' => 10,
+            ],
             [
                 'name' => 'Order of Bacon',
                 'sort' => 30,
@@ -70,6 +78,99 @@ public function testOrderFilterDescOnArray($dataset)
     {
         $orderFilter = new OrderFilter();
         $result = $orderFilter($dataset, 'sort', 'DESC');
+        $expected = [
+            [
+                'name' => 'Order of Bacon',
+                'sort' => 30,
+            ],
+            [
+                'name' => 'super size me',
+                'sort' => 10,
+            ],
+            [
+                'name' => 'Side order of fries',
+                'sort' => 3,
+            ],
+            [
+                'name' => 'Whee',
+                'sort' => 0,
+            ],
+        ];
+
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * @dataProvider dataProvider_singleLevelArray
+     *
+     * @param array $dataset
+     */
+    public function testOrderFilterAscOnArrayCaseSensitive($dataset)
+    {
+        $orderFilter = new OrderFilter();
+        $result = $orderFilter($dataset, 'name', 'ASC');
+        $expected = [
+            [
+                'name' => 'Order of Bacon',
+                'sort' => 30,
+            ],
+            [
+                'name' => 'Side order of fries',
+                'sort' => 3,
+            ],
+            [
+                'name' => 'Whee',
+                'sort' => 0,
+            ],
+            [
+                'name' => 'super size me',
+                'sort' => 10,
+            ],
+        ];
+
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * @dataProvider dataProvider_singleLevelArray
+     *
+     * @param array $dataset
+     */
+    public function testOrderFilterDescOnArrayCaseSensitive($dataset)
+    {
+        $orderFilter = new OrderFilter();
+        $result = $orderFilter($dataset, 'name', 'DESC');
+        $expected = [
+            [
+                'name' => 'super size me',
+                'sort' => 10,
+            ],
+            [
+                'name' => 'Whee',
+                'sort' => 0,
+            ],
+            [
+                'name' => 'Side order of fries',
+                'sort' => 3,
+            ],
+            [
+                'name' => 'Order of Bacon',
+                'sort' => 30,
+            ],
+        ];
+
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * @dataProvider dataProvider_singleLevelArray
+     *
+     * @param array $dataset
+     */
+    public function testOrderFilterAscOnArrayCaseInsensitive($dataset)
+    {
+        $orderFilter = new OrderFilter();
+        $result = $orderFilter($dataset, 'name', 'ASC', true);
         $expected = [
             [
                 'name' => 'Order of Bacon',
@@ -79,10 +180,45 @@ public function testOrderFilterDescOnArray($dataset)
                 'name' => 'Side order of fries',
                 'sort' => 3,
             ],
+            [
+                'name' => 'super size me',
+                'sort' => 10,
+            ],
+            [
+                'name' => 'Whee',
+                'sort' => 0,
+            ],
+        ];
+
+        $this->assertEquals($expected, $result);
+    }
+
+    /**
+     * @dataProvider dataProvider_singleLevelArray
+     *
+     * @param array $dataset
+     */
+    public function testOrderFilterDescOnArrayCaseInsensitive($dataset)
+    {
+        $orderFilter = new OrderFilter();
+        $result = $orderFilter($dataset, 'name', 'DESC', true);
+        $expected = [
             [
                 'name' => 'Whee',
                 'sort' => 0,
             ],
+            [
+                'name' => 'super size me',
+                'sort' => 10,
+            ],
+            [
+                'name' => 'Side order of fries',
+                'sort' => 3,
+            ],
+            [
+                'name' => 'Order of Bacon',
+                'sort' => 30,
+            ],
         ];
 
         $this->assertEquals($expected, $result);