Enforce PSR-12

Author: devdot

.gitlab-ci.yml

@@ -0,0 +1,23 @@
+
+# required for this CI Pipeline:
+#   - squizlabs/php_codesniffer
+#   - phpstan.neon file
+# recommended: captainhook/captainhook
+        
+
+default:
+  image: serversideup/php:8.1-cli
+
+stages:
+  - test
+
+cache:
+  paths:
+   - vendor/
+
+test_quality:
+  script:
+    - composer install
+    - vendor/bin/phpcs --standard=PSR12 -n src
+    # - vendor/bin/phpcs --standard=PSR12 -n tests --exclude=PSR1.Methods.CamelCapsMethodName
+    - vendor/bin/phpstan analyse

captainhook.json

@@ -0,0 +1,47 @@
+{
+    "commit-msg": {
+        "enabled": true,
+        "actions": []
+    },
+    "pre-push": {
+        "enabled": false,
+        "actions": []
+    },
+    "pre-commit": {
+        "enabled": true,
+        "actions": [
+            {
+                "action": "vendor/bin/phpcbf --standard=PSR12 src",
+                "options": []
+            },
+            {
+                "action": "vendor/bin/phpstan analyze",
+                "options": []
+            }
+        ]
+    },
+    "prepare-commit-msg": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-commit": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-merge": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-checkout": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-rewrite": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-change": {
+        "enabled": false,
+        "actions": []
+    }
+}

composer.json

@@ -35,6 +35,8 @@
         }
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^1.10",
+        "squizlabs/php_codesniffer": "^3.7",
+        "captainhook/captainhook": "^5.16"
     }
 }

src/Commands/AboutLog.php

@@ -32,13 +32,13 @@ class AboutLog extends Command
      * @return int
      */
     public function handle()
-    {   
-        // gather all channels as they are used     
+    {
+        // gather all channels as they are used
         $mainChannels = [
-            'Default Channel' => config('logging.default'), 
+            'Default Channel' => config('logging.default'),
             'Deprecations Channel' => config('logging.deprecations.channel'),
         ];
-       
+
         // now parse the main channels for their used channels
         $channels = [];
 
@@ -48,24 +48,24 @@ public function handle()
             ['level' => 'emergency'],
         );
 
-        foreach($mainChannels as $key => $channel) {
-            if($channel == null) {
+        foreach ($mainChannels as $key => $channel) {
+            if ($channel == null) {
                 // overwrite with null string
                 $mainChannels[$key] = self::STR_NULL;
                 continue;
             }
 
-            $channels[$channel] = config('logging.channels.'.$channel);
+            $channels[$channel] = config('logging.channels.' . $channel);
 
             // check if this channel has sub-channels
-            if(count(config('logging.channels.'.$channel.'.channels', []))) {
-                $subchannels = config('logging.channels.'.$channel.'.channels');
-                foreach($subchannels as $sub) {
-                    $channels[$sub] = config('logging.channels.'.$sub);
+            if (count(config('logging.channels.' . $channel . '.channels', []))) {
+                $subchannels = config('logging.channels.' . $channel . '.channels');
+                foreach ($subchannels as $sub) {
+                    $channels[$sub] = config('logging.channels.' . $sub);
                 }
 
                 // update the channel string for this main channel
-                $mainChannels[$key] = $channel.': '.implode(', ', $subchannels);
+                $mainChannels[$key] = $channel . ': ' . implode(', ', $subchannels);
             }
         }
 
@@ -77,27 +77,29 @@ public function handle()
         CommandHelper::displaySection($this, 'Logging Configuration', array_merge($config, $mainChannels));
 
         // get data from channels
-        foreach($channels as $channel => $config) {
+        foreach ($channels as $channel => $config) {
             // make sure each channel has driver and level
 
             // custom sort the config: first driver, level, path, rest alphabetical
             $arr = [
                 'driver' => $config['driver'] ?? null,
                 'level' => $config['level'] ?? null,
             ];
-            if(isset($config['path'])) $arr['path'] = $config['path'];
+            if (isset($config['path'])) {
+                $arr['path'] = $config['path'];
+            }
             ksort($config);
             $config = array_merge($arr, $config);
 
             $display = [];
             // now sift through the config
-            foreach($config as $key => $value) {
+            foreach ($config as $key => $value) {
                 // make arrays into strings
-                if(is_array($value)) {
+                if (is_array($value)) {
                     $value = implode(', ', $value);
                 }
 
-                switch($key) {
+                switch ($key) {
                     // filter away what shouldnt be shown
                     case 'username':
                     case 'password':
@@ -107,11 +109,10 @@ public function handle()
                         break;
                     case 'path':
                         // now check if this file exists and when it was modified
-                        if(file_exists($value)) {
-                            $value = '<fg=gray><'.date('Y-m-d H:i:s', (int) filemtime($value)).'></> '.$value;
-                        }
-                        else {
-                            $value = '<fg=gray><file missing></> <fg=red>'.$value.'</>';
+                        if (file_exists($value)) {
+                            $value = '<fg=gray><' . date('Y-m-d H:i:s', (int) filemtime($value)) . '></> ' . $value;
+                        } else {
+                            $value = '<fg=gray><file missing></> <fg=red>' . $value . '</>';
                         }
                         break;
                     case 'level':
@@ -120,16 +121,16 @@ public function handle()
                         break;
                 }
 
-                if(is_bool($value)) {
+                if (is_bool($value)) {
                     $value = $value ? self::STR_TRUE : self::STR_FALSE;
                 }
 
                 $display[$key] = $value ?? self::STR_NULL;
             }
 
-            CommandHelper::displaySection($this, 'Channel: '.$channel, $display);
+            CommandHelper::displaySection($this, 'Channel: ' . $channel, $display);
         }
-        
+
         $this->newLine();
 
         return Command::SUCCESS;

src/Commands/ClearLog.php

@@ -31,25 +31,25 @@ class ClearLog extends Command
      * @return int
      */
     public function handle()
-    {   
+    {
         // make sure the all flag is set when no channel is provided
-        if(empty($this->argument('channel')) && $this->option('all') === false) {
+        if (empty($this->argument('channel')) && $this->option('all') === false) {
             $this->error('No channel name provided. If you wish to clear all logs, set the --all option explicitly.');
             return Command::INVALID;
         }
 
         // now create the channel driver objects safely
         $channels = [];
-        if($this->argument('channel')) {
+        if ($this->argument('channel')) {
             $channel = $this->argument('channel');
             $channels[] = (string) (is_array($channel) ? $channel[0] : $channel);
             // check if this channel is configured
-            if(empty(config('logging.channels.'.$channels[0]))) {
+            if (empty(config('logging.channels.' . $channels[0]))) {
                 $this->error('Channel is not configured!');
                 return Command::INVALID;
             }
         }
-        if($this->option('all')) {
+        if ($this->option('all')) {
             $channels = [
                 config('logging.default'),
                 config('logging.deprecations.channel'),
@@ -66,13 +66,13 @@ public function handle()
         // and load the files through the driver
         $files = $multidriver->getFilenames();
 
-        $this->line('Found '.count($files).' log files');
+        $this->line('Found ' . count($files) . ' log files');
 
         // loop through the files and clear them
-        foreach($files as $file) {
+        foreach ($files as $file) {
             $this->line($file);
             // clear the file
-            if(unlink($file) == false) {
+            if (unlink($file) == false) {
                 $this->error('Failed unlinking file!');
                 continue;
             }

src/Commands/SearchLog.php

@@ -6,7 +6,8 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 
-class SearchLog extends ShowLog {
+class SearchLog extends ShowLog
+{
     protected $description = 'Search through all log entries';
 
     /**
@@ -16,34 +17,38 @@ class SearchLog extends ShowLog {
         'search' => '',
     ];
 
-    public function __construct() {
+    public function __construct()
+    {
         // basically, we use the parent class and add an arugment
         parent::__construct();
         $this->addArgument('search', InputArgument::REQUIRED, 'Search term to be searched for in the logs.');
         $this->setName('log:search');
     }
 
-    public function handle() {
+    public function handle()
+    {
         // basically, we add the search term to the filter and then we let the parent function handle it normally
         $search = $this->argument('search');
         $this->filter['search'] = (string) (is_array($search) ? $search[0] : $search);
-        $this->line('Running search via log:show for <bg=yellow>'.$this->filter['search'].'</>');
+        $this->line('Running search via log:show for <bg=yellow>' . $this->filter['search'] . '</>');
         parent::handle();
 
         return Command::SUCCESS;
     }
 
-    protected function addHighlightingToRecord(LogRecord $record): LogRecord {
+    protected function addHighlightingToRecord(LogRecord $record): LogRecord
+    {
         $message = preg_replace(
             [
-                '/('.$this->filter['search'].')/i', 
-                '/\\\\<bg=yellow>('.$this->filter['search'].')<\/>/i', // the sequence \<bg=yellow> causes errors, even when everything is escaped like \\<...> (maybe a Symfony bug?)
+                '/(' . $this->filter['search'] . ')/i',
+                '/\\\\<bg=yellow>(' . $this->filter['search'] . ')<\/>/i', // the sequence \<bg=yellow> causes errors, even when everything is escaped like \\<...> (maybe a Symfony bug?)
             ],
             [
                 '<bg=yellow>$1</>',
                 '<bg=yellow>\\\\$1</>', // solution to the issue above: include the backslash in the highlighting
             ],
-            $record['message']);
+            $record['message']
+        );
         $driver = $record->getDriver();
         $record = new LogRecord(
             $record['datetime'],
@@ -57,16 +62,18 @@ protected function addHighlightingToRecord(LogRecord $record): LogRecord {
         return $record;
     }
 
-    protected function printRecord(LogRecord $record): void {
+    protected function printRecord(LogRecord $record): void
+    {
         // simply add highlighting and then let the parent handle it
         $record = $this->addHighlightingToRecord($record);
         parent::printRecord($record);
     }
 
-    protected function printRecordSingleline(LogRecord $record): void {
+    protected function printRecordSingleline(LogRecord $record): void
+    {
         // same as print Record
         // simply add highlighting and then let the parent handle it
         $record = $this->addHighlightingToRecord($record);
         parent::printRecordSingleline($record);
     }
-}
+}