Fix #93: Fix KeysetPaginator to order by field names with underscore (#94)

albertborsos · web-flow · commit 474c1278879e · 2022-04-05T23:10:19.000+04:00
diff --git a/src/Paginator/KeysetPaginator.php b/src/Paginator/KeysetPaginator.php
@@ -17,14 +17,14 @@
 use Yiisoft\Data\Reader\Sort;
 use Yiisoft\Data\Reader\SortableDataInterface;
 
+use Yiisoft\Strings\Inflector;
 use function array_reverse;
 use function count;
 use function is_callable;
 use function is_object;
 use function key;
 use function reset;
 use function sprintf;
-use function ucfirst;
 
 /**
  * Keyset paginator.
@@ -306,7 +306,7 @@ private function previousPageExist(ReadableDataInterface $dataReader, Sort $sort
      */
     private function getValueFromItem($item, string $field)
     {
-        $methodName = 'get' . ucfirst($field);
+        $methodName = 'get' . (new Inflector())->toPascalCase($field);
 
         if (is_object($item) && is_callable([$item, $methodName])) {
             return $item->$methodName();
diff --git a/tests/Paginator/KeysetPaginatorTest.php b/tests/Paginator/KeysetPaginatorTest.php
@@ -194,9 +194,20 @@ public function testReadObjectsWithPublicProperties(): void
         $this->assertTrue($paginator->isOnFirstPage());
     }
 
-    public function testReadObjectsWithGetters(): void
+    public function readObjectsWithGettersDataProvider(): array
     {
-        $sort = Sort::only(['id', 'name'])->withOrderString('id');
+        return [
+            'order by id field' => ['id', 'getId'],
+            'order by created_at field' => ['created_at', 'getCreatedAt'],
+        ];
+    }
+
+    /**
+     * @dataProvider readObjectsWithGettersDataProvider
+     */
+    public function testReadObjectsWithGetters(string $orderByField, string $getter): void
+    {
+        $sort = Sort::only(['id', 'name', 'created_at'])->withOrderString($orderByField);
         $data = [
             $this->createObjectWithGetters(1, 'Codename Boris 1'),
             $this->createObjectWithGetters(2, 'Codename Boris 2'),
@@ -207,7 +218,7 @@ public function testReadObjectsWithGetters(): void
         $paginator = (new KeysetPaginator($dataReader))->withPageSize(2);
 
         $this->assertSame([$data[0], $data[1]], $this->iterableToArray($paginator->read()));
-        $this->assertSame((string) $data[1]->getId(), $paginator->getNextPageToken());
+        $this->assertSame((string) $data[1]->$getter(), $paginator->getNextPageToken());
         $this->assertTrue($paginator->isOnFirstPage());
     }
 
@@ -573,11 +584,13 @@ private function createObjectWithGetters(int $id, string $name): object
         return new class ($id, $name) {
             private int $id;
             private string $name;
+            private int $createdAt;
 
-            public function __construct(int $id, string $name)
+            public function __construct(int $id, string $name, int $createdAt = null)
             {
                 $this->id = $id;
                 $this->name = $name;
+                $this->createdAt = $createdAt ?: time();
             }
 
             public function getId(): string
@@ -589,6 +602,11 @@ public function getName(): string
             {
                 return $this->name;
             }
+
+            public function getCreatedAt(): int
+            {
+                return $this->createdAt;
+            }
         };
     }
 
