Minor Refactoring

- Added support for more type-specific checks of attribute values.
- Added support for more type-specific attribute rendering.
- Improved generalized methods for checking columns in a report.
- Added unit tests.
- Minor code cleanup.
- Added secret hidden feature for internal testing.

src/columns/CMakeLists.txt

@@ -27,6 +27,7 @@ set (columns_SRCS Column.cpp Column.h
                   ColTags.cpp ColTags.h
                   ColUntil.cpp ColUntil.h
                   ColUrgency.cpp ColUrgency.h
+                  ColUDA.cpp ColUDA.h
                   ColUUID.cpp ColUUID.h
                   ColWait.cpp ColWait.h)
 

src/columns/ColBg.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColDate.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <stdlib.h>

src/columns/ColDepends.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <algorithm>

src/columns/ColDescription.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <stdlib.h>

src/columns/ColDue.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <stdlib.h>

src/columns/ColEnd.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <ColEnd.h>

src/columns/ColEntry.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <ColEntry.h>

src/columns/ColFg.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColID.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <math.h>

src/columns/ColIMask.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <math.h>

src/columns/ColMask.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <math.h>

src/columns/ColParent.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <math.h>

src/columns/ColPriority.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColProject.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColRecur.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColStart.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColStatus.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColString.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColTags.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <algorithm>

src/columns/ColUDA.cpp

@@ -0,0 +1,155 @@
+////////////////////////////////////////////////////////////////////////////////
+// taskwarrior - a command line task list manager.
+//
+// Copyright 2006-2012, Paul Beckingham, Federico Hernandez.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+// http://www.opensource.org/licenses/mit-license.php
+//
+////////////////////////////////////////////////////////////////////////////////
+
+#define L10N                                           // Localization complete.
+
+#include <Context.h>
+#include <Duration.h>
+#include <Date.h>
+#include <ColUDA.h>
+#include <text.h>
+#include <i18n.h>
+
+extern Context context;
+
+////////////////////////////////////////////////////////////////////////////////
+ColumnUDA::ColumnUDA ()
+{
+  _name  = "<uda>";
+  _type  = "string";
+  _style = "default";
+  _label = "";
+
+  _hyphenate = (_type == "string") ? true : false;
+
+  _styles.push_back (_style);
+
+  // TODO _examples.push_back ("?");
+}
+
+////////////////////////////////////////////////////////////////////////////////
+ColumnUDA::~ColumnUDA ()
+{
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// Set the minimum and maximum widths for the value.
+//
+void ColumnUDA::measure (Task& task, int& minimum, int& maximum)
+{
+  if (_style == "default")
+  {
+    std::string value = task.get (_name);
+
+    if (_type == "date")
+    {
+      // Determine the output date format, which uses a hierarchy of definitions.
+      //   rc.report.<report>.dateformat
+      //   rc.dateformat.report
+      //   rc.dateformat.
+      Date date ((time_t) strtol (value.c_str (), NULL, 10));
+      std::string format = context.config.get ("report." + _report + ".dateformat");
+      if (format == "")
+        format = context.config.get ("dateformat.report");
+      if (format == "")
+        format = context.config.get ("dateformat");
+
+      minimum = maximum = date.toString (format).length ();
+    }
+    else if (_type == "duration")
+    {
+      minimum = maximum = Duration (value).formatCompact ().length ();
+    }
+    else if (_type == "string")
+    {
+      std::string stripped = Color::strip (value);
+      maximum = longestLine (stripped);
+      minimum = longestWord (stripped);
+    }
+    else if (_type == "numeric")
+    {
+      minimum = maximum = value.length ();
+    }
+  }
+  else
+    throw format (STRING_COLUMN_BAD_FORMAT, _name, _style);
+}
+
+////////////////////////////////////////////////////////////////////////////////
+void ColumnUDA::render (
+  std::vector <std::string>& lines,
+  Task& task,
+  int width,
+  Color& color)
+{
+  if (_style == "default")
+  {
+    std::string value = task.get (_name);
+
+    if (_type == "date")
+    {
+      // Determine the output date format, which uses a hierarchy of definitions.
+      //   rc.report.<report>.dateformat
+      //   rc.dateformat.report
+      //   rc.dateformat.
+      std::string format = context.config.get ("report." + _report + ".dateformat");
+      if (format == "")
+        format = context.config.get ("dateformat.report");
+      if (format == "")
+        format = context.config.get ("dateformat");
+
+      lines.push_back (
+        color.colorize (
+          leftJustify (
+            Date ((time_t) strtol (value.c_str (), NULL, 10))
+              .toString (format), width)));
+    }
+    else if (_type == "duration")
+    {
+      lines.push_back (
+        color.colorize (
+          rightJustify (
+            Duration (value).formatCompact (),
+            width)));
+    }
+    else if (_type == "string")
+    {
+      std::vector <std::string> raw;
+      wrapText (raw, value, width, _hyphenate);
+
+      std::vector <std::string>::iterator i;
+      for (i = raw.begin (); i != raw.end (); ++i)
+        lines.push_back (color.colorize (leftJustify (*i, width)));
+    }
+    else if (_type == "numeric")
+    {
+      lines.push_back (color.colorize (rightJustify (value, width)));
+    }
+  }
+}
+
+////////////////////////////////////////////////////////////////////////////////

src/columns/ColUDA.h

@@ -0,0 +1,52 @@
+////////////////////////////////////////////////////////////////////////////////
+// taskwarrior - a command line task list manager.
+//
+// Copyright 2006-2012, Paul Beckingham, Federico Hernandez.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+// http://www.opensource.org/licenses/mit-license.php
+//
+////////////////////////////////////////////////////////////////////////////////
+
+#ifndef INCLUDED_COLUDA
+#define INCLUDED_COLUDA
+#define L10N                                           // Localization complete.
+
+#include <vector>
+#include <string>
+#include <Column.h>
+#include <Color.h>
+#include <Task.h>
+
+class ColumnUDA : public Column
+{
+public:
+  ColumnUDA ();
+  ~ColumnUDA ();
+
+  void measure (Task&, int&, int&);
+  void render (std::vector <std::string>&, Task&, int, Color&);
+
+private:
+  bool _hyphenate;
+};
+
+#endif
+////////////////////////////////////////////////////////////////////////////////

src/columns/ColUUID.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <math.h>

src/columns/ColUntil.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <ColUntil.h>

src/columns/ColUrgency.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <Context.h>

src/columns/ColWait.cpp

@@ -25,7 +25,6 @@
 //
 ////////////////////////////////////////////////////////////////////////////////
 
-
 #define L10N                                           // Localization complete.
 
 #include <ColWait.h>

src/columns/Column.cpp

@@ -50,6 +50,7 @@
 #include <ColUntil.h>
 #include <ColUrgency.h>
 #include <ColUUID.h>
+#include <ColUDA.h>
 #include <ColWait.h>
 #include <text.h>
 #include <i18n.h>
@@ -103,6 +104,11 @@ Column* Column::factory (const std::string& name, const std::string& report)
 
   // Special non-task column.
   else if (column_name == "string")      c = new ColumnString ();
+
+  // UDA.
+  else if (context.config.get ("uda." + column_name + ".type") != "")
+    c = Column::uda (column_name);
+
   else
     throw format (STRING_COLUMN_BAD_NAME, column_name);
 
@@ -138,6 +144,55 @@ void Column::factory (std::map <std::string, Column*>& all)
   c = new ColumnUrgency ();        all[c->_name] = c;
   c = new ColumnUUID ();           all[c->_name] = c;
   c = new ColumnWait ();           all[c->_name] = c;
+
+  Column::uda (all);
+}
+
+////////////////////////////////////////////////////////////////////////////////
+void Column::uda (std::map <std::string, Column*>& all)
+{
+  // For each UDA, instantiate and initialize ColumnUDA().
+  std::map <std::string, int> udas;
+  std::vector <std::string> names;
+  context.config.all (names);
+
+  std::vector <std::string>::iterator i;
+  for (i = names.begin (); i != names.end (); ++i)
+  {
+    if (i->substr (0, 4) == "uda.")
+    {
+      std::string::size_type period = 4;
+      if ((period = i->find ('.', period)) != std::string::npos)
+        udas[i->substr (4, period - 4)] = 0;
+    }
+  }
+
+  std::map <std::string, int>::iterator uda;
+  for (uda = udas.begin (); uda != udas.end (); ++uda)
+  {
+    Column* c = Column::uda (uda->first);
+    all[c->_name] = c;
+  }
+}
+
+////////////////////////////////////////////////////////////////////////////////
+Column* Column::uda (const std::string& name)
+{
+  Column* c = new ColumnUDA ();
+  c->_name = name;
+
+  std::string key = "uda." + name + ".type";
+  c->_type = context.config.get (key);
+  if (c->_type != "string"   &&
+      c->_type != "date"     &&
+      c->_type != "duration" &&
+      c->_type != "numeric")
+    throw std::string (STRING_UDA_TYPE);
+
+  key = "uda." + name + ".label";
+  if (context.config.get (key) != "")
+    c->_label = context.config.get (key);
+  return c;
 }
 
 ////////////////////////////////////////////////////////////////////////////////

src/columns/Column.h

@@ -39,6 +39,8 @@ class Column
 public:
   static Column* factory (const std::string&, const std::string&);
   static void factory (std::map <std::string, Column*>&);
+  static void uda (std::map <std::string, Column*>&);
+  static Column* uda (const std::string&);
 
   Column ();
   Column (const Column&);