Merge pull request #132 from phil-davis/php-cs-fixer-3-for-5.1

chore: allow php-cs-fixer major version 3

Author: phil-davis

.github/workflows/ci.yml

@@ -14,13 +14,16 @@ jobs:
       matrix:
         php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
         coverage: ['pcov']
+        code-style: ['yes']
         code-analysis: ['no']
         include:
           - php-versions: '7.1'
             coverage: 'none'
+            code-style: 'yes'
             code-analysis: 'yes'
           - php-versions: '8.4'
             coverage: 'pcov'
+            code-style: 'yes'
             code-analysis: 'yes'
     steps:
       - name: Checkout
@@ -51,7 +54,7 @@ jobs:
         run: composer install --no-progress --prefer-dist --optimize-autoloader
 
       - name: Code Analysis (PHP CS-Fixer)
-        if: matrix.code-analysis == 'yes'
+        if: matrix.code-style == 'yes'
         run: PHP_CS_FIXER_IGNORE_ENV=true php vendor/bin/php-cs-fixer fix --dry-run --diff
 
       - name: Code Analysis (PHPStan)

.gitignore

@@ -6,3 +6,4 @@ composer.lock
 tests/cov
 tests/.phpunit.result.cache
 .php_cs.cache
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,18 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude('vendor')
+    ->in(__DIR__);
+
+$config = new PhpCsFixer\Config();
+$config->setRules([
+    '@PSR1' => true,
+    '@Symfony' => true,
+    'blank_line_between_import_groups' => false,
+    'nullable_type_declaration' => [
+        'syntax' => 'question_mark',
+    ],
+    'nullable_type_declaration_for_default_null_value' => true,
+]);
+$config->setFinder($finder);
+return $config;

.php_cs.dist

@@ -6,7 +6,12 @@ $config->getFinder()
     ->in(__DIR__);
 $config->setRules([
     '@PSR1' => true,
-    '@Symfony' => true
+    '@Symfony' => true,
+    'ordered_imports' => [
+        'imports_order' => [
+            'class', 'function', 'const',
+        ],
+    ],
 ]);
 
 return $config;

composer.json

@@ -46,7 +46,7 @@
         }
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "~2.17.1",
+        "friendsofphp/php-cs-fixer": "~2.17.1||^3.63",
         "phpstan/phpstan": "^0.12",
         "phpunit/phpunit" : "^7.5 || ^8.5 || ^9.6"
     },
@@ -55,7 +55,7 @@
             "phpstan analyse lib tests"
         ],
         "cs-fixer": [
-            "php-cs-fixer fix"
+            "PHP_CS_FIXER_IGNORE_ENV=true php-cs-fixer fix"
         ],
         "phpunit": [
             "phpunit --configuration tests/phpunit.xml"

examples/curl.php

@@ -1,5 +1,7 @@
 #!/usr/bin/env php
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 /*
  * The following example demonstrates doing asynchronous HTTP requests with
@@ -26,10 +28,10 @@
 curl_setopt_array($ch1, CURLOPT_URL, 'http://httpbin.org/delay/5');
 curl_setopt_array($ch2, CURLOPT_URL, 'http://httpbin.org/delay/5');
 
-//create the multiple cURL handle
+// create the multiple cURL handle
 $mh = curl_multi_init();
 
-//add the two handles
+// add the two handles
 curl_multi_add_handle($mh, $ch1);
 curl_multi_add_handle($mh, $ch2);
 
@@ -112,7 +114,7 @@ function curl_multi_loop_scheduler($mh, callable $done)
 
 Loop\run();
 
-//close the handles
+// close the handles
 curl_multi_remove_handle($mh, $ch1);
 curl_multi_remove_handle($mh, $ch2);
 curl_multi_close($mh);

examples/promise.php

@@ -1,9 +1,11 @@
 #!/usr/bin/env php
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
-use function Sabre\Event\coroutine;
 use Sabre\Event\Loop;
 use Sabre\Event\Promise;
+use function Sabre\Event\coroutine;
 
 require __DIR__.'/../vendor/autoload.php';
 
@@ -25,6 +27,7 @@
 $result = $promise
     ->then(function ($value) {
         echo "Step 2\n";
+
         // Immediately returning a new value.
         return $value.' world';
     })
@@ -42,6 +45,7 @@
     })
     ->then(function ($value) {
         echo "Step 4\n";
+
         // This is the final event handler.
         return $value.' you rock!';
     })

examples/tail.php

@@ -1,5 +1,7 @@
 #!/usr/bin/env php
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 /*
  * This example can be used to logfile processing and basically wraps the tail

lib/Loop/Loop.php

@@ -24,7 +24,7 @@ class Loop
      */
     public function setTimeout(callable $cb, float $timeout)
     {
-        $triggerTime = microtime(true) + ($timeout);
+        $triggerTime = microtime(true) + $timeout;
 
         if (!$this->timers) {
             // Special case when the timers array was empty.

lib/Promise.php

@@ -5,7 +5,6 @@
 namespace Sabre\Event;
 
 use Exception;
-use Throwable;
 
 /**
  * An implementation of the Promise pattern.
@@ -30,17 +29,17 @@ class Promise
     /**
      * The asynchronous operation is pending.
      */
-    const PENDING = 0;
+    public const PENDING = 0;
 
     /**
      * The asynchronous operation has completed, and has a result.
      */
-    const FULFILLED = 1;
+    public const FULFILLED = 1;
 
     /**
      * The asynchronous operation has completed with an error.
      */
-    const REJECTED = 2;
+    public const REJECTED = 2;
 
     /**
      * The current state of this promise.
@@ -128,8 +127,6 @@ public function otherwise(callable $onRejected): Promise
 
     /**
      * Marks this promise as fulfilled and sets its return value.
-     *
-     * @param mixed $value
      */
     public function fulfill($value = null)
     {
@@ -146,7 +143,7 @@ public function fulfill($value = null)
     /**
      * Marks this promise as rejected, and set its rejection reason.
      */
-    public function reject(Throwable $reason)
+    public function reject(\Throwable $reason)
     {
         if (self::PENDING !== $this->state) {
             throw new PromiseAlreadyResolvedException('This promise is already resolved, and you\'re not allowed to resolve a promise more than once');
@@ -169,7 +166,6 @@ public function reject(Throwable $reason)
      * one. In PHP it might be useful to call this on the last promise in a
      * chain.
      *
-     * @return mixed
      * @psalm-return TReturn
      */
     public function wait()
@@ -208,10 +204,8 @@ public function wait()
      *
      * If the promise was fulfilled, this will be the result value. If the
      * promise was rejected, this property hold the rejection reason.
-     *
-     * @var mixed
      */
-    protected $value = null;
+    protected $value;
 
     /**
      * This method is used to call either an onFulfilled or onRejected callback.
@@ -242,7 +236,7 @@ private function invokeCallback(Promise $subPromise, ?callable $callBack = null)
                         // immediately fulfill the chained promise.
                         $subPromise->fulfill($result);
                     }
-                } catch (Throwable $e) {
+                } catch (\Throwable $e) {
                     // If the event handler threw an exception, we need to make sure that
                     // the chained promise is rejected as well.
                     $subPromise->reject($e);