home · contact · privacy
Add Conditions for Todos/Processes to be met or undone by other Todos.
[plomtask] / plomtask / todos.py
index 7150f0d702c44ec89e170e5381b20c8e61ea42ae..ce83faddff55278c0efe44f604f6a5fddfaa5851 100644 (file)
@@ -4,50 +4,202 @@ from sqlite3 import Row
 from plomtask.db import DatabaseConnection
 from plomtask.days import Day
 from plomtask.processes import Process
-from plomtask.exceptions import NotFoundException
+from plomtask.conditions import Condition
+from plomtask.exceptions import (NotFoundException, BadFormatException,
+                                 HandledException)
 
 
 class Todo:
     """Individual actionable."""
 
+    # pylint: disable=too-many-instance-attributes
+
     def __init__(self, id_: int | None, process: Process,
                  is_done: bool, day: Day) -> None:
         self.id_ = id_
         self.process = process
-        self.is_done = is_done
+        self._is_done = is_done
         self.day = day
-
-    def __eq__(self, other: object) -> bool:
-        return isinstance(other, self.__class__) and self.id_ == other.id_
+        self.children: list[Todo] = []
+        self.parents: list[Todo] = []
+        self.conditions: list[Condition] = []
+        self.fulfills: list[Condition] = []
+        self.undoes: list[Condition] = []
+        if not self.id_:
+            self.conditions = process.conditions[:]
+            self.fulfills = process.fulfills[:]
+            self.undoes = process.undoes[:]
 
     @classmethod
-    def from_table_row(cls, row: Row, db_conn: DatabaseConnection) -> Todo:
-        """Make Todo from database row."""
-        return cls(id_=row[0],
+    def from_table_row(cls, db_conn: DatabaseConnection, row: Row) -> Todo:
+        """Make Todo from database row, write to DB cache."""
+        todo = cls(id_=row[0],
                    process=Process.by_id(db_conn, row[1]),
-                   is_done=row[2],
+                   is_done=bool(row[2]),
                    day=Day.by_date(db_conn, row[3]))
+        assert todo.id_ is not None
+        db_conn.cached_todos[todo.id_] = todo
+        return todo
 
     @classmethod
-    def by_id(cls, db_conn: DatabaseConnection, id_: int) -> Todo:
-        """Get Todo of .id_=id_."""
-        for row in db_conn.exec('SELECT * FROM todos WHERE id = ?', (id_,)):
-            return cls.from_table_row(row, db_conn)
-        raise NotFoundException(f'Todo of ID not found: {id_}')
+    def by_id(cls, db_conn: DatabaseConnection, id_: int | None) -> Todo:
+        """Get Todo of .id_=id_ and children (from DB cache if possible)."""
+        if id_ in db_conn.cached_todos.keys():
+            todo = db_conn.cached_todos[id_]
+        else:
+            todo = None
+            for row in db_conn.exec('SELECT * FROM todos WHERE id = ?',
+                                    (id_,)):
+                todo = cls.from_table_row(db_conn, row)
+                break
+            if todo is None:
+                raise NotFoundException(f'Todo of ID not found: {id_}')
+            for row in db_conn.exec('SELECT child FROM todo_children '
+                                    'WHERE parent = ?', (id_,)):
+                todo.children += [cls.by_id(db_conn, row[0])]
+            for row in db_conn.exec('SELECT parent FROM todo_children '
+                                    'WHERE child = ?', (id_,)):
+                todo.parents += [cls.by_id(db_conn, row[0])]
+            for row in db_conn.exec('SELECT condition FROM todo_conditions '
+                                    'WHERE todo = ?', (id_,)):
+                todo.conditions += [Condition.by_id(db_conn, row[0])]
+            for row in db_conn.exec('SELECT condition FROM todo_fulfills '
+                                    'WHERE todo = ?', (id_,)):
+                todo.fulfills += [Condition.by_id(db_conn, row[0])]
+            for row in db_conn.exec('SELECT condition FROM todo_undoes '
+                                    'WHERE todo = ?', (id_,)):
+                todo.undoes += [Condition.by_id(db_conn, row[0])]
+        assert isinstance(todo, Todo)
+        return todo
 
     @classmethod
     def by_date(cls, db_conn: DatabaseConnection, date: str) -> list[Todo]:
         """Collect all Todos for Day of date."""
         todos = []
-        for row in db_conn.exec('SELECT * FROM todos WHERE day = ?', (date,)):
-            todos += [cls.from_table_row(row, db_conn)]
+        for row in db_conn.exec('SELECT id FROM todos WHERE day = ?', (date,)):
+            todos += [cls.by_id(db_conn, row[0])]
         return todos
 
+    @classmethod
+    def enablers_for_at(cls, db_conn: DatabaseConnection, condition: Condition,
+                        date: str) -> list[Todo]:
+        """Collect all Todos of day that enable condition."""
+        enablers = []
+        for row in db_conn.exec('SELECT todo FROM todo_fulfills '
+                                'WHERE condition = ?', (condition.id_,)):
+            todo = cls.by_id(db_conn, row[0])
+            if todo.day.date == date:
+                enablers += [todo]
+        return enablers
+
+    @classmethod
+    def disablers_for_at(cls, db_conn: DatabaseConnection,
+                         condition: Condition, date: str) -> list[Todo]:
+        """Collect all Todos of day that disable condition."""
+        disablers = []
+        for row in db_conn.exec('SELECT todo FROM todo_undoes '
+                                'WHERE condition = ?', (condition.id_,)):
+            todo = cls.by_id(db_conn, row[0])
+            if todo.day.date == date:
+                disablers += [todo]
+        return disablers
+
+    @property
+    def is_doable(self) -> bool:
+        """Decide whether .is_done settable based on children, Conditions."""
+        for child in self.children:
+            if not child.is_done:
+                return False
+        for condition in self.conditions:
+            if not condition.is_active:
+                return False
+        return True
+
+    @property
+    def is_done(self) -> bool:
+        """Wrapper around self._is_done so we can control its setter."""
+        return self._is_done
+
+    @is_done.setter
+    def is_done(self, value: bool) -> None:
+        if value != self.is_done and not self.is_doable:
+            raise BadFormatException('cannot change doneness of undoable Todo')
+        if self._is_done != value:
+            self._is_done = value
+            if value is True:
+                for condition in self.fulfills:
+                    condition.is_active = True
+                for condition in self.undoes:
+                    condition.is_active = False
+
+    def set_undoes(self, db_conn: DatabaseConnection, ids: list[int]) -> None:
+        """Set self.undoes to Conditions identified by ids."""
+        self.set_conditions(db_conn, ids, 'undoes')
+
+    def set_fulfills(self, db_conn: DatabaseConnection,
+                     ids: list[int]) -> None:
+        """Set self.fulfills to Conditions identified by ids."""
+        self.set_conditions(db_conn, ids, 'fulfills')
+
+    def set_conditions(self, db_conn: DatabaseConnection, ids: list[int],
+                       target: str = 'conditions') -> None:
+        """Set self.[target] to Conditions identified by ids."""
+        target_list = getattr(self, target)
+        while len(target_list) > 0:
+            target_list.pop()
+        for id_ in ids:
+            target_list += [Condition.by_id(db_conn, id_)]
+
+    def add_child(self, child: Todo) -> None:
+        """Add child to self.children, guard against recursion"""
+        def walk_steps(node: Todo) -> None:
+            if node.id_ == self.id_:
+                raise BadFormatException('bad child choice causes recursion')
+            for child in node.children:
+                walk_steps(child)
+        if self.id_ is None:
+            raise HandledException('Can only add children to saved Todos.')
+        if child.id_ is None:
+            raise HandledException('Can only add saved children to Todos.')
+        if child in self.children:
+            raise BadFormatException('cannot adopt same child twice')
+        walk_steps(child)
+        self.children += [child]
+        child.parents += [self]
+
     def save(self, db_conn: DatabaseConnection) -> None:
-        """Write self to DB."""
+        """Write self and children to DB and its cache."""
         if self.process.id_ is None:
             raise NotFoundException('Process of Todo without ID (not saved?)')
         cursor = db_conn.exec('REPLACE INTO todos VALUES (?,?,?,?)',
                               (self.id_, self.process.id_,
                                self.is_done, self.day.date))
         self.id_ = cursor.lastrowid
+        assert self.id_ is not None
+        db_conn.cached_todos[self.id_] = self
+        db_conn.exec('DELETE FROM todo_children WHERE parent = ?',
+                     (self.id_,))
+        for child in self.children:
+            db_conn.exec('INSERT INTO todo_children VALUES (?, ?)',
+                         (self.id_, child.id_))
+        db_conn.exec('DELETE FROM todo_fulfills WHERE todo = ?', (self.id_,))
+        for condition in self.fulfills:
+            if condition.id_ is None:
+                raise NotFoundException('Fulfilled Condition of Todo '
+                                        'without ID (not saved?)')
+            db_conn.exec('INSERT INTO todo_fulfills VALUES (?, ?)',
+                         (self.id_, condition.id_))
+        db_conn.exec('DELETE FROM todo_undoes WHERE todo = ?', (self.id_,))
+        for condition in self.undoes:
+            if condition.id_ is None:
+                raise NotFoundException('Undone Condition of Todo '
+                                        'without ID (not saved?)')
+            db_conn.exec('INSERT INTO todo_undoes VALUES (?, ?)',
+                         (self.id_, condition.id_))
+        db_conn.exec('DELETE FROM todo_conditions WHERE todo = ?', (self.id_,))
+        for condition in self.conditions:
+            if condition.id_ is None:
+                raise NotFoundException('Condition of Todo '
+                                        'without ID (not saved?)')
+            db_conn.exec('INSERT INTO todo_conditions VALUES (?, ?)',
+                         (self.id_, condition.id_))