fixes for phpcs

rrd108 · Jan 26, 2024 · 26103da · 26103da
1 parent 6b5fd1f
commit 26103da
Show file tree

Hide file tree

Showing 13 changed files with 89 additions and 116 deletions.
diff --git a/composer.json b/composer.json
@@ -40,7 +40,8 @@
     }
   },
   "scripts": {
-    "cs-check": "phpcs --colors -p src/ tests/",
-    "cs-fix": "phpcbf --colors -p src/ tests/"
+    "test": "phpunit",
+    "cs-check": "phpcs --colors -p ./src ./tests",
+    "cs-fix": "phpcbf --colors -p ./src ./tests"
   }
 }
diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<ruleset name="CakePHP Sentry">
+  <config name="installed_paths" value="../../cakephp/cakephp-codesniffer" />
+
+  <rule ref="CakePHP" />
+</ruleset>
diff --git a/src/ApiTokenAuthenticatorPlugin.php b/src/ApiTokenAuthenticatorPlugin.php
@@ -1,24 +1,29 @@
 <?php
+declare(strict_types=1);
 
 namespace ApiTokenAuthenticator;
 
-use Cake\Core\Configure;
-use Cake\Routing\Router;
-use Cake\Core\BasePlugin;
-use Cake\Http\MiddlewareQueue;
-use Cake\Console\CommandCollection;
+use ApiTokenAuthenticator\Authentication\Authenticator\ProvisoryTokenAuthenticator;
 use Authentication\AuthenticationService;
-use Cake\Core\PluginApplicationInterface;
-use Psr\Http\Message\ServerRequestInterface;
-use Authentication\Identifier\AbstractIdentifier;
 use Authentication\AuthenticationServiceInterface;
-use Authentication\Middleware\AuthenticationMiddleware;
 use Authentication\AuthenticationServiceProviderInterface;
-use ApiTokenAuthenticator\Authentication\Authenticator\ProvisoryTokenAuthenticator;
+use Authentication\Identifier\AbstractIdentifier;
+use Authentication\Middleware\AuthenticationMiddleware;
+use Cake\Console\CommandCollection;
+use Cake\Core\BasePlugin;
+use Cake\Core\Configure;
+use Cake\Core\PluginApplicationInterface;
+use Cake\Http\MiddlewareQueue;
+use Cake\Routing\Router;
+use Psr\Http\Message\ServerRequestInterface;
 
 class ApiTokenAuthenticatorPlugin extends BasePlugin implements AuthenticationServiceProviderInterface
 {
     // TODO disable CSRF middleware - now it is manually in Application.php
+
+    /**
+     * @inheritDoc
+     */
     public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
     {
         // Add middleware here.
@@ -32,6 +37,9 @@ public function middleware(MiddlewareQueue $middleware): MiddlewareQueue
         return $middleware;
     }
 
+    /**
+     * @inheritDoc
+     */
     public function console(CommandCollection $commands): CommandCollection
     {
         // Add console commands here.
@@ -40,13 +48,19 @@ public function console(CommandCollection $commands): CommandCollection
         return $commands;
     }
 
+    /**
+     * @inheritDoc
+     */
     public function bootstrap(PluginApplicationInterface $app): void
     {
         // Add constants, load configuration defaults.
         // By default will load `config/bootstrap.php` in the plugin.
         parent::bootstrap($app);
     }
 
+    /**
+     * @inheritDoc
+     */
     public function routes($routes): void
     {
         // Add routes.
@@ -57,7 +71,7 @@ public function routes($routes): void
     /**
      * Returns a service provider instance.
      *
-     * @param  \Psr\Http\Message\ServerRequestInterface $request Request
+     * @param \Psr\Http\Message\ServerRequestInterface $request Request
      * @return \Authentication\AuthenticationServiceInterface
      */
     public function getAuthenticationService(ServerRequestInterface $request): AuthenticationServiceInterface
@@ -68,28 +82,30 @@ public function getAuthenticationService(ServerRequestInterface $request): Authe
 
         $fields = [
             AbstractIdentifier::CREDENTIAL_USERNAME => $options['fields']['username'],
-            AbstractIdentifier::CREDENTIAL_PASSWORD => $options['fields']['password']
+            AbstractIdentifier::CREDENTIAL_PASSWORD => $options['fields']['password'],
         ];
 
         $service->loadAuthenticator(
-            ProvisoryTokenAuthenticator::class, [
-            'header' => $options['header'],
+            ProvisoryTokenAuthenticator::class,
+            [
+                'header' => $options['header'],
             ]
         );
         $service->loadIdentifier('Authentication.Token');
 
         $service->loadAuthenticator(
-            'Authentication.Form', [
-            'fields' => $fields,
-            'loginUrl' => Router::url(
-                [
-                'prefix' => false,
-                'plugin' => null,
-                'controller' => $options['login']['controller'],
-                'action' => $options['login']['action'],
-                '_ext' => $options['login']['_ext']
-                ]
-            ),
+            'Authentication.Form',
+            [
+                'fields' => $fields,
+                'loginUrl' => Router::url(
+                    [
+                        'prefix' => false,
+                        'plugin' => null,
+                        'controller' => $options['login']['controller'],
+                        'action' => $options['login']['action'],
+                        '_ext' => $options['login']['_ext'],
+                    ]
+                ),
             ]
         );
 
@@ -101,7 +117,7 @@ public function getAuthenticationService(ServerRequestInterface $request): Authe
                 'Authentication.Password',
                 [
                     'fields' => $fields,
-                    'passwordHasher' => $options['passwordHasher']
+                    'passwordHasher' => $options['passwordHasher'],
                 ]
             );
         }

diff --git a/src/Authentication/Authenticator/ProvisoryTokenAuthenticator.php b/src/Authentication/Authenticator/ProvisoryTokenAuthenticator.php
@@ -1,16 +1,21 @@
 <?php
+declare(strict_types=1);
 
 namespace ApiTokenAuthenticator\Authentication\Authenticator;
 
-use Cake\I18n\DateTime;
-use Cake\Core\Configure;
 use Authentication\Authenticator\Result;
-use Psr\Http\Message\ServerRequestInterface;
 use Authentication\Authenticator\ResultInterface;
 use Authentication\Authenticator\TokenAuthenticator;
+use Cake\Core\Configure;
+use Cake\I18n\DateTime;
+use Psr\Http\Message\ServerRequestInterface;
 
 class ProvisoryTokenAuthenticator extends TokenAuthenticator
 {
+    /**
+     * @param \Psr\Http\Message\ServerRequestInterface $request The request.
+     * @return \Authentication\Authenticator\ResultInterface
+     */
     public function authenticate(ServerRequestInterface $request): ResultInterface
     {
         $result = parent::authenticate($request);

diff --git a/src/Controller/AppController.php b/src/Controller/AppController.php
@@ -1,19 +1,26 @@
 <?php
+declare(strict_types=1);
 
 namespace ApiTokenAuthenticator\Controller;
 
-use Cake\View\JsonView;
 use App\Controller\AppController as BaseController;
+use Cake\View\JsonView;
 
 class AppController extends BaseController
 {
+    /**
+     * @inheritDoc
+     */
     public function initialize(): void
     {
         parent::initialize();
         // TODO do we need this here or just in the application?
         $this->loadComponent('Authentication.Authentication');
     }
 
+    /**
+     * @inheritDoc
+     */
     public function viewClasses(): array
     {
         // TODO do we need this here or just in the application?

diff --git a/tests/Fixture/UsersFixture.php b/tests/Fixture/UsersFixture.php
@@ -10,7 +10,7 @@ class UsersFixture extends TestFixture
         [
             'id' => 1,
             'email' => 'rrd',
-            'password' => '$2y$10$ZVRmoo2amhyBLFqz/Qoo8OsqbGDXs95AdQM/gmLSJ2BghRSWdmRDS',   // 123
+            'password' => '$2y$10$ZVRmoo2amhyBLFqz/Qoo8OsqbGDXs95AdQM/gmLSJ2BghRSWdmRDS', // 123
             'token' => 'token-1',
             'created' => '2023-10-21 12:12:12',
             'modified' => '2023-10-21 12:12:12',

diff --git a/tests/TestCase/Authentication/Authenticator/ProvisoryTokenAuthenticatorTest.php b/tests/TestCase/Authentication/Authenticator/ProvisoryTokenAuthenticatorTest.php
@@ -1,13 +1,14 @@
 <?php
+declare(strict_types=1);
 
 namespace ApiTokenAuthenticator\Test\Authentication\Authenticator;
 
-use Cake\Core\Configure;
-use Cake\TestSuite\TestCase;
-use Cake\Http\ServerRequestFactory;
+use ApiTokenAuthenticator\Authentication\Authenticator\ProvisoryTokenAuthenticator;
 use Authentication\Authenticator\Result;
 use Authentication\Identifier\IdentifierCollection;
-use ApiTokenAuthenticator\Authentication\Authenticator\ProvisoryTokenAuthenticator;
+use Cake\Core\Configure;
+use Cake\Http\ServerRequestFactory;
+use Cake\TestSuite\TestCase;
 
 class ProvisoryTokenAuthenticatorTest extends TestCase
 {

diff --git a/tests/TestCase/Controller/UsersControllerTest.php b/tests/TestCase/Controller/UsersControllerTest.php
@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace TestApp\Test\TestCase\Controller;
@@ -20,7 +19,7 @@ public function testLogin(): void
         $this->post('/users/login.json', ['email' => 'rrd', 'password' => '123']);
         $this->assertResponseOk();
         $this->assertHeader('Content-Type', 'application/json');
-        $user =  $this->viewVariable('user');
+        $user = $this->viewVariable('user');
         $this->assertEquals('token-1', $user->token);
     }
 
@@ -31,22 +30,21 @@ public function testIndex(): void
 
         $this->configRequest(
             [
-            'headers' => ['Token' => 'FalseToken']
+                'headers' => ['Token' => 'FalseToken'],
             ]
         );
         $this->get('/users.json');
         $this->assertResponseCode(401);
 
-
         $this->configRequest(
             [
-            'headers' => ['Token' => 'token-1']
+                'headers' => ['Token' => 'token-1'],
             ]
         );
         $this->get('/users.json');
         $this->assertResponseOk();
         $this->assertHeader('Content-Type', 'application/json');
-        $users =  $this->viewVariable('users');
+        $users = $this->viewVariable('users');
         $this->assertEquals('rrd', $users->toArray()[0]->email);
     }
 }
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -1,67 +1,7 @@
 <?php
-
 declare(strict_types=1);
 
-use Cake\Core\Configure;
-use Cake\Core\Plugin;
-use Cake\Datasource\ConnectionManager;
-use Cake\Routing\Router;
-use Cake\Utility\Security;
-
-$findRoot = function ($root) {
-    do {
-        $lastRoot = $root;
-        $root = dirname($root);
-        if (is_dir($root . '/vendor/cakephp/cakephp')) {
-            return $root;
-        }
-    } while ($root !== $lastRoot);
-    throw new Exception('Cannot find the root of the application, unable to run tests');
-};
-$root = $findRoot(__FILE__);
-unset($findRoot);
-chdir($root);
-
-//require_once 'vendor/cakephp/cakephp/src/functions.php';
-//require_once 'vendor/autoload.php';
-
-define('ROOT', $root . DS . 'tests' . DS . 'test_app' . DS);
-// define('APP', ROOT . 'App' . DS);
-// define('TMP', sys_get_temp_dir() . DS);
-define('CONFIG', ROOT . DS . 'config' . DS);
-
-Configure::write('debug', true);
-Configure::write(
-    'App', [
-    'namespace' => 'TestApp',
-    'encoding' => 'UTF-8',
-    'paths' => [
-        'plugins' => [ROOT . 'Plugin' . DS],
-        'templates' => [ROOT . 'templates' . DS],
-    ],
-    ]
-);
-
-ConnectionManager::setConfig(
-    'test', [
-    'className' => 'Cake\Database\Connection',
-    'driver' => 'Cake\Database\Driver\Sqlite',
-    'database' => ':memory:',
-    'encoding' => 'utf8',
-    'timezone' => 'UTC',
-    'quoteIdentifiers' => false,
-    ]
-);
-
-Router::reload();
-//Security::setSalt('rrd');
-
-Plugin::getCollection()->add(new \Authentication\Plugin());
-
-$_SERVER['PHP_SELF'] = '/';
-
-Configure::load('ApiTokenAuthenticator.apiTokenAuthenticator');
-
 use Cake\TestSuite\Fixture\SchemaLoader;
 // Load a schema dump file.
+
 (new SchemaLoader())->loadSqlFiles('tests/schema.sql', 'test');
diff --git a/tests/test_app/config/plugins.php b/tests/test_app/config/plugins.php
@@ -1,4 +1,4 @@
 <?php
 return [
-    'ApiTokenAuthenticator' => []
+    'ApiTokenAuthenticator' => [],
 ];
diff --git a/tests/test_app/src/Application.php b/tests/test_app/src/Application.php
@@ -1,25 +1,24 @@
 <?php
-
 declare(strict_types=1);
 
 namespace TestApp;
 
-use Cake\Http\BaseApplication;
-use Cake\Http\MiddlewareQueue;
-use Cake\Routing\RouteBuilder;
 use Cake\Core\ContainerInterface;
-use Cake\Routing\Route\DashedRoute;
+use Cake\Http\BaseApplication;
 use Cake\Http\Middleware\BodyParserMiddleware;
+use Cake\Http\MiddlewareQueue;
 use Cake\Routing\Middleware\RoutingMiddleware;
+use Cake\Routing\Route\DashedRoute;
+use Cake\Routing\RouteBuilder;
 
 class Application extends BaseApplication
 {
-
     public function routes(RouteBuilder $routes): void
     {
         $routes->setRouteClass(DashedRoute::class);
         $routes->scope(
-            '/', function (RouteBuilder $builder): void {
+            '/',
+            function (RouteBuilder $builder): void {
                 $builder->setExtensions(['json']);
                 $builder->resources('Users');
                 $builder->fallbacks();
@@ -30,7 +29,7 @@ public function routes(RouteBuilder $routes): void
     public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
     {
         return $middlewareQueue->add(new RoutingMiddleware($this))
-            ->add(new BodyParserMiddleware());;
+            ->add(new BodyParserMiddleware());
     }
 
     public function services(ContainerInterface $container): void

diff --git a/tests/test_app/src/Controller/AppController.php b/tests/test_app/src/Controller/AppController.php
@@ -1,5 +1,4 @@
 <?php
-
 declare(strict_types=1);
 
 namespace TestApp\Controller;