enable phan for tests & examples, phan happy

Author: codemasher

.phan/config.php

@@ -25,6 +25,7 @@
 	// Thus, both first-party and third-party code being used by
 	// your application should be included in this list.
 	'directory_list'                  => [
+		'examples',
 		'src',
 		'tests',
 		'vendor',
@@ -48,7 +49,9 @@
 	//       should be added to both the `directory_list`
 	//       and `exclude_analysis_directory_list` arrays.
 	'exclude_analysis_directory_list' => [
-		'tests',
 		'vendor',
 	],
+	'suppress_issue_types'            => [
+		'PhanUndeclaredGlobalVariable', // happens in get-token examples
+	],
 ];

examples/get-token/_flow-oauth1.php

@@ -41,7 +41,7 @@
 	if($provider instanceof UserInfo){
 		printf('<pre>%s</pre>', print_r($provider->me(), true));
 	}
-
+	/** @phan-suppress-next-line PhanUndeclaredMethod ($provider is, in fact, also instance of OAuthInterface) */
 	$tokenJSON = $provider->getAccessTokenFromStorage()->toJSON();
 
 	printf('<textarea cols="120" rows="5" onclick="this.select();">%s</textarea>', $tokenJSON);

examples/get-token/_flow-oauth2.php

@@ -31,7 +31,7 @@
 	if($provider instanceof CSRFToken && isset($_GET['state'])){
 		$state = $_GET['state'];
 	}
-
+	/** @phan-suppress-next-line PhanUndeclaredMethod ($provider is, in fact, also instance of OAuthInterface) */
 	$token = $provider->getAccessToken($_GET['code'], $state);
 
 	// save the token [...]
@@ -48,7 +48,7 @@
 	if($provider instanceof UserInfo){
 		printf('<pre>%s</pre>', print_r($provider->me(), true));
 	}
-
+	/** @phan-suppress-next-line PhanUndeclaredMethod */
 	$tokenJSON = $provider->getAccessTokenFromStorage()->toJSON();
 
 	printf('<textarea cols="120" rows="5" onclick="this.select();">%s</textarea>', $tokenJSON);

src/Core/AccessToken.php

@@ -22,17 +22,17 @@
  * @see https://datatracker.ietf.org/doc/html/rfc6749#section-1.4
  *
  * // Oauth1
- * @property string|null $accessTokenSecret
+ * @property string|null                    $accessTokenSecret
  *
  * // Oauth2
- * @property array       $scopes
- * @property string|null $refreshToken
+ * @property array                          $scopes
+ * @property string|null                    $refreshToken
  *
  * // common
- * @property string|null $accessToken
- * @property int         $expires
- * @property array       $extraParams
- * @property string      $provider
+ * @property string|null                    $accessToken
+ * @property DateTime|DateInterval|int|null $expires
+ * @property array                          $extraParams
+ * @property string                         $provider
  */
 final class AccessToken extends SettingsContainerAbstract{
 

tests/Core/OAuthOptionsTest.php

@@ -31,7 +31,7 @@ public function testSetStorageEncryptionKey():void{
 	public function testSetStorageEncryptionKeyInvalidException():void{
 		$this->expectException(OAuthStorageException::class);
 		$this->expectExceptionMessage('invalid encryption key');
-
+		/** @phan-suppress-next-line PhanNoopNew */
 		new OAuthOptions(['storageEncryptionKey' => 'foo']);
 	}
 
@@ -44,7 +44,7 @@ public function testSetFileStoragePath():void{
 	public function testSetFileStoragePathInvalidException():void{
 		$this->expectException(OAuthStorageException::class);
 		$this->expectExceptionMessage('invalid storage path "/foo"');
-
+		/** @phan-suppress-next-line PhanNoopNew */
 		new OAuthOptions(['fileStoragePath' => '/foo']);
 	}
 

tests/Providers/DummyOAuth1Provider.php

@@ -12,7 +12,6 @@
 namespace chillerlan\OAuthTest\Providers;
 
 use chillerlan\OAuth\Core\{AccessToken, OAuth1Provider, TokenInvalidate};
-use chillerlan\OAuth\Providers\ProviderException;
 
 /**
  * An OAuth1 provider implementation

tests/Providers/Live/OAuth2ProviderLiveTestAbstract.php

@@ -30,7 +30,7 @@ public function testRequestCredentialsToken():void{
 		}
 
 		$this->provider->setStorage(new MemoryStorage);
-
+		/** @phan-suppress-next-line PhanUndeclaredMethod ($this->provider is, in fact, instance of ClientCredentials) */
 		$token = $this->provider->getClientCredentialsToken($this->clientCredentialsScopes);
 
 		$this::assertInstanceOf(AccessToken::class, $token);

tests/Providers/Live/OAuthProviderLiveTestAbstract.php

@@ -39,13 +39,15 @@ public function testMe():void{
 		}
 
 		try{
+			/** @phan-suppress-next-line PhanUndeclaredMethod ($this->provider is, in fact, instance of UserInfo) */
 			$user = $this->provider->me();
 		}
 		catch(UnauthorizedAccessException){
 			$this::markTestSkipped('unauthorized: token is missing or expired');
 		}
 
 		try{
+			/** @phan-suppress-next-line PhanPossiblyUndeclaredVariable */
 			$this->assertMeResponse($user);
 		}
 		catch(ExpectationFailedException $e){
@@ -62,10 +64,16 @@ public function testMe():void{
 	protected function assertUnauthorizedAccessException(AccessToken $token):void{
 		$this->expectException(UnauthorizedAccessException::class);
 
+		/** @phan-suppress-next-line PhanUndeclaredMethod ($this->provider is, in fact, instance of UserInfo) */
 		$this->provider->me();
 	}
 
 	public function testUnauthorizedAccessException():void{
+
+		if(!$this->provider instanceof UserInfo){
+			$this::markTestSkipped('AuthenticatedUser N/A');
+		}
+
 		$token                    = $this->storage->getAccessToken($this->provider->name);
 		// avoid refresh
 		$token->expires           = AccessToken::NEVER_EXPIRES;

tests/Providers/Live/PayPalAPITest.php

@@ -14,7 +14,6 @@
 use chillerlan\OAuth\Core\AuthenticatedUser;
 use chillerlan\OAuth\Providers\PayPal;
 use PHPUnit\Framework\Attributes\Group;
-use function is_array;
 
 /**
  * @property \chillerlan\OAuth\Providers\PayPal $provider

tests/Providers/Unit/OAuth1ProviderUnitTestAbstract.php

@@ -6,6 +6,8 @@
  * @author       smiley <smiley@chillerlan.net>
  * @copyright    2018 smiley
  * @license      MIT
+ *
+ * @phan-file-suppress PhanAccessMethodInternal
  */
 declare(strict_types=1);