Added additional tools, updated components, docs.

Author: dmitriy

.circleci/config.yml

@@ -10,7 +10,7 @@ jobs:
       - checkout
 
       - run:
-          name: Start container and verify it's working
+          name: Start containers and verify it's working
           command: |
             make start-test
 
@@ -37,6 +37,26 @@ jobs:
             make ecs
             make phpcs
 
+      - run:
+          name: Run PHP copy/paste detector
+          command: |
+            make phpcpd
+
+      - run:
+          name: Run PHP mess detector
+          command: |
+            make phpmd
+
+      - run:
+          name: Run PHPStan static analysis tool
+          command: |
+            make phpstan
+
+      - run:
+          name: Run Phpinsights PHP quality checks
+          command: |
+            make phpinsights
+
       - store_artifacts:
           path: reports
 

.dockerignore

@@ -10,6 +10,7 @@ bootstrap/cache
 .phpstorm.meta.php
 Dockerfile
 _ide_helper.php
+Dockerfile
 docker-compose.yml
 docker-compose-test-ci.yml
 docker-compose-staging.yml

.github/workflows/ci.yml

@@ -34,9 +34,17 @@ jobs:
               run: make seed
             - name: Run test suite
               run: make phpunit
-            - name: Run coding standard
+            - name: Run PHP coding standard
               run: make ecs
-            - name: Run codeSniffer
+            - name: Run PHP codeSniffer
               run: make phpcs
+            - name: Run PHP copy/paste detector
+              run: make phpcpd
+            - name: Run PHP mess detector
+              run: make phpmd
+            - name: Run PHPStan static analysis tool
+              run: make phpstan
+            - name: Run Phpinsights PHP quality checks
+              run: make phpinsights
             - name: Stop the docker images
               run: make stop-test

.gitlab-ci.yml

@@ -33,6 +33,10 @@ build:
     - make phpunit
     - make ecs
     - make phpcs
+    - make phpcpd
+    - make phpmd
+    - make phpstan
+    - make phpinsights
     - make stop-test
   artifacts:
     paths:

.php_cs.dist

@@ -0,0 +1,8 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR12' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+;

Makefile

@@ -140,15 +140,15 @@ report-code-coverage: ## update code coverage on coveralls.io. Note: COVERALLS_R
 
 ###> phpcs ###
 phpcs: ## Run PHP CodeSniffer
-	@make exec-bash cmd="./vendor/bin/phpcs --version && ./vendor/bin/phpcs --standard=PSR2 --colors -p app"
+	@make exec-bash cmd="./vendor/bin/phpcs --version && ./vendor/bin/phpcs --standard=PSR2 --colors -p app tests"
 ###< phpcs ###
 
 ###> ecs ###
 ecs: ## Run Easy Coding Standard
-	@make exec-bash cmd="error_reporting=0 ./vendor/bin/ecs --clear-cache check app"
+	@make exec-bash cmd="./vendor/bin/ecs --version && ./vendor/bin/ecs --clear-cache check app tests"
 
 ecs-fix: ## Run The Easy Coding Standard to fix issues
-	@make exec-bash cmd="error_reporting=0 ./vendor/bin/ecs --clear-cache --fix check app"
+	@make exec-bash cmd="./vendor/bin/ecs --version && ./vendor/bin/ecs --clear-cache --fix check app tests"
 ###< ecs ###
 
 ###> phpmetrics ###
@@ -165,3 +165,27 @@ phpmetrics-process: ## Generates PhpMetrics static analysis, should be run insid
 	@php ./vendor/bin/phpmetrics --version
 	@./vendor/bin/phpmetrics --junit=reports/junit.xml --report-html=reports/phpmetrics .
 ###< phpmetrics ###
+
+###> php copy/paste detector ###
+phpcpd:
+	@make exec cmd="php phpcpd.phar --fuzzy app tests"
+###< php copy/paste detector ###
+
+###> php mess detector ###
+phpmd:
+	@make exec cmd="php ./vendor/bin/phpmd app text phpmd_ruleset.xml --suffixes php"
+###< php mess detector ###
+
+###> PHPStan static analysis tool ###
+phpstan:
+	@echo "\033[32mRunning PHPStan - PHP Static Analysis Tool\033[39m"
+	@make exec cmd="php artisan cache:clear --env=test"
+	@make exec cmd="./vendor/bin/phpstan --version"
+	@make exec cmd="./vendor/bin/phpstan analyze app tests"
+###< PHPStan static analysis tool ###
+
+###> Phpinsights PHP quality checks ###
+phpinsights:
+	@echo "\033[32mRunning PHP Insights\033[39m"
+	@make exec cmd="php -d error_reporting=0 ./vendor/bin/phpinsights analyse --no-interaction --min-quality=100 --min-complexity=85 --min-architecture=100 --min-style=100"
+###< Phpinsights PHP quality checks ###

app/Console/Commands/DbWaitDatabase.php

@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace App\Console\Commands;
 
@@ -11,8 +11,6 @@ class DbWaitDatabase extends Command
 {
     /**
      * Wait sleep time for db connection in seconds
-     *
-     * @var int
      */
     private const WAIT_SLEEP_TIME = 2;
 
@@ -32,20 +30,16 @@ class DbWaitDatabase extends Command
 
     /**
      * Execute the console command.
-     *
-     * @param DB $db
-     *
-     * @return integer
      */
-    public function handle(DB $db): int
+    public function handle(DB $database): int
     {
         for ($i = 0; $i < 60; $i += self::WAIT_SLEEP_TIME) {
             try {
-                $db::select('SHOW TABLES');
+                $database::select('SHOW TABLES');
                 $this->info('Connection to the database is ok!');
 
                 return 0;
-            } catch (QueryException $e) {
+            } catch (QueryException $exception) {
                 $this->comment('Trying to connect to the database seconds:' . $i);
                 sleep(self::WAIT_SLEEP_TIME);
 

app/Console/Kernel.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Console;
 
@@ -16,8 +17,7 @@ class Kernel extends ConsoleKernel
 
     /**
      * Define the application's command schedule.
-     *
-     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
+     * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter
      */
     protected function schedule(Schedule $schedule): void
     {

app/Exceptions/Handler.php

@@ -1,8 +1,8 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Exceptions;
 
-use Exception;
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 
 class Handler extends ExceptionHandler
@@ -25,28 +25,9 @@ class Handler extends ExceptionHandler
     ];
 
     /**
-     * Report or log an exception.
-     *
-     * @param  \Exception  $exception
-     *
-     * @throws \Exception
-     */
-    public function report(Exception $exception): void
-    {
-        parent::report($exception);
-    }
-
-    /**
-     * Render an exception into an HTTP response.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Exception  $exception
-     * @return \Symfony\Component\HttpFoundation\Response
-     *
-     * @throws \Exception
+     * Register the exception handling callbacks for the application.
      */
-    public function render($request, Exception $exception)
+    public function register(): void
     {
-        return parent::render($request, $exception);
     }
 }

app/Http/Controllers/Auth/ConfirmPasswordController.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Controllers\Auth;
 

app/Http/Controllers/Auth/ForgotPasswordController.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Controllers\Auth;
 

app/Http/Controllers/Auth/LoginController.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Controllers\Auth;
 

app/Http/Controllers/Auth/RegisterController.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Controllers\Auth;
 
@@ -42,7 +43,6 @@ public function __construct()
     /**
      * Get a validator for an incoming registration request.
      *
-     * @param  array  $data
      * @return \Illuminate\Contracts\Validation\Validator
      */
     protected function validator(array $data)
@@ -57,7 +57,6 @@ protected function validator(array $data)
     /**
      * Create a new user instance after a valid registration.
      *
-     * @param  array  $data
      * @return \App\User
      */
     protected function create(array $data)

app/Http/Controllers/Auth/ResetPasswordController.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Controllers\Auth;
 

app/Http/Controllers/Auth/VerificationController.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Controllers\Auth;
 

app/Http/Controllers/Controller.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Controllers;
 

app/Http/Kernel.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http;
 

app/Http/Middleware/Authenticate.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Middleware;
 
@@ -17,5 +18,7 @@ protected function redirectTo($request)
         if (!$request->expectsJson()) {
             return route('login');
         }
+
+        return null;
     }
 }

app/Http/Middleware/CheckForMaintenanceMode.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Middleware;
 

app/Http/Middleware/EncryptCookies.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Middleware;
 

app/Http/Middleware/RedirectIfAuthenticated.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Middleware;
 
@@ -12,7 +13,6 @@ class RedirectIfAuthenticated
      * Handle an incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
      * @param  string|null  $guard
      * @return mixed
      */

app/Http/Middleware/TrimStrings.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Middleware;
 

app/Http/Middleware/TrustProxies.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Middleware;
 

app/Http/Middleware/VerifyCsrfToken.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Http\Middleware;
 

app/Providers/AppServiceProvider.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Providers;
 

app/Providers/AuthServiceProvider.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Providers;
 

app/Providers/BroadcastServiceProvider.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Providers;
 

app/Providers/EventServiceProvider.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Providers;
 

app/Providers/RouteServiceProvider.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App\Providers;
 
@@ -9,8 +10,6 @@ class RouteServiceProvider extends ServiceProvider
 {
     /**
      * The path to the "home" route for your application.
-     *
-     * @var string
      */
     public const HOME = '/home';
 

app/User.php

@@ -1,4 +1,5 @@
 <?php
+declare(strict_types = 1);
 
 namespace App;