Added int type check to $tries and declared strict types (BC break).

Added FailingTooHardException::getAttempts.

Author: Bilge

composer.json

@@ -17,7 +17,7 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^8.5|^9",
-    "amphp/amp": "^2.1"
+    "amphp/amp": "^2.2"
   },
   "autoload": {
     "files": [
@@ -27,6 +27,11 @@
       "ScriptFUSION\\Retry\\": "src"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "ScriptFUSIONTest\\Retry\\": "test"
+    }
+  },
   "scripts": {
     "test": "phpunit -c test"
   }

src/FailingTooHardException.php

@@ -1,13 +1,29 @@
 <?php
+declare(strict_types=1);
+
 namespace ScriptFUSION\Retry;
 
 /**
  * The exception that is thrown when an operation fails too many times.
  */
 class FailingTooHardException extends \RuntimeException
 {
-    public function __construct($attempts, \Exception $previous)
+    private $attempts;
+
+    public function __construct(int $attempts, \Exception $previous)
     {
         parent::__construct("Operation failed after $attempts attempt(s).", 0, $previous);
+
+        $this->attempts = $attempts;
+    }
+
+    /**
+     * Gets the number of times the operation was attempted before giving up.
+     *
+     * @return int Number of attempts.
+     */
+    public function getAttempts(): int
+    {
+        return $this->attempts;
     }
 }

src/retry.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 namespace ScriptFUSION\Retry;
 
 use Amp\Coroutine;
@@ -12,19 +14,16 @@
  *
  * @param int $tries Number of times.
  * @param callable $operation Operation.
- * @param callable $onError Optional. Exception handler.
+ * @param callable|null $onError Optional. Exception handler.
  *
  * @return mixed Result of running the operation if tries is greater than zero, otherwise null.
  *
- * @throws FailingTooHardException The maximum number of attempts was reached.
- * @throws \UnexpectedValueException The operation returned an unsupported type.
  */
-function retry($tries, callable $operation, callable $onError = null)
+function retry(int $tries, callable $operation, callable $onError = null)
 {
-    /** @var \Generator $generator */
     $generator = (static function () use ($tries, $operation, $onError): \Generator {
         // Nothing to do if tries less than or equal to zero.
-        if (($tries |= 0) <= $attempts = 0) {
+        if ($tries <= $attempts = 0) {
             return;
         }
 
@@ -76,15 +75,13 @@ function retry($tries, callable $operation, callable $onError = null)
  *
  * @param int $tries Number of times.
  * @param callable $operation Operation.
- * @param callable $onError Optional. Exception handler.
+ * @param callable|null $onError Optional. Exception handler.
  *
  * @return Promise Promise that returns the result of running the operation if tries is greater than zero, otherwise
  *     a promise that yields null.
  *
- * @throws FailingTooHardException The maximum number of attempts was reached.
- * @throws \UnexpectedValueException The operation returned an unsupported type.
  */
-function retryAsync($tries, callable $operation, callable $onError = null): Promise
+function retryAsync(int $tries, callable $operation, callable $onError = null): Promise
 {
     $generator = retry($tries, $operation, $onError);
 

test/FailingTooHardExceptionTest.php

@@ -0,0 +1,18 @@
+<?php
+declare(strict_types=1);
+
+namespace ScriptFUSIONTest\Retry;
+
+use ScriptFUSION\Retry\FailingTooHardException;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @see FailingTooHardException
+ */
+final class FailingTooHardExceptionTest extends TestCase
+{
+    public function testGetAttempts(): void
+    {
+        self::assertSame($attempts = 123, (new FailingTooHardException($attempts, new \Exception()))->getAttempts());
+    }
+}

test/phpunit.xml

@@ -1,12 +1,13 @@
 <phpunit
     beStrictAboutOutputDuringTests="true"
 >
-    <testsuite>
+    <testsuite name="all">
         <directory>.</directory>
     </testsuite>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
+
+    <coverage processUncoveredFiles="true">
+        <include>
             <directory>../src</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </coverage>
 </phpunit>