TW-101 - New description column format: Truncated WITH annotation count

Adds a "truncated with annotation count" column style for the
description field and corresponding unit test.

ChangeLog

@@ -26,6 +26,8 @@
         Weber).
 - TW-44 Space handling in dateformat (thanks to Louis-Claude Canon).
 - TW-72 extend info report with urgency column
+- TW-101 New description column format: Truncated WITH annotation count (thanks
+         to atomicules)
 - TW-115 allow "0day" durations for UDAs.
 - TW-128 new helper command; _envs.
 - TW-168 modification of due date relative to current due date (thanks to Dirk

NEWS

@@ -32,6 +32,8 @@ New configuration options in taskwarrior 2.4.0
   - New themes: dark-default-16.theme, dark-gray-blue-256.theme
   - The 'allow.empty.filter' setting can be set to 'no' to disallow the
     potentially dangerous combination of write commands and empty filters.
+  - New truncated+count column style for the description field which as the 
+    name says is a combination of the existing truncated and count styles.
 
 Newly deprecated features in taskwarrior 2.4.0
 

src/columns/ColDescription.cpp

@@ -49,6 +49,7 @@ ColumnDescription::ColumnDescription ()
   _styles.push_back ("oneline");
   _styles.push_back ("truncated");
   _styles.push_back ("count");
+  _styles.push_back ("truncated_count");
 
   _dateformat = context.config.get ("dateformat.annotation");
   if (_dateformat == "")
@@ -74,6 +75,7 @@ ColumnDescription::ColumnDescription ()
                        + " " + t + " " + a4);
   _examples.push_back (d.substr (0, 20) + "...");
   _examples.push_back (d + " [4]");
+  _examples.push_back (d.substr (0, 20) + "... [4]");
 
   _hyphenate = context.config.getBoolean ("hyphenate");
 
@@ -163,6 +165,13 @@ void ColumnDescription::measure (Task& task, unsigned int& minimum, unsigned int
     minimum = longestWord (description);
   }
 
+  // The te... [2]
+  else if (_style == "truncated_count")
+  {
+    minimum = 4;
+    maximum = utf8_width (description) + 1 + 1 + format (task.annotation_count).length () + 1;
+  }
+
   else
     throw format (STRING_COLUMN_BAD_FORMAT, _name, _style);
 }
@@ -262,6 +271,29 @@ void ColumnDescription::render (
     for (i = raw.begin (); i != raw.end (); ++i)
       lines.push_back (color.colorize (leftJustify (*i, width)));
   }
+
+  // This is a des... [2]
+  else if (_style == "truncated_count")
+  {
+    std::map <std::string, std::string> annos;
+    task.getAnnotations (annos);
+    int len = utf8_width (description);
+    std::string annos_count;
+    int len_annos = 0;
+
+    if (annos.size ())
+    {
+      annos_count = " [" + format ((int) annos.size ()) + "]";
+      len_annos = utf8_width (annos_count);
+      len += len_annos;
+    }
+
+    if (len > width)
+      lines.push_back (color.colorize (description.substr (0, width - len_annos - 3) + "..." + annos_count));
+    else
+      lines.push_back (color.colorize (leftJustify (description + annos_count, width)));
+
+  }
 }
 
 ////////////////////////////////////////////////////////////////////////////////

test/bug.101.t

@@ -0,0 +1,106 @@
+#!/usr/bin/env python2.7
+# -*- coding: utf-8 -*-
+
+import sys
+import os
+import unittest
+import math
+# Ensure python finds the local simpletap and basetest modules
+sys.path.append(os.path.dirname(os.path.abspath(__file__)))
+
+from basetest import Task, TestCase
+
+
+class TestBug101(TestCase):
+    def setUp(self):
+        """Executed before each test in the class"""
+        self.t = Task()
+        # Define report with truncated_count style
+        with open(self.t.taskrc, 'a') as fh:
+            fh.write("report.bug101.columns=description.truncated_count\n")
+        #Find screen width in order to generate long enough string
+        command = ("_get", "context.width")
+        code, out, err = self.t(command)
+        self.width = int(out)
+        #Since task strips leading and trailing spaces, for the purposes
+        #of these tests, ensure description contains no spaces so we know
+        #exactly what string we are expecting
+        self.short_description = "A_task_description_"
+        #Generate long string
+        self.long_description = self.short_description * int(math.ceil(float(self.width)/len(self.short_description)))
+
+    def test_short_no_count(self):
+        """Check short description with no annotations"""
+        command = ("add", self.short_description)
+        self.t(command)
+
+        command = ("bug101",)
+        code, out, err = self.t(command)
+
+        expected = self.short_description
+        self.assertIn(expected, out)
+
+    def test_short_with_count(self):
+        """Check short description with annotations"""
+        command = ("add", self.short_description)
+        self.t(command)
+
+        command = ("1", "annotate", "A task annotation")
+        self.t(command)
+
+        command = ("bug101",)
+        code, out, err = self.t(command)
+
+        expected = self.short_description + " [1]"
+        self.assertIn(expected, out)
+
+    def test_long_no_count(self):
+        """Check long description with no annotations"""
+        command = ("add", self.long_description)
+        self.t(command)
+
+        command = ("bug101",)
+        code, out, err = self.t(command)
+
+        expected = self.long_description[:(self.width - 3)] + "..."
+        self.assertIn(expected, out)
+
+    def test_long_with_count(self):
+        """Check long description with annotations"""
+        command = ("add", self.long_description)
+        self.t(command)
+
+        command = ("1", "annotate", "A task annotation")
+        self.t(command)
+
+        command = ("bug101",)
+        code, out, err = self.t(command)
+
+        expected = self.long_description[:(self.width - 7)] + "... [1]"
+        self.assertIn(expected, out)
+
+    def test_long_with_double_digit_count(self):
+        """Check long description with double digit amount of annotations"""
+        command = ("add", self.long_description)
+        self.t(command)
+
+        for a in range(10):
+            command = ("1", "annotate", "A task annotation")
+            self.t(command)
+
+        command = ("bug101",)
+        code, out, err = self.t(command)
+
+        expected = self.long_description[:(self.width - 8)] + "... [10]"
+        self.assertIn(expected, out)
+
+    def tearDown(self):
+        command = ("1", "delete")
+        self.t(command, "y\n")
+
+
+if __name__ == "__main__":
+    from simpletap import TAPTestRunner
+    unittest.main(testRunner=TAPTestRunner())
+
+# vim: ai sts=4 et sw=4