Merge pull request #2 from ace411/v0.x

v0.x changes

Author: ace411

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.2', '7.3', '7.4', '8.0']
+        php: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
     name: PHP ${{ matrix.php }}
     steps:
       - uses: actions/checkout@v1

README.md

@@ -36,30 +36,27 @@ $ composer require chemem/asyncify
 If you want to take a Functional Programming approach, facilitated by currying, the example below should suffice.
 
 ```php
-use React\EventLoop\Loop;
 use function Chemem\Asyncify\call;
 
-$call = call(Loop::get(), __DIR__);
-
-$exec = $call('file_get_contents', ['foo.txt'])->then(
-  function (?string $contents) {
-    echo $contents;
-  },
-  function (\Throwable $err) {
-    echo $err->getMessage();
-  }
-);
+$call = call('file_get_contents', ['foo.txt'])
+  ->then(
+    function (?string $contents) {
+      echo $contents;
+    },
+    function (\Throwable $err) {
+      echo $err->getMessage();
+    }
+  );
 ```
 
 ### Or
 
 If you prefer a more conventional OOP approach, the snippet below should prove apt.
 
 ```php
-use React\EventLoop\Loop;
 use Chemem\Asyncify\Async;
 
-$exec = Async::create(Loop::get())
+$exec = Async::create()
   ->call('file_get_contents', ['foo.txt'])
   ->then(
     function (?string $contents) {
@@ -71,9 +68,11 @@ $exec = Async::create(Loop::get())
   );
 ```
 
-Though both examples in the antecedent text utilize the new default loop, the old standard with the `Factory::create()` and `$loop->run()` artifacts is still supported.
+The examples directory contains more nuanced uses of the library that I recommend you check out.
 
-**Note:** The examples directory contains more nuanced uses of the library that I recommend you check out.
+## Limitation
+
+`asyncify` is no panacea, but is capable of asynchronously executing a plethora of blocking calls. As presently constituted, the library is incapable of processing inputs and outputs that cannot be serialized.
 
 ## API Reference
 
@@ -83,8 +82,8 @@ Though both examples in the antecedent text utilize the new default loop, the ol
 class Async {
 
   /* Methods */
-  public static create( LoopInterface $loop [, ?string $rootDir = null ] ) : Async;
-  public function call( string $function [, array $args ] ) : PromiseInterface;
+  public static create( ?string $autoload = null [, ?React\EventLoop\LoopInterface $rootDir = null ] ) : Async;
+  public function call( string $function [, array $args ] ) : React\Promise\PromiseInterface;
 }
 ```
 
@@ -95,14 +94,12 @@ class Async {
 ### Function
 
 ```php
-call ( mixed ...$args ) : callable
-
-asyncify ( LoopInterface $loop [, ?string $rootDir [, string $func [, array $args ] ] ] ) : PromiseInterface
+call ( string $func [, array $args [, ?string $autoload = null [, ?React\EventLoop\LoopInterface $args = null ] ] ] ) : React\Promise\PromiseInterface;
 ```
 
-`call` - Curryied version of asyncify (bootstraps asynchronous function calls)
+`call` - Curryied function that bootstraps asynchronous function calls
 
-`asyncify` - Runs a synchronous PHP function asynchronously
+> **Note:** `asyncify` utilizes the autoload file in the root directory of the project from which it is invoked.
 
 ## Dealing with problems
 

composer.json

@@ -1,8 +1,8 @@
 {
   "name": "chemem/asyncify",
-  "type": "library",
   "description": "A package that runs synchronous PHP functions asynchronously.",
   "license": "Apache-2.0",
+  "type": "library",
   "authors": [
     {
       "name": "Lochemem Bruno Michael",
@@ -18,25 +18,29 @@
   },
   "require-dev": {
     "ergebnis/composer-normalize": "~2",
-    "friendsofphp/php-cs-fixer": "~2",
+    "friendsofphp/php-cs-fixer": "~2 || ~3",
     "phpunit/phpunit": "~8 || ~9",
-    "seregazhuk/react-promise-testing": "~0"
+    "react/async": "~3 || ~4"
   },
+  "minimum-stability": "stable",
   "autoload": {
     "psr-4": {
       "Chemem\\Asyncify\\": "src/"
     },
     "files": [
-      "src/Internal/functions.php",
-      "src/functions.php"
+      "src/index.php"
     ]
   },
   "autoload-dev": {
     "psr-4": {
       "Chemem\\Asyncify\\Tests\\": "tests/"
     }
   },
-  "minimum-stability": "stable",
+  "config": {
+    "allow-plugins": {
+      "ergebnis/composer-normalize": true
+    }
+  },
   "scripts": {
     "cs:fix": "php-cs-fixer fix --config=.php-cs-fixer.php --diff --verbose --allow-risky=yes",
     "test": "phpunit -c phpunit.xml.dist"

examples/arbitrary.php

@@ -2,7 +2,7 @@
 
 /**
  * simple script that runs a user-defined function asynchronously and wraps its return value in a promise
- * -> works only if the arbitrary function is expressed as a string
+ * -> works only if the arbitrary function is expressed as an anonymous function - in a string
  *
  * @package chemem/asyncify
  * @author Lochemem Bruno Michael
@@ -14,6 +14,7 @@
 require __DIR__ . '/../vendor/autoload.php';
 
 use React\EventLoop\Loop;
+
 use function Chemem\Asyncify\call;
 
 $square = <<<'CODE'
@@ -22,13 +23,12 @@
 })
 CODE;
 
-$call = call(Loop::get());
-
-$proc = $call($square, [12])->then(
-  function (int $square) {
-    echo $square . PHP_EOL;
-  },
-  function ($err) {
-    echo $err->getMessage() . PHP_EOL;
-  }
-);
+$call = call($square, [12])
+  ->then(
+    function (int $square) {
+      echo $square . PHP_EOL;
+    },
+    function ($err) {
+      echo $err->getMessage() . PHP_EOL;
+    }
+  );

examples/multiple.php

@@ -15,11 +15,12 @@
 
 use React\EventLoop\Loop;
 use Chemem\Asyncify\Async;
+
 use function React\Promise\all;
 
 const BASE_URI = 'https://jsonplaceholder.typicode.com/';
 
-$async = Async::create(Loop::get());
+$async = Async::create();
 
 $proc = all([
   $async->call('file_get_contents', [BASE_URI . 'todos/1']),

examples/readFile.php

@@ -14,16 +14,15 @@
 require __DIR__ . '/../vendor/autoload.php';
 
 use React\EventLoop\Loop;
-use function Chemem\Asyncify\call;
 
-$call = call(Loop::get());
+use function Chemem\Asyncify\call;
 
-$proc = $call('file_get_contents', [])
+$call = call('file_get_contents', [])
   ->then(
-    function (?string $result) {
-      \var_dump($result);
+    function (?int $result) {
+      echo \sprintf("Wrote %d bytes\n", $result);
     },
     function (\Throwable $err) {
-      echo $err->getMessage();
+      echo $err->getMessage() . PHP_EOL;
     }
   );

src/Async.php

@@ -15,6 +15,8 @@
 use React\EventLoop\LoopInterface;
 use React\Promise\PromiseInterface;
 
+use function Chemem\Asyncify\Internal\asyncify;
+
 class Async
 {
   /**
@@ -25,16 +27,16 @@ class Async
   private $loop;
 
   /**
-   * project root directory
+   * path to autoloader
    *
-   * @var string $rootDir
+   * @var string $autoload
    */
-  private $rootDir;
+  private $autoload;
 
-  public function __construct(LoopInterface $loop, ?string $rootDir = null)
+  public function __construct(?string $autoload = null, ?LoopInterface $loop = null)
   {
-    $this->loop    = $loop;
-    $this->rootDir = $rootDir;
+    $this->loop     = $loop;
+    $this->autoload = $autoload;
   }
 
   /**
@@ -44,18 +46,17 @@ public function __construct(LoopInterface $loop, ?string $rootDir = null)
    * create :: Object -> String -> Object
    *
    * @param LoopInterface $loop
-   * @param string $rootDir
+   * @param string $autoload
    * @return Async
    */
-  public static function create(LoopInterface $loop, ?string $rootDir = null): Async
+  public static function create(?string $autoload = null, ?LoopInterface $loop = null): Async
   {
-    return new static($loop, $rootDir);
+    return new static($autoload, $loop);
   }
 
   /**
    * call
-   * asynchronously calls a synchronous PHP function
-   * -> returns result subsumed in promise
+   * asynchronously calls a synchronous PHP function and subsumes result in promise
    *
    * call :: String -> Array -> Promise s a
    *
@@ -65,6 +66,6 @@ public static function create(LoopInterface $loop, ?string $rootDir = null): Asy
    */
   public function call(string $function, array $args): PromiseInterface
   {
-    return asyncify($this->loop, $this->rootDir, $function, $args);
+    return asyncify($function, $args, $this->autoload, $this->loop);
   }
 }