Make 'depends' field a little more tolerant of malformed data

taskw/fields/__init__.py

@@ -1,7 +1,7 @@
 from .base import Field
 from .annotationarray import AnnotationArrayField
 from .array import ArrayField
-from .commaseparateduuid import CommaSeparatedUUIDField
+from .depends import DependsField
 from .choice import ChoiceField
 from .date import DateField
 from .duration import DurationField

taskw/fields/depends.py

@@ -0,0 +1,49 @@
+from __future__ import absolute_import
+
+from distutils.version import LooseVersion
+
+import re
+import uuid
+
+from .base import DirtyableList, Field
+
+
+class DependsField(Field):
+    version = LooseVersion('2.4')
+
+    def deserialize(self, value):
+        if not value:
+            return DirtyableList([])
+
+        try:
+            # In task-2.5, this moved from a comma-separated string to a real list.
+            # here we allow a migration path where old splitable strings are
+            # handled as well as newschool lists.
+            value_list = value
+            if hasattr(value_list, "split"):  # It's not actually a list!
+                value_list = value_list.split(",")
+
+            return DirtyableList([uuid.UUID(v) for v in value_list])
+        except ValueError:
+            dependency_finder = re.compile(
+                "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
+            )
+            return DirtyableList(
+                [uuid.UUID(v) for v in dependency_finder.findall(value)]
+            )
+
+    def serialize(self, value):
+        if not value:
+            value = []
+
+        if not hasattr(value, "__iter__"):
+            raise ValueError("Value must be list or tuple, not %r." % value)
+
+        if self.version < LooseVersion("2.5"):
+            return ",".join([str(v) for v in value])
+        else:
+            # We never hit this second code branch now.  taskwarrior changed
+            # API slightly in version 2.5, but we're just going to go with
+            # backwards compatibility for now.
+            # Some day we should switch wholesale to the new path.
+            return [str(v) for v in value]

taskw/task.py

@@ -9,7 +9,7 @@
     AnnotationArrayField,
     ArrayField,
     ChoiceField,
-    CommaSeparatedUUIDField,
+    DependsField,
     DateField,
     DurationField,
     Field,
@@ -29,7 +29,7 @@
 class Task(dict):
     FIELDS = {
         'annotations': AnnotationArrayField(label='Annotations'),
-        'depends': CommaSeparatedUUIDField(label='Depends Upon'),
+        'depends': DependsField(label='Depends Upon'),
         'description': StringField(label='Description'),
         'due': DateField(label='Due'),
         'end': DateField(label='Ended'),

taskw/test/test_fields.py

@@ -176,9 +176,9 @@ def test_serialize_case_insensitive(self):
         self.assertEqual(actual_value, expected_value)
 
 
-class TestCommaSeparatedUUIDField(TestCase):
+class TestDependsField(TestCase):
     def setUp(self):
-        self.field = fields.CommaSeparatedUUIDField()
+        self.field = fields.DependsField()
 
     def test_serialize_single_uuid(self):
         single_uuid = [uuid.uuid4()]
@@ -218,6 +218,27 @@ def test_deserialize_uuid_string_undashed(self):
 
         self.assertEqual(actual_value, expected_value)
 
+    def test_deserialize_malformed_1(self):
+        malformed_depends_field = "[\"eb3a14ce-fee7-4309-b097-aca4ac21851d\",\"ee4ff9af-9017-4292-a4cd-afc363802e4d\"]"
+
+        actual_value = self.field.deserialize(malformed_depends_field)
+        expected_value = [
+            uuid.UUID("eb3a14ce-fee7-4309-b097-aca4ac21851d"),
+            uuid.UUID("ee4ff9af-9017-4292-a4cd-afc363802e4d"),
+        ]
+
+        self.assertEqual(actual_value, expected_value)
+
+    def test_deserialize_malformed_2(self):
+        malformed_depends_field = "[\"[\"59aec08a-a9cc-4804-8e98-9abdd2f8595e\"\",\"\"e3a32703-45e6-436b-8274-6f39b46f2ded\"]\"]"
+
+        actual_value = self.field.deserialize(malformed_depends_field)
+        expected_value = [
+            uuid.UUID("59aec08a-a9cc-4804-8e98-9abdd2f8595e"),
+            uuid.UUID("e3a32703-45e6-436b-8274-6f39b46f2ded"),
+        ]
+
+        self.assertEqual(actual_value, expected_value)
 
 class TestDateField(TestCase):
     def setUp(self):