🚿 PHPCS & PHPMD happy

codemasher · codemasher · commit d1040b04ea9f · 2024-05-19T20:04:56.000+02:00
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/examples/Providers/LastFM/topalbum-patchwork.php b/examples/Providers/LastFM/topalbum-patchwork.php
@@ -152,4 +152,3 @@ function sendResponse(array $response):void{
 	echo json_encode($response, JSON_PRETTY_PRINT);
 	exit;
 }
-
diff --git a/examples/Providers/Spotify/playlist-diff.php b/examples/Providers/Spotify/playlist-diff.php
@@ -29,7 +29,7 @@ public function diff(string $playlistID1, string $playlistID2, bool $createAsPla
 		return $diff;
 	}
 
-};
+}
 
 /**
  * @var \OAuthExampleProviderFactory $factory
diff --git a/examples/create-description.php b/examples/create-description.php
@@ -45,7 +45,7 @@
 
 	$table[] = '| ['.$provider->getName().']('.$provider->getApiDocURL().')'.
 		' | [link]('.$provider->getApplicationURL().')'.
-		' | '.($provider->getUserRevokeURL() !== null ? '[link]('.$provider->getUserRevokeURL().')' : '').
+		' | '.(($provider->getUserRevokeURL() !== null) ? '[link]('.$provider->getUserRevokeURL().')' : '').
 		' | '.$oauthVersion.
 		' | '.(($provider instanceof UserInfo) ? '✓' : '').
 		' | '.(($provider instanceof CSRFToken) ? '✓' : '').
diff --git a/examples/provider-example-common.php b/examples/provider-example-common.php
@@ -16,6 +16,7 @@
  *
  * @var string $AUTOLOADER - path to an alternate autoloader
  */
+// PHPCS:ignore
 require_once ($AUTOLOADER ?? __DIR__.'/../vendor/autoload.php');
 require_once __DIR__.'/OAuthExampleProviderFactory.php';
 
diff --git a/phpmd.xml.dist b/phpmd.xml.dist
@@ -26,6 +26,7 @@
 		<exclude name="ExitExpression"/>
 	</rule>
 	<rule ref="rulesets/naming.xml">
+		<exclude name="ShortMethodName"/>
 		<exclude name="LongVariable"/>
 		<exclude name="ShortVariable"/>
 		<exclude name="ConstantNamingConventions"/>
diff --git a/src/Core/OAuth1Provider.php b/src/Core/OAuth1Provider.php
@@ -101,7 +101,7 @@ protected function getRequestTokenRequestParams():array{
 	 *
 	 * @throws \chillerlan\OAuth\Providers\ProviderException
 	 */
-	protected function parseTokenResponse(ResponseInterface $response, bool $checkCallbackConfirmed = false):AccessToken{
+	protected function parseTokenResponse(ResponseInterface $response, bool|null $checkCallbackConfirmed = null):AccessToken{
 		$data = QueryUtil::parse(MessageUtil::decompress($response));
 
 		if(empty($data)){
@@ -122,7 +122,10 @@ protected function parseTokenResponse(ResponseInterface $response, bool $checkCa
 		}
 
 		// MUST be present and set to "true". The parameter is used to differentiate from previous versions of the protocol
-		if($checkCallbackConfirmed && (!isset($data['oauth_callback_confirmed']) || $data['oauth_callback_confirmed'] !== 'true')){
+		if(
+			$checkCallbackConfirmed === true
+			&& (!isset($data['oauth_callback_confirmed']) || $data['oauth_callback_confirmed'] !== 'true')
+		){
 			throw new ProviderException('invalid OAuth 1.0a response');
 		}
 
diff --git a/src/Core/OAuth2Provider.php b/src/Core/OAuth2Provider.php
@@ -417,7 +417,7 @@ protected function getRefreshAccessTokenRequestBodyParams(string $refreshToken):
 	 * @throws \chillerlan\OAuth\Providers\ProviderException
 	 */
 	public function invalidateAccessToken(AccessToken $token = null, string|null $type = null):bool{
-		$type = strtolower(trim($type ?? 'access_token'));
+		$type = strtolower(trim(($type ?? 'access_token')));
 
 		// @link https://datatracker.ietf.org/doc/html/rfc7009#section-2.1
 		if(!in_array($type, ['access_token', 'refresh_token'])){
@@ -587,7 +587,10 @@ final public function setCodeVerifier(array $params):array{
 	/**
 	 * @implements \chillerlan\OAuth\Core\PKCE::generateVerifier()
 	 * @see \chillerlan\OAuth\Core\OAuth2Provider::setCodeChallenge()
+	 *
 	 * @phan-suppress PhanUndeclaredClassMethod, PhanUndeclaredMethod
+	 * @noinspection PhpFullyQualifiedNameUsageInspection
+	 * @SuppressWarnings(PHPMD.MissingImport)
 	 */
 	final public function generateVerifier(int $length):string{
 
diff --git a/src/Core/Utilities.php b/src/Core/Utilities.php
@@ -46,7 +46,7 @@ class Utilities{
 	 * Fetches a list of provider classes in the given directory
 	 */
 	public static function getProviders(string|null $providerDir = null, string|null $namespace = null):array{
-		$providerDir = realpath($providerDir ?? __DIR__.'/../Providers');
+		$providerDir = realpath(($providerDir ?? __DIR__.'/../Providers'));
 		$namespace   = trim(($namespace ?? 'chillerlan\\OAuth\\Providers'), '\\');
 		$providers   = [];
 
diff --git a/src/OAuthOptions.php b/src/OAuthOptions.php
@@ -14,7 +14,7 @@
 use chillerlan\Settings\SettingsContainerAbstract;
 
 /**
- * This class holds all settings related to the OAuth provider as well as the default HTTP client.
+ * This class holds all settings related to the OAuth provider
  */
 class OAuthOptions extends SettingsContainerAbstract{
 	use OAuthOptionsTrait;
diff --git a/src/Providers/LastFM.php b/src/Providers/LastFM.php
@@ -156,7 +156,7 @@ public function request(
 		array|null                        $headers = null,
 		string|null                       $protocolVersion = null
 	):ResponseInterface{
-		$method    = strtoupper($method ?? 'GET');
+		$method    = strtoupper(($method ?? 'GET'));
 		$headers ??= [];
 
 		if($body !== null && !is_array($body)){
@@ -345,7 +345,7 @@ public function clearScrobbles():static{
 	 */
 	protected function parseTrack(array $track):array{
 		// we're using the settings container and its setters to enforce variables and types etc.
-		return (new class($track) extends SettingsContainerAbstract{
+		$parser = new class ($track) extends SettingsContainerAbstract{
 
 			protected string      $artist;
 			protected string      $track;
@@ -410,7 +410,9 @@ protected function set_duration(int $duration):void{
 				$this->duration = $duration;
 			}
 
-		})->toArray();
+		};
+
+		return $parser->toArray();
 	}
 
 	/**
diff --git a/tests/Attributes/Provider.php b/tests/Attributes/Provider.php
@@ -7,7 +7,7 @@
  * @copyright    2024 smiley
  * @license      MIT
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace chillerlan\OAuthTest\Attributes;
 
diff --git a/tests/Core/AuthenticatedUserTest.php b/tests/Core/AuthenticatedUserTest.php
@@ -42,7 +42,7 @@ public function testClassIsReadOnly():void{
 
 		// cannot overwrite via fromIterable()
 		$userdata = [
-			'id'   => 456,
+			'id'       => 456,
 			'userName' => 'nope',
 			'email'    => 'me@nowhere.com',
 		];
diff --git a/tests/Providers/ProviderUnitTestAbstract.php b/tests/Providers/ProviderUnitTestAbstract.php
@@ -163,12 +163,13 @@ protected function getMockHttpClient(ResponseInterface $response):ClientInterfac
 
 			public function __construct(
 				private readonly ResponseInterface $mockedResponse
-			){}
+			){
+				// noop
+			}
 
 			public function sendRequest(RequestInterface $request):ResponseInterface{
 				 return $this->mockedResponse;
 			}
-
 		};
 	}
 
diff --git a/tests/Providers/Unit/LastFMTest.php b/tests/Providers/Unit/LastFMTest.php
@@ -24,11 +24,13 @@ final class LastFMTest extends OAuthProviderUnitTestAbstract{
 
 	protected const TEST_TOKEN = '{"session":{"name":"lfm-user","key":"sk","subscriber":0}}';
 
+	// PHPCS:ignore
 	protected const SCROBBLE_RESPONSE_SINGLE =
 		'{"scrobbles":{"scrobble":{"artist":{"corrected":"0","#text":"Helium"},"album":{"corrected":"0"},'.
 		'"track":{"corrected":"0","#text":"Vibrations"},"ignoredMessage":{"code":"0","#text":""},'.
 		'"albumArtist":{"corrected":"0","#text":""},"timestamp":"1712992925"},"@attr":{"ignored":0,"accepted":1}}}';
 
+	// PHPCS:ignore
 	protected const SCROBBLE_RESPONSE_MULTI =
 		'{"scrobbles":{"scrobble":[{"artist":{"corrected":"0","#text":"Helium"},"album":{"corrected":"0"},'.
 		'"track":{"corrected":"0","#text":"Vibrations"},"ignoredMessage":{"code":"0","#text":""},'.

Original file line number	Diff line number	Diff line change
`@@ -152,4 +152,3 @@ function sendResponse(array $response):void{`
`152`	`152`	`echo json_encode($response, JSON_PRETTY_PRINT);`
`153`	`153`	`exit;`
`154`	`154`	`}`
`155`		`-`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function diff(string $playlistID1, string $playlistID2, bool $createAsPla`
`29`	`29`	`return $diff;`
`30`	`30`	`}`
`31`	`31`
`32`		`-};`
	`32`	`+}`
`33`	`33`
`34`	`34`	`/**`
`35`	`35`	`* @var \OAuthExampleProviderFactory $factory`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`*`
`17`	`17`	`* @var string $AUTOLOADER - path to an alternate autoloader`
`18`	`18`	`*/`
	`19`	`+// PHPCS:ignore`
`19`	`20`	`require_once ($AUTOLOADER ?? __DIR__.'/../vendor/autoload.php');`
`20`	`21`	`require_once __DIR__.'/OAuthExampleProviderFactory.php';`
`21`	`22`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ protected function getRequestTokenRequestParams():array{`
`101`	`101`	`*`
`102`	`102`	`* @throws \chillerlan\OAuth\Providers\ProviderException`
`103`	`103`	`*/`
`104`		`- protected function parseTokenResponse(ResponseInterface $response, bool $checkCallbackConfirmed = false):AccessToken{`
	`104`	`+ protected function parseTokenResponse(ResponseInterface $response, bool\|null $checkCallbackConfirmed = null):AccessToken{`
`105`	`105`	`$data = QueryUtil::parse(MessageUtil::decompress($response));`
`106`	`106`
`107`	`107`	`if(empty($data)){`
`@@ -122,7 +122,10 @@ protected function parseTokenResponse(ResponseInterface $response, bool $checkCa`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`// MUST be present and set to "true". The parameter is used to differentiate from previous versions of the protocol`
`125`		`- if($checkCallbackConfirmed && (!isset($data['oauth_callback_confirmed']) \|\| $data['oauth_callback_confirmed'] !== 'true')){`
	`125`	`+ if(`
	`126`	`+ $checkCallbackConfirmed === true`
	`127`	`+ && (!isset($data['oauth_callback_confirmed']) \|\| $data['oauth_callback_confirmed'] !== 'true')`
	`128`	`+ ){`
`126`	`129`	`throw new ProviderException('invalid OAuth 1.0a response');`
`127`	`130`	`}`
`128`	`131`