Split React Promises from RxPHP

davidwdan · davidwdan · commit 73ebcd2d6482 · 2016-12-21T19:59:54.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/composer.lock
+/vendor
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,17 @@
+language: php
+sudo: required
+
+php:
+  - 7
+  - 7.1
+  - hhvm
+
+matrix:
+  allow_failures:
+    - php: hhvm
+
+install:
+  - composer install
+
+script:
+  - phpunit
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Voryx LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# ReactPHP Promises 
+
+Provides RxPHP 2 support for ReactPHP's [Promises](https://github.com/reactphp/promise)
+
+RxPHP v2 will only support [async-interop promises](https://github.com/async-interop/promise) by default.  This project restores the ReactPHP Promise support found in RxPHP v1.
+
+## Usage
+
+### From Observable
+```php
+    
+  $observable = \Rx\Observable::of(42);
+  $promise = \Rx\React\Promise::fromObservable($observable);
+  
+  $promise->then(function ($value) {
+      echo "Value {$value}\n";
+  });
+    
+```
+
+### To Observable
+```php
+    
+  $promise = \Rx\React\Promise::resolved(42);
+  $observable = \Rx\React\Promise::toObservable($promise);
+  
+  $observable->subscribe(function ($value) {
+      echo "Value {$value}\n";
+  });
+    
+```
diff --git a/composer.json b/composer.json
@@ -0,0 +1,42 @@
+{
+  "name": "rx/react-promise",
+  "type": "library",
+  "description": "RxPHP v2 support for ReactPHP's Promises",
+  "keywords": [
+    "rxphp",
+    "reactivex",
+    "react",
+    "reactphp",
+    "promise",
+    "rx.php"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "David Dan",
+      "email": "davidwdan@gmail.com",
+      "role": "Developer"
+    },
+    {
+      "name": "Matt Bonneau",
+      "email": "matt@bonneau.net",
+      "role": "Developer"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "Rx\\React\\": "src/"
+    }
+  },
+  "require": {
+    "react/promise": "~2.2",
+    "wyrihaximus/react-async-interop-loop": "dev-master",
+    "reactivex/rxphp": "2.x-dev"
+  },
+  "repositories": [
+    {
+      "type": "vcs",
+      "url": "https://github.com/davidwdan/RxPHP.git"
+    }
+  ]
+}
diff --git a/examples/bootstrap.php b/examples/bootstrap.php
@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of RxPHP.
+ *
+ * (c) Alexander <iam.asm89@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if (file_exists($file = __DIR__.'/../vendor/autoload.php')) {
+    $autoload = require_once $file;
+} else {
+    throw new RuntimeException('Install dependencies to run test suite.');
+}
+
+function asString($value) {
+    if (is_array($value)) {
+        return json_encode($value);
+    }
+    return (string) $value;
+}
+
+$createStdoutObserver = function ($prefix = '') {
+    return new Rx\Observer\CallbackObserver(
+        function ($value) use ($prefix) { echo $prefix . "Next value: " . asString($value) . "\n"; },
+        function ($error) use ($prefix) { echo $prefix . "Exception: " . $error->getMessage() . "\n"; },
+        function ()       use ($prefix) { echo $prefix . "Complete!\n"; }
+    );
+};
+
+
+$stdoutObserver = $createStdoutObserver();
diff --git a/examples/defer.php b/examples/defer.php
@@ -0,0 +1,13 @@
+<?php
+
+require_once __DIR__.'/bootstrap.php';
+
+/* Using a promise */
+$source = \Rx\React\PromiseFactory::toObservable(function () {
+    return \Rx\React\Promise::resolved(42);
+});
+
+$subscription = $source->subscribe($createStdoutObserver());
+
+//Next value: 42
+//Complete!
diff --git a/examples/defer.php.expect b/examples/defer.php.expect
@@ -0,0 +1,2 @@
+Next value: 42
+Complete!
diff --git a/examples/promise-from-observable.php b/examples/promise-from-observable.php
@@ -0,0 +1,16 @@
+<?php
+
+require_once __DIR__.'/bootstrap.php';
+
+// With React Promise
+$source = \Rx\Observable::of(42);
+$promise = \Rx\React\Promise::fromObservable($source);
+
+$promise->then(function ($value) {
+    echo "Value {$value}\n";
+});
+
+//Value 42
+
+
+
diff --git a/examples/promise-from-observable.php.expect b/examples/promise-from-observable.php.expect
@@ -0,0 +1 @@
+Value 42
diff --git a/examples/promise-to-observable.php b/examples/promise-to-observable.php
@@ -0,0 +1,23 @@
+<?php
+
+require_once __DIR__.'/bootstrap.php';
+
+
+$p = \Rx\React\Promise::resolved(42);
+$source = \Rx\React\Promise::toObservable($p);
+
+$subscription = $source->subscribe($stdoutObserver);
+
+//Next value: 42
+//Complete!
+
+
+
+// Create a promise which rejects with an error
+$p = \Rx\React\Promise::rejected(new Exception('because'));
+
+$source2 = \Rx\React\Promise::toObservable($p);
+
+$subscription = $source2->subscribe($createStdoutObserver());
+
+//Exception: because
diff --git a/examples/promise-to-observable.php.expect b/examples/promise-to-observable.php.expect
@@ -0,0 +1,3 @@
+Next value: 42
+Complete!
+Exception: because
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<phpunit
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        colors="true"
+        convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        processIsolation="false"
+        stopOnFailure="false"
+        syntaxCheck="false"
+        bootstrap="tests/bootstrap.php">
+    <testsuites>
+        <testsuite name="Rx/Stream Tests">
+            <directory>tests/</directory>
+        </testsuite>
+    </testsuites>
+
+</phpunit>
diff --git a/src/Promise.php b/src/Promise.php
@@ -0,0 +1,94 @@
+<?php
+
+namespace Rx\React;
+
+use React\Promise\CancellablePromiseInterface;
+use Rx\Disposable\CallbackDisposable;
+use Rx\ObservableInterface;
+use Rx\Observable;
+use Rx\Observable\AnonymousObservable;
+use Rx\Observer\CallbackObserver;
+use Rx\Subject\AsyncSubject;
+use React\Promise\Deferred;
+
+final class Promise
+{
+    /**
+     * @param mixed $value
+     * @return \React\Promise\Promise A promise resolved to $value
+     */
+    public static function resolved($value)
+    {
+        $d = new Deferred();
+        $d->resolve($value);
+        return $d->promise();
+    }
+
+    /**
+     * @param mixed $exception
+     * @return \React\Promise\Promise A promise rejected with $exception
+     */
+    public static function rejected($exception)
+    {
+        $d = new Deferred();
+        $d->reject($exception);
+        return $d->promise();
+    }
+
+    /**
+     * Converts an existing observable sequence to React Promise
+     *
+     * @param ObservableInterface $observable
+     * @param Deferred $deferred
+     * @return \React\Promise\Promise
+     */
+    public static function fromObservable(ObservableInterface $observable, Deferred $deferred = null): \React\Promise\Promise
+    {
+        $d     = $deferred ?: new Deferred();
+        $value = null;
+
+        $observable->subscribe(new CallbackObserver(
+            function ($v) use (&$value) {
+                $value = $v;
+            },
+            function ($error) use ($d) {
+                $d->reject($error);
+            },
+            function () use ($d, &$value) {
+                $d->resolve($value);
+            }
+        ));
+
+        return $d->promise();
+    }
+
+    /**
+     * Converts a Promise to an Observable sequence
+     *
+     * @param CancellablePromiseInterface $promise
+     * @return Observable\AnonymousObservable
+     */
+    public static function toObservable(CancellablePromiseInterface $promise): AnonymousObservable
+    {
+        $subject = new AsyncSubject();
+
+        $p = $promise->then(
+            function ($value) use ($subject) {
+                $subject->onNext($value);
+                $subject->onCompleted();
+            },
+            function ($error) use ($subject) {
+                $error = $error instanceof \Exception ? $error : new RejectedPromiseException($error);
+                $subject->onError($error);
+            }
+        );
+
+        return new AnonymousObservable(function ($observer) use ($subject, $p) {
+            $disp = $subject->subscribe($observer);
+            return new CallbackDisposable(function () use ($p, $disp) {
+                $disp->dispose();
+                $p->cancel();
+            });
+        });
+    }
+}
diff --git a/src/PromiseFactory.php b/src/PromiseFactory.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Rx\React;
+
+use Rx\Observable;
+
+final class PromiseFactory
+{
+    /**
+     * Returns an observable sequence that invokes the specified factory function whenever a new observer subscribes.
+     *
+     * @param callable $factory
+     * @return \Rx\Observable\AnonymousObservable
+     */
+    public static function toObservable(callable $factory)
+    {
+        $observableFactory = function () use ($factory) {
+            return Promise::toObservable($factory());
+        };
+
+        return Observable::defer($observableFactory);
+    }
+}
diff --git a/src/RejectedPromiseException.php b/src/RejectedPromiseException.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Rx\React;
+
+class RejectedPromiseException extends \Exception
+{
+    private $rejectValue;
+
+    /**
+     * RejectedPromiseException constructor.
+     */
+    public function __construct($rejectValue)
+    {
+        $this->rejectValue = $rejectValue;
+
+        parent::__construct("Promise rejected with non-exception");
+    }
+
+    /**
+     * @return string
+     */
+    public function getRejectValue()
+    {
+        return $this->rejectValue;
+    }
+}
diff --git a/tests/Rx/Functional/FunctionalTestCase.php b/tests/Rx/Functional/FunctionalTestCase.php
diff --git a/tests/Rx/Functional/React/PromiseFactoryTest.php b/tests/Rx/Functional/React/PromiseFactoryTest.php
diff --git a/tests/Rx/Functional/React/PromiseFromObservableTest.php b/tests/Rx/Functional/React/PromiseFromObservableTest.php
diff --git a/tests/Rx/Functional/React/PromiseToObservableTest.php b/tests/Rx/Functional/React/PromiseToObservableTest.php
diff --git a/tests/Rx/TestCase.php b/tests/Rx/TestCase.php
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
