Update PHP language syntax, documentation, and tests

reactphp · Feb 21, 2024 · 92d95c7 · 92d95c7
1 parent b013836
commit 92d95c7
Show file tree

Hide file tree

Showing 18 changed files with 79 additions and 81 deletions.
diff --git a/README.md b/README.md
@@ -353,7 +353,7 @@ By default, this will call `end()` on the destination stream once the
 source stream emits an `end` event. This can be disabled like this:
 
 ```php
-$source->pipe($dest, array('end' => false));
+$source->pipe($dest, ['end' => false]);
 ```
 
 Note that this only applies to the `end` event.
@@ -1126,7 +1126,7 @@ $through = new ThroughStream(function ($data) {
 });
 $through->on('data', $this->expectCallableOnceWith("[2, true]\n"));
 
-$through->write(array(2, true));
+$through->write([2, true]);
 ```
 
 The callback function is allowed to throw an `Exception`. In this case,

diff --git a/composer.json b/composer.json
@@ -31,7 +31,7 @@
         "evenement/evenement": "^3.0 || ^2.0 || ^1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.6 || ^5.7",
+        "phpunit/phpunit": "^9.6 || ^7.5",
         "clue/stream-filter": "~1.2"
     },
     "autoload": {

diff --git a/phpunit.xml.legacy b/phpunit.xml.legacy
@@ -2,7 +2,7 @@
 
 <!-- PHPUnit configuration file with old format for legacy PHPUnit -->
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/5.7/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.5/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          colors="true">
     <testsuites>

diff --git a/src/CompositeStream.php b/src/CompositeStream.php
@@ -20,11 +20,11 @@ public function __construct(ReadableStreamInterface $readable, WritableStreamInt
             return;
         }
 
-        Util::forwardEvents($this->readable, $this, array('data', 'end', 'error'));
-        Util::forwardEvents($this->writable, $this, array('drain', 'error', 'pipe'));
+        Util::forwardEvents($this->readable, $this, ['data', 'end', 'error']);
+        Util::forwardEvents($this->writable, $this, ['drain', 'error', 'pipe']);
 
-        $this->readable->on('close', array($this, 'close'));
-        $this->writable->on('close', array($this, 'close'));
+        $this->readable->on('close', [$this, 'close']);
+        $this->writable->on('close', [$this, 'close']);
     }
 
     public function isReadable()
@@ -46,7 +46,7 @@ public function resume()
         $this->readable->resume();
     }
 
-    public function pipe(WritableStreamInterface $dest, array $options = array())
+    public function pipe(WritableStreamInterface $dest, array $options = [])
     {
         return Util::pipe($this, $dest, $options);
     }

diff --git a/src/DuplexResourceStream.php b/src/DuplexResourceStream.php
@@ -80,10 +80,10 @@ public function __construct($stream, LoopInterface $loop = null, $readChunkSize
         $that = $this;
 
         $this->buffer->on('error', function ($error) use ($that) {
-            $that->emit('error', array($error));
+            $that->emit('error', [$error]);
         });
 
-        $this->buffer->on('close', array($this, 'close'));
+        $this->buffer->on('close', [$this, 'close']);
 
         $this->buffer->on('drain', function () use ($that) {
             $that->emit('drain');
@@ -113,7 +113,7 @@ public function pause()
     public function resume()
     {
         if (!$this->listening && $this->readable) {
-            $this->loop->addReadStream($this->stream, array($this, 'handleData'));
+            $this->loop->addReadStream($this->stream, [$this, 'handleData']);
             $this->listening = true;
         }
     }
@@ -163,7 +163,7 @@ public function end($data = null)
         $this->buffer->end($data);
     }
 
-    public function pipe(WritableStreamInterface $dest, array $options = array())
+    public function pipe(WritableStreamInterface $dest, array $options = [])
     {
         return Util::pipe($this, $dest, $options);
     }
@@ -187,13 +187,13 @@ public function handleData($stream)
         \restore_error_handler();
 
         if ($error !== null) {
-            $this->emit('error', array(new \RuntimeException('Unable to read from stream: ' . $error->getMessage(), 0, $error)));
+            $this->emit('error', [new \RuntimeException('Unable to read from stream: ' . $error->getMessage(), 0, $error)]);
             $this->close();
             return;
         }
 
         if ($data !== '') {
-            $this->emit('data', array($data));
+            $this->emit('data', [$data]);
         } elseif (\feof($this->stream)) {
             // no data read => we reached the end and close the stream
             $this->emit('end');

diff --git a/src/ReadableResourceStream.php b/src/ReadableResourceStream.php
@@ -93,12 +93,12 @@ public function pause()
     public function resume()
     {
         if (!$this->listening && !$this->closed) {
-            $this->loop->addReadStream($this->stream, array($this, 'handleData'));
+            $this->loop->addReadStream($this->stream, [$this, 'handleData']);
             $this->listening = true;
         }
     }
 
-    public function pipe(WritableStreamInterface $dest, array $options = array())
+    public function pipe(WritableStreamInterface $dest, array $options = [])
     {
         return Util::pipe($this, $dest, $options);
     }
@@ -139,13 +139,13 @@ public function handleData()
         \restore_error_handler();
 
         if ($error !== null) {
-            $this->emit('error', array(new \RuntimeException('Unable to read from stream: ' . $error->getMessage(), 0, $error)));
+            $this->emit('error', [new \RuntimeException('Unable to read from stream: ' . $error->getMessage(), 0, $error)]);
             $this->close();
             return;
         }
 
         if ($data !== '') {
-            $this->emit('data', array($data));
+            $this->emit('data', [$data]);
         } elseif (\feof($this->stream)) {
             // no data read => we reached the end and close the stream
             $this->emit('end');

diff --git a/src/ReadableStreamInterface.php b/src/ReadableStreamInterface.php
@@ -278,7 +278,7 @@ public function resume();
      * source stream emits an `end` event. This can be disabled like this:
      *
      * ```php
-     * $source->pipe($dest, array('end' => false));
+     * $source->pipe($dest, ['end' => false]);
      * ```
      *
      * Note that this only applies to the `end` event.
@@ -322,7 +322,7 @@ public function resume();
      * @param array $options
      * @return WritableStreamInterface $dest stream as-is
      */
-    public function pipe(WritableStreamInterface $dest, array $options = array());
+    public function pipe(WritableStreamInterface $dest, array $options = []);
 
     /**
      * Closes the stream (forcefully).

diff --git a/src/ThroughStream.php b/src/ThroughStream.php
@@ -48,7 +48,7 @@
  * });
  * $through->on('data', $this->expectCallableOnceWith("[2, true]\n"));
  *
- * $through->write(array(2, true));
+ * $through->write([2, true]);
  * ```
  *
  * The callback function is allowed to throw an `Exception`. In this case,
@@ -108,7 +108,7 @@ public function resume()
         }
     }
 
-    public function pipe(WritableStreamInterface $dest, array $options = array())
+    public function pipe(WritableStreamInterface $dest, array $options = [])
     {
         return Util::pipe($this, $dest, $options);
     }
@@ -133,14 +133,14 @@ public function write($data)
             try {
                 $data = \call_user_func($this->callback, $data);
             } catch (\Exception $e) {
-                $this->emit('error', array($e));
+                $this->emit('error', [$e]);
                 $this->close();
 
                 return false;
             }
         }
 
-        $this->emit('data', array($data));
+        $this->emit('data', [$data]);
 
         // emit drain event on next resume if currently paused (throttled)
         if ($this->paused) {

diff --git a/src/Util.php b/src/Util.php
@@ -13,7 +13,7 @@ final class Util
      * @return WritableStreamInterface $dest stream as-is
      * @see ReadableStreamInterface::pipe() for more details
      */
-    public static function pipe(ReadableStreamInterface $source, WritableStreamInterface $dest, array $options = array())
+    public static function pipe(ReadableStreamInterface $source, WritableStreamInterface $dest, array $options = [])
     {
         // source not readable => NO-OP
         if (!$source->isReadable()) {
@@ -27,7 +27,7 @@ public static function pipe(ReadableStreamInterface $source, WritableStreamInter
             return $dest;
         }
 
-        $dest->emit('pipe', array($source));
+        $dest->emit('pipe', [$source]);
 
         // forward all source data events as $dest->write()
         $source->on('data', $dataer = function ($data) use ($source, $dest) {

diff --git a/src/WritableResourceStream.php b/src/WritableResourceStream.php
@@ -68,7 +68,7 @@ public function write($data)
         if (!$this->listening && $this->data !== '') {
             $this->listening = true;
 
-            $this->loop->addWriteStream($this->stream, array($this, 'handleWrite'));
+            $this->loop->addWriteStream($this->stream, [$this, 'handleWrite']);
         }
 
         return !isset($this->data[$this->softLimit - 1]);
@@ -137,7 +137,7 @@ public function handleWrite()
         // Should this turn out to be a permanent error later, it will eventually
         // send *nothing* and we can detect this.
         if (($sent === 0 || $sent === false) && $error !== null) {
-            $this->emit('error', array(new \RuntimeException('Unable to write to stream: ' . $error)));
+            $this->emit('error', [new \RuntimeException('Unable to write to stream: ' . $error)]);
             $this->close();
 
             return;

diff --git a/tests/CompositeStreamTest.php b/tests/CompositeStreamTest.php
@@ -217,7 +217,7 @@ public function itShouldReceiveForwardedEvents()
         $composite->on('data', $this->expectCallableOnce());
         $composite->on('drain', $this->expectCallableOnce());
 
-        $readable->emit('data', array('foo'));
+        $readable->emit('data', ['foo']);
         $writable->emit('drain');
     }
 
@@ -241,7 +241,7 @@ public function itShouldHandlePipingCorrectly()
 
         $input = new ThroughStream();
         $input->pipe($composite);
-        $input->emit('data', array('foo'));
+        $input->emit('data', ['foo']);
     }
 
     /** @test */
@@ -262,6 +262,6 @@ public function itShouldForwardPipeCallsToReadableStream()
             ->with('foo');
 
         $composite->pipe($output);
-        $readable->emit('data', array('foo'));
+        $readable->emit('data', ['foo']);
     }
 }
diff --git a/tests/DuplexResourceStreamIntegrationTest.php b/tests/DuplexResourceStreamIntegrationTest.php
@@ -17,40 +17,38 @@ class DuplexResourceStreamIntegrationTest extends TestCase
 {
     public function loopProvider()
     {
-        return array(
-            array(
-                function() {
-                    return true;
-                },
-                function () {
-                    return new StreamSelectLoop();
-                }
-            ),
-            array(
-                function () {
-                    return function_exists('event_base_new');
-                },
-                function () {
-                    return class_exists('React\EventLoop\ExtLibeventLoop') ? new ExtLibeventLoop() : new LibEventLoop();
-                }
-            ),
-            array(
-                function () {
-                    return class_exists('libev\EventLoop');
-                },
-                function () {
-                    return class_exists('React\EventLoop\ExtLibevLoop') ? new ExtLibevLoop() : new LibEvLoop();
-                }
-            ),
-            array(
-                function () {
-                    return class_exists('EventBase') && class_exists('React\EventLoop\ExtEventLoop');
-                },
-                function () {
-                    return new ExtEventLoop();
-                }
-            )
-        );
+        yield [
+            function() {
+                return true;
+            },
+            function () {
+                return new StreamSelectLoop();
+            }
+        ];
+        yield [
+            function () {
+                return function_exists('event_base_new');
+            },
+            function () {
+                return class_exists('React\EventLoop\ExtLibeventLoop') ? new ExtLibeventLoop() : new LibEventLoop();
+            }
+        ];
+        yield [
+            function () {
+                return class_exists('libev\EventLoop');
+            },
+            function () {
+                return class_exists('React\EventLoop\ExtLibevLoop') ? new ExtLibevLoop() : new LibEvLoop();
+            }
+        ];
+        yield [
+            function () {
+                return class_exists('EventBase') && class_exists('React\EventLoop\ExtEventLoop');
+            },
+            function () {
+                return new ExtEventLoop();
+            }
+        ];
     }
 
     /**

diff --git a/tests/DuplexResourceStreamTest.php b/tests/DuplexResourceStreamTest.php
@@ -427,7 +427,7 @@ public function testBufferEventsShouldBubbleUp()
         $conn->on('error', $this->expectCallableOnce());
 
         $buffer->emit('drain');
-        $buffer->emit('error', array(new \RuntimeException('Whoops')));
+        $buffer->emit('error', [new \RuntimeException('Whoops')]);
     }
 
     /**

diff --git a/tests/Stub/ReadableStreamStub.php b/tests/Stub/ReadableStreamStub.php
@@ -20,19 +20,19 @@ public function isReadable()
     // trigger data event
     public function write($data)
     {
-        $this->emit('data', array($data));
+        $this->emit('data', [$data]);
     }
 
     // trigger error event
     public function error($error)
     {
-        $this->emit('error', array($error));
+        $this->emit('error', [$error]);
     }
 
     // trigger end event
     public function end()
     {
-        $this->emit('end', array());
+        $this->emit('end', []);
     }
 
     public function pause()
@@ -52,7 +52,7 @@ public function close()
         $this->emit('close');
     }
 
-    public function pipe(WritableStreamInterface $dest, array $options = array())
+    public function pipe(WritableStreamInterface $dest, array $options = [])
     {
         Util::pipe($this, $dest, $options);
 

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -41,10 +41,10 @@ protected function createCallableMock()
     {
         if (method_exists('PHPUnit\Framework\MockObject\MockBuilder', 'addMethods')) {
             // PHPUnit 9+
-            return $this->getMockBuilder('stdClass')->addMethods(array('__invoke'))->getMock();
+            return $this->getMockBuilder('stdClass')->addMethods(['__invoke'])->getMock();
         } else {
-            // legacy PHPUnit 4 - PHPUnit 9
-            return $this->getMockBuilder('stdClass')->setMethods(array('__invoke'))->getMock();
+            // legacy PHPUnit
+            return $this->getMockBuilder('stdClass')->setMethods(['__invoke'])->getMock();
         }
     }
 

diff --git a/tests/ThroughStreamTest.php b/tests/ThroughStreamTest.php
@@ -185,7 +185,7 @@ public function pipingStuffIntoItShouldWork()
         $through->on('data', $this->expectCallableOnceWith('foo'));
 
         $readable->pipe($through);
-        $readable->emit('data', array('foo'));
+        $readable->emit('data', ['foo']);
     }
 
     /** @test */
@@ -243,7 +243,7 @@ public function writeAfterEndShouldReturnFalse()
     public function writeDataWillCloseStreamShouldReturnFalse()
     {
         $through = new ThroughStream();
-        $through->on('data', array($through, 'close'));
+        $through->on('data', [$through, 'close']);
 
         $this->assertFalse($through->write('foo'));
     }