Add new automatic action to close task based on date moved

ChangeLog

@@ -1,10 +1,12 @@
-Version 1.0.34
+Version 1.0.34 (unreleased)
 --------------
 
 New features:
 
 * Custom project roles with configurable restrictions
 * Duplicate a task to multiple projects during creation
+* New automatic action:
+    - Close a task in a specific column when not moved during a given period
 
 Version 1.0.33
 --------------

app/Action/TaskCloseNoActivityColumn.php

@@ -5,7 +5,7 @@ namespace Kanboard\Action;
 use Kanboard\Model\TaskModel;
 
 /**
- * Close automatically a task after inactive and in an defined column
+ * Close automatically a task after inactive and in a defined column
  *
  * @package Kanboard\Action
  * @author  Frederic Guillot

app/Action/TaskCloseNotMovedColumn.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Kanboard\Action;
+
+use Kanboard\Model\TaskModel;
+
+/**
+ * Close automatically in a defined column after a certain amount of time
+ *
+ * @package Kanboard\Action
+ * @author  Frederic Guillot
+ */
+class TaskCloseNotMovedColumn extends Base
+{
+    /**
+     * Get automatic action description
+     *
+     * @access public
+     * @return string
+     */
+    public function getDescription()
+    {
+        return t('Close a task in a specific column when not moved during a given period');
+    }
+
+    /**
+     * 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 (defined by the user)
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array(
+            'duration' => t('Duration in days'),
+            'column_id' => t('Column')
+        );
+    }
+
+    /**
+     * Get the required parameter for the event
+     *
+     * @access public
+     * @return string[]
+     */
+    public function getEventRequiredParameters()
+    {
+        return array('tasks');
+    }
+
+    /**
+     * Execute the action (close the task)
+     *
+     * @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();
+        $max = $this->getParam('duration') * 86400;
+
+        foreach ($data['tasks'] as $task) {
+            $duration = time() - $task['date_moved'];
+
+            if ($duration > $max && $task['column_id'] == $this->getParam('column_id')) {
+                $results[] = $this->taskStatusModel->close($task['id']);
+            }
+        }
+
+        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

@@ -2,12 +2,12 @@
 
 namespace Kanboard\ServiceProvider;
 
+use Pimple\Container;
+use Pimple\ServiceProviderInterface;
 use Kanboard\Action\TaskAssignColorPriority;
 use Kanboard\Action\TaskAssignDueDateOnCreation;
 use Kanboard\Action\TaskMoveColumnClosed;
 use Kanboard\Action\TaskMoveColumnNotMovedPeriod;
-use Pimple\Container;
-use Pimple\ServiceProviderInterface;
 use Kanboard\Core\Action\ActionManager;
 use Kanboard\Action\CommentCreation;
 use Kanboard\Action\CommentCreationMoveTaskColumn;
@@ -36,6 +36,7 @@ use Kanboard\Action\TaskOpen;
 use Kanboard\Action\TaskUpdateStartDate;
 use Kanboard\Action\TaskCloseNoActivity;
 use Kanboard\Action\TaskCloseNoActivityColumn;
+use Kanboard\Action\TaskCloseNotMovedColumn;
 use Kanboard\Action\TaskAssignColorSwimlane;
 use Kanboard\Action\TaskAssignPrioritySwimlane;
 
@@ -75,6 +76,7 @@ class ActionProvider implements ServiceProviderInterface
         $container['actionManager']->register(new TaskCloseColumn($container));
         $container['actionManager']->register(new TaskCloseNoActivity($container));
         $container['actionManager']->register(new TaskCloseNoActivityColumn($container));
+        $container['actionManager']->register(new TaskCloseNotMovedColumn($container));
         $container['actionManager']->register(new TaskCreation($container));
         $container['actionManager']->register(new TaskDuplicateAnotherProject($container));
         $container['actionManager']->register(new TaskEmail($container));

tests/units/Action/TaskCloseNotMovedColumnTest.php

@@ -0,0 +1,49 @@
+<?php
+
+require_once __DIR__.'/../Base.php';
+
+use Kanboard\Action\TaskCloseNotMovedColumn;
+use Kanboard\Event\TaskListEvent;
+use Kanboard\Model\TaskCreationModel;
+use Kanboard\Model\TaskFinderModel;
+use Kanboard\Model\ProjectModel;
+use Kanboard\Model\TaskModel;
+
+class TaskCloseNotMovedColumnTest extends Base
+{
+    public function testClose()
+    {
+        $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')));
+        $this->assertEquals(2, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test')));
+        $this->assertEquals(3, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test', 'column_id' => 2)));
+
+        $this->container['db']->table(TaskModel::TABLE)->in('id', array(1, 3))->update(array('date_moved' => strtotime('-10days')));
+
+        $tasks = $taskFinderModel->getAll(1);
+        $event = new TaskListEvent(array('tasks' => $tasks, 'project_id' => 1));
+
+        $action = new TaskCloseNotMovedColumn($this->container);
+        $action->setProjectId(1);
+        $action->setParam('duration', 2);
+        $action->setParam('column_id', 2);
+
+        $this->assertTrue($action->execute($event, TaskModel::EVENT_DAILY_CRONJOB));
+
+        $task = $taskFinderModel->getById(1);
+        $this->assertNotEmpty($task);
+        $this->assertEquals(1, $task['is_active']);
+
+        $task = $taskFinderModel->getById(2);
+        $this->assertNotEmpty($task);
+        $this->assertEquals(1, $task['is_active']);
+
+        $task = $taskFinderModel->getById(3);
+        $this->assertNotEmpty($task);
+        $this->assertEquals(0, $task['is_active']);
+    }
+}