Re-worked pagination to not mutate the api classes

Author: GrahamCampbell

composer.json

@@ -26,7 +26,8 @@
         "psr/cache": "^1.0",
         "psr/http-client-implementation": "^1.0",
         "psr/http-factory-implementation": "^1.0",
-        "psr/http-message": "^1.0"
+        "psr/http-message": "^1.0",
+        "symfony/polyfill-php80": "^1.17"
     },
     "require-dev": {
         "symfony/cache": "^5.1.8",

lib/Github/Api/AbstractApi.php

@@ -4,81 +4,100 @@
 
 use Github\Client;
 use Github\HttpClient\Message\ResponseMediator;
+use ValueError;
 
 /**
- * Abstract class for Api classes.
- *
  * @author Joseph Bielawski <[email protected]>
+ * @author Graham Campbell <[email protected]>
  */
 abstract class AbstractApi implements ApiInterface
 {
     /**
-     * The client.
+     * The client instance.
      *
      * @var Client
      */
-    protected $client;
+    private $client;
 
     /**
-     * The requested page (GitHub pagination).
+     * The per page parameter.
      *
-     * @var null|int
+     * @var int|null
      */
-    private $page;
+    private $perPage;
 
     /**
-     * Number of items per page (GitHub pagination).
+     * Create a new API instance.
      *
-     * @var null|int
-     */
-    protected $perPage;
-
-    /**
-     * @param Client $client
+     * @param Client   $client
+     * @param int|null $perPage
+     *
+     * @return void
      */
-    public function __construct(Client $client)
+    public function __construct(Client $client, int $perPage = null)
     {
-        $this->client = $client;
-    }
+        if (null !== $perPage && ($perPage < 1 || $perPage > 100)) {
+            throw new ValueError(sprintf('%s::__construct(): Argument #2 ($perPage) must be between 1 and 100, or null', self::class));
+        }
 
-    public function configure()
-    {
+        $this->client = $client;
+        $this->perPage = $perPage;
     }
 
     /**
-     * @return null|int
+     * Get the client instance.
+     *
+     * @return Client
      */
-    public function getPage()
+    protected function getClient()
     {
-        return $this->page;
+        return $this->client;
     }
 
     /**
-     * @param null|int $page
+     * Get the API version.
+     *
+     * @return string
      */
-    public function setPage($page)
+    protected function getApiVersion()
     {
-        $this->page = (null === $page ? $page : (int) $page);
-
-        return $this;
+        return $this->client->getApiVersion();
     }
 
     /**
-     * @return null|int
+     * Get the number of values to fetch per page.
+     *
+     * @return int|null
      */
-    public function getPerPage()
+    protected function getPerPage()
     {
         return $this->perPage;
     }
 
     /**
-     * @param null|int $perPage
+     * Create a new instance with the given page parameter.
+     *
+     * This must be an integer between 1 and 100.
+     *
+     * @param int|null $perPage
+     *
+     * @return static
      */
-    public function setPerPage($perPage)
+    public function perPage(?int $perPage)
     {
-        $this->perPage = (null === $perPage ? $perPage : (int) $perPage);
+        if (null !== $perPage && ($perPage < 1 || $perPage > 100)) {
+            throw new ValueError(sprintf('%s::perPage(): Argument #1 ($perPage) must be between 1 and 100, or null', self::class));
+        }
+
+        $copy = clone $this;
+
+        $copy->perPage = $perPage;
 
-        return $this;
+        return $copy;
+    }
+
+    public function configure()
+    {
     }
 
     /**
@@ -92,12 +111,10 @@ public function setPerPage($perPage)
      */
     protected function get($path, array $parameters = [], array $requestHeaders = [])
     {
-        if (null !== $this->page && !isset($parameters['page'])) {
-            $parameters['page'] = $this->page;
-        }
         if (null !== $this->perPage && !isset($parameters['per_page'])) {
             $parameters['per_page'] = $this->perPage;
         }
+
         if (array_key_exists('ref', $parameters) && null === $parameters['ref']) {
             unset($parameters['ref']);
         }

lib/Github/Api/ApiInterface.php

@@ -3,13 +3,19 @@
 namespace Github\Api;
 
 /**
- * Api interface.
- *
  * @author Joseph Bielawski <[email protected]>
+ * @author Graham Campbell <[email protected]>
  */
 interface ApiInterface
 {
-    public function getPerPage();
-
-    public function setPerPage($perPage);
+    /**
+     * Create a new instance with the given per page parameter.
+     *
+     * This must be an integer between 1 and 100.
+     *
+     * @param int|null $perPage
+     *
+     * @return static
+     */
+    public function perPage(?int $perPage);
 }

lib/Github/Api/CurrentUser.php

@@ -35,15 +35,15 @@ public function update(array $params)
      */
     public function emails()
     {
-        return new Emails($this->client);
+        return new Emails($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return Followers
      */
     public function follow()
     {
-        return new Followers($this->client);
+        return new Followers($this->getClient(), $this->getPerPage());
     }
 
     public function followers($page = 1)
@@ -71,23 +71,23 @@ public function issues(array $params = [], $includeOrgIssues = true)
      */
     public function keys()
     {
-        return new PublicKeys($this->client);
+        return new PublicKeys($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return Notifications
      */
     public function notifications()
     {
-        return new Notifications($this->client);
+        return new Notifications($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return Memberships
      */
     public function memberships()
     {
-        return new Memberships($this->client);
+        return new Memberships($this->getClient(), $this->getPerPage());
     }
 
     /**
@@ -147,15 +147,15 @@ public function repositories($type = 'owner', $sort = 'full_name', $direction =
      */
     public function watchers()
     {
-        return new Watchers($this->client);
+        return new Watchers($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return Starring
      */
     public function starring()
     {
-        return new Starring($this->client);
+        return new Starring($this->getClient(), $this->getPerPage());
     }
 
     /**

lib/Github/Api/CurrentUser/Starring.php

@@ -26,7 +26,7 @@ class Starring extends AbstractApi
     public function configure($bodyType = null)
     {
         if ('star' === $bodyType) {
-            $this->acceptHeaderValue = sprintf('application/vnd.github.%s.star+json', $this->client->getApiVersion());
+            $this->acceptHeaderValue = sprintf('application/vnd.github.%s.star+json', $this->getApiVersion());
         }
 
         return $this;

lib/Github/Api/Enterprise.php

@@ -22,30 +22,30 @@ class Enterprise extends AbstractApi
      */
     public function stats()
     {
-        return new Stats($this->client);
+        return new Stats($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return License
      */
     public function license()
     {
-        return new License($this->client);
+        return new License($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return ManagementConsole
      */
     public function console()
     {
-        return new ManagementConsole($this->client);
+        return new ManagementConsole($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return UserAdmin
      */
     public function userAdmin()
     {
-        return new UserAdmin($this->client);
+        return new UserAdmin($this->getClient(), $this->getPerPage());
     }
 }

lib/Github/Api/Gist/Comments.php

@@ -29,7 +29,7 @@ public function configure($bodyType = null)
             $bodyType = 'raw';
         }
 
-        $this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s+json', $this->client->getApiVersion(), $bodyType);
+        $this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s+json', $this->getApiVersion(), $bodyType);
 
         return $this;
     }

lib/Github/Api/Gists.php

@@ -32,7 +32,7 @@ public function configure($bodyType = null)
             $bodyType = 'raw';
         }
 
-        $this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s', $this->client->getApiVersion(), $bodyType);
+        $this->acceptHeaderValue = sprintf('application/vnd.github.%s.%s', $this->getApiVersion(), $bodyType);
 
         return $this;
     }
@@ -177,6 +177,6 @@ public function unstar($id)
      */
     public function comments()
     {
-        return new Comments($this->client);
+        return new Comments($this->getClient(), $this->getPerPage());
     }
 }

lib/Github/Api/GitData.php

@@ -22,38 +22,38 @@ class GitData extends AbstractApi
      */
     public function blobs()
     {
-        return new Blobs($this->client);
+        return new Blobs($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return Commits
      */
     public function commits()
     {
-        return new Commits($this->client);
+        return new Commits($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return References
      */
     public function references()
     {
-        return new References($this->client);
+        return new References($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return Tags
      */
     public function tags()
     {
-        return new Tags($this->client);
+        return new Tags($this->getClient(), $this->getPerPage());
     }
 
     /**
      * @return Trees
      */
     public function trees()
     {
-        return new Trees($this->client);
+        return new Trees($this->getClient(), $this->getPerPage());
     }
 }

lib/Github/Api/GitData/Blobs.php

@@ -26,7 +26,7 @@ class Blobs extends AbstractApi
     public function configure($bodyType = null)
     {
         if ('raw' === $bodyType) {
-            $this->acceptHeaderValue = sprintf('application/vnd.github.%s.raw', $this->client->getApiVersion());
+            $this->acceptHeaderValue = sprintf('application/vnd.github.%s.raw', $this->getApiVersion());
         }
 
         return $this;