Apply code styling fixes

SocialiteProviders · Sep 7, 2023 · f4866e7 · f4866e7
1 parent d3922d6
commit f4866e7
Show file tree

Hide file tree

Showing 15 changed files with 45 additions and 92 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -18,14 +18,13 @@ class Config implements Contracts\ConfigInterface
      * @param  string  $key
      * @param  string  $secret
      * @param  string|callable  $callbackUri
-     * @param  array  $additionalProviderConfig
      */
     public function __construct($key, $secret, $callbackUri, array $additionalProviderConfig = [])
     {
         $this->config = array_merge([
-            'client_id'     => $key,
+            'client_id' => $key,
             'client_secret' => $secret,
-            'redirect'      => $this->formatRedirectUri($callbackUri),
+            'redirect' => $this->formatRedirectUri($callbackUri),
         ], $additionalProviderConfig);
     }
 

diff --git a/src/Contracts/Helpers/ConfigRetrieverInterface.php b/src/Contracts/Helpers/ConfigRetrieverInterface.php
@@ -6,7 +6,6 @@ interface ConfigRetrieverInterface
 {
     /**
      * @param  string  $providerName
-     * @param  array  $additionalConfigKeys
      * @return \SocialiteProviders\Manager\Contracts\ConfigInterface
      */
     public function fromServices($providerName, array $additionalConfigKeys = []);

diff --git a/src/Contracts/OAuth1/ProviderInterface.php b/src/Contracts/OAuth1/ProviderInterface.php
@@ -7,7 +7,6 @@
 interface ProviderInterface
 {
     /**
-     * @param  \SocialiteProviders\Manager\Contracts\ConfigInterface  $config
      * @return $this
      */
     public function setConfig(Config $config);

diff --git a/src/Contracts/OAuth2/ProviderInterface.php b/src/Contracts/OAuth2/ProviderInterface.php
@@ -8,7 +8,6 @@
 interface ProviderInterface extends SocialiteOauth2ProviderInterface
 {
     /**
-     * @param  \SocialiteProviders\Manager\Contracts\ConfigInterface  $config
      * @return $this
      */
     public function setConfig(Config $config);

diff --git a/src/Helpers/ConfigRetriever.php b/src/Helpers/ConfigRetriever.php
@@ -31,7 +31,6 @@ class ConfigRetriever implements ConfigRetrieverInterface
 
     /**
      * @param  string  $providerName
-     * @param  array  $additionalConfigKeys
      * @return \SocialiteProviders\Manager\Contracts\ConfigInterface
      */
     public function fromServices($providerName, array $additionalConfigKeys = [])
@@ -50,8 +49,6 @@ public function fromServices($providerName, array $additionalConfigKeys = [])
     }
 
     /**
-     * @param  array  $configKeys
-     * @param  \Closure  $keyRetrievalClosure
      * @return array
      */
     protected function getConfigItems(array $configKeys, Closure $keyRetrievalClosure)
@@ -60,8 +57,6 @@ protected function getConfigItems(array $configKeys, Closure $keyRetrievalClosur
     }
 
     /**
-     * @param  array  $keys
-     * @param  \Closure  $keyRetrievalClosure
      * @return array
      */
     protected function retrieveItemsFromConfig(array $keys, Closure $keyRetrievalClosure)
@@ -112,20 +107,16 @@ protected function getConfigFromServicesArray($providerName)
             // If we are running in console we should spoof values to make Socialite happy...
             if (app()->runningInConsole()) {
                 $configArray = [
-                    'client_id'     => "{$this->providerIdentifier}_KEY",
+                    'client_id' => "{$this->providerIdentifier}_KEY",
                     'client_secret' => "{$this->providerIdentifier}_SECRET",
-                    'redirect'      => "{$this->providerIdentifier}_REDIRECT_URI",
+                    'redirect' => "{$this->providerIdentifier}_REDIRECT_URI",
                 ];
             } else {
                 throw new MissingConfigException("There is no services entry for $providerName");
             }
         }
 
-
-
-
-
-            return $this->servicesArray = $configArray;
+        return $this->servicesArray = $configArray;
     }
 
     /**

diff --git a/src/OAuth1/AbstractProvider.php b/src/OAuth1/AbstractProvider.php
@@ -119,7 +119,6 @@ public function stateless($stateless = true)
     /**
      * Set the scopes of the requested access.
      *
-     * @param  array  $scopes
      * @return $this
      */
     public function scopes(array $scopes)
@@ -132,7 +131,6 @@ public function scopes(array $scopes)
     /**
      * Set the custom parameters of the request.
      *
-     * @param  array  $parameters
      * @return $this
      */
     public function with(array $parameters)
@@ -143,7 +141,6 @@ public function with(array $parameters)
     }
 
     /**
-     * @param  Config  $config
      * @return $this
      */
     public function setConfig(Config $config)

diff --git a/src/OAuth1/Server.php b/src/OAuth1/Server.php
@@ -39,7 +39,6 @@ abstract class Server extends BaseServer
      * the temporary credentials identifier as passed back by the server
      * and finally the verifier code.
      *
-     * @param  \League\OAuth1\Client\Credentials\TemporaryCredentials  $temporaryCredentials
      * @param  string  $temporaryIdentifier
      * @param  string  $verifier
      * @return array
@@ -65,7 +64,7 @@ public function getTokenCredentials(TemporaryCredentials $temporaryCredentials,
         try {
             if ($client instanceof Client) {
                 $response = $client->post($uri, [
-                    'headers'     => $headers,
+                    'headers' => $headers,
                     'form_params' => $bodyParameters,
                 ]);
             } else {
@@ -76,15 +75,14 @@ public function getTokenCredentials(TemporaryCredentials $temporaryCredentials,
         }
 
         return [
-            'tokenCredentials'        => $this->createTokenCredentials($response->getBody()),
+            'tokenCredentials' => $this->createTokenCredentials($response->getBody()),
             'credentialsResponseBody' => $response->getBody(),
         ];
     }
 
     /**
      * Set the scopes of the requested access.
      *
-     * @param  array  $scopes
      * @return $this
      */
     public function scopes(array $scopes)
@@ -97,7 +95,6 @@ public function scopes(array $scopes)
     /**
      * Set the custom parameters of the request.
      *
-     * @param  array  $parameters
      * @return $this
      */
     public function with(array $parameters)
@@ -110,7 +107,6 @@ public function with(array $parameters)
     /**
      * Format the given scopes.
      *
-     * @param  array  $scopes
      * @param  string  $scopeSeparator
      * @return string
      */

diff --git a/src/OAuth1/User.php b/src/OAuth1/User.php
@@ -20,7 +20,6 @@ class User extends BaseUser
      *
      * Might include things such as the token and refresh token
      *
-     * @param  array  $accessTokenResponseBody
      * @return $this
      */
     public function setAccessTokenResponseBody(array $accessTokenResponseBody)

diff --git a/src/OAuth2/User.php b/src/OAuth2/User.php
@@ -20,7 +20,6 @@ class User extends BaseUser
      *
      * Might include things such as the token and refresh token
      *
-     * @param  array  $accessTokenResponseBody
      * @return $this
      */
     public function setAccessTokenResponseBody(array $accessTokenResponseBody)

diff --git a/src/SocialiteWasCalled.php b/src/SocialiteWasCalled.php
@@ -22,10 +22,6 @@ class SocialiteWasCalled
 
     private ConfigRetrieverInterface $configRetriever;
 
-    /**
-     * @param  \Illuminate\Contracts\Container\Container  $app
-     * @param  \SocialiteProviders\Manager\Contracts\Helpers\ConfigRetrieverInterface  $configRetriever
-     */
     public function __construct(Application $app, ConfigRetrieverInterface $configRetriever)
     {
         $this->app = $app;
@@ -65,7 +61,6 @@ function () use ($socialite, $providerName, $providerClass, $oauth1Server) {
     }
 
     /**
-     * @param  \Laravel\Socialite\SocialiteManager  $socialite
      * @param  string  $providerName
      * @param  string  $providerClass
      * @param  null|string  $oauth1Server
@@ -83,7 +78,6 @@ protected function buildProvider(SocialiteManager $socialite, $providerName, $pr
     /**
      * Build an OAuth 1 provider instance.
      *
-     * @param  \Laravel\Socialite\SocialiteManager  $socialite
      * @param  string  $providerClass  must extend Laravel\Socialite\One\AbstractProvider
      * @param  string  $providerName
      * @param  string  $oauth1Server  must extend League\OAuth1\Client\Server\Server
@@ -109,7 +103,6 @@ protected function buildOAuth1Provider(SocialiteManager $socialite, $providerCla
     /**
      * Build an OAuth 2 provider instance.
      *
-     * @param  SocialiteManager  $socialite
      * @param  string  $providerClass  must extend Laravel\Socialite\Two\AbstractProvider
      * @param  string  $providerName
      * @return \Laravel\Socialite\Two\AbstractProvider
@@ -128,8 +121,6 @@ protected function buildOAuth2Provider(SocialiteManager $socialite, $providerCla
     }
 
     /**
-     * @param  string  $providerClass
-     * @param  string  $providerName
      * @return \SocialiteProviders\Manager\Contracts\ConfigInterface
      */
     protected function getConfig(string $providerClass, string $providerName)
@@ -159,7 +150,7 @@ private function isOAuth1($oauth1Server)
      */
     private function classExtends($class, $baseClass)
     {
-        if (false === is_subclass_of($class, $baseClass)) {
+        if (is_subclass_of($class, $baseClass) === false) {
             throw new InvalidArgumentException("{$class} does not extend {$baseClass}");
         }
     }

diff --git a/tests/ConfigRetrieverTest.php b/tests/ConfigRetrieverTest.php
@@ -57,10 +57,10 @@ public function it_retrieves_a_config_from_the_services(): void
         $uri = 'uri';
         $additionalConfigItem = 'test';
         $config = [
-            'client_id'     => $key,
+            'client_id' => $key,
             'client_secret' => $secret,
-            'redirect'      => $uri,
-            'additional'    => $additionalConfigItem,
+            'redirect' => $uri,
+            'additional' => $additionalConfigItem,
         ];
         self::$functions
             ->shouldReceive('config')

diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -15,9 +15,9 @@ public function it_returns_a_config_array(): void
         $secret = 'secret';
         $callbackUri = 'uri';
         $result = [
-            'client_id'     => $key,
+            'client_id' => $key,
             'client_secret' => $secret,
-            'redirect'      => $callbackUri,
+            'redirect' => $callbackUri,
         ];
 
         $config = new Config($key, $secret, $callbackUri);
@@ -34,10 +34,10 @@ public function it_allows_additional_config_items(): void
         $secret = 'secret';
         $callbackUri = 'uri';
         $result = [
-            'client_id'     => $key,
+            'client_id' => $key,
             'client_secret' => $secret,
-            'redirect'      => $callbackUri,
-            'additional'    => true,
+            'redirect' => $callbackUri,
+            'additional' => true,
         ];
         $additional = ['additional' => true];
 
@@ -56,10 +56,10 @@ public function it_allows_closure_config_redirect()
         $callbackUri = 'uri';
         $callbackFunc = fn () => $callbackUri;
         $result = [
-            'client_id'     => $key,
+            'client_id' => $key,
             'client_secret' => $secret,
-            'redirect'      => $callbackUri,
-            'additional'    => true,
+            'redirect' => $callbackUri,
+            'additional' => true,
         ];
         $additional = ['additional' => true];
 

diff --git a/tests/ManagerTestTrait.php b/tests/ManagerTestTrait.php
@@ -88,27 +88,20 @@ protected function configRetrieverMockWithDefaultExpectations($providerName, $pr
         return $configRetriever;
     }
 
-    /**
-     * @return array
-     */
     protected function config(): array
     {
         return [
-            'client_id'     => 'test',
+            'client_id' => 'test',
             'client_secret' => 'test',
-            'redirect'      => 'test',
+            'redirect' => 'test',
         ];
     }
 
-    /**
-     * @param  array  $config
-     * @return array
-     */
     protected function oauth1FormattedConfig(array $config): array
     {
         return [
-            'identifier'   => $config['client_id'],
-            'secret'       => $config['client_secret'],
+            'identifier' => $config['client_id'],
+            'secret' => $config['client_secret'],
             'callback_uri' => $config['redirect'],
         ];
     }
@@ -152,7 +145,6 @@ protected function oauth2ProviderStubClass(): string
 
     /**
      * @param  string  $stub
-     * @return \Mockery\MockInterface
      */
     protected function mockStub($stub): MockInterface
     {
@@ -161,16 +153,12 @@ protected function mockStub($stub): MockInterface
 
     /**
      * @param  string  $stub
-     * @return string
      */
     protected function fullStubClassName($stub): string
     {
         return __NAMESPACE__.'\Stubs\\'.$stub;
     }
 
-    /**
-     * @return string
-     */
     protected function invalidClass(): string
     {
         return 'FooBar';