Merge pull request #3 from php-http/implementation

sagikazarmark · sagikazarmark · commit 1f63526cbda9 · 2015-12-24T23:59:42.000+01:00
Add Fulfilled and Rejected promise implementations
diff --git a/.editorconfig b/.editorconfig
@@ -7,6 +7,3 @@ indent_size = 4
 indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
-
-[*.yml*]
-indent_size = 2
diff --git a/.gitattributes b/.gitattributes
@@ -1,5 +1,14 @@
-.editorconfig   export-ignore
-.gitattributes  export-ignore
-.gitignore      export-ignore
-CONTRIBUTING.md export-ignore
-CONDUCT.md      export-ignore
+spec/            export-ignore
+tests/           export-ignore
+.editorconfig    export-ignore
+.gitattributes   export-ignore
+.gitignore       export-ignore
+.php_cs          export-ignore
+.scrutinizer.yml export-ignore
+.styleci.yml     export-ignore
+.travis.yml      export-ignore
+CONDUCT.md       export-ignore
+CONTRIBUTING.md  export-ignore
+phpspec.yml.ci   export-ignore
+phpspec.yml.dist export-ignore
+phpunit.xml.dist export-ignore
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 build/
 vendor/
 composer.lock
+phpspec.yml
+phpunit.xml
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,13 @@
+<?php
+
+/*
+ * In order to make it work, fabpot/php-cs-fixer and sllh/php-cs-fixer-styleci-bridge must be installed globally
+ * with composer.
+ *
+ * @link https://github.com/Soullivaneuh/php-cs-fixer-styleci-bridge
+ * @link https://github.com/FriendsOfPHP/PHP-CS-Fixer
+ */
+
+use SLLH\StyleCIBridge\ConfigBridge;
+
+return ConfigBridge::create();
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,8 @@
+filter:
+    paths: [src/*]
+checks:
+    php:
+        code_rating: true
+        duplication: true
+tools:
+    external_code_coverage: true
diff --git a/.styleci.yml b/.styleci.yml
@@ -0,0 +1,14 @@
+preset: symfony
+
+finder:
+    exclude:
+        - "spec"
+        - "tests"
+    path:
+        - "src"
+
+enabled:
+    - short_array_syntax
+
+disabled:
+    - unalign_double_arrow
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,41 @@
+language: php
+
+sudo: false
+
+cache:
+    directories:
+        - $HOME/.composer/cache
+
+php:
+    - 5.4
+    - 5.5
+    - 5.6
+    - 7.0
+    - hhvm
+
+env:
+    global:
+        - TEST_COMMAND="composer test"
+
+branches:
+    except:
+        - /^analysis-.*$/
+
+matrix:
+    fast_finish: true
+    include:
+        - php: 5.4
+          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest" COVERAGE=true TEST_COMMAND="composer test-ci"
+
+before_install:
+    - travis_retry composer self-update
+
+install:
+    - travis_retry composer update ${COMPOSER_FLAGS} --prefer-source --no-interaction
+
+script:
+    - $TEST_COMMAND
+
+after_success:
+    - if [[ "$COVERAGE" = true ]]; then wget https://scrutinizer-ci.com/ocular.phar; fi
+    - if [[ "$COVERAGE" = true ]]; then php ocular.phar code-coverage:upload --format=php-clover build/coverage.xml; fi
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -75,7 +75,7 @@ $ git rebase -i HEAD~3
 If your branch conflicts with the master branch, you will need to rebase and repush it with the following commands:
 
 ``` bash
-$ git remote add upstream git@github.com:php-http/repo-name.git
+$ git remote add upstream git@github.com:orga/repo-name.git
 $ git pull --rebase upstream master
 $ git push -f origin feature-or-bug-fix-description
 ```
diff --git a/README.md b/README.md
@@ -23,14 +23,22 @@ $ composer require php-http/promise
 Please see the [official documentation](http://docs.httplug.io).
 
 
+## Testing
+
+``` bash
+$ composer test
+```
+
+
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
 
 
 ## Security
 
-If you discover any security related issues, please contact us at [security@php-http.org](mailto:security@php-http.org).
+If you discover any security related issues, please contact us at [security@httplug.io](mailto:security@httplug.io)
+or [security@php-http.org](mailto:security@php-http.org).
 
 
 ## License
diff --git a/composer.json b/composer.json
@@ -14,11 +14,22 @@
             "email": "mark.sagikazar@gmail.com"
         }
     ],
+    "require": {
+        "psr/http-message": "^1.0"
+    },
+    "require-dev": {
+        "phpspec/phpspec": "^2.4",
+        "henrikbjorn/phpspec-code-coverage" : "^1.0"
+    },
     "autoload": {
         "psr-4": {
             "Http\\Promise\\": "src/"
         }
     },
+    "scripts": {
+        "test": "vendor/bin/phpspec run",
+        "test-ci": "vendor/bin/phpspec run -c phpspec.yml.ci"
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "0.2-dev"
diff --git a/phpspec.yml.ci b/phpspec.yml.ci
@@ -0,0 +1,10 @@
+suites:
+    tools_suite:
+        namespace: Http\Promise
+        psr4_prefix: Http\Promise
+formatter.name: pretty
+extensions:
+    - PhpSpec\Extension\CodeCoverageExtension
+code_coverage:
+    format: clover
+    output: build/coverage.xml
diff --git a/phpspec.yml.dist b/phpspec.yml.dist
@@ -0,0 +1,5 @@
+suites:
+    tools_suite:
+        namespace: Http\Promise
+        psr4_prefix: Http\Promise
+formatter.name: pretty
diff --git a/spec/FulfilledPromiseSpec.php b/spec/FulfilledPromiseSpec.php
@@ -0,0 +1,67 @@
+<?php
+
+namespace spec\Http\Promise;
+
+use Http\Promise\Promise;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class FulfilledPromiseSpec extends ObjectBehavior
+{
+    function let(ResponseInterface $response)
+    {
+        $this->beConstructedWith($response);
+    }
+
+    function it_is_initializable(ResponseInterface $response)
+    {
+        $this->shouldHaveType('Http\Promise\FulfilledPromise');
+    }
+
+    function it_is_a_promise()
+    {
+        $this->shouldImplement('Http\Promise\Promise');
+    }
+
+    function it_returns_a_fulfilled_promise(ResponseInterface $response)
+    {
+        $promise = $this->then(function (ResponseInterface $responseReceived) use ($response) {
+            if (Argument::is($responseReceived)->scoreArgument($response->getWrappedObject())) {
+                return $response->getWrappedObject();
+            }
+        });
+
+        $promise->shouldHaveType('Http\Promise\Promise');
+        $promise->shouldHaveType('Http\Promise\FulfilledPromise');
+        $promise->getState()->shouldReturn(Promise::FULFILLED);
+        $promise->wait()->shouldReturn($response);
+    }
+
+    function it_returns_a_rejected_promise(RequestInterface $request, ResponseInterface $response)
+    {
+        $exception = new \Exception();
+
+        $promise = $this->then(function (ResponseInterface $responseReceived) use ($response, $exception) {
+            if (Argument::is($responseReceived)->scoreArgument($response->getWrappedObject())) {
+                throw $exception;
+            }
+        });
+
+        $promise->shouldHaveType('Http\Promise\Promise');
+        $promise->shouldHaveType('Http\Promise\RejectedPromise');
+        $promise->getState()->shouldReturn(Promise::REJECTED);
+        $promise->shouldThrow($exception)->duringWait();
+    }
+
+    function it_is_in_fulfilled_state()
+    {
+        $this->getState()->shouldReturn(Promise::FULFILLED);
+    }
+
+    function it_has_a_response(ResponseInterface $response)
+    {
+        $this->wait()->shouldReturn($response);
+    }
+}
diff --git a/spec/RejectedPromiseSpec.php b/spec/RejectedPromiseSpec.php
@@ -0,0 +1,73 @@
+<?php
+
+namespace spec\Http\Promise;
+
+use Http\Promise\Promise;
+use Psr\Http\Message\ResponseInterface;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class RejectedPromiseSpec extends ObjectBehavior
+{
+    function let()
+    {
+        $this->beConstructedWith(new \Exception());
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Promise\RejectedPromise');
+    }
+
+    function it_is_a_promise()
+    {
+        $this->shouldImplement('Http\Promise\Promise');
+    }
+
+    function it_returns_a_fulfilled_promise(ResponseInterface $response)
+    {
+        $exception = new \Exception();
+        $this->beConstructedWith($exception);
+
+        $promise = $this->then(null, function (\Exception $exceptionReceived) use($exception, $response) {
+            if (Argument::is($exceptionReceived)->scoreArgument($exception)) {
+                return $response->getWrappedObject();
+            }
+        });
+
+        $promise->shouldHaveType('Http\Promise\Promise');
+        $promise->shouldHaveType('Http\Promise\FulfilledPromise');
+        $promise->getState()->shouldReturn(Promise::FULFILLED);
+        $promise->wait()->shouldReturn($response);
+    }
+
+    function it_returns_a_rejected_promise()
+    {
+        $exception = new \Exception();
+        $this->beConstructedWith($exception);
+
+        $promise = $this->then(null, function (\Exception $exceptionReceived) use($exception) {
+            if (Argument::is($exceptionReceived)->scoreArgument($exception)) {
+                throw $exception;
+            }
+        });
+
+        $promise->shouldHaveType('Http\Promise\Promise');
+        $promise->shouldHaveType('Http\Promise\RejectedPromise');
+        $promise->getState()->shouldReturn(Promise::REJECTED);
+        $promise->shouldThrow($exception)->duringWait();
+    }
+
+    function it_is_in_rejected_state()
+    {
+        $this->getState()->shouldReturn(Promise::REJECTED);
+    }
+
+    function it_returns_an_exception()
+    {
+        $exception = new \Exception();
+
+        $this->beConstructedWith($exception);
+        $this->shouldThrow($exception)->duringWait();
+    }
+}
diff --git a/src/FulfilledPromise.php b/src/FulfilledPromise.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace Http\Promise;
+
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * A promise already fulfilled.
+ *
+ * @author Joel Wurtz <jwurtz@jolicode.com>
+ */
+final class FulfilledPromise implements Promise
+{
+    /**
+     * @var ResponseInterface
+     */
+    private $response;
+
+    /**
+     * @param ResponseInterface $response
+     */
+    public function __construct(ResponseInterface $response)
+    {
+        $this->response = $response;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function then(callable $onFulfilled = null, callable $onRejected = null)
+    {
+        if (null === $onFulfilled) {
+            return $this;
+        }
+
+        try {
+            return new self($onFulfilled($this->response));
+        } catch (\Exception $e) {
+            return new RejectedPromise($e);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getState()
+    {
+        return Promise::FULFILLED;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function wait($unwrap = true)
+    {
+        if ($unwrap) {
+            return $this->response;
+        }
+    }
+}
diff --git a/src/Promise.php b/src/Promise.php
@@ -62,7 +62,7 @@ public function getState();
      *
      * @return ResponseInterface|null Resolved value, null if $unwrap is set to false
      *
-     * @throws \Http\Client\Exception The rejection reason.
+     * @throws \Exception The rejection reason.
      */
     public function wait($unwrap = true);
 }
diff --git a/src/RejectedPromise.php b/src/RejectedPromise.php
