Add source code

Author: abdala

.gitignore

@@ -1,6 +1,4 @@
 composer.phar
+composer.lock
 /vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+.phpunit.result.cache

.scrutinizer.yml

@@ -0,0 +1,12 @@
+checks:
+  php:
+    code_rating: true
+    duplication: true
+
+build:
+  tests:
+    override:
+      - command: 'phpunit --coverage-clover=clover.xml'
+        coverage:
+          file: 'clover.xml'
+          format: 'clover'

.travis.yml

@@ -0,0 +1,17 @@
+language: php
+
+php:
+  - 7.2
+  - 7.3
+  - 7.4snapshot
+
+matrix:
+  allow_failures:
+    - php: 7.4snapshot
+
+before_script:
+  - composer selfupdate
+  - composer install --prefer-dist
+  
+notifications:
+  email: false

README.md

@@ -1 +1,112 @@
-# task-manager-lib
+[![Build Status](https://travis-ci.org/cgauge/task-manager-lib.svg?branch=master)](https://travis-ci.org/cgauge/task-manager-lib)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cgauge/task-manager-lib/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/cgauge/task-manager-lib/?branch=master)
+
+# Task Manager ⚙️
+
+# Installation
+
+```bash
+composer require customergauge/task-manager
+```
+# Usage
+
+## Execute a task
+
+```php
+use Customergauge\TaskManager\Task;
+use Customergauge\TaskManager\TaskManager;
+
+class SimpleTask implements Task
+{
+    public function run(array $attributes) : array
+    {
+        echo "simple task";
+    }
+}
+
+$taskManager = new TaskManager; // defaults to StopOnFailure strategy
+$taskManager->add(new SimpleTask);
+
+$taskManager->run([]);
+
+// output: simple task 
+```
+## Continue on failure strategy
+
+```php
+use Customergauge\TaskManager\Task;
+use Customergauge\TaskManager\TaskManager;
+use Customergauge\TaskManager\Strategy\ContinueOnFailure;
+
+class FirstTask implements Task
+{
+    public function run(array $attributes) : array
+    {
+        throw new Exception;
+    }
+}
+
+class SecondTask implements Task
+{
+    public function run(array $attributes) : array
+    {
+        echo "second task";
+    }
+}
+
+$taskManager = new TaskManager(new ContinueOnFailure);
+$taskManager->add(new FirstTask)
+    ->add(new SecondTask)
+
+$taskManager->run([]);
+
+// output: second task
+```
+
+## Rollback executed tasks 
+
+```php
+use Customergauge\TaskManager\Task;
+use Customergauge\TaskManager\Reversible;
+use Customergauge\TaskManager\TaskManager;
+use Customergauge\TaskManager\Strategy\RollbackOnFailure;
+
+class FirstTask implements Task, Reversible
+{
+    public function run(array $attributes) : array
+    {
+        echo "first task";
+    }
+
+    public function reverse(array $attributes)
+    {
+        echo "reverse first task";
+    }
+}
+
+class SecondTask implements Task
+{
+    public function run(array $attributes) : array
+    {
+        throw new Exception;
+    }
+}
+
+$taskManager = new TaskManager(new RollbackOnFailure);
+$taskManager->add(new FirstTask)
+    ->add(new SecondTask)
+
+$taskManager->run([]);
+
+// output: 
+    firt task
+    reverse first task
+```
+
+# Contributing
+
+Contributions are always welcome, please have a look at our issues to see if there's something you could help with.
+
+# License
+
+Task Manager is licensed under MIT license.

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "customergauge/task-manager",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Abdala Cerqueira",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^7.2",
+        "psr/log": "^1.1"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.0",
+        "doctrine/coding-standard": "^6.0",
+        "phpstan/phpstan": "^0.11.8"
+    },
+    "autoload": {
+        "psr-4": {
+            "CustomerGauge\\TaskManager\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Test\\CustomerGauge\\TaskManager\\": "tests/"
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Unit Tests">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/InvalidTaskAttribute.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CustomerGauge\TaskManager;
+
+use InvalidArgumentException;
+use function get_class;
+use function implode;
+use function sprintf;
+
+class InvalidTaskAttribute extends InvalidArgumentException
+{
+    /**
+     * @param array<int, int|string> $keys
+     */
+    public static function duplicatedKey(Task $task, array $keys) : self
+    {
+        $message = sprintf(
+            'Duplicate task [%s] attribute keys [%s]. Use a different attribute key.',
+            get_class($task),
+            implode(', ', $keys)
+        );
+
+        return new static($message);
+    }
+}

src/Reversible.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CustomerGauge\TaskManager;
+
+interface Reversible
+{
+    /**
+     * @param mixed[] $attributes
+     */
+    public function reverse(array $attributes) : void;
+}

src/Strategy/ContinueOnFailure.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CustomerGauge\TaskManager\Strategy;
+
+use Throwable;
+
+class ContinueOnFailure implements Strategy
+{
+    /** @var Throwable[] */
+    private $exceptions = [];
+
+    /**
+     * @param mixed[] $context
+     */
+    public function execute(callable $callback, array $context = []) : void
+    {
+        try {
+            $callback();
+        } catch (Throwable $e) {
+            $this->exceptions[] = $e;
+        }
+    }
+
+    /**
+     * @return Throwable[]
+     */
+    public function exceptions() : array
+    {
+        return $this->exceptions;
+    }
+}

src/Strategy/RollbackOnFailure.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CustomerGauge\TaskManager\Strategy;
+
+use CustomerGauge\TaskManager\Reversible;
+use CustomerGauge\TaskManager\Task;
+use Throwable;
+use function array_filter;
+use function array_unshift;
+
+class RollbackOnFailure implements Strategy
+{
+    /** @var Task[] */
+    private $executed = [];
+
+    /** @var mixed[] */
+    private $context;
+
+    /**
+     * @param mixed[] $context
+     */
+    public function execute(callable $callback, array $context = []) : void
+    {
+        $this->context = $context;
+
+        try {
+            $task = $callback();
+
+            array_unshift($this->executed, $task);
+        } catch (Throwable $e) {
+            $this->rollback();
+        }
+    }
+
+    public function rollback() : void
+    {
+        $tasks = array_filter($this->executed, static function ($task) : bool {
+            return $task instanceof Reversible;
+        });
+
+        foreach ($tasks as $task) {
+            $task->reverse($this->context);
+        }
+    }
+}