Automatic action to change task color when due date is expired (PR #3062)

ChangeLog

@@ -7,6 +7,7 @@ New features:
 * Send tasks by email
 * Add Reply-To header to emails sent from Kanboard
 * Upload Sqlite database from user interface
+* Automatic action to change task color when due date is expired
 
 Improvements:
 

app/Action/TaskAssignColorOnDueDate.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace Kanboard\Action;
+
+use Kanboard\Model\TaskModel;
+
+
+/**
+ * Assign a color to a priority
+ *
+ * @package Kanboard\Action
+ * @author  Julien Buratto
+ */
+class TaskAssignColorOnDueDate extends Base
+{
+    /**
+     * Get action description
+     *
+     * @access public
+     * @return string
+     */
+    public function getDescription()
+    {
+        return t('Assign automatically a color when due date is expired');
+    }
+
+    /**
+     * Get the list of compatible events
+     *
+     * @access public
+     * @return array
+     */
+    public function getCompatibleEvents()
+    {
+        return array(
+            TaskModel::EVENT_DAILY_CRONJOB,
+        );
+    }
+
+    /**
+     * Get the required parameter for the action
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array(
+            'color_id' => t('Color'),
+        );
+    }
+
+    /**
+     * Get all tasks
+     *
+     * @access public
+     * @return array
+     */
+
+    public function getEventRequiredParameters()
+    {
+        return array('tasks');
+    }
+
+    /**
+     * Execute the action (change the task color)
+     *
+     * @access public
+     * @param  array   $data   Event data dictionary
+     * @return bool            True if the action was executed or false when not executed
+     */
+    public function doAction(array $data)
+    {
+        $results = array();
+
+        foreach ($data['tasks'] as $task) {
+            if ($task['date_due'] <= time() && $task['date_due'] > 0) {
+                $values = array(
+                    'id'       => $task['id'],
+                    'color_id' => $this->getParam('color_id'),
+                );
+                $results[] = $this->taskModificationModel->update($values, false);
+            }
+        }
+
+        return in_array(true, $results, true);
+    }
+
+    /**
+     * Check if the event data meet the action condition
+     *
+     * @access public
+     * @param  array   $data   Event data dictionary
+     * @return bool
+     */
+    public function hasRequiredCondition(array $data)
+    {
+        return count($data['tasks']) > 0;
+    }
+}

app/ServiceProvider/ActionProvider.php

@@ -4,6 +4,7 @@ namespace Kanboard\ServiceProvider;
 
 use Pimple\Container;
 use Pimple\ServiceProviderInterface;
+use Kanboard\Action\TaskAssignColorOnDueDate;
 use Kanboard\Action\TaskAssignColorPriority;
 use Kanboard\Action\TaskAssignDueDateOnCreation;
 use Kanboard\Action\TaskMoveColumnClosed;
@@ -92,6 +93,7 @@ class ActionProvider implements ServiceProviderInterface
         $container['actionManager']->register(new TaskAssignDueDateOnCreation($container));
         $container['actionManager']->register(new TaskAssignColorSwimlane($container));
         $container['actionManager']->register(new TaskAssignPrioritySwimlane($container));
+        $container['actionManager']->register(new TaskAssignColorOnDueDate($container));
 
         return $container;
     }

tests/units/Action/TaskAssignColorOnDueDateTest.php

@@ -0,0 +1,37 @@
+<?php
+
+require_once __DIR__.'/../Base.php';
+
+use Kanboard\Action\TaskAssignColorOnDueDate;
+use Kanboard\Event\TaskListEvent;
+use Kanboard\Model\TaskCreationModel;
+use Kanboard\Model\TaskFinderModel;
+use Kanboard\Model\ProjectModel;
+use Kanboard\Model\TaskModel;
+
+class TaskAssignColorOnDueDateTest extends Base
+{
+    public function testChangeColor()
+    {
+        $projectModel = new ProjectModel($this->container);
+        $taskCreationModel = new TaskCreationModel($this->container);
+        $taskFinderModel = new TaskFinderModel($this->container);
+
+        $this->assertEquals(1, $projectModel->create(array('name' => 'test1')));
+        $this->assertEquals(1, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test', 'date_due' => strtotime('-1 day'))));
+        $this->assertEquals(2, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test')));
+
+        $tasks = $taskFinderModel->getAll(1);
+        $event = new TaskListEvent(array('tasks' => $tasks, 'project_id' => 1));
+
+        $action = new TaskAssignColorOnDueDate($this->container);
+        $action->setProjectId(1);
+        $action->setParam('color_id', 'red');
+
+        $this->assertTrue($action->execute($event, TaskModel::EVENT_DAILY_CRONJOB));
+
+        $tasks = $taskFinderModel->getAll(1);
+        $this->assertEquals('red', $tasks[0]['color_id']);
+        $this->assertEquals('yellow', $tasks[1]['color_id']);
+    }
+}