fix: adding natural sort filter (#586)

BinarCode · Sep 7, 2023 · 528b2dc · 528b2dc
1 parent bbb64ae
commit 528b2dc
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 0 deletions.
diff --git a/src/Filters/Sorts/NaturalSortFilter.php b/src/Filters/Sorts/NaturalSortFilter.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Filters\Sorts;
+
+class NaturalSortFilter
+{
+    public function __invoke($request, $query, $value, string $column): void
+    {
+        $query->orderByRaw("CAST({$column} AS UNSIGNED) {$value}, {$column} {$value}");
+    }
+}
diff --git a/tests/Feature/Filters/SortableFilterTest.php b/tests/Feature/Filters/SortableFilterTest.php
@@ -3,6 +3,7 @@
 namespace Binaryk\LaravelRestify\Tests\Feature\Filters;
 
 use Binaryk\LaravelRestify\Filters\SortableFilter;
+use Binaryk\LaravelRestify\Filters\Sorts\NaturalSortFilter;
 use Binaryk\LaravelRestify\Tests\Fixtures\User\User;
 use Binaryk\LaravelRestify\Tests\Fixtures\User\UserRepository;
 use Binaryk\LaravelRestify\Tests\IntegrationTestCase;
@@ -33,4 +34,51 @@ public function test_can_order_using_filter_sortable_definition(): void
         $this->assertSame('Alisa', $this->getJson(UserRepository::route(query: ['sort' => '-name']))
             ->json('data.1.attributes.name'));
     }
+
+    public function test_can_order_using_natural_sortable_filter(): void
+    {
+        User::factory()->create([
+            'name' => '1',
+        ]);
+
+        User::factory()->create([
+            'name' => '10',
+        ]);
+
+        User::factory()->create([
+            'name' => '2',
+        ]);
+
+        User::factory()->create([
+            'name' => '20',
+        ]);
+
+        UserRepository::$sort = [
+            'name' => NaturalSortFilter::class,
+        ];
+
+        $this->assertSame('1', $this->getJson(UserRepository::route(query: ['sort' => 'name']))
+            ->json('data.0.attributes.name'));
+
+        $this->assertSame('2', $this->getJson(UserRepository::route(query: ['sort' => 'name']))
+            ->json('data.1.attributes.name'));
+
+        $this->assertSame('10', $this->getJson(UserRepository::route(query: ['sort' => 'name']))
+            ->json('data.2.attributes.name'));
+
+        $this->assertSame('20', $this->getJson(UserRepository::route(query: ['sort' => 'name']))
+            ->json('data.3.attributes.name'));
+
+        $this->assertSame('20', $this->getJson(UserRepository::route(query: ['sort' => '-name']))
+            ->json('data.0.attributes.name'));
+
+        $this->assertSame('10', $this->getJson(UserRepository::route(query: ['sort' => '-name']))
+            ->json('data.1.attributes.name'));
+
+        $this->assertSame('2', $this->getJson(UserRepository::route(query: ['sort' => '-name']))
+            ->json('data.2.attributes.name'));
+
+        $this->assertSame('1', $this->getJson(UserRepository::route(query: ['sort' => '-name']))
+            ->json('data.3.attributes.name'));
+    }
 }