Add new automatic action: Move task to another column when the category is changed

8 files changed, 186 insertions, 9 deletions

diff --git a/app/Action/Base.php b/app/Action/Base.php
index f29e9323..d0c81d89 100644
--- a/app/Action/Base.php
+++ b/app/Action/Base.php
@@ -222,12 +222,17 @@ abstract class Base extends \Core\Base
         }
 
         $data = $event->getAll();
+        $result = false;
 
         if ($this->isExecutable($data)) {
             $this->called = true;
-            return $this->doAction($data);
+            $result = $this->doAction($data);
         }
 
-        return false;
+        if (DEBUG) {
+            $this->container['logger']->debug(get_called_class().' => '.($result ? 'true' : 'false'));
+        }
+
+        return $result;
     }
 }
diff --git a/app/Action/TaskMoveColumnAssigned.php b/app/Action/TaskMoveColumnAssigned.php
index decf4b01..70ad7699 100644
--- a/app/Action/TaskMoveColumnAssigned.php
+++ b/app/Action/TaskMoveColumnAssigned.php
@@ -22,6 +22,7 @@ class TaskMoveColumnAssigned extends Base
     {
         return array(
             Task::EVENT_ASSIGNEE_CHANGE,
+            Task::EVENT_UPDATE,
         );
     }
 
@@ -85,6 +86,6 @@ class TaskMoveColumnAssigned extends Base
      */
     public function hasRequiredCondition(array $data)
     {
-        return $data['column_id'] == $this->getParam('src_column_id') && $data['owner_id'];
+        return $data['column_id'] == $this->getParam('src_column_id') && $data['owner_id'] > 0;
     }
 }
diff --git a/app/Action/TaskMoveColumnCategoryChange.php b/app/Action/TaskMoveColumnCategoryChange.php
new file mode 100644
index 00000000..a0f41ba4
--- /dev/null
+++ b/app/Action/TaskMoveColumnCategoryChange.php
@@ -0,0 +1,89 @@
+<?php
+
+namespace Action;
+
+use Model\Task;
+
+/**
+ * Move a task to another column when the category is changed
+ *
+ * @package action
+ * @author  Francois Ferrand
+ */
+class TaskMoveColumnCategoryChange extends Base
+{
+    /**
+     * Get the list of compatible events
+     *
+     * @access public
+     * @return array
+     */
+    public function getCompatibleEvents()
+    {
+        return array(
+            Task::EVENT_UPDATE,
+        );
+    }
+
+    /**
+     * Get the required parameter for the action (defined by the user)
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array(
+            'dest_column_id' => t('Destination column'),
+            'category_id' => t('Category'),
+        );
+    }
+
+    /**
+     * Get the required parameter for the event
+     *
+     * @access public
+     * @return string[]
+     */
+    public function getEventRequiredParameters()
+    {
+        return array(
+            'task_id',
+            'column_id',
+            'project_id',
+            'category_id',
+        );
+    }
+
+    /**
+     * Execute the action (move the task to another column)
+     *
+     * @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)
+    {
+        $original_task = $this->taskFinder->getById($data['task_id']);
+
+        return $this->taskPosition->movePosition(
+            $data['project_id'],
+            $data['task_id'],
+            $this->getParam('dest_column_id'),
+            $original_task['position'],
+            $original_task['swimlane_id']
+        );
+    }
+
+    /**
+     * 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 $data['column_id'] != $this->getParam('dest_column_id') && $data['category_id'] == $this->getParam('category_id');
+    }
+}
diff --git a/app/Action/TaskMoveColumnUnAssigned.php b/app/Action/TaskMoveColumnUnAssigned.php
index b773252d..2216c8d0 100644
--- a/app/Action/TaskMoveColumnUnAssigned.php
+++ b/app/Action/TaskMoveColumnUnAssigned.php
@@ -21,7 +21,8 @@ class TaskMoveColumnUnAssigned extends Base
     public function getCompatibleEvents()
     {
         return array(
-            Task::EVENT_ASSIGNEE_CHANGE
+            Task::EVENT_ASSIGNEE_CHANGE,
+            Task::EVENT_UPDATE,
         );
     }
 
@@ -85,6 +86,6 @@ class TaskMoveColumnUnAssigned extends Base
      */
     public function hasRequiredCondition(array $data)
     {
-        return $data['column_id'] == $this->getParam('src_column_id') && ! $data['owner_id'];
+        return $data['column_id'] == $this->getParam('src_column_id') && $data['owner_id'] == 0;
     }
 }
diff --git a/app/Model/Action.php b/app/Model/Action.php
index 3e8aa091..c3bfe017 100644
--- a/app/Model/Action.php
+++ b/app/Model/Action.php
@@ -57,6 +57,7 @@ class Action extends Base
             'TaskAssignUser' => t('Change the assignee based on an external username'),
             'TaskAssignCategoryLabel' => t('Change the category based on an external label'),
             'TaskUpdateStartDate' => t('Automatically update the start date'),
+            'TaskMoveColumnCategoryChange' => t('Move the task to another column when the category is changed'),
         );
 
         asort($values);
diff --git a/app/Model/TaskModification.php b/app/Model/TaskModification.php
index 677fcd60..4691ce81 100644
--- a/app/Model/TaskModification.php
+++ b/app/Model/TaskModification.php
@@ -42,13 +42,19 @@ class TaskModification extends Base
      */
     public function fireEvents(array $task, array $new_values)
     {
+        $events = array();
         $event_data = array_merge($task, $new_values, array('task_id' => $task['id']));
 
-        if (isset($new_values['owner_id']) && $task['owner_id'] != $new_values['owner_id']) {
-            $events = array(Task::EVENT_ASSIGNEE_CHANGE);
+        // Values changed
+        $event_data['changes'] = array_diff_assoc($new_values, $task);
+        unset($event_data['changes']['date_modification']);
+
+        if ($this->isFieldModified('owner_id', $event_data['changes'])) {
+            $events[] = Task::EVENT_ASSIGNEE_CHANGE;
         }
         else {
-            $events = array(Task::EVENT_CREATE_UPDATE, Task::EVENT_UPDATE);
+            $events[] = Task::EVENT_CREATE_UPDATE;
+            $events[] = Task::EVENT_UPDATE;
         }
 
         foreach ($events as $event) {
@@ -57,6 +63,19 @@ class TaskModification extends Base
     }
 
     /**
+     * Return true if the field is the only modified value
+     *
+     * @access public
+     * @param  string  $field
+     * @param  array   $changes
+     * @return boolean
+     */
+    public function isFieldModified($field, array $changes)
+    {
+        return isset($changes[$field]) && count($changes) === 1;
+    }
+
+    /**
      * Prepare data before task modification
      *
      * @access public
diff --git a/tests/units/ActionTaskMoveColumnCategoryChangeTest.php b/tests/units/ActionTaskMoveColumnCategoryChangeTest.php
new file mode 100644
index 00000000..0ddee786
--- /dev/null
+++ b/tests/units/ActionTaskMoveColumnCategoryChangeTest.php
@@ -0,0 +1,61 @@
+<?php
+
+require_once __DIR__.'/Base.php';
+
+use Event\GenericEvent;
+use Model\Task;
+use Model\TaskCreation;
+use Model\TaskFinder;
+use Model\Project;
+use Model\Category;
+use Integration\GithubWebhook;
+
+class ActionTaskMoveColumnCategoryChangeTest extends Base
+{
+    public function testExecute()
+    {
+        $action = new Action\TaskMoveColumnCategoryChange($this->container, 1, Task::EVENT_UPDATE);
+        $action->setParam('dest_column_id', 3);
+        $action->setParam('category_id', 1);
+
+        $this->assertEquals(3, $action->getParam('dest_column_id'));
+        $this->assertEquals(1, $action->getParam('category_id'));
+
+        // We create a task in the first column
+        $tc = new TaskCreation($this->container);
+        $tf = new TaskFinder($this->container);
+        $p = new Project($this->container);
+        $c = new Category($this->container);
+
+        $this->assertEquals(1, $p->create(array('name' => 'test')));
+        $this->assertEquals(1, $c->create(array('name' => 'bug', 'project_id' => 1)));
+        $this->assertEquals(1, $tc->create(array('title' => 'test', 'project_id' => 1, 'column_id' => 1)));
+
+        // No category should be assigned + column_id=1
+        $task = $tf->getById(1);
+        $this->assertNotEmpty($task);
+        $this->assertEmpty($task['category_id']);
+        $this->assertEquals(1, $task['column_id']);
+
+        // We create an event to move the task to the 2nd column
+        $event = array(
+            'task_id' => 1,
+            'column_id' => 1,
+            'project_id' => 1,
+            'category_id' => 1,
+        );
+
+        // Our event should be executed
+        $this->assertTrue($action->hasCompatibleEvent());
+        $this->assertTrue($action->hasRequiredProject($event));
+        $this->assertTrue($action->hasRequiredParameters($event));
+        $this->assertTrue($action->hasRequiredCondition($event));
+        $this->assertTrue($action->isExecutable($event));
+        $this->assertTrue($action->execute(new GenericEvent($event)));
+
+        // Our task should be moved to the other column
+        $task = $tf->getById(1);
+        $this->assertNotEmpty($task);
+        $this->assertEquals(3, $task['column_id']);
+    }
+}
diff --git a/tests/units/ActionTaskUpdateStartDateTest.php b/tests/units/ActionTaskUpdateStartDateTest.php
index da36551d..4bf87452 100644
--- a/tests/units/ActionTaskUpdateStartDateTest.php
+++ b/tests/units/ActionTaskUpdateStartDateTest.php
@@ -38,7 +38,7 @@ class ActionTaskUpdateStartDateTest extends Base
         // Our event should be executed
         $this->assertTrue($action->execute(new GenericEvent($event)));
 
-        // Our task should be closed
+        // Our task should be updated
         $task = $tf->getById(1);
         $this->assertNotEmpty($task);
         $this->assertEquals(time(), $task['date_started'], '', 2);