PHPStan: fix first batch of level 6 issues

lib/Bitbucket/API/Api.php

@@ -21,6 +21,7 @@
 
 /**
  * @author Alexandru Guzinschi <[email protected]>
+ * @phpstan-import-type OptionalClientOption from Client
  */
 class Api
 {
@@ -41,7 +42,7 @@ class Api
     protected $httpClient;
 
     /**
-     * @param array           $options
+     * @param OptionalClientOption $options
      * @param ClientInterface $client
      */
     public function __construct(array $options = array(), ClientInterface $client = null)
@@ -84,6 +85,9 @@ public function setCredentials(Authentication $authentication)
         $this->addPlugin(new AuthenticationPlugin($authentication));
     }
 
+    /**
+     * @return void
+     */
     public function addPlugin(Plugin $plugin)
     {
         $this->httpClient->getClientBuilder()->removePlugin(get_class($plugin));

lib/Bitbucket/API/Http/Client.php

@@ -21,12 +21,12 @@
 
 /**
  * @author  Alexandru G.    <[email protected]>
+ * @phpstan-type ClientOption array{base_url: string, api_version: string, api_versions: string[], format: string, formats: string[], user_agent: string, timeout: int, verify_peer: bool}
+ * @phpstan-type OptionalClientOption array{base_url?: string, api_version?: string, api_versions?: string[], format?: string, formats?: string[], user_agent?: string, timeout?: int, verify_peer?: bool}
  */
 class Client implements ClientInterface
 {
-    /**
-     * @var array
-     */
+    /** @var ClientOption */
     protected $options = array(
         'base_url'      => 'https://api.bitbucket.org',
         'api_version'   => '2.0',
@@ -45,6 +45,9 @@ class Client implements ClientInterface
     /** @var HistoryPlugin */
     private $responseHistory;
 
+    /**
+     * @param OptionalClientOption $options
+     */
     public function __construct(array $options = array(), HttpPluginClientBuilder $httpClientBuilder = null)
     {
         $this->responseHistory = new HistoryPlugin();
@@ -214,11 +217,11 @@ public function setApiVersion($version)
      */
     public function isApiVersion($version)
     {
-        return abs($this->options['api_version'] - $version) < 0.00001;
+        return (float) $version === (float) $this->options['api_version'];
     }
 
     /**
-     * {@inheritdoc}
+     * @return string
      */
     public function getApiBaseUrl()
     {

lib/Bitbucket/API/Http/HttpPluginClientBuilder.php

@@ -28,6 +28,9 @@ public function __construct(HttpClient $httpClient = null, MessageFactory $messa
         $this->messageFactory = $messageFactory ?: MessageFactoryDiscovery::find();
     }
 
+    /**
+     * @return void
+     */
     public function addPlugin(Plugin $plugin)
     {
         if ($plugin instanceof ApiVersionPlugin) {
@@ -40,7 +43,8 @@ public function addPlugin(Plugin $plugin)
     }
 
     /**
-     * @param string $pluginClass
+     * @param class-string<Plugin> $pluginClass
+     * @return void
      */
     public function removePlugin($pluginClass)
     {
@@ -82,6 +86,9 @@ public function getHttpClient()
         return $this->pluginClient;
     }
 
+    /**
+     * @return MessageFactory
+     */
     public function getMessageFactory()
     {
         return $this->messageFactory;

lib/Bitbucket/API/Http/Plugin/ApiOneCollectionPlugin.php

@@ -45,6 +45,9 @@ public function __construct(ResponseFactory $responseFactory = null)
         $this->responseFactory = $responseFactory ?: MessageFactoryDiscovery::find();
     }
 
+    /**
+     * @return callable
+     */
     protected function doHandleRequest(RequestInterface $request, callable $next, callable $first)
     {
         return $next($request)->then(function (ResponseInterface $response) use ($request) {

lib/Bitbucket/API/Http/Plugin/HistoryPlugin.php

@@ -31,7 +31,7 @@ public function getLastResponse()
         return $this->lastResponse;
     }
 
-    public function addSuccess(RequestInterface $request, ResponseInterface $response)
+    public function addSuccess(RequestInterface $request, ResponseInterface $response): void
     {
         $this->lastRequest = $request;
         $this->lastResponse = $response;

lib/Bitbucket/API/Http/Plugin/HistoryVersionBridge.php

@@ -10,15 +10,15 @@
     trait HistoryVersionBridge
     {
         // History method for php-http/client-common 2
-        public function addFailure(RequestInterface $request, ClientExceptionInterface $exception)
+        public function addFailure(RequestInterface $request, ClientExceptionInterface $exception): void
         {
         }
     }
 } else {
     trait HistoryVersionBridge
     {
         // History method for php-http/client-common 1
-        public function addFailure(RequestInterface $request, Exception $exception)
+        public function addFailure(RequestInterface $request, Exception $exception): void
         {
         }
     }

lib/Bitbucket/API/Http/Plugin/NormalizeArrayPlugin.php

@@ -32,6 +32,7 @@ class NormalizeArrayPlugin implements Plugin
 
     /**
      * {@inheritDoc}
+     * @return callable
      */
     protected function doHandleRequest(RequestInterface $request, callable $next, callable $first)
     {

lib/Bitbucket/API/Repositories/BranchRestrictions.php

@@ -164,6 +164,7 @@ public function delete($account, $repo, $id)
      * Add allowed permission types
      *
      * @param array $restrictions
+     * @return void
      */
     public function addAllowedRestrictionType($restrictions = array())
     {

phpstan.neon

@@ -1,5 +1,10 @@
 parameters:
-    level: 5
+    level: 6
     paths:
         - lib
         - test
+
+    ignoreErrors:
+        - '#Method Bitbucket\\[a-z\\]+(TestCase|Test)::[a-z0-9]*provider[a-z0-9]*\(\) return type has no value type specified in iterable type#i'
+        - '#Method Bitbucket\\[a-z\\]+Test::test[a-z0-9]*\(\) has parameter \$[a-z0-9]+ with no value type specified in iterable type#i'
+        - '#no value type specified in iterable type array#'

test/Bitbucket/Tests/API/ApiTest.php

@@ -7,13 +7,13 @@
 
 class ApiTest extends TestCase
 {
-    public function testCredentials()
+    public function testCredentials(): void
     {
         $api = new Api;
         $api->setCredentials(new BasicAuth('api_username', 'api_password'));
     }
 
-    public function testShouldDoGetRequest()
+    public function testShouldDoGetRequest(): void
     {
         $endpoint = '/repositories/gentle/eof/issues/3';
         $params = [];
@@ -28,7 +28,7 @@ public function testShouldDoGetRequest()
         $this->assertSame('GET', $request->getMethod());
     }
 
-    public function testShouldDoPostRequest()
+    public function testShouldDoPostRequest(): void
     {
         $endpoint = '/repositories/gentle/eof/issues/3';
         $params = ['key' => 'value'];
@@ -44,7 +44,7 @@ public function testShouldDoPostRequest()
         $this->assertSame(http_build_query($params), $request->getBody()->getContents());
     }
 
-    public function testShouldDoPutRequest()
+    public function testShouldDoPutRequest(): void
     {
         $endpoint = '/repositories/gentle/eof/issues/3';
         $params = ['key' => 'value'];
@@ -60,7 +60,7 @@ public function testShouldDoPutRequest()
         $this->assertSame(http_build_query($params), $request->getBody()->getContents());
     }
 
-    public function testShouldDoDeleteRequest()
+    public function testShouldDoDeleteRequest(): void
     {
         $endpoint = '/repositories/gentle/eof/issues/3';
         $params = [];
@@ -76,7 +76,7 @@ public function testShouldDoDeleteRequest()
         $this->assertSame('DELETE', $request->getMethod());
     }
 
-    public function testFormat()
+    public function testFormat(): void
     {
         $this->expectException(\InvalidArgumentException::class);
 
@@ -95,16 +95,17 @@ public function testFormat()
 
     /**
      * @dataProvider invalidChildNameProvider
+     * @param mixed $name
      */
-    public function testSPFShouldFailWithInvalidClassName($name)
+    public function testSPFShouldFailWithInvalidClassName($name): void
     {
         $this->expectException(\InvalidArgumentException::class);
 
         $bitbucket = new Api();
         $bitbucket->api($name);
     }
 
-    public function testDifferentHttpClientInstanceOnCloning()
+    public function testDifferentHttpClientInstanceOnCloning(): void
     {
         $repo1 = new \Bitbucket\API\Repositories();
         $repo2 = clone $repo1;
@@ -115,10 +116,14 @@ public function testDifferentHttpClientInstanceOnCloning()
         $this->assertNotSame($repo1, $repo2);
     }
 
-    public function invalidChildNameProvider()
+    public function invalidChildNameProvider(): array
     {
         return [
-            [[]], [new \stdClass()], [21], ['32.4'], ['invalid']
+            [[]],
+            [new \stdClass()],
+            [21],
+            ['32.4'],
+            ['invalid'],
         ];
     }
 }

test/Bitbucket/Tests/API/GroupPrivilegesTest.php

@@ -15,7 +15,7 @@ protected function setUp(): void
         $this->groupPrivileges = $this->getApiMock(GroupPrivileges::class);
     }
 
-    public function testGetGroupsPrivilegesSuccess()
+    public function testGetGroupsPrivilegesSuccess(): void
     {
         $endpoint = '/1.0/group-privileges/gentle/';
 
@@ -24,7 +24,7 @@ public function testGetGroupsPrivilegesSuccess()
         $this->assertRequest('GET', $endpoint, '', 'format=json');
     }
 
-    public function testGetRepositoryPrivilegesSuccess()
+    public function testGetRepositoryPrivilegesSuccess(): void
     {
         $endpoint = '/1.0/group-privileges/gentle/dummy-repo';
 
@@ -33,7 +33,7 @@ public function testGetRepositoryPrivilegesSuccess()
         $this->assertRequest('GET', $endpoint, '', 'format=json');
     }
 
-    public function testGetGroupPrivilegesSuccess()
+    public function testGetGroupPrivilegesSuccess(): void
     {
         $endpoint = '/1.0/group-privileges/gentle/dummy-repo/owner/testers';
 
@@ -42,7 +42,7 @@ public function testGetGroupPrivilegesSuccess()
         $this->assertRequest('GET', $endpoint, '', 'format=json');
     }
 
-    public function testGetRepositoriesPrivilegeGroupSuccess()
+    public function testGetRepositoriesPrivilegeGroupSuccess(): void
     {
         $endpoint = '/1.0/group-privileges/gentle/owner/testers';
 
@@ -51,14 +51,14 @@ public function testGetRepositoriesPrivilegeGroupSuccess()
         $this->assertRequest('GET', $endpoint, '', 'format=json');
     }
 
-    public function testGrantGroupPrivilegesInvalidPrivilege()
+    public function testGrantGroupPrivilegesInvalidPrivilege(): void
     {
         $this->expectException(\InvalidArgumentException::class);
 
         $this->groupPrivileges->grant('gentle', 'repo', 'owner', 'sys-admins', 'invalid');
     }
 
-    public function testGrantGroupPrivilegesSuccess()
+    public function testGrantGroupPrivilegesSuccess(): void
     {
         $endpoint = '/1.0/group-privileges/gentle/repo/owner/sys-admins';
         $params = 'read';
@@ -68,7 +68,7 @@ public function testGrantGroupPrivilegesSuccess()
         $this->assertRequest('PUT', $endpoint, $params, 'format=json');
     }
 
-    public function testRemoveGroupPrivilegesFromRepositorySuccess()
+    public function testRemoveGroupPrivilegesFromRepositorySuccess(): void
     {
         $endpoint = '/1.0/group-privileges/gentle/repo/owner/sys-admins';
 

test/Bitbucket/Tests/API/Groups/MembersTest.php

@@ -16,7 +16,7 @@ protected function setUp(): void
         $this->members = $this->getApiMock(Members::class);
     }
 
-    public function testGetAllGroupMembers()
+    public function testGetAllGroupMembers(): void
     {
         $endpoint = '/1.0/groups/gentle/testers/members';
         $expectedResult = $this->fakeResponse(['dummy']);
@@ -27,7 +27,7 @@ public function testGetAllGroupMembers()
         $this->assertResponse($expectedResult, $actual);
     }
 
-    public function testAddMemberToGroupSuccess()
+    public function testAddMemberToGroupSuccess(): void
     {
         $endpoint = '/1.0/groups/gentle/testers/members/steve';
 
@@ -36,7 +36,7 @@ public function testAddMemberToGroupSuccess()
         $this->assertRequest('PUT', $endpoint, '', 'format=json');
     }
 
-    public function testDeleteMemberFromGroupSuccess()
+    public function testDeleteMemberFromGroupSuccess(): void
     {
         $endpoint = '/1.0/groups/gentle/testers/members/steve';
 

test/Bitbucket/Tests/API/GroupsTest.php

@@ -16,7 +16,7 @@ protected function setUp(): void
         $this->groups = $this->getApiMock(Groups::class);
     }
 
-    public function testGetAllGroups()
+    public function testGetAllGroups(): void
     {
         $endpoint = '/1.0/groups/gentle/';
         $expectedResult = $this->fakeResponse(['dummy']);
@@ -27,7 +27,7 @@ public function testGetAllGroups()
         $this->assertRequest('GET', $endpoint, '', 'format=json');
     }
 
-    public function testGetAllGroupsWithFilters()
+    public function testGetAllGroupsWithFilters(): void
     {
         $endpoint = '/1.0/groups';
         $query = 'group=gentle%2Ftesters%26group%3Dgentle%2Fmaintainers&format=json';
@@ -39,7 +39,7 @@ public function testGetAllGroupsWithFilters()
         $this->assertResponse($expectedResult, $actual);
     }
 
-    public function testCreateGroupSuccess()
+    public function testCreateGroupSuccess(): void
     {
         $endpoint = '/1.0/groups/gentle/';
         $params = http_build_query([
@@ -51,7 +51,7 @@ public function testCreateGroupSuccess()
         $this->assertRequest('POST', $endpoint, $params, 'format=json');
     }
 
-    public function testUpdateGroupSuccess()
+    public function testUpdateGroupSuccess(): void
     {
         $endpoint = '/1.0/groups/gentle/dummy/';
         $params = [
@@ -64,7 +64,7 @@ public function testUpdateGroupSuccess()
         $this->assertRequest('PUT', $endpoint, http_build_query($params), 'format=json');
     }
 
-    public function testDeleteGroupSuccess()
+    public function testDeleteGroupSuccess(): void
     {
         $endpoint = '/1.0/groups/gentle/dummy/';
 
@@ -73,7 +73,7 @@ public function testDeleteGroupSuccess()
         $this->assertRequest('DELETE', $endpoint, '', 'format=json');
     }
 
-    public function testGetMembers()
+    public function testGetMembers(): void
     {
         $this->assertInstanceOf(Members::class, $this->groups->members());
     }