Merge pull request #2 from Tobion/overengineer

Overengineer + Modernize

Author: Tobion

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.gitattributes

@@ -0,0 +1,6 @@
+/tests export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+phpunit.xml.dist export-ignore

.gitignore

@@ -1,6 +1,3 @@
-# Composer
-/composer.phar
-/composer.lock
-/vendor
-
-/build
+composer.lock
+phpunit.xml
+vendor/

.travis.yml

@@ -1,17 +1,13 @@
 language: php
 
 php:
-    - 5.4
-    - 5.5
-    - 5.6
-    - hhvm
-    - 7
-
-before_install:
-    - composer self-update
+    - 7.1
+    - 7.2
+    - 7.3
+    - 7.4snapshot
 
 install:
-    - composer install --prefer-source
+    - composer install --no-interaction --prefer-dist
 
 script:
     - ./vendor/bin/phpunit --coverage-text

LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2015 Tobias Schultze and Christian Riesen
+Copyright (c) 2015-2019 Tobias Schultze
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ 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.
-

README.md

@@ -1,35 +1,54 @@
 Retry
 =====
 
-PHP class for retrying code pieces in case of exceptions.
+PHP library for retrying code, e.g. HTTP requests or database transactions, in case of failures.
 
 [![Build Status](https://travis-ci.org/Tobion/retry.svg)](https://travis-ci.org/Tobion/retry)
 
-Born out of a need of [Tobias Schultze](https://github.com/Tobion) and [Christian Riesen](https://github.com/ChristianRiesen) for a project at [Liip](http://www.liip.ch)
-which then found a specific [merge request into Doctrine](https://github.com/doctrine/dbal/pull/718/files). We
-thought this works just as well on a generic basis.
+Installation
+------------
+
+    $ composer require tobion/retry
 
 Usage
 -----
 
-Make sure it's autoloaded. Wrap the code you want retried with the class and execute it.
-
 ```php
 use Tobion\Retry\Retry;
 
-// Anon function
-$retry = new Retry(function () { return 42; });
-
-// Outputs 42
-echo $retry();
-
+$callableThatMightFail = function (int $arg1, int $arg2): int {
+    if (random_int(1, 2) % 2) {
+        throw new \RuntimeException('Sudden error');
+    }
+
+    return $arg1 + $arg2;
+};
+
+// Allows you to call the callable with parameters and retry its execution in case an exception is thrown.
+// You can access the return value of the callable (3 in this case).
+$returnValue = Retry::retry($callableThatMightFail, 1, 2);
+
+// By default:
+// - The callable is retried twice (i.e. max three executions). If it still fails, the last error is rethrown.
+// - Retries have a 300 milliseconds delay between them.
+// - Every \Throwable will trigger the retry logic, i.e. both \Exception and \Error.
+// You can adjust the retry logic like this:
+$retryingCallable = Retry::configure()
+    ->setMaxRetries(5)
+    ->setDelayInMs(100)
+    ->setRetryableExceptions(\RuntimeException::class) // other failures like \TypeError will not be retried
+    ->decorate($callableThatMightFail)
+;
+$returnValue = $retryingCallable(1, 2);
+// $retryingCallable just decorates the original callable and can be used like it.
+// To find out how often it had to retry, you can use:
+$retryingCallable->getRetries();
 ```
 
-You can configure the exceptions to listen to for retries, the number of retries and the time between retries (in milliseconds) at construction time of the Retry class.
-
-By default it will catch all exceptions
+Contributing
+------------
 
-Development
------------
+To run tests:
 
-To run tests, install [composer](https://getcomposer.org/), run `composer install` (or wherever you have composer installed) then run `vendor/phpunit/phpunit/phpunit` 
+    $ composer install
+    $ vendor/bin/phpunit

composer.json

@@ -2,31 +2,20 @@
     "name": "tobion/retry",
     "type": "library",
     "description": "A generic library to retry an operation in case of an error. You can configure the behavior like the exceptions to retry on.",
-    "keywords": [
-        "retry",
-        "retryable",
-        "restart",
-        "repeat"
-    ],
+    "keywords": ["retry", "retryable", "restart", "repeat"],
     "homepage": "https://github.com/Tobion/retry",
     "license": "MIT",
     "authors": [
         {
             "name": "Tobias Schultze",
-            "role": "Developer"
-        },
-        {
-            "name": "Christian Riesen",
-            "email": "chris.riesen@gmail.com",
-            "homepage": "http://christianriesen.com",
-            "role": "Developer"
+            "homepage": "https://github.com/Tobion"
         }
     ],
     "require": {
-        "php": ">=5.4"
+        "php": ">=7.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "4.*"
+        "phpunit/phpunit": "^7.5"
     },
     "autoload": {
         "psr-4": {
@@ -40,7 +29,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "0.1.x-dev"
+            "dev-master": "1.x-dev"
         }
     }
 }

phpunit.xml.dist

@@ -1,8 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.6/phpunit.xsd"
-    backupGlobals                           = "false"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.5/phpunit.xsd"
     beStrictAboutTestsThatDoNotTestAnything = "true"
     beStrictAboutOutputDuringTests          = "true"
     colors                                  = "true"

src/DelayMilliseconds.php renamed to src/ExceptionHandler/DelayMilliseconds.php

@@ -1,38 +1,26 @@
 <?php
 
-namespace Tobion\Retry;
+namespace Tobion\Retry\ExceptionHandler;
 
 /**
  * Invokable class that delays execution by given number of milliseconds with usleep.
   *
  * @author Tobias Schultze <http://tobion.de>
  * @author Christian Riesen <http://christianriesen.com>
  */
-class DelayMilliseconds
+final class DelayMilliseconds
 {
     /**
-     * Delay in milliseconds.
-     *
      * @var int
      */
     private $milliseconds;
 
-    /**
-     * Constructor.
-     *
-     * @param int $milliseconds Delay in milliseconds
-     */
-    public function __construct($milliseconds)
+    public function __construct(int $milliseconds)
     {
         $this->milliseconds = $milliseconds;
     }
 
-    /**
-     * Wait the configured amount of milliseconds.
-     *
-     * @return void
-     */
-    public function __invoke()
+    public function __invoke(): void
     {
         if ($this->milliseconds <= 0) {
             return;

src/ExceptionHandler/DelegatingStack.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Tobion\Retry\ExceptionHandler;
+
+/**
+ * Invokable class that delegates exception handling to an array of callables.
+  *
+ * @author Tobias Schultze <http://tobion.de>
+ */
+final class DelegatingStack
+{
+    /**
+     * @var callable[]
+     */
+    private $exceptionHandlers = [];
+
+    public function __construct(callable ...$exceptionHandlers)
+    {
+        $this->exceptionHandlers = $exceptionHandlers;
+    }
+
+    public function __invoke(\Throwable $e): void
+    {
+        foreach ($this->exceptionHandlers as $callable) {
+            $callable($e);
+        }
+    }
+}