Replace promise with future

Author: kelunik

src/Driver/ParallelFilesystemDriver.php

@@ -25,7 +25,7 @@ final class ParallelFilesystemDriver implements FilesystemDriver
     /** @var \SplObjectStorage Worker storage. */
     private \SplObjectStorage $workerStorage;
 
-    /** @var Future Pending worker request promise. */
+    /** @var Future Pending worker request */
     private Future $pendingWorker;
 
     /**

src/Filesystem.php

@@ -24,7 +24,7 @@ public function openFile(string $path, string $mode): File
     /**
      * Execute a file stat operation.
      *
-     * If the requested path does not exist the resulting Promise will resolve to NULL.
+     * If the requested path does not exist, it will return NULL.
      *
      * @param string $path File system path.
      */
@@ -36,7 +36,7 @@ public function getStatus(string $path): ?array
     /**
      * Same as {@see Filesystem::getStatus()} except if the path is a link then the link's data is returned.
      *
-     * If the requested path does not exist the resulting Promise will resolve to NULL.
+     * If the requested path does not exist, it will return NULL.
      *
      * @param string $path File system path.
      */
@@ -63,8 +63,7 @@ public function exists(string $path): bool
     /**
      * Retrieve the size in bytes of the file at the specified path.
      *
-     * If the path does not exist or is not a regular file this
-     * function's returned Promise WILL resolve as a failure.
+     * If the path does not exist or is not a regular file, this method will throw.
      *
      * @param string $path File system path.
      *
@@ -119,8 +118,7 @@ public function isFile(string $path): bool
     /**
      * Does the specified path exist and is it a symlink?
      *
-     * If the path does not exist the returned Promise will resolve
-     * to FALSE and will not reject with an error.
+     * If the path does not exist, this method will return FALSE.
      *
      * @param string $path File system path.
      */

src/FilesystemDriver.php

@@ -23,7 +23,7 @@ public function getStatus(string $path): ?array;
     /**
      * Same as {@see FilesystemDriver::getStatus()} except if the path is a link then the link's data is returned.
      *
-     * If the requested path does not exist the resulting Promise will resolve to NULL.
+     * If the requested path does not exist, this method will return NULL.
      *
      * @param string $path The file system path to stat.
      *
@@ -130,7 +130,7 @@ public function touch(string $path, ?int $modificationTime, ?int $accessTime): v
      *
      * @param string $path The file path from which to buffer contents.
      *
-     * @return string A promise resolving to a string upon successful resolution.
+     * @return string The file contents.
      *
      * @throws FilesystemException If the operation fails.
      */

test/AsyncFileTest.php

@@ -16,13 +16,13 @@ public function testSimultaneousReads()
 
         $handle = $this->driver->openFile(__FILE__, "r");
 
-        $promise1 = async(fn () => $handle->read(length: 20));
-        $promise2 = async(fn () => $handle->read(length: 20));
+        $future1 = async(fn () => $handle->read(length: 20));
+        $future2 = async(fn () => $handle->read(length: 20));
 
         $expected = \substr(File\read(__FILE__), 0, 20);
-        $this->assertSame($expected, $promise1->await());
+        $this->assertSame($expected, $future1->await());
 
-        $promise2->await();
+        $future2->await();
     }
 
     public function testSeekWhileReading()
@@ -31,13 +31,13 @@ public function testSeekWhileReading()
 
         $handle = $this->driver->openFile(__FILE__, "r");
 
-        $promise1 = async(fn () => $handle->read(length: 10));
-        $promise2 = async(fn () => $handle->read(length: 0));
+        $future1 = async(fn () => $handle->read(length: 10));
+        $future2 = async(fn () => $handle->read(length: 0));
 
         $expected = \substr(File\read(__FILE__), 0, 10);
-        $this->assertSame($expected, $promise1->await());
+        $this->assertSame($expected, $future1->await());
 
-        $promise2->await();
+        $future2->await();
     }
 
     public function testReadWhileWriting()
@@ -50,12 +50,12 @@ public function testReadWhileWriting()
 
         $data = "test";
 
-        $promise1 = async(fn () => $handle->write($data));
-        $promise2 = async(fn () => $handle->read(length: 10));
+        $future1 = async(fn () => $handle->write($data));
+        $future2 = async(fn () => $handle->read(length: 10));
 
-        $this->assertNull($promise1->await());
+        $this->assertNull($future1->await());
 
-        $promise2->await();
+        $future2->await();
     }
 
     public function testWriteWhileReading()
@@ -66,12 +66,12 @@ public function testWriteWhileReading()
 
         $handle = $this->driver->openFile($path, "c+");
 
-        $promise1 = async(fn () => $handle->read(length: 10));
-        $promise2 = async(fn () => $handle->write("test"));
+        $future1 = async(fn () => $handle->read(length: 10));
+        $future2 = async(fn () => $handle->write("test"));
 
-        $this->assertNull($promise1->await());
+        $this->assertNull($future1->await());
 
-        $promise2->await();
+        $future2->await();
     }
 
     public function testCancelReadThenReadAgain()