Tests: Add tests for modified fields

[etc/taskwarrior.git] / tasklib / task.py

diff --git a/tasklib/task.py b/tasklib/task.py
index 9eff14cedea2651dadae67cbea572306302aab0b..d9b2678e084b89fb3e7a75867b0fa0f07bbf02e7 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -29,19 +29,35 @@ class TaskResource(object):
 
     def _load_data(self, data):
         self._data = data
 
     def _load_data(self, data):
         self._data = data

+        # We need to use a copy for original data, so that changes
+        # are not propagated
+        self._original_data = data.copy()

 
     def __getitem__(self, key):
 
     def __getitem__(self, key):

-        hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
-                               lambda x: x)
-        return hydrate_func(self._data.get(key))
+        # This is a workaround to make TaskResource non-iterable
+        # over simple index-based iteration
+        try:
+            int(key)
+            raise StopIteration
+        except ValueError:
+            pass
+
+        return self._deserialize(key, self._data.get(key))

 
     def __setitem__(self, key, value):
         if key in self.read_only_fields:
             raise RuntimeError('Field \'%s\' is read-only' % key)
 
     def __setitem__(self, key, value):
         if key in self.read_only_fields:
             raise RuntimeError('Field \'%s\' is read-only' % key)

+        self._data[key] = self._serialize(key, value)
+
+    def _deserialize(self, key, value):
+        hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
+                               lambda x: x)
+        return hydrate_func(value)
+
+    def _serialize(self, key, value):

         dehydrate_func = getattr(self, 'serialize_{0}'.format(key),
                                  lambda x: x)
         dehydrate_func = getattr(self, 'serialize_{0}'.format(key),
                                  lambda x: x)

-        self._data[key] = dehydrate_func(value)
-        self._modified_fields.add(key)
+        return dehydrate_func(value)

 
     def __str__(self):
         s = six.text_type(self.__unicode__())
 
     def __str__(self):
         s = six.text_type(self.__unicode__())


@@ -76,7 +92,7 @@ class TaskAnnotation(TaskResource):
 
 
 class Task(TaskResource):
 
 
 class Task(TaskResource):

-    read_only_fields = ['id', 'entry', 'urgency', 'uuid']
+    read_only_fields = ['id', 'entry', 'urgency', 'uuid', 'modified']

 
     class DoesNotExist(Exception):
         pass
 
     class DoesNotExist(Exception):
         pass


@@ -103,15 +119,46 @@ class Task(TaskResource):
     def __init__(self, warrior, data={}, **kwargs):
         self.warrior = warrior
 
     def __init__(self, warrior, data={}, **kwargs):
         self.warrior = warrior
 

-        # We keep data for backwards compatibility
-        kwargs.update(data)
+        # We serialize the data in kwargs so that users of the library
+        # do not have to pass different data formats via __setitem__ and
+        # __init__ methods, that would be confusing
+
+        # Rather unfortunate syntax due to python2.6 comaptiblity
+        self._load_data(dict((key, self._serialize(key, value))
+                        for (key, value) in six.iteritems(kwargs)))

 
 

-        self._load_data(kwargs)
-        self._modified_fields = set()
+        # We keep data for backwards compatibility
+        # TODO: Should we keep this using unserialized access to _data dict?
+        self._data.update(data)
+        self._original_data.update(data)

 
     def __unicode__(self):
         return self['description']
 
 
     def __unicode__(self):
         return self['description']
 

+    def __eq__(self, other):
+        if self['uuid'] and other['uuid']:
+            # For saved Tasks, just define equality by equality of uuids
+            return self['uuid'] == other['uuid']
+        else:
+            # If the tasks are not saved, compare the actual instances
+            return id(self) == id(other)
+
+
+    def __hash__(self):
+        if self['uuid']:
+            # For saved Tasks, just define equality by equality of uuids
+            return self['uuid'].__hash__()
+        else:
+            # If the tasks are not saved, return hash of instance id
+            return id(self).__hash__()
+
+    @property
+    def _modified_fields(self):
+        writable_fields = set(self._data.keys()) - set(self.read_only_fields)
+        for key in writable_fields:
+            if self._data.get(key) != self._original_data.get(key):
+                yield key
+

     @property
     def completed(self):
         return self['status'] == six.text_type('completed')
     @property
     def completed(self):
         return self['status'] == six.text_type('completed')


@@ -133,6 +180,8 @@ class Task(TaskResource):
         return self['uuid'] is not None or self['id'] is not None
 
     def serialize_due(self, date):
         return self['uuid'] is not None or self['id'] is not None
 
     def serialize_due(self, date):

+        if not date:
+            return None

         return date.strftime(DATE_FORMAT)
 
     def deserialize_due(self, date_str):
         return date.strftime(DATE_FORMAT)
 
     def deserialize_due(self, date_str):


@@ -140,6 +189,41 @@ class Task(TaskResource):
             return None
         return datetime.datetime.strptime(date_str, DATE_FORMAT)
 
             return None
         return datetime.datetime.strptime(date_str, DATE_FORMAT)
 

+    def serialize_depends(self, cur_dependencies):
+        # Check that all the tasks are saved
+        for task in cur_dependencies:
+            if not task.saved:
+                raise Task.NotSaved('Task \'%s\' needs to be saved before '
+                                    'it can be set as dependency.' % task)
+
+        # Return the list of uuids
+        return ','.join(task['uuid'] for task in cur_dependencies)
+
+    def deserialize_depends(self, raw_uuids):
+        raw_uuids = raw_uuids or ''  # Convert None to empty string
+        uuids = raw_uuids.split(',')
+        return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
+
+    def format_depends(self):
+        # We need to generate added and removed dependencies list,
+        # since Taskwarrior does not accept redefining dependencies.
+
+        # This cannot be part of serialize_depends, since we need
+        # to keep a list of all depedencies in the _data dictionary,
+        # not just currently added/removed ones
+
+        old_dependencies_raw = self._original_data.get('depends','')
+        old_dependencies = self.deserialize_depends(old_dependencies_raw)
+
+        added = self['depends'] - old_dependencies
+        removed = old_dependencies - self['depends']
+
+        # Removed dependencies need to be prefixed with '-'
+        return ','.join(
+                [t['uuid'] for t in added] +
+                ['-' + t['uuid'] for t in removed]
+            )
+

     def deserialize_annotations(self, data):
         return [TaskAnnotation(self, d) for d in data] if data else []
 
     def deserialize_annotations(self, data):
         return [TaskAnnotation(self, d) for d in data] if data else []
 


@@ -204,7 +288,6 @@ class Task(TaskResource):
             # Circumvent the ID storage, since ID is considered read-only
             self._data['id'] = int(id_lines[0].split(' ')[2].rstrip('.'))
 
             # Circumvent the ID storage, since ID is considered read-only
             self._data['id'] = int(id_lines[0].split(' ')[2].rstrip('.'))
 

-        self._modified_fields.clear()

         self.refresh()
 
     def add_annotation(self, annotation):
         self.refresh()
 
     def add_annotation(self, annotation):


@@ -228,16 +311,27 @@ class Task(TaskResource):
     def _get_modified_fields_as_args(self):
         args = []
 
     def _get_modified_fields_as_args(self):
         args = []
 

+        def add_field(field):
+            # Task version older than 2.4.0 ignores first word of the
+            # task description if description: prefix is used
+            if self.warrior.version < VERSION_2_4_0 and field == 'description':
+                args.append(self._data[field])
+            elif field == 'depends':
+                args.append('{0}:{1}'.format(field, self.format_depends()))
+            else:
+                # Use empty string to substitute for None value
+                args.append('{0}:{1}'.format(field, self._data[field] or ''))
+

         # If we're modifying saved task, simply pass on all modified fields
         if self.saved:
             for field in self._modified_fields:
         # If we're modifying saved task, simply pass on all modified fields
         if self.saved:
             for field in self._modified_fields:

-                args.append('{0}:{1}'.format(field, self._data[field]))
+                add_field(field)

         # For new tasks, pass all fields that make sense
         else:
             for field in self._data.keys():
                 if field in self.read_only_fields:
                     continue
         # For new tasks, pass all fields that make sense
         else:
             for field in self._data.keys():
                 if field in self.read_only_fields:
                     continue

-                args.append('{0}:{1}'.format(field, self._data[field]))
+                add_field(field)

 
         return args
 
 
         return args
 


@@ -255,8 +349,13 @@ class Task(TaskResource):
             to_update = dict(
                 [(k, new_data.get(k)) for k in only_fields])
             self._data.update(to_update)
             to_update = dict(
                 [(k, new_data.get(k)) for k in only_fields])
             self._data.update(to_update)

+            self._original_data.update(to_update)

         else:
             self._data = new_data
         else:
             self._data = new_data

+            # We need to create a clone for original_data though
+            # Shallow copy is alright, since data dict uses only
+            # primitive data types
+            self._original_data = new_data.copy()

 
 
 class TaskFilter(object):
 
 
 class TaskFilter(object):


@@ -276,7 +375,13 @@ class TaskFilter(object):
         # Replace the value with empty string, since that is the
         # convention in TW for empty values
         value = value if value is not None else ''
         # Replace the value with empty string, since that is the
         # convention in TW for empty values
         value = value if value is not None else ''

-        self.filter_params.append('{0}:{1}'.format(key, value))
+
+        # If we are filtering by uuid:, do not use uuid keyword
+        # due to TW-1452 bug
+        if key == 'uuid':
+            self.filter_params.insert(0, value)
+        else:
+            self.filter_params.append('{0}:{1}'.format(key, value))

 
     def get_filter_params(self):
         return [f for f in self.filter_params if f]
 
     def get_filter_params(self):
         return [f for f in self.filter_params if f]