Move exceptions to BatchResult

Author: sagikazarmark

spec/Exception/BatchExceptionSpec.php

@@ -9,6 +9,11 @@
 
 class BatchExceptionSpec extends ObjectBehavior
 {
+    function let(BatchResult $batchResult)
+    {
+        $this->beConstructedWith($batchResult);
+    }
+
     function it_is_initializable()
     {
         $this->shouldHaveType('Http\Client\Exception\BatchException');
@@ -24,50 +29,8 @@ function it_is_an_exception()
         $this->shouldImplement('Http\Client\Exception');
     }
 
-    function it_throws_an_exception_if_the_result_is_not_available()
-    {
-        $this->shouldThrow('RuntimeException')->duringGetResult();
-    }
-
-    function it_throws_an_exception_if_the_result_is_already_set(BatchResult $batchResult)
+    function it_has_a_batch_result()
     {
-        $this->setResult($batchResult);
-
         $this->getResult()->shouldHaveType('Http\Client\BatchResult');
-        $this->shouldThrow('RuntimeException')->duringSetResult($batchResult);
-    }
-
-    function it_has_an_exception_for_a_request(RequestInterface $request, Exception $exception)
-    {
-        $this->shouldThrow('UnexpectedValueException')->duringGetExceptionFor($request);
-        $this->hasExceptionFor($request)->shouldReturn(false);
-
-        $this->addException($request, $exception);
-
-        $this->getExceptionFor($request)->shouldReturn($exception);
-        $this->hasExceptionFor($request)->shouldReturn(true);
-    }
-
-    function it_has_exceptions(RequestInterface $request, Exception $exception)
-    {
-        $this->getExceptions()->shouldReturn([]);
-
-        $this->addException($request, $exception);
-
-        $this->getExceptions()->shouldReturn([$exception]);
-    }
-
-    function it_checks_if_a_request_failed(RequestInterface $request, Exception $exception, BatchResult $batchResult)
-    {
-        $batchResult->hasResponseFor($request)->willReturn(false);
-        $this->setResult($batchResult);
-
-        $this->isSuccessful($request)->shouldReturn(false);
-        $this->isFailed($request)->shouldReturn(false);
-
-        $this->addException($request, $exception);
-
-        $this->isSuccessful($request)->shouldReturn(false);
-        $this->isFailed($request)->shouldReturn(true);
     }
 }

src/BatchResult.php

@@ -7,7 +7,7 @@
 use Psr\Http\Message\ResponseInterface;
 
 /**
- * Successful responses returned from parallel request execution
+ * Responses and exceptions returned from parallel request execution
  *
  * @author Márk Sági-Kazár <[email protected]>
  */
@@ -54,8 +54,61 @@ public function hasResponseFor(RequestInterface $request);
      * @param ResponseInterface $response
      *
      * @return BatchResult
-     *
-     * @internal
      */
     public function addResponse(RequestInterface $request, ResponseInterface $response);
+
+    /**
+     * Checks if a request is successful
+     *
+     * @param RequestInterface $request
+     *
+     * @return boolean
+     */
+    public function isSuccessful(RequestInterface $request);
+
+    /**
+     * Checks if a request is failed
+     *
+     * @param RequestInterface $request
+     *
+     * @return boolean
+     */
+    public function isFailed(RequestInterface $request);
+
+    /**
+     * Returns all exceptions
+     *
+     * @return Exception[]
+     */
+    public function getExceptions();
+
+    /**
+     * Returns an exception for a request
+     *
+     * @param RequestInterface $request
+     *
+     * @return Exception
+     *
+     * @throws \UnexpectedValueException If request is not found
+     */
+    public function getExceptionFor(RequestInterface $request);
+
+    /**
+     * Checks if there is an exception for a request
+     *
+     * @param RequestInterface $request
+     *
+     * @return boolean
+     */
+    public function hasExceptionFor(RequestInterface $request);
+
+    /**
+     * Adds an exception
+     *
+     * @param RequestInterface  $request
+     * @param Exception         $exception
+     *
+     * @return BatchResult
+     */
+    public function addException(RequestInterface $request, Exception $exception);
 }

src/Exception/BatchException.php

@@ -21,129 +21,20 @@ final class BatchException extends \RuntimeException implements Exception
     private $result;
 
     /**
-     * @var \SplObjectStorage
+     * @param BatchResult $result
      */
-    private $exceptions;
-
-    public function __construct()
+    public function __construct(BatchResult $result)
     {
-        $this->exceptions = new \SplObjectStorage();
+        $this->result = $result;
     }
 
     /**
-     * Returns the BatchResult that contains those responses that where successful.
-     *
-     * Note that the BatchResult may contains 0 responses if all requests failed.
+     * Returns the BatchResult that contains all responses and exceptions
      *
      * @return BatchResult
-     *
-     * @throws \RuntimeException If the BatchResult is not available
      */
     public function getResult()
     {
-        if (!isset($this->result)) {
-            throw new \RuntimeException('BatchResult is not available');
-        }
-
         return $this->result;
     }
-
-    /**
-     * Sets the successful response list
-     *
-     * @param BatchResult $result
-     *
-     * @throws \RuntimeException If the BatchResult is already set
-     *
-     * @internal
-     */
-    public function setResult(BatchResult $result)
-    {
-        if (isset($this->result)) {
-            throw new \RuntimeException('BatchResult is already set');
-        }
-
-        $this->result = $result;
-    }
-
-    /**
-     * Checks if a request is successful
-     *
-     * @param RequestInterface $request
-     *
-     * @return boolean
-     */
-    public function isSuccessful(RequestInterface $request)
-    {
-        return $this->getResult()->hasResponseFor($request);
-    }
-
-    /**
-     * Checks if a request is failed
-     *
-     * @param RequestInterface $request
-     *
-     * @return boolean
-     */
-    public function isFailed(RequestInterface $request)
-    {
-        return $this->exceptions->contains($request);
-    }
-
-    /**
-     * Returns all exceptions
-     *
-     * @return Exception[]
-     */
-    public function getExceptions()
-    {
-        $exceptions = [];
-
-        foreach ($this->exceptions as $request) {
-            $exceptions[] = $this->exceptions[$request];
-        }
-
-        return $exceptions;
-    }
-
-    /**
-     * Returns an exception for a request
-     *
-     * @param RequestInterface $request
-     *
-     * @return Exception
-     *
-     * @throws \UnexpectedValueException If request is not found
-     */
-    public function getExceptionFor(RequestInterface $request)
-    {
-        try {
-            return $this->exceptions[$request];
-        } catch (\UnexpectedValueException $e) {
-            throw new \UnexpectedValueException('Request not found', $e->getCode(), $e);
-        }
-    }
-
-    /**
-     * Checks if there is an exception for a request
-     *
-     * @param RequestInterface $request
-     *
-     * @return boolean
-     */
-    public function hasExceptionFor(RequestInterface $request)
-    {
-        return $this->exceptions->contains($request);
-    }
-
-    /**
-     * Adds an exception
-     *
-     * @param RequestInterface  $request
-     * @param Exception         $exception
-     */
-    public function addException(RequestInterface $request, Exception $exception)
-    {
-        $this->exceptions->attach($request, $exception);
-    }
 }