AS1024
/
Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Associate tags to tasks in BoardFormatter

This commit is contained in:
Frederic Guillot 2016-06-24 10:05:45 -04:00
parent 9e278a9370
commit 700b4e8f02
No known key found for this signature in database
GPG Key ID: 92D77191BA7FBC99
9 changed files with 386 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
app/Formatter/BoardColumnFormatter.php
View File

@ -15,6 +15,7 @@ class BoardColumnFormatter extends BaseFormatter implements FormatterInterface
protected $swimlaneId = 0;
protected $columns = array();
protected $tasks = array();
protected $tags = array();
/**
* Set swimlaneId
@ -55,6 +56,19 @@ class BoardColumnFormatter extends BaseFormatter implements FormatterInterface
return $this;
}
/**
* Set tags
*
* @access public
* @param array $tags
* @return $this
*/
public function withTags(array $tags)
{
$this->tags = $tags;
return $this;
}
/**
* Apply formatter
*
@ -66,6 +80,7 @@ class BoardColumnFormatter extends BaseFormatter implements FormatterInterface
foreach ($this->columns as &$column) {
$column['tasks'] = BoardTaskFormatter::getInstance($this->container)
->withTasks($this->tasks)
->withTags($this->tags)
->withSwimlaneId($this->swimlaneId)
->withColumnId($column['id'])
->format();

5
app/Formatter/BoardFormatter.php
View File

@ -44,12 +44,14 @@ class BoardFormatter extends BaseFormatter implements FormatterInterface
{
$swimlanes = $this->swimlaneModel->getSwimlanes($this->projectId);
$columns = $this->columnModel->getAll($this->projectId);
$tasks = $this->query
->eq(TaskModel::TABLE.'.project_id', $this->projectId)
->asc(TaskModel::TABLE.'.position')
->findAll();
$task_ids = array_column($tasks, 'id');
$tags = $this->taskTagModel->getTagsByTasks($task_ids);
if (empty($swimlanes) || empty($columns)) {
return array();
}
@ -58,6 +60,7 @@ class BoardFormatter extends BaseFormatter implements FormatterInterface
->withSwimlanes($swimlanes)
->withColumns($columns)
->withTasks($tasks)
->withTags($tags)
->format();
}
}

15
app/Formatter/BoardSwimlaneFormatter.php
View File

@ -15,6 +15,7 @@ class BoardSwimlaneFormatter extends BaseFormatter implements FormatterInterface
protected $swimlanes = array();
protected $columns = array();
protected $tasks = array();
protected $tags = array();
/**
* Set swimlanes
@ -55,6 +56,19 @@ class BoardSwimlaneFormatter extends BaseFormatter implements FormatterInterface
return $this;
}
/**
* Set tags
*
* @access public
* @param array $tags
* @return $this
*/
public function withTags(array $tags)
{
$this->tags = $tags;
return $this;
}
/**
* Apply formatter
*
@ -71,6 +85,7 @@ class BoardSwimlaneFormatter extends BaseFormatter implements FormatterInterface
->withSwimlaneId($swimlane['id'])
->withColumns($this->columns)
->withTasks($this->tasks)
->withTags($this->tags)
->format();
$swimlane['nb_swimlanes'] = $nb_swimlanes;

22
app/Formatter/BoardTaskFormatter.php
View File

@ -13,9 +13,23 @@ use Kanboard\Core\Filter\FormatterInterface;
class BoardTaskFormatter extends BaseFormatter implements FormatterInterface
{
protected $tasks = array();
protected $tags = array();
protected $columnId = 0;
protected $swimlaneId = 0;
/**
* Set tags
*
* @access public
* @param array $tags
* @return $this
*/
public function withTags(array $tags)
{
$this->tags = $tags;
return $this;
}
/**
* Set tasks
*
@ -63,17 +77,19 @@ class BoardTaskFormatter extends BaseFormatter implements FormatterInterface
*/
public function format()
{
return array_values(array_filter($this->tasks, array($this, 'filterTasks')));
$tasks = array_values(array_filter($this->tasks, array($this, 'filterTasks')));
array_merge_relation($tasks, $this->tags, 'tags', 'id');
return $tasks;
}
/**
* Keep only tasks of the given column and swimlane
*
* @access public
* @access protected
* @param array $task
* @return bool
*/
public function filterTasks(array $task)
protected function filterTasks(array $task)
{
return $task['column_id'] == $this->columnId && $task['swimlane_id'] == $this->swimlaneId;
}

61
app/Model/TaskTagModel.php
View File

@ -26,7 +26,7 @@ class TaskTagModel extends Base
* @param integer $task_id
* @return array
*/
public function getAll($task_id)
public function getTagsByTask($task_id)
{
return $this->db->table(TagModel::TABLE)
->columns(TagModel::TABLE.'.id', TagModel::TABLE.'.name')
@ -35,6 +35,28 @@ class TaskTagModel extends Base
->findAll();
}
/**
* Get all tags associated to a list of tasks
*
* @access public
* @param integer[] $task_ids
* @return array
*/
public function getTagsByTasks($task_ids)
{
if (empty($task_ids)) {
return array();
}
$tags = $this->db->table(TagModel::TABLE)
->columns(TagModel::TABLE.'.id', TagModel::TABLE.'.name', self::TABLE.'.task_id')
->in(self::TABLE.'.task_id', $task_ids)
->join(self::TABLE, 'tag_id', 'id')
->findAll();
return array_column_index($tags, 'task_id');
}
/**
* Get dictionary of tags
*
@ -44,7 +66,7 @@ class TaskTagModel extends Base
*/
public function getList($task_id)
{
$tags = $this->getAll($task_id);
$tags = $this->getTagsByTask($task_id);
return array_column($tags, 'name', 'id');
}
@ -61,8 +83,8 @@ class TaskTagModel extends Base
{
$task_tags = $this->getList($task_id);
return $this->addTags($project_id, $task_id, $task_tags, $tags) &&
$this->removeTags($task_id, $task_tags, $tags);
return $this->associateTags($project_id, $task_id, $task_tags, $tags) &&
$this->dissociateTags($task_id, $task_tags, $tags);
}
/**
@ -73,7 +95,7 @@ class TaskTagModel extends Base
* @param integer $tag_id
* @return boolean
*/
public function associate($task_id, $tag_id)
public function associateTag($task_id, $tag_id)
{
return $this->db->table(self::TABLE)->insert(array(
'task_id' => $task_id,
@ -89,7 +111,7 @@ class TaskTagModel extends Base
* @param integer $tag_id
* @return boolean
*/
public function dissociate($task_id, $tag_id)
public function dissociateTag($task_id, $tag_id)
{
return $this->db->table(self::TABLE)
->eq('task_id', $task_id)
@ -97,12 +119,22 @@ class TaskTagModel extends Base
->remove();
}
private function addTags($project_id, $task_id, $task_tags, $tags)
/**
* Associate missing tags
*
* @access protected
* @param integer $project_id
* @param integer $task_id
* @param array $task_tags
* @param array $tags
* @return bool
*/
protected function associateTags($project_id, $task_id, $task_tags, $tags)
{
foreach ($tags as $tag) {
$tag_id = $this->tagModel->findOrCreateTag($project_id, $tag);
if (! isset($task_tags[$tag_id]) && ! $this->associate($task_id, $tag_id)) {
if (! isset($task_tags[$tag_id]) && ! $this->associateTag($task_id, $tag_id)) {
return false;
}
}
@ -110,11 +142,20 @@ class TaskTagModel extends Base
return true;
}
private function removeTags($task_id, $task_tags, $tags)
/**
* Dissociate removed tags
*
* @access protected
* @param integer $task_id
* @param array $task_tags
* @param array $tags
* @return bool
*/
protected function dissociateTags($task_id, $task_tags, $tags)
{
foreach ($task_tags as $tag_id => $tag) {
if (! in_array($tag, $tags)) {
if (! $this->dissociate($task_id, $tag_id)) {
if (! $this->dissociateTag($task_id, $tag_id)) {
return false;
}
}

52
app/functions.php
View File

@ -2,11 +2,61 @@
use Kanboard\Core\Translator;
/**
* Associate another dict to a dict based on a common key
*
* @param array $input
* @param array $relations
* @param string $relation
* @param string $column
*/
function array_merge_relation(array &$input, array &$relations, $relation, $column)
{
foreach ($input as &$row) {
if (isset($row[$column]) && isset($relations[$row[$column]])) {
$row[$relation] = $relations[$row[$column]];
} else {
$row[$relation] = array();
}
}
}
/**
* Create indexed array from a list of dict
*
* $input = [
* ['k1' => 1, 'k2' => 2], ['k1' => 3, 'k2' => 4], ['k1' => 2, 'k2' => 5]
* ]
*
* array_column_index($input, 'k1') will returns:
*
* [
* 1 => [['k1' => 1, 'k2' => 2], ['k1' => 2, 'k2' => 5]],
* 3 => [['k1' => 3, 'k2' => 4]],
* ]
*
* @param array $input
* @param string $column
* @return array
*/
function array_column_index(array &$input, $column)
{
$result = array();
foreach ($input as &$row) {
if (isset($row[$column])) {
$result[$row[$column]][] = $row;
}
}
return $result;
}
/**
* Sum all values from a single column in the input array
*
* $input = [
* ['column' => 2'], ['column' => 3']
* ['column' => 2], ['column' => 3]
* ]
*
* array_column_sum($input, 'column') returns 5

81
tests/units/Formatter/BoardFormatterTest.php
View File

@ -6,6 +6,7 @@ use Kanboard\Model\ProjectModel;
use Kanboard\Model\SwimlaneModel;
use Kanboard\Model\TaskCreationModel;
use Kanboard\Model\TaskFinderModel;
use Kanboard\Model\TaskTagModel;
require_once __DIR__.'/../Base.php';
@ -308,4 +309,84 @@ class BoardFormatterTest extends Base
$this->assertSame(0, $board[2]['columns'][2]['nb_tasks']);
$this->assertSame(0, $board[2]['columns'][3]['nb_tasks']);
}
public function testFormatWithTags()
{
$projectModel = new ProjectModel($this->container);
$taskFinderModel = new TaskFinderModel($this->container);
$taskCreationModel = new TaskCreationModel($this->container);
$taskTagModel = new TaskTagModel($this->container);
$this->assertEquals(1, $projectModel->create(array('name' => 'Test')));
$this->assertEquals(1, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test1')));
$this->assertEquals(2, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test2', 'column_id' => 3)));
$this->assertEquals(3, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test3')));
$this->assertTrue($taskTagModel->save(1, 1, array('My tag 1', 'My tag 2')));
$this->assertTrue($taskTagModel->save(1, 2, array('My tag 3')));
$board = BoardFormatter::getInstance($this->container)
->withQuery($taskFinderModel->getExtendedQuery())
->withProjectId(1)
->format();
$this->assertCount(1, $board);
$this->assertEquals('Default swimlane', $board[0]['name']);
$this->assertCount(4, $board[0]['columns']);
$this->assertEquals(1, $board[0]['nb_swimlanes']);
$this->assertEquals(4, $board[0]['nb_columns']);
$this->assertEquals(3, $board[0]['nb_tasks']);
$this->assertEquals(0, $board[0]['score']);
$this->assertEquals(2, $board[0]['columns'][0]['column_nb_tasks']);
$this->assertEquals(0, $board[0]['columns'][1]['column_nb_tasks']);
$this->assertEquals(1, $board[0]['columns'][2]['column_nb_tasks']);
$this->assertEquals(0, $board[0]['columns'][3]['column_nb_tasks']);
$this->assertEquals(0, $board[0]['columns'][0]['column_score']);
$this->assertEquals(0, $board[0]['columns'][1]['column_score']);
$this->assertEquals(0, $board[0]['columns'][2]['column_score']);
$this->assertEquals(0, $board[0]['columns'][3]['column_score']);
$this->assertSame(0, $board[0]['columns'][0]['score']);
$this->assertSame(0, $board[0]['columns'][1]['score']);
$this->assertSame(0, $board[0]['columns'][2]['score']);
$this->assertSame(0, $board[0]['columns'][3]['score']);
$this->assertSame(2, $board[0]['columns'][0]['nb_tasks']);
$this->assertSame(0, $board[0]['columns'][1]['nb_tasks']);
$this->assertSame(1, $board[0]['columns'][2]['nb_tasks']);
$this->assertSame(0, $board[0]['columns'][3]['nb_tasks']);
$this->assertEquals('test1', $board[0]['columns'][0]['tasks'][0]['title']);
$this->assertEquals('test3', $board[0]['columns'][0]['tasks'][1]['title']);
$this->assertEquals('test2', $board[0]['columns'][2]['tasks'][0]['title']);
$expected = array(
array(
'id' => 1,
'name' => 'My tag 1',
'task_id' => 1,
),
array(
'id' => 2,
'name' => 'My tag 2',
'task_id' => 1,
),
);
$this->assertEquals($expected, $board[0]['columns'][0]['tasks'][0]['tags']);
$this->assertEquals(array(), $board[0]['columns'][0]['tasks'][1]['tags']);
$expected = array(
array(
'id' => 3,
'name' => 'My tag 3',
'task_id' => 2,
),
);
$this->assertEquals($expected, $board[0]['columns'][2]['tasks'][0]['tags']);
}
}

102
tests/units/FunctionTest.php
View File

@ -18,4 +18,106 @@ class FunctionTest extends Base
$this->assertSame(579.7, array_column_sum($input, 'my_column'));
}
public function testArrayColumnIndex()
{
$input = array(
array(
'k1' => 11,
'k2' => 22,
),
array(
'k1' => 11,
'k2' => 55,
),
array(
'k1' => 33,
'k2' => 44,
),
array()
);
$expected = array(
11 => array(
array(
'k1' => 11,
'k2' => 22,
),
array(
'k1' => 11,
'k2' => 55,
)
),
33 => array(
array(
'k1' => 33,
'k2' => 44,
)
)
);
$this->assertSame($expected, array_column_index($input, 'k1'));
}
public function testArrayMergeRelation()
{
$relations = array(
88 => array(
'id' => 123,
'value' => 'test1',
),
99 => array(
'id' => 456,
'value' => 'test2',
),
55 => array()
);
$input = array(
array(),
array(
'task_id' => 88,
'title' => 'task1'
),
array(
'task_id' => 99,
'title' => 'task2'
),
array(
'task_id' => 11,
'title' => 'task3'
)
);
$expected = array(
array(
'my_relation' => array(),
),
array(
'task_id' => 88,
'title' => 'task1',
'my_relation' => array(
'id' => 123,
'value' => 'test1',
),
),
array(
'task_id' => 99,
'title' => 'task2',
'my_relation' => array(
'id' => 456,
'value' => 'test2',
),
),
array(
'task_id' => 11,
'title' => 'task3',
'my_relation' => array(),
)
);
array_merge_relation($input, $relations, 'my_relation', 'task_id');
$this->assertSame($expected, $input);
}
}

50
tests/units/Model/TaskTagModelTest.php
View File

@ -24,7 +24,7 @@ class TaskTagModelTest extends Base
$this->assertTrue($taskTagModel->save(1, 1, array('My tag 1', 'My tag 2', 'My tag 3')));
$tags = $taskTagModel->getAll(1);
$tags = $taskTagModel->getTagsByTask(1);
$this->assertCount(3, $tags);
$this->assertEquals(1, $tags[0]['id']);
@ -38,7 +38,7 @@ class TaskTagModelTest extends Base
$this->assertTrue($taskTagModel->save(1, 1, array('My tag 3', 'My tag 1', 'My tag 4')));
$tags = $taskTagModel->getAll(1);
$tags = $taskTagModel->getTagsByTask(1);
$this->assertCount(3, $tags);
$this->assertEquals(1, $tags[0]['id']);
@ -64,4 +64,50 @@ class TaskTagModelTest extends Base
$this->assertEquals('My tag 4', $tags[3]['name']);
$this->assertEquals(1, $tags[3]['project_id']);
}
public function testGetTagsForTasks()
{
$projectModel = new ProjectModel($this->container);
$taskCreationModel = new TaskCreationModel($this->container);
$taskTagModel = new TaskTagModel($this->container);
$this->assertEquals(1, $projectModel->create(array('name' => 'Test')));
$this->assertEquals(1, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test1')));
$this->assertEquals(2, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test2')));
$this->assertEquals(3, $taskCreationModel->create(array('project_id' => 1, 'title' => 'test3')));
$this->assertTrue($taskTagModel->save(1, 1, array('My tag 1', 'My tag 2', 'My tag 3')));
$this->assertTrue($taskTagModel->save(1, 2, array('My tag 3')));
$tags = $taskTagModel->getTagsByTasks(array(1, 2, 3));
$expected = array(
1 => array(
array(
'id' => 1,
'name' => 'My tag 1',
'task_id' => 1
),
array(
'id' => 2,
'name' => 'My tag 2',
'task_id' => 1
),
array(
'id' => 3,
'name' => 'My tag 3',
'task_id' => 1
),
),
2 => array(
array(
'id' => 3,
'name' => 'My tag 3',
'task_id' => 2,
)
)
);
$this->assertEquals($expected, $tags);
}
}