allow php8 and upgrade to cs-fixer 3.0

Author: basz

.gitignore

@@ -1,4 +1,4 @@
 composer.lock
 vendor/*
-.php_cs.cache
+.php-cs-fixer.cache
 

.php_cs .php-cs-fixer.php

@@ -8,9 +8,9 @@
  *
  * @see       https://bushbaby.nl/
  *
- * @copyright Copyright (c) 2016-2019 prooph software GmbH <[email protected]>
- * @copyright Copyright (c) 2016-2019 Sascha-Oliver Prolic <[email protected]>.
- * @copyright Copyright (c) 2010-2019 bushbaby multimedia. (https://bushbaby.nl)
+ * @copyright Copyright (c) 2016-2021 prooph software GmbH <[email protected]>
+ * @copyright Copyright (c) 2016-2021 Sascha-Oliver Prolic <[email protected]>.
+ * @copyright Copyright (c) 2010-2021 bushbaby multimedia. (https://bushbaby.nl)
  * @author    Bas Kamer <[email protected]>
  * @license   MIT
  *
@@ -20,10 +20,10 @@
 declare(strict_types=1);
 
 $config = new \Bsb\CS\Config();
-$config->getFinder()->in(__DIR__)->exclude([])->append(['.php_cs']);
+$config->getFinder()->in(__DIR__)->exclude([])->append(['.php-cs-fixer.php']);
 
-$cacheDir = \getenv('TRAVIS') ? \getenv('HOME') . '/.php-cs-fixer' : __DIR__;
+$cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__;
 
-$config->setCacheFile($cacheDir . '/.php_cs.cache');
+$config->setCacheFile($cacheDir . '/.php-cs-fixer.cache');
 
 return $config;

README.md

@@ -16,7 +16,7 @@ $ composer require --dev bushbaby/php-cs-fixer-config
 
 ### Configuration
 
-Create a configuration file `.php_cs` in the root of your project:
+Create a configuration file `.php-cs-fixer.php` in the root of your project:
 
 ```php
 <?php
@@ -26,23 +26,23 @@ $config->getFinder()->in(__DIR__);
 
 $cacheDir = getenv('TRAVIS') ? getenv('HOME') . '/.php-cs-fixer' : __DIR__;
 
-$config->setCacheFile($cacheDir . '/.php_cs.cache');
+$config->setCacheFile($cacheDir . '/.php-cs-fixer.cache');
 
 return $config;
 ```
 
 ### Git
 
-Add `.php_cs.cache` (this is the cache file created by `php-cs-fixer`) to `.gitignore`:
+Add `.php-cs-fixer.cache` (this is the cache file created by `php-cs-fixer`) to `.gitignore`:
 
 ```
 vendor/
-.php_cs.cache
+.php-cs-fixer.cache
 ```
 
 ### Travis
 
-Update your `.travis.yml` to cache the `php_cs.cache` file:
+Update your `.travis.yml` to cache the `.php-cs-fixer` directory:
 
 ```yml
 cache:
@@ -54,12 +54,12 @@ Then run `php-cs-fixer` in the `script` section:
 
 ```yml
 script:
-  - vendor/bin/php-cs-fixer fix --config=.php_cs --verbose --diff --dry-run
+  - vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --verbose --diff --dry-run
 ```
 
 ### GitLab
 
-Update your `.gitlab-ci` to cache the `php_cs.cache` file:
+Update your `.gitlab-ci` to cache the `.php-cs-fixer.cache` file:
 
 ```
   script:
@@ -76,52 +76,6 @@ If you need to fix issues locally, just run
 $ ./vendor/bin/php-cs-fixer fix -v
 ```
 
-### Pre-commit hook
-
-You can add a `pre-commit` hook
-
-```
-$ touch .git/pre-commit && chmod +x .git/pre-commit
-```
- 
-Paste this into `.git/pre-commit`:
-
-```bash
-#!/usr/bin/env bash
-
-echo "pre commit hook start"
-
-CURRENT_DIRECTORY=`pwd`
-GIT_HOOKS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-
-PROJECT_DIRECTORY="$GIT_HOOKS_DIR/../.."
-
-cd $PROJECT_DIRECTORY;
-PHP_CS_FIXER="vendor/bin/php-cs-fixer"
-
-HAS_PHP_CS_FIXER=false
-
-if [ -x "$PHP_CS_FIXER" ]; then
-    HAS_PHP_CS_FIXER=true
-fi
-
-if $HAS_PHP_CS_FIXER; then
-    git status --porcelain | grep -e '^[AM]\(.*\).php$' | cut -c 3- | while read line; do
-        ${PHP_CS_FIXER} fix --config-file=.php_cs --verbose ${line};
-        git add "$line";
-    done
-else
-    echo ""
-    echo "Please install php-cs-fixer, e.g.:"
-    echo ""
-    echo "  composer require friendsofphp/php-cs-fixer:2.0.0"
-    echo ""
-fi
-
-cd $CURRENT_DIRECTORY;
-echo "pre commit hook finish"
-```
- 
 ## License
 
 This package is licensed using the MIT License.

composer.json

@@ -19,12 +19,16 @@
     }
   ],
   "require": {
-    "php": "^7.1",
-    "friendsofphp/php-cs-fixer": "^2.1"
+    "php": "^7.1.3 || ^8.0",
+    "friendsofphp/php-cs-fixer": "^3.0"
   },
   "autoload": {
     "psr-4": {
       "Bsb\\CS\\": "src"
     }
+  },
+  "scripts": {
+    "php-check": "php-cs-fixer fix --dry-run",
+    "php-fix": "php-cs-fixer fix"
   }
 }

src/Config.php

@@ -8,9 +8,9 @@
  *
  * @see       https://bushbaby.nl/
  *
- * @copyright Copyright (c) 2016-2019 prooph software GmbH <[email protected]>
- * @copyright Copyright (c) 2016-2019 Sascha-Oliver Prolic <[email protected]>.
- * @copyright Copyright (c) 2010-2019 bushbaby multimedia. (https://bushbaby.nl)
+ * @copyright Copyright (c) 2016-2021 prooph software GmbH <[email protected]>
+ * @copyright Copyright (c) 2016-2021 Sascha-Oliver Prolic <[email protected]>.
+ * @copyright Copyright (c) 2010-2021 bushbaby multimedia. (https://bushbaby.nl)
  * @author    Bas Kamer <[email protected]>
  * @license   MIT
  *
@@ -33,13 +33,9 @@ class Config extends PhpCsFixerConfig
         '@PSR2' => true,
         '@Symfony' => true,
         'array_syntax' => ['syntax' => 'short'],
-        'binary_operator_spaces' => [
-            'align_double_arrow' => false,
-            'align_equals' => false,
-        ],
-        'blank_line_after_namespace' => true,
+         'blank_line_after_namespace' => true,
         'blank_line_after_opening_tag' => true,
-        'blank_line_before_return' => true,
+        'blank_line_before_statement' => true,
         'braces' => true,
         'cast_spaces' => true,
         'class_definition' => true,
@@ -51,9 +47,9 @@ class Config extends PhpCsFixerConfig
         'full_opening_tag' => true,
         'function_declaration' => true,
         'function_typehint_space' => true,
-        'hash_to_slash_comment' => true,
+        'single_line_comment_style' => true,
         'header_comment' => [
-            'commentType' => 'PHPDoc',
+            'comment_type' => 'PHPDoc',
             'header' => 'Bushbaby was here at `%package%` in `%year%`! Please create a .docheader in the project root and run `composer cs-fix`',
             'location' => 'after_open',
             'separate' => 'both',
@@ -62,10 +58,10 @@ class Config extends PhpCsFixerConfig
         'indentation_type' => true,
         'line_ending' => true,
         'linebreak_after_opening_tag' => true,
-        'lowercase_constants' => true,
+        'constant_case' => true,
         'lowercase_keywords' => true,
         'method_argument_space' => true,
-        'method_separation' => true,
+        'class_attributes_separation' => true,
         'modernize_types_casting' => true,
         'native_function_casing' => true,
         'native_function_invocation' => true,
@@ -74,13 +70,13 @@ class Config extends PhpCsFixerConfig
         'no_blank_lines_after_class_opening' => true,
         'no_closing_tag' => true,
         'no_empty_statement' => true,
-        'no_extra_consecutive_blank_lines' => true,
+        'no_extra_blank_lines' => true,
         'no_leading_import_slash' => true,
         'no_leading_namespace_whitespace' => true,
         'no_multiline_whitespace_around_double_arrow' => true,
-        'no_multiline_whitespace_before_semicolons' => true,
+        'multiline_whitespace_before_semicolons' => true,
         'no_short_bool_cast' => true,
-        'no_short_echo_tag' => true,
+        'echo_tag_syntax' => ['format' => 'long'],
         'no_singleline_whitespace_before_semicolons' => true,
         'no_spaces_around_offset' => true,
         'no_spaces_inside_parenthesis' => true,
@@ -99,8 +95,10 @@ class Config extends PhpCsFixerConfig
         'object_operator_without_whitespace' => true,
         'ordered_imports' => true,
         'phpdoc_indent' => true,
-        'phpdoc_inline_tag' => true,
-        'psr4' => true,
+        'general_phpdoc_tag_rename' => true,
+        'phpdoc_inline_tag_normalizer' => true,
+        'phpdoc_tag_type' => true,
+        'psr_autoloading' => true,
         'return_type_declaration' => true,
         'semicolon_after_instruction' => true,
         'short_scalar_cast' => true,
@@ -115,7 +113,7 @@ class Config extends PhpCsFixerConfig
         'switch_case_semicolon_to_colon' => true,
         'switch_case_space' => true,
         'ternary_operator_spaces' => true,
-        'trailing_comma_in_multiline_array' => true,
+        'trailing_comma_in_multiline' => ['elements' => ['arrays']],
         'trim_array_spaces' => true,
         'unary_operator_spaces' => true,
         'visibility_required' => true,
@@ -126,7 +124,7 @@ public function __construct(array $overrides = [])
     {
         parent::__construct('bushbaby php-cs-fixer-config');
 
-        $this->setRules(\array_merge($this->defaults, $overrides));
+        $this->setRules(array_merge($this->defaults, $overrides));
         $this->setRiskyAllowed(true);
     }
 
@@ -141,23 +139,23 @@ public function getRules(): array
 
     private function headerComment(array $rules): array
     {
-        if (\file_exists('.docheader')) {
-            $header = \file_get_contents('.docheader');
+        if (file_exists('.docheader')) {
+            $header = file_get_contents('.docheader');
         } else {
             $header = $rules['header'];
         }
 
         // remove comments from existing .docheader or crash
-        $header = \str_replace(['/**', ' */', ' * ', ' *'], '', $header);
+        $header = str_replace(['/**', ' */', ' * ', ' *'], '', $header);
         $package = 'unknown';
 
-        if (\file_exists('composer.json')) {
-            $package = \json_decode(\file_get_contents('composer.json'))->name ?? 'unknown/unknown';
+        if (file_exists('composer.json')) {
+            $package = json_decode(file_get_contents('composer.json'))->name ?? 'unknown/unknown';
         }
 
-        $header = \str_replace(['%package%', '%year%'], [$package, (new \DateTime('now'))->format('Y')], $header);
+        $header = str_replace(['%package%', '%year%'], [$package, (new \DateTime('now'))->format('Y')], $header);
 
-        $rules['header'] = \trim($header);
+        $rules['header'] = trim($header);
 
         return $rules;
     }