New Automatic Actions: Colour by Swimlane and Priority by Swimlane

4 files changed, 330 insertions, 0 deletions

diff --git a/app/Action/TaskAssignColorSwimlane.php b/app/Action/TaskAssignColorSwimlane.php
new file mode 100644
index 00000000..31f2d25a
--- /dev/null
+++ b/app/Action/TaskAssignColorSwimlane.php
@@ -0,0 +1,99 @@
+<?php
+
+namespace Kanboard\Action;
+
+use Kanboard\Model\TaskModel;
+
+/**
+ * Assign a color to a task based on Swimlane
+ *
+ * @package Kanboard\Action
+ * @author  Dave Almond
+ */
+class TaskAssignColorSwimlane extends Base
+{
+    /**
+     * Get automatic action description
+     *
+     * @access public
+     * @return string
+     */
+    public function getDescription()
+    {
+        return t('Assign a color when the task is moved to a specific swimlane');
+    }
+
+    /**
+     * Get the list of compatible events
+     *
+     * @access public
+     * @return array
+     */
+    public function getCompatibleEvents()
+    {
+        return array(
+            TaskModel::EVENT_CREATE,
+            TaskModel::EVENT_MOVE_SWIMLANE,
+        );
+    }
+
+    /**
+     * Get the required parameter for the action (defined by the user)
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array(
+            'swimlane_id' => t('Swimlane'),
+            'color_id' => t('Color'),
+        );
+    }
+
+    /**
+     * Get the required parameter for the event
+     *
+     * @access public
+     * @return string[]
+     */
+    public function getEventRequiredParameters()
+    {
+        return array(
+            'task_id',
+            'task' => array(
+                'project_id',
+                'swimlane_id',
+            ),
+        );
+    }
+
+    /**
+     * Execute the action (set 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)
+    {
+        $values = array(
+            'id' => $data['task_id'],
+            'color_id' => $this->getParam('color_id'),
+        );
+
+        return $this->taskModificationModel->update($values, false);
+    }
+
+    /**
+     * 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['task']['swimlane_id'] == $this->getParam('swimlane_id');
+    }
+}
diff --git a/app/Action/TaskAssignPrioritySwimlane.php b/app/Action/TaskAssignPrioritySwimlane.php
new file mode 100644
index 00000000..7eaca7c8
--- /dev/null
+++ b/app/Action/TaskAssignPrioritySwimlane.php
@@ -0,0 +1,99 @@
+<?php
+
+namespace Kanboard\Action;
+
+use Kanboard\Model\TaskModel;
+
+/**
+ * Set a priority automatically according to the Swimlane
+ *
+ * @package Kanboard\Action
+ * @author  Dave Almond
+ */
+class TaskAssignPrioritySwimlane extends Base
+{
+    /**
+     * Get automatic action description
+     *
+     * @access public
+     * @return string
+     */
+    public function getDescription()
+    {
+        return t('Assign a priority when the task is moved to a specific swimlane');
+    }
+
+    /**
+     * Get the list of compatible events
+     *
+     * @access public
+     * @return array
+     */
+    public function getCompatibleEvents()
+    {
+        return array(
+            TaskModel::EVENT_CREATE,
+            TaskModel::EVENT_MOVE_SWIMLANE,
+        );
+    }
+
+    /**
+     * Get the required parameter for the action (defined by the user)
+     *
+     * @access public
+     * @return array
+     */
+    public function getActionRequiredParameters()
+    {
+        return array(
+            'swimlane_id' => t('Swimlane'),
+            'priority' => t('Priority'),
+        );
+    }
+
+    /**
+     * Get the required parameter for the event
+     *
+     * @access public
+     * @return string[]
+     */
+    public function getEventRequiredParameters()
+    {
+        return array(
+            'task_id',
+            'task' => array(
+                'project_id',
+                'swimlane_id',
+            ),
+        );
+    }
+
+    /**
+     * Execute the action (set the priority)
+     *
+     * @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)
+    {
+        $values = array(
+            'id' => $data['task_id'],
+            'priority' => $this->getParam('priority'),
+        );
+
+        return $this->taskModificationModel->update($values);
+    }
+
+    /**
+     * 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['task']['swimlane_id'] == $this->getParam('swimlane_id');
+    }
+}
diff --git a/tests/units/Action/TaskAssignColorSwimlaneTest.php b/tests/units/Action/TaskAssignColorSwimlaneTest.php
new file mode 100644
index 00000000..898838da
--- /dev/null
+++ b/tests/units/Action/TaskAssignColorSwimlaneTest.php
@@ -0,0 +1,66 @@
+<?php
+
+require_once __DIR__.'/../Base.php';
+
+use Kanboard\Event\TaskEvent;
+use Kanboard\Model\TaskCreationModel;
+use Kanboard\Model\TaskFinderModel;
+use Kanboard\Model\ProjectModel;
+use Kanboard\Model\TaskModel;
+use Kanboard\Action\TaskAssignColorSwimlane;
+
+class TaskAssignColorSwimlaneTest extends Base
+{
+    public function testChangeSwimlane()
+    {
+        $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')));
+
+        $event = new TaskEvent(array(
+            'task_id' => 1,
+            'task' => array(
+                'project_id' => 1,
+                'swimlane_id' => 2,
+            )
+        ));
+
+        $action = new TaskAssignColorSwimlane($this->container);
+        $action->setProjectId(1);
+        $action->setParam('color_id', 'red');
+          $action->setParam('swimlane_id', 2);
+
+        $this->assertTrue($action->execute($event, TaskModel::EVENT_MOVE_SWIMLANE));
+
+        $task = $taskFinderModel->getById(1);
+        $this->assertNotEmpty($task);
+        $this->assertEquals('red', $task['color_id']);
+    }
+
+    public function testWithWrongCategory()
+    {
+        $projectModel = new ProjectModel($this->container);
+        $taskCreationModel = new TaskCreationModel($this->container);
+
+        $this->assertEquals(1, $projectModel->create(array('name' => 'test1')));
+        $this->assertEquals(1, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test')));
+
+        $event = new TaskEvent(array(
+            'task_id' => 1,
+            'task' => array(
+                'project_id' => 1,
+                'swimlane_id' => 3,
+            )
+        ));
+
+        $action = new TaskAssignColorSwimlane($this->container);
+        $action->setProjectId(1);
+        $action->setParam('color_id', 'red');
+        $action->setParam('swimlane_id', 2);
+
+        $this->assertFalse($action->execute($event, TaskModel::EVENT_MOVE_SWIMLANE));
+    }
+}
diff --git a/tests/units/Action/TaskAssignPrioritySwimlaneTest.php b/tests/units/Action/TaskAssignPrioritySwimlaneTest.php
new file mode 100644
index 00000000..f7217f5b
--- /dev/null
+++ b/tests/units/Action/TaskAssignPrioritySwimlaneTest.php
@@ -0,0 +1,66 @@
+<?php
+
+require_once __DIR__.'/../Base.php';
+
+use Kanboard\Event\TaskEvent;
+use Kanboard\Model\TaskCreationModel;
+use Kanboard\Model\TaskFinderModel;
+use Kanboard\Model\ProjectModel;
+use Kanboard\Model\TaskModel;
+use Kanboard\Action\TaskAssignPrioritySwimlane;
+
+class TaskAssignColorColumnTest extends Base
+{
+    public function testChangeSwimlane()
+    {
+        $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')));
+
+        $event = new TaskEvent(array(
+            'task_id' => 1,
+            'task' => array(
+                'project_id' => 1,
+                'priority' => 1,
+            )
+        ));
+
+        $action = new TaskAssignPrioritySwimlane($this->container);
+        $action->setProjectId(1);
+        $action->setParam('priority', 2);
+        $action->setParam('swimlane_id', 2);
+
+        $this->assertTrue($action->execute($event, TaskModel::EVENT_MOVE_SWIMLANE));
+
+        $task = $taskFinderModel->getById(1);
+        $this->assertNotEmpty($task);
+        $this->assertEquals(2, $task['priority']);
+    }
+
+    public function testWithWrongCategory()
+    {
+        $projectModel = new ProjectModel($this->container);
+        $taskCreationModel = new TaskCreationModel($this->container);
+
+        $this->assertEquals(1, $projectModel->create(array('name' => 'test1')));
+        $this->assertEquals(1, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test')));
+
+        $event = new TaskEvent(array(
+            'task_id' => 1,
+            'task' => array(
+                'project_id' => 1,
+                'swimlane_id' => 3,
+            )
+        ));
+
+        $action = new TaskAssignColorColumn($this->container);
+        $action->setProjectId(1);
+        $action->setParam('priority', 2);
+        $action->setParam('swimlane_id', 2);
+
+        $this->assertFalse($action->execute($event, TaskModel::EVENT_MOVE_SWIMLANE));
+    }
+}