Merge pull request #11 from mcg-web/promise-adapter

Add promise adapter

.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false
+
+[*.mk,Makefile]
+indent_style = tab
+
+[*.php]
+indent_size = 4

.gitignore

@@ -1,4 +1,5 @@
 /vendor/
+/bin
 composer.lock
 composer.phar
 phpunit.xml

.php_cs

@@ -9,9 +9,6 @@
  * file that was distributed with this source code.
  */
 
-require_once __DIR__.'/vendor/autoload.php';
-
-use SLLH\StyleCIBridge\ConfigBridge;
 use Symfony\CS\Fixer\Contrib\HeaderCommentFixer;
 
 $header = <<<EOF
@@ -23,21 +20,18 @@ For the full copyright and license information, please view the LICENSE
 file that was distributed with this source code.
 EOF;
 
-// PHP-CS-Fixer 1.x
-if (method_exists('Symfony\CS\Fixer\Contrib\HeaderCommentFixer', 'getHeader')) {
-    HeaderCommentFixer::setHeader($header);
-}
-
-$config = ConfigBridge::create();
-
-// PHP-CS-Fixer 2.x
-if (method_exists($config, 'setRules')) {
-    $config->setRules(array_merge($config->getRules(), [
-        'header_comment' => ['header' => $header]
-    ]));
-}
-
-return $config
-    ->setUsingCache(true)
-    ->fixers(array_merge($config->getFixers(), ['header_comment']))
-;
+return PhpCsFixer\Config::create()
+    ->setRules([
+      '@PSR2' => true,
+      'array_syntax' => ['syntax' => 'short'],
+      'no_unreachable_default_argument_value' => false,
+      'heredoc_to_nowdoc' => false,
+      'header_comment' => ['header' => $header],
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__)
+            ->exclude(['vendor'])
+    )
+  ;

.travis.yml

@@ -1,33 +1,35 @@
 language: php
 
 php:
-    - nightly
-    - hhvm
-    - 5.5
-    - 5.6
-    - 7.0
-    - 7.1
+  - 5.5
+  - 5.6
+  - 7.0
+  - 7.1
+  - nightly
+  - hhvm
 
 branches:
-    only:
-        - master
-        - /^\d+\.\d+$/
+  only:
+    - master
+    - /^\d+\.\d+$/
 
-allow_failures:
+matrix:
+  allow_failures:
     - php: nightly
 
 cache:
-    directories:
-        - $HOME/.composer/cache
+  directories:
+    - $HOME/.composer/cache
 
 before_install:
-    - if [[ "$TRAVIS_PHP_VERSION" != "5.6" && "$TRAVIS_PHP_VERSION" != "hhvm" ]]; then phpenv config-rm xdebug.ini || true; fi
-    - composer selfupdate
-    - composer require "guzzlehttp/promises"
+  - if [[ "$TRAVIS_PHP_VERSION" != "5.6" && "$TRAVIS_PHP_VERSION" != "hhvm" ]]; then phpenv config-rm xdebug.ini || true; fi
+  - composer selfupdate
 
 install: composer update --prefer-dist --no-interaction
 
-script: if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then phpunit -d xdebug.max_nesting_level=1000 --debug --coverage-clover build/logs/clover.xml; else phpunit --debug; fi
+script:
+  - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then bin/phpunit --debug --coverage-clover build/logs/clover.xml; else bin/phpunit --debug; fi
+  - if [ "$TRAVIS_PHP_VERSION" == "7.0" ]; then composer require "friendsofphp/php-cs-fixer:^2.0" && bin/php-cs-fixer fix --diff --dry-run -v; fi;
 
 after_success:
-    - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then composer require "satooshi/php-coveralls:^1.0" && travis_retry php vendor/bin/coveralls -v; fi
+  - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then composer require "satooshi/php-coveralls:^1.0" && travis_retry php bin/coveralls -v; fi

README.md

@@ -31,9 +31,9 @@ Create loaders by providing a batch loading instance.
 use Overblog\DataLoader\DataLoader;
 
 $myBatchGetUsers = function ($keys) { /* ... */ };
-$promiseFactory = new MyPromiseFactory();
+$promiseAdapter = new MyPromiseAdapter();
 
-$userLoader = new DataLoader($myBatchGetUsers, $promiseFactory);
+$userLoader = new DataLoader($myBatchGetUsers, $promiseAdapter);
 ```
 
 A batch loading callable / callback accepts an Array of keys, and returns a Promise which
@@ -123,12 +123,12 @@ Each `DataLoaderPHP` instance contains a unique memoized cache. Use caution when
 used in long-lived applications or those which serve many users with different
 access permissions and consider creating a new instance per web request.
 
-##### `new DataLoader(callable $batchLoadFn, PromiseFactoryInterface $promiseFactory [, Option $options])`
+##### `new DataLoader(callable $batchLoadFn, PromiseAdapterInterface $promiseAdapter [, Option $options])`
 
 Create a new `DataLoaderPHP` given a batch loading instance and options.
 
 - *$batchLoadFn*: A callable / callback which accepts an Array of keys, and returns a Promise which resolves to an Array of values.
-- *$promiseFactory*: Any object that implements `McGWeb\PromiseFactory\PromiseFactoryInterface`. (see [McGWeb/Promise-Factory](https://github.com/mcg-web/promise-factory))
+- *$promiseAdapter*: Any object that implements `Overblog\PromiseAdapter\PromiseAdapterInterface`. (see [Overblog/Promise-Adapter](./lib/promise-adapter/docs/usage.md))
 - *$options*: An optional object of options:
 
   - *batch*: Default `true`. Set to `false` to disable batching, instead
@@ -163,7 +163,7 @@ list($a, $b) = DataLoader::await($myLoader->loadMany(['a', 'b']));
 
 This is equivalent to the more verbose:
 
-```js
+```php
 list($a, $b) = DataLoader::await(\React\Promise\all([
   $myLoader->load('a'),
   $myLoader->load('b')
@@ -202,10 +202,8 @@ Await method process all waiting promise in all dataLoaderPHP instances.
 - *$unwrap*: controls whether or not the value of the promise is returned for a fulfilled promise
   or if an exception is thrown if the promise is rejected. Default `true`.
 
-## Using with Webonyx/GraphQL [WIP]
+## Using with Webonyx/GraphQL
 
-A [PR](https://github.com/webonyx/graphql-php/pull/67) is open on [Webonyx/GraphQL](https://github.com/webonyx/graphql-php)
-to supports DataLoaderPHP and more generally promise.
 Here [an example](https://github.com/mcg-web/sandbox-dataloader-graphql-php/blob/master/with-dataloader.php).
 
 ## Credits

composer.json

@@ -1,24 +1,43 @@
 {
-    "name": "overblog/dataloader-php",
-    "type": "library",
-    "license": "MIT",
-    "description": "DataLoaderPhp is a generic utility to be used as part of your application's data fetching layer to provide a simplified and consistent API over various remote data sources such as databases or web services via batching and caching.",
-    "keywords": ["dataLoader", "caching", "batching"],
-    "autoload": {
-        "psr-4": {
-            "Overblog\\DataLoader\\": "src/"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Overblog\\DataLoader\\Tests\\": "tests/"
-        }
-    },
-    "require": {
-        "php": "^5.5|^7.0",
-        "mcg-web/promise-factory": "^0.2"
-    },
-    "require-dev": {
-        "phpunit/phpunit": "^4.1|^5.1"
+  "name": "overblog/dataloader-php",
+  "type": "library",
+  "license": "MIT",
+  "description": "DataLoaderPhp is a generic utility to be used as part of your application's data fetching layer to provide a simplified and consistent API over various remote data sources such as databases or web services via batching and caching.",
+  "keywords": ["dataLoader", "caching", "batching"],
+  "config" : {
+    "bin-dir": "bin",
+    "sort-packages": true
+  },
+  "autoload": {
+    "psr-4": {
+      "Overblog\\DataLoader\\": "src/",
+      "Overblog\\PromiseAdapter\\": "lib/promise-adapter/src/"
     }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Overblog\\DataLoader\\Test\\": "tests/",
+      "Overblog\\PromiseAdapter\\Test\\": "lib/promise-adapter/tests/"
+    }
+  },
+  "replace": {
+    "overblog/promise-adapter": "self.version"
+  },
+  "require": {
+    "php": "^5.5|^7.0"
+  },
+  "require-dev": {
+    "guzzlehttp/promises": "^1.3.0",
+    "phpunit/phpunit": "^4.1|^5.1",
+    "react/promise": "^2.5.0"
+  },
+  "suggest": {
+    "guzzlehttp/promises": "To use with Guzzle promise",
+    "react/promise": "To use with ReactPhp promise"
+  },
+  "extra": {
+    "branch-alias": {
+      "dev-master": "0.3-dev"
+    }
+  }
 }

lib/promise-adapter/.gitignore

@@ -0,0 +1,5 @@
+/vendor/
+composer.lock
+composer.phar
+phpunit.xml
+/bin

lib/promise-adapter/.travis.yml

@@ -0,0 +1,33 @@
+language: php
+
+php:
+  - 5.5
+  - 5.6
+  - 7.0
+  - 7.1
+  - nightly
+  - hhvm
+
+branches:
+  only:
+    - master
+    - /^\d+\.\d+$/
+
+matrix:
+  allow_failures:
+    - php: nightly
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+before_install:
+  - if [[ "$TRAVIS_PHP_VERSION" != "5.6" && "$TRAVIS_PHP_VERSION" != "hhvm" ]]; then phpenv config-rm xdebug.ini || true; fi
+  - composer selfupdate
+
+install: composer update --prefer-dist --no-interaction
+
+script: if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then bin/phpunit --debug --coverage-clover build/logs/clover.xml; else bin/phpunit --debug; fi
+
+after_success:
+  - if [ "$TRAVIS_PHP_VERSION" == "5.6" ]; then composer require "satooshi/php-coveralls:^1.0" && travis_retry php bin/coveralls -v; fi

lib/promise-adapter/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Overblog
+
+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.

lib/promise-adapter/README.md

@@ -0,0 +1,26 @@
+# PromiseAdapter
+
+This library tries to create a simple promise adapter standard while waiting for a psr.
+It Comes out of the box with adapter for [ReactPhp/Promise](https://github.com/reactphp/promise) and
+[Guzzle/Promises](https://github.com/guzzle/promises).
+
+[![Build Status](https://travis-ci.org/overblog/promise-adapter.svg?branch=master)](https://travis-ci.org/overblog/promise-adapter)
+[![Coverage Status](https://coveralls.io/repos/github/overblog/promise-adapter/badge.svg?branch=master)](https://coveralls.io/github/overblog/promise-adapter?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/overblog/promise-adapter/version)](https://packagist.org/packages/overblog/promise-adapter)
+[![License](https://poser.pugx.org/overblog/promise-adapter/license)](https://packagist.org/packages/overblog/promise-adapter)
+
+## Installation
+
+First, install PromiseAdapter using composer.
+
+```sh
+composer require "overblog/promise-adapter"
+```
+
+# Usage
+
+see [here](./docs/usage.md)
+
+## License
+
+Overblog/PromiseAdapter is released under the [MIT](https://github.com/overblog/promise-adapter/blob/master/LICENSE) license.

lib/promise-adapter/composer.json

@@ -0,0 +1,38 @@
+{
+  "name": "overblog/promise-adapter",
+  "description": "This library tries to create a simple promise adapter standard while waiting for a psr.",
+  "type": "library",
+  "keywords": [
+    "promise",
+    "adapter",
+    "guzzle",
+    "react"
+  ],
+  "config" : {
+    "bin-dir": "bin",
+    "sort-packages": true
+  },
+  "autoload": {
+    "psr-4": {
+      "Overblog\\PromiseAdapter\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Overblog\\PromiseAdapter\\Test\\": "tests/"
+    }
+  },
+  "require": {
+    "php": "^5.5|^7.0"
+  },
+  "require-dev": {
+    "guzzlehttp/promises": "^1.3.0",
+    "phpunit/phpunit": "^4.1|^5.1",
+    "react/promise": "^2.5.0"
+  },
+  "suggest": {
+    "guzzlehttp/promises": "To use with Guzzle promise",
+    "react/promise": "To use with ReactPhp promise"
+  },
+  "license": "MIT"
+}

lib/promise-adapter/docs/usage.md

@@ -0,0 +1,23 @@
+# Promise adapter usage
+
+## Optional requirements
+
+Optional to use Guzzle:
+
+```sh
+composer require "guzzlehttp/promises"
+```
+
+Optional to use ReactPhp:
+
+```sh
+composer require "react/promise"
+```
+
+## Supported Adapter
+
+*Guzzle*: `Overblog\PromiseAdapter\Adapter\GuzzleHttpPromiseAdapter`
+
+*ReactPhp*: `Overblog\PromiseAdapter\Adapter\ReactPromiseAdapter`
+
+To use a custom Promise lib you can implement `Overblog\PromiseAdapter\PromiseAdapterInterface`