Display tags in task list view

ChangeLog

@@ -7,6 +7,7 @@ New features:
 
 Improvements:
 
+* Display tags in task list view
 * Change users list layout
 * Project priority is always rendered now
 

app/Controller/TaskListController.php

@@ -28,6 +28,7 @@ class TaskListController extends BaseController
             ->setMax(30)
             ->setOrder(TaskModel::TABLE.'.id')
             ->setDirection('DESC')
+            ->setFormatter($this->taskListFormatter)
             ->setQuery($this->taskLexer
                 ->build($search)
                 ->withFilter(new TaskProjectFilter($project['id']))
@@ -36,10 +37,10 @@ class TaskListController extends BaseController
             ->calculate();
 
         $this->response->html($this->helper->layout->app('task_list/listing', array(
-            'project' => $project,
+            'project'     => $project,
-            'title' => $project['name'],
+            'title'       => $project['name'],
             'description' => $this->helper->projectHeader->getDescription($project),
-            'paginator' => $paginator,
+            'paginator'   => $paginator,
         )));
     }
 }

app/Core/Base.php

@@ -74,6 +74,7 @@ use Pimple\Container;
  * @property \Kanboard\Formatter\TaskCalendarFormatter               $taskCalendarFormatter
  * @property \Kanboard\Formatter\TaskGanttFormatter                  $taskGanttFormatter
  * @property \Kanboard\Formatter\TaskICalFormatter                   $taskICalFormatter
+ * @property \Kanboard\Formatter\TaskListFormatter                   $taskListFormatter
  * @property \Kanboard\Formatter\TaskSuggestMenuFormatter            $taskSuggestMenuFormatter
  * @property \Kanboard\Formatter\UserAutoCompleteFormatter           $userAutoCompleteFormatter
  * @property \Kanboard\Formatter\UserMentionFormatter                $userMentionFormatter

app/Core/Paginator.php

@@ -2,13 +2,14 @@
 
 namespace Kanboard\Core;
 
+use Kanboard\Core\Filter\FormatterInterface;
 use Pimple\Container;
 use PicoDb\Table;
 
 /**
- * Paginator helper
+ * Paginator Helper
  *
- * @package  core
+ * @package  Kanboard\Core
  * @author   Frederic Guillot
  */
 class Paginator
@@ -109,6 +110,11 @@ class Paginator
      */
     private $params = array();
 
+    /**
+     * @var FormatterInterface
+     */
+    protected $formatter = null;
+
     /**
      * Constructor
      *
@@ -125,7 +131,7 @@ class Paginator
      *
      * @access public
      * @param  \PicoDb\Table
-     * @return Paginator
+     * @return $this
      */
     public function setQuery(Table $query)
     {
@@ -134,6 +140,18 @@ class Paginator
         return $this;
     }
 
+    /**
+     * Set Formatter
+     *
+     * @param  FormatterInterface $formatter
+     * @return $this
+     */
+    public function setFormatter(FormatterInterface $formatter)
+    {
+        $this->formatter = $formatter;
+        return $this;
+    }
+
     /**
      * Execute a PicoDb query
      *
@@ -143,11 +161,16 @@ class Paginator
     public function executeQuery()
     {
         if ($this->query !== null) {
-            return $this->query
+            $this->query
-                        ->offset($this->offset)
+                ->offset($this->offset)
-                        ->limit($this->limit)
+                ->limit($this->limit)
-                        ->orderBy($this->order, $this->direction)
+                ->orderBy($this->order, $this->direction);
-                        ->findAll();
+
+            if ($this->formatter !== null) {
+                return $this->formatter->withQuery($this->query)->format();
+            } else {
+                return $this->query->findAll();
+            }
         }
 
         return array();
@@ -160,7 +183,7 @@ class Paginator
      * @param  string      $controller
      * @param  string      $action
      * @param  array       $params
-     * @return Paginator
+     * @return $this
      */
     public function setUrl($controller, $action, array $params = array())
     {
@@ -175,7 +198,7 @@ class Paginator
      *
      * @access public
      * @param  array       $items
-     * @return Paginator
+     * @return $this
      */
     public function setCollection(array $items)
     {
@@ -199,7 +222,7 @@ class Paginator
      *
      * @access public
      * @param  integer    $total
-     * @return Paginator
+     * @return $this
      */
     public function setTotal($total)
     {
@@ -223,7 +246,7 @@ class Paginator
      *
      * @access public
      * @param  integer     $page
-     * @return Paginator
+     * @return $this
      */
     public function setPage($page)
     {
@@ -247,7 +270,7 @@ class Paginator
      *
      * @access public
      * @param  string     $order
-     * @return Paginator
+     * @return $this
      */
     public function setOrder($order)
     {
@@ -260,7 +283,7 @@ class Paginator
      *
      * @access public
      * @param  string    $direction
-     * @return Paginator
+     * @return $this
      */
     public function setDirection($direction)
     {
@@ -273,7 +296,7 @@ class Paginator
      *
      * @access public
      * @param  integer     $limit
-     * @return Paginator
+     * @return $this
      */
     public function setMax($limit)
     {
@@ -307,7 +330,7 @@ class Paginator
      *
      * @access public
      * @param  boolean    $condition
-     * @return Paginator
+     * @return $this
      */
     public function calculateOnlyIf($condition)
     {
@@ -322,7 +345,7 @@ class Paginator
      * Calculate the offset value accoring to url params and the page number
      *
      * @access public
-     * @return Paginator
+     * @return $this
      */
     public function calculate()
     {
@@ -421,7 +444,7 @@ class Paginator
      * @access public
      * @return string
      */
-    public function generatPageShowing()
+    public function generatePageShowing()
     {
         return '<span class="pagination-showing">'.t('Showing %d-%d of %d', (($this->getPage() - 1) * $this->getMax() + 1), min($this->getTotal(), $this->getPage() * $this->getMax()), $this->getTotal()).'</span>';
     }
@@ -432,7 +455,7 @@ class Paginator
      * @access public
      * @return boolean
      */
-    public function hasNothingtoShow()
+    public function hasNothingToShow()
     {
         return $this->offset === 0 && ($this->total - $this->offset) <= $this->limit;
     }
@@ -447,9 +470,9 @@ class Paginator
     {
         $html = '';
 
-        if (! $this->hasNothingtoShow()) {
+        if (! $this->hasNothingToShow()) {
             $html .= '<div class="pagination">';
-            $html .= $this->generatPageShowing();
+            $html .= $this->generatePageShowing();
             $html .= $this->generatePreviousLink();
             $html .= $this->generateNextLink();
             $html .= '</div>';

app/Formatter/TaskListFormatter.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Kanboard\Formatter;
+
+use Kanboard\Core\Filter\FormatterInterface;
+
+/**
+ * Class TaskListFormatter
+ *
+ * @package Kanboard\Formatter
+ * @author  Frederic Guillot
+ */
+class TaskListFormatter extends BaseFormatter implements FormatterInterface
+{
+    /**
+     * Apply formatter
+     *
+     * @access public
+     * @return mixed
+     */
+    public function format()
+    {
+        $tasks = $this->query->findAll();
+        $taskIds = array_column($tasks, 'id');
+        $tags = $this->taskTagModel->getTagsByTasks($taskIds);
+        array_merge_relation($tasks, $tags, 'tags', 'id');
+
+        return $tasks;
+    }
+}

app/ServiceProvider/FormatterProvider.php

@@ -28,6 +28,7 @@ class FormatterProvider implements ServiceProviderInterface
             'TaskCalendarFormatter',
             'TaskGanttFormatter',
             'TaskICalFormatter',
+            'TaskListFormatter',
             'TaskSuggestMenuFormatter',
             'UserAutoCompleteFormatter',
             'UserMentionFormatter',

app/Template/task_list/task_details.php

@@ -20,4 +20,10 @@
             <?php endif ?>
         </span>
     <?php endif ?>
+
+    <?php foreach ($task['tags'] as $tag): ?>
+        <span class="table-list-category task-list-tag">
+            <?= $this->text->e($tag['name']) ?>
+        </span>
+    <?php endforeach ?>
 </div>

assets/sass/_table_list.sass

@@ -96,7 +96,7 @@
   font-size: size('compact')
   font-weight: 500
   color: color('dark')
-  padding: 1px 3px 1px 2px
+  padding: 1px 2px 1px 2px
   border-radius: 3px
   background: bg-color('light')
   border: 1px solid #ccc

assets/sass/_task_tags.sass

@@ -11,3 +11,7 @@
 
 .task-summary-container .task-tags
   margin-top: 10px
+
+.task-list-tag
+  background: #ffeb8e
+  border-color: #333

tests/units/Formatter/TaskListFormatterTest.php

@@ -0,0 +1,60 @@
+<?php
+
+use Kanboard\Formatter\TaskListFormatter;
+use Kanboard\Model\ProjectModel;
+use Kanboard\Model\TaskCreationModel;
+use Kanboard\Model\TaskFinderModel;
+use Kanboard\Model\TaskTagModel;
+
+require_once __DIR__.'/../Base.php';
+
+class TaskListFormatterTest extends Base
+{
+    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')));
+
+        $listing = TaskListFormatter::getInstance($this->container)
+            ->withQuery($taskFinderModel->getExtendedQuery())
+            ->format();
+
+        $this->assertCount(3, $listing);
+
+        $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, $listing[0]['tags']);
+
+        $expected = array(
+            array(
+                'id' => 3,
+                'name' => 'My tag 3',
+                'task_id' => 2,
+            ),
+        );
+
+        $this->assertEquals($expected, $listing[1]['tags']);
+        $this->assertEquals(array(), $listing[2]['tags']);
+    }
+}