Fix deprecated errors in tests (#575)

KorvinSzanto · web-flow · commit 573ca2e0e348 · 2025-02-14T13:33:14.000-08:00
* Fix deprecated errors in tests

* Safely count all possible types

* Support iterable type fully in newer pagerfanta versions

* Use psalm 4.30
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -9,7 +9,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-20.04]
-        php: [7.4, 8.0, 8.1]
+        php: [7.4, 8.0, 8.1, 8.2, 8.3, 8.4]
 
     name: League - PHP ${{ matrix.php }} on ${{ matrix.os }}
 
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -37,7 +37,7 @@ jobs:
           php-version: 8.1
           extensions: apcu, redis
           coverage: none
-          tools: vimeo/psalm:4.22.0
+          tools: vimeo/psalm:4.30.0
 
       - name: Download dependencies
         uses: ramsey/composer-install@v1
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 composer.lock
 build
 vendor
-.phpunit.result.cache
+.phpunit.result.cache
+.idea
diff --git a/composer.json b/composer.json
@@ -26,18 +26,18 @@
     "require-dev": {
         "doctrine/orm": "^2.5",
         "illuminate/contracts": "~5.0",
+        "laminas/laminas-paginator": "~2.12",
         "mockery/mockery": "^1.3",
-        "pagerfanta/pagerfanta": "~1.0.0",
+        "pagerfanta/pagerfanta": "~1.0.0|~4.0.0",
         "phpstan/phpstan": "^1.4",
         "phpunit/phpunit": "^9.5",
         "squizlabs/php_codesniffer": "~3.4",
-        "vimeo/psalm": "^4.22",
-        "zendframework/zend-paginator": "~2.3"
+        "vimeo/psalm": "^4.30"
     },
     "suggest": {
         "illuminate/pagination": "The Illuminate Pagination component.",
         "pagerfanta/pagerfanta": "Pagerfanta Paginator",
-        "zendframework/zend-paginator": "Zend Framework Paginator"
+        "laminas/laminas-paginator": "Laminas Framework Paginator"
     },
     "autoload": {
         "psr-4": {
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -6,3 +6,5 @@ parameters:
   reportUnmatchedIgnoredErrors: false
   paths:
     - src
+  bootstrapFiles:
+    - test/phpstan.php
diff --git a/psalm.xml b/psalm.xml
@@ -8,6 +8,7 @@
     errorBaseline="psalm.baseline.xml"
 >
     <projectFiles>
+        <file name="test/phpstan.php" />
         <directory name="src" />
         <ignoreFiles>
             <directory name="vendor" />
diff --git a/src/Manager.php b/src/Manager.php
@@ -61,7 +61,7 @@ class Manager
      */
     private ScopeFactoryInterface $scopeFactory;
 
-    public function __construct(ScopeFactoryInterface $scopeFactory = null)
+    public function __construct(?ScopeFactoryInterface $scopeFactory = null)
     {
         $this->scopeFactory = $scopeFactory ?: new ScopeFactory();
     }
@@ -72,7 +72,7 @@ public function __construct(ScopeFactoryInterface $scopeFactory = null)
     public function createData(
         ResourceInterface $resource,
         ?string $scopeIdentifier = null,
-        Scope $parentScopeInstance = null
+        ?Scope $parentScopeInstance = null
     ): Scope {
         if ($parentScopeInstance !== null) {
             return $this->scopeFactory->createChildScopeFor($this, $parentScopeInstance, $resource, $scopeIdentifier);
diff --git a/src/Pagination/DoctrinePaginatorAdapter.php b/src/Pagination/DoctrinePaginatorAdapter.php
@@ -19,6 +19,8 @@
  */
 class DoctrinePaginatorAdapter implements PaginatorInterface
 {
+    use PaginatorCountTrait;
+
     /**
      * The paginator instance.
      * @var  Paginator
@@ -73,7 +75,7 @@ public function getTotal(): int
      */
     public function getCount(): int
     {
-        return $this->paginator->getIterator()->count();
+        return $this->getTraversableCount($this->paginator->getIterator());
     }
 
     /**
@@ -93,7 +95,7 @@ public function getUrl(int $page): string
     }
 
     /**
-     * Get the the route generator.
+     * Get the route generator.
      */
     private function getRouteGenerator(): callable
     {
diff --git a/src/Pagination/LaminasPaginatorAdapter.php b/src/Pagination/LaminasPaginatorAdapter.php
@@ -0,0 +1,95 @@
+<?php
+
+/*
+ * This file is part of the League\Fractal package.
+ *
+ * (c) Phil Sturgeon <me@philsturgeon.uk>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace League\Fractal\Pagination;
+
+use Laminas\Paginator\Paginator;
+
+/**
+ * A paginator adapter for laminas/laminas-paginator.
+ *
+ * @author Abdul Malik Ikhsan <samsonasik@gmail.com>
+ */
+class LaminasPaginatorAdapter implements PaginatorInterface
+{
+    protected Paginator $paginator;
+
+    /**
+     * The route generator.
+     *
+     * @var callable
+     */
+    protected $routeGenerator;
+
+    public function __construct(Paginator $paginator, callable $routeGenerator)
+    {
+        $this->paginator = $paginator;
+        $this->routeGenerator = $routeGenerator;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getCurrentPage(): int
+    {
+        return $this->paginator->getCurrentPageNumber();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getLastPage(): int
+    {
+        return $this->paginator->count();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getTotal(): int
+    {
+        return $this->paginator->getTotalItemCount();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getCount(): int
+    {
+        return $this->paginator->getCurrentItemCount();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getPerPage(): int
+    {
+        return $this->paginator->getItemCountPerPage();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getUrl(int $page): string
+    {
+        return call_user_func($this->routeGenerator, $page);
+    }
+
+    public function getPaginator(): Paginator
+    {
+        return $this->paginator;
+    }
+
+    public function getRouteGenerator(): callable
+    {
+        return $this->routeGenerator;
+    }
+}
diff --git a/src/Pagination/PagerfantaPaginatorAdapter.php b/src/Pagination/PagerfantaPaginatorAdapter.php
@@ -20,6 +20,8 @@
  */
 class PagerfantaPaginatorAdapter implements PaginatorInterface
 {
+    use PaginatorCountTrait;
+
     protected Pagerfanta $paginator;
 
     /**
@@ -64,7 +66,7 @@ public function getTotal(): int
      */
     public function getCount(): int
     {
-        return count($this->paginator->getCurrentPageResults());
+        return $this->getIterableCount($this->paginator->getCurrentPageResults());
     }
 
     /**
diff --git a/src/Pagination/PaginatorCountTrait.php b/src/Pagination/PaginatorCountTrait.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace League\Fractal\Pagination;
+
+trait PaginatorCountTrait
+{
+    /**
+     * Safely get the count from an iterable
+     */
+    private function getIterableCount(iterable $iterable): int
+    {
+        if ($iterable instanceof \Traversable) {
+            return $this->getTraversableCount($iterable);
+        }
+
+        return count($iterable);
+    }
+
+    /**
+     * Safely get the count from a traversable
+     */
+    private function getTraversableCount(\Traversable $traversable): int
+    {
+        if ($traversable instanceof \Countable) {
+            return count($traversable);
+        }
+
+        // Call the "count" method if it exists
+        if (method_exists($traversable, 'count')) {
+            return $traversable->count();
+        }
+
+        // If not, fall back to iterator_count and rewind if possible
+        $count = iterator_count($traversable);
+        if ($traversable instanceof \Iterator || $traversable instanceof \IteratorAggregate) {
+            $traversable->rewind();
+        }
+
+        return $count;
+    }
+
+}
diff --git a/test/Pagination/DoctrinePaginatorAdapterTest.php b/test/Pagination/DoctrinePaginatorAdapterTest.php
@@ -2,7 +2,9 @@
 namespace League\Fractal\Test\Pagination;
 
 use Doctrine\ORM\Query;
+use Doctrine\ORM\Tools\Pagination\Paginator;
 use League\Fractal\Pagination\DoctrinePaginatorAdapter;
+use League\Fractal\Test\Stub\SimpleTraversable;
 use Mockery;
 use PHPUnit\Framework\TestCase;
 
@@ -28,11 +30,9 @@ public function testPaginationAdapter()
         $paginator->shouldReceive('getQuery')->andReturn($query);
 
         //Mock the iterator of the paginator
-        $iterator = Mockery::mock('IteratorAggregate');
-        $iterator->shouldReceive('count')->andReturn($count);
+        $iterator = new \ArrayIterator(range(1, $count));
         $paginator->shouldReceive('getIterator')->andReturn($iterator);
 
-
         $adapter = new DoctrinePaginatorAdapter($paginator, function ($page) {
             return 'http://example.com/foo?page='.$page;
         });
@@ -57,6 +57,20 @@ public function testPaginationAdapter()
         );
     }
 
+    public function testCountingTraversables()
+    {
+        $traversable = new SimpleTraversable(range(1, 100));
+        $adapter = Mockery::mock('Doctrine\ORM\Tools\Pagination\Paginator');
+        $adapter->shouldReceive('getIterator')->andReturn($traversable);
+        $adapter = new DoctrinePaginatorAdapter($adapter, function ($page) {
+            return (string) $page;
+        });
+
+        $this->assertEquals($traversable->key(), 0);
+        $this->assertEquals($adapter->getCount(), 100);
+        $this->assertEquals($traversable->key(), 0);
+    }
+
     public function tearDown(): void
     {
         Mockery::close();
diff --git a/test/Pagination/LaminasFrameworkPaginatorAdapterTest.php b/test/Pagination/LaminasFrameworkPaginatorAdapterTest.php
@@ -0,0 +1,53 @@
+<?php
+namespace League\Fractal\Test\Pagination;
+
+use League\Fractal\Pagination\LaminasPaginatorAdapter;
+use Mockery;
+use PHPUnit\Framework\TestCase;
+
+class LaminasFrameworkPaginatorAdapterTest extends TestCase
+{
+    public function testPaginationAdapter()
+    {
+        $items = [
+            'Item 1', 'Item 2', 'Item 3', 'Item 4', 'Item 5', 'Item 6', 'Item 7', 'Item 8', 'Item 9', 'Item 10',
+            'Item 11', 'Item 12', 'Item 13', 'Item 14', 'Item 15', 'Item 16', 'Item 17', 'Item 18', 'Item 19', 'Item 20',
+            'Item 21', 'Item 22', 'Item 23', 'Item 24', 'Item 25', 'Item 26', 'Item 27', 'Item 28', 'Item 29', 'Item 30',
+            'Item 31', 'Item 32', 'Item 33', 'Item 34', 'Item 35', 'Item 36', 'Item 37', 'Item 38', 'Item 39', 'Item 40',
+            'Item 41', 'Item 42', 'Item 43', 'Item 44', 'Item 45', 'Item 46', 'Item 47', 'Item 48', 'Item 49', 'Item 50',
+        ];
+
+        $adapter = Mockery::mock('Laminas\Paginator\Adapter\ArrayAdapter', [$items])->makePartial();
+
+        $total = 50;
+        $count = 10;
+        $perPage = 10;
+        $currentPage = 2;
+        $lastPage = 5;
+
+        $paginator = Mockery::mock('Laminas\Paginator\Paginator', [$adapter])->makePartial();
+
+        $paginator->shouldReceive('getCurrentPageNumber')->andReturn($currentPage);
+        $paginator->shouldReceive('count')->andReturn($lastPage);
+        $paginator->shouldReceive('getItemCountPerPage')->andReturn($perPage);
+
+        $adapter = new LaminasPaginatorAdapter($paginator, function ($page) {
+            return 'http://example.com/foo?page='.$page;
+        });
+
+        $this->assertInstanceOf('League\Fractal\Pagination\PaginatorInterface', $adapter);
+
+        $this->assertSame($currentPage, $adapter->getCurrentPage());
+        $this->assertSame($lastPage, $adapter->getLastPage());
+        $this->assertSame($count, $adapter->getCount());
+        $this->assertSame($total, $adapter->getTotal());
+        $this->assertSame($perPage, $adapter->getPerPage());
+        $this->assertSame('http://example.com/foo?page=1', $adapter->getUrl(1));
+        $this->assertSame('http://example.com/foo?page=3', $adapter->getUrl(3));
+    }
+
+    public function tearDown(): void
+    {
+        Mockery::close();
+    }
+}
diff --git a/test/Pagination/PaginatorCountTraitTest.php b/test/Pagination/PaginatorCountTraitTest.php
diff --git a/test/Pagination/ZendFrameworkPaginatorAdapterTest.php b/test/Pagination/ZendFrameworkPaginatorAdapterTest.php
diff --git a/test/Serializer/DataArraySerializerTest.php b/test/Serializer/DataArraySerializerTest.php
diff --git a/test/Stub/SimpleTraversable.php b/test/Stub/SimpleTraversable.php
diff --git a/test/phpstan.php b/test/phpstan.php

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`errorBaseline="psalm.baseline.xml"`
`9`	`9`	`>`
`10`	`10`	`<projectFiles>`
	`11`	`+ <file name="test/phpstan.php" />`
`11`	`12`	`<directory name="src" />`
`12`	`13`	`<ignoreFiles>`
`13`	`14`	`<directory name="vendor" />`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`*/`
`20`	`20`	`class DoctrinePaginatorAdapter implements PaginatorInterface`
`21`	`21`	`{`
	`22`	`+ use PaginatorCountTrait;`
	`23`	`+`
`22`	`24`	`/**`
`23`	`25`	`* The paginator instance.`
`24`	`26`	`* @var Paginator`
`@@ -73,7 +75,7 @@ public function getTotal(): int`
`73`	`75`	`*/`
`74`	`76`	`public function getCount(): int`
`75`	`77`	`{`
`76`		`- return $this->paginator->getIterator()->count();`
	`78`	`+ return $this->getTraversableCount($this->paginator->getIterator());`
`77`	`79`	`}`
`78`	`80`
`79`	`81`	`/**`
`@@ -93,7 +95,7 @@ public function getUrl(int $page): string`
`93`	`95`	`}`
`94`	`96`
`95`	`97`	`/**`
`96`		`- * Get the the route generator.`
	`98`	`+ * Get the route generator.`
`97`	`99`	`*/`
`98`	`100`	`private function getRouteGenerator(): callable`
`99`	`101`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`*/`
`21`	`21`	`class PagerfantaPaginatorAdapter implements PaginatorInterface`
`22`	`22`	`{`
	`23`	`+ use PaginatorCountTrait;`
	`24`	`+`
`23`	`25`	`protected Pagerfanta $paginator;`
`24`	`26`
`25`	`27`	`/**`
`@@ -64,7 +66,7 @@ public function getTotal(): int`
`64`	`66`	`*/`
`65`	`67`	`public function getCount(): int`
`66`	`68`	`{`
`67`		`- return count($this->paginator->getCurrentPageResults());`
	`69`	`+ return $this->getIterableCount($this->paginator->getCurrentPageResults());`
`68`	`70`	`}`
`69`	`71`
`70`	`72`	`/**`