New support for subtasks

.gitignore

@@ -13,5 +13,6 @@ docs/_build/
 .coverage
 .hypothesis
 *.tmp
+.mypy_cache/
 
 todoman/version.py

AUTHORS.rst

@@ -34,3 +34,4 @@ Authors are listed in alphabetical order.
 * Swati Garg <swati4star@gmail.com>
 * Thomas Glanzmann <thomas@glanzmann.de>
 * https://github.com/Pikrass
+* https://github.com/powerjungle

CHANGELOG.rst

@@ -12,6 +12,11 @@ v4.7.0
   by setuptools no longer has performance issues.
 * Added shell completions for fish.
 * Implement a new ``lists`` command to display all lists.
+* Added support for RELATED-TO property and RELTYPE parameter, allowing the
+  parsing and creation of subtasks. This requires adding two new columns to
+  the database. The `SCHEMA_VERSION` has been incremented, so the cache will
+  be recreated. No changes to the configuration or lists is needed. The tasks
+  are now printed as a tree when subtasks are present.
 
 v4.6.0
 ------

docs/source/contributing.rst

@@ -23,6 +23,11 @@ without them being properly documented.
 Run ``pip install -e .`` to install todoman and its dependencies into a
 virtualenv.
 
+If the database is changed in a breaking way, the ``SCHEMA_VERSION`` variable
+in the class ``Cache`` has to be incremented to allow the cache to be recreated
+after todoman has been updated. An example would be adding new fields or
+removing old unnecessary fields and etc.
+
 We use ``pre-commit`` to run style and convention checks. Run ``pre-commit
 install``` to install our git-hooks. These will check code style and inform you
 of any issues when attempting to commit. This will also run ``black`` to

tests/test_backend.py

@@ -49,6 +49,8 @@ def test_supported_fields_are_serializeable() -> None:
 def test_vtodo_serialization(todo_factory: Callable) -> None:
     """Test VTODO serialization: one field of each type."""
     description = "A tea would be nice, thanks."
+    related_val = "1292818859927632133"
+    related_val_reltype = "PARENT"
     todo = todo_factory(
         categories=["tea", "drinking", "hot"],
         description=description,
@@ -58,6 +60,8 @@ def test_vtodo_serialization(todo_factory: Callable) -> None:
         status="IN-PROCESS",
         summary="Some tea",
         rrule="FREQ=MONTHLY",
+        related_to=related_val,
+        related_to_reltype=related_val_reltype,
     )
     writer = VtodoWriter(todo)
     vtodo = writer.serialize()
@@ -69,6 +73,8 @@ def test_vtodo_serialization(todo_factory: Callable) -> None:
     assert vtodo.decoded("dtstart") == date(3000, 3, 21)
     assert str(vtodo.get("status")) == "IN-PROCESS"
     assert vtodo.get("rrule") == icalendar.vRecur.from_ical("FREQ=MONTHLY")
+    assert vtodo.get("related-to") == related_val
+    assert vtodo.get("related-to").params.get("reltype") == related_val_reltype
 
 
 @freeze_time("2017-04-04 20:11:57")

tests/test_cli.py

@@ -484,13 +484,9 @@ def test_color_due_dates(
     assert not result.exception
     due_str = due.strftime("%Y-%m-%d")
     if hours == 72:
-        expected = (
-            f"[ ] 1 \x1b[35m\x1b[0m \x1b[37m{due_str}\x1b[0m aaa @default\x1b[0m\n"
-        )
+        expected = f"[ ] 1 \x1b[37m{due_str}\x1b[0m aaa @default\x1b[0m\n"
     else:
-        expected = (
-            f"[ ] 1 \x1b[35m\x1b[0m \x1b[31m{due_str}\x1b[0m aaa @default\x1b[0m\n"
-        )
+        expected = f"[ ] 1 \x1b[31m{due_str}\x1b[0m aaa @default\x1b[0m\n"
     assert result.output == expected
 
 
@@ -499,17 +495,15 @@ def test_color_flag(runner: CliRunner, todo_factory: Callable) -> None:
 
     result = runner.invoke(cli, ["--color", "always"], color=True)
     assert (
-        result.output.strip()
-        == "[ ] 1 \x1b[35m\x1b[0m \x1b[31m2007-03-22\x1b[0m YARR! @default\x1b[0m"
+        result.output.strip() == "[ ] 1 \x1b[31m2007-03-22\x1b[0m YARR! @default\x1b[0m"
     )
     result = runner.invoke(cli, color=True)
     assert (
-        result.output.strip()
-        == "[ ] 1 \x1b[35m\x1b[0m \x1b[31m2007-03-22\x1b[0m YARR! @default\x1b[0m"
+        result.output.strip() == "[ ] 1 \x1b[31m2007-03-22\x1b[0m YARR! @default\x1b[0m"
     )
 
     result = runner.invoke(cli, ["--color", "never"], color=True)
-    assert result.output.strip() == "[ ] 1  2007-03-22 YARR! @default"
+    assert result.output.strip() == "[ ] 1 2007-03-22 YARR! @default"
 
 
 def test_flush(

tests/test_formatter.py

@@ -106,15 +106,17 @@ def test_format_datetime(default_formatter: DefaultFormatter) -> None:
 def test_detailed_format(runner: CliRunner, todo_factory: Callable) -> None:
     todo_factory(
         description=(
-            "Test detailed formatting\nThis includes multiline descriptions\nBlah!"
+            "Test detailed formatting\n"
+            + "This includes multiline descriptions\n"
+            + "Blah!"
         ),
         location="Over the hills, and far away",
     )
 
-    # TODO:use formatter instead of runner?
+    # TODO: use formatter instead of runner?
     result = runner.invoke(cli, ["show", "1"])
     expected = [
-        "[ ] 1  (no due date) YARR! @default",
+        "[ ] 1 (no due date) YARR! @default",
         "",
         "Description:",
         "Test detailed formatting",
@@ -202,7 +204,7 @@ def test_format_multiple_with_list(
     assert todo.list
     assert (
         default_formatter.compact_multiple([todo])
-        == "[ ] 1 \x1b[35m\x1b[0m \x1b[37m(no due date)\x1b[0m YARR! @default\x1b[0m"
+        == "[ ] 1 \x1b[37m(no due date)\x1b[0m YARR! @default\x1b[0m"
     )
 
 

tests/test_model.py

@@ -260,6 +260,12 @@ def test_todo_setters(todo_factory: Callable) -> None:
     todo.due = None
     assert todo.due is None
 
+    todo.related_to = "123"
+    assert todo.related_to == "123"
+
+    todo.related_to_reltype = "CHILD"
+    assert todo.related_to_reltype == "CHILD"
+
 
 @freeze_time("2017-03-19-15")
 def test_is_completed() -> None:
@@ -401,6 +407,8 @@ def test_clone() -> None:
     todo.uid = "123"
     todo.id = 123
     todo.filename = "123.ics"
+    todo.related_to = "12345678"
+    todo.related_to_reltype = "PARENT"
 
     clone = todo.clone()
 
@@ -412,6 +420,8 @@ def test_clone() -> None:
     assert clone.id is None
     assert todo.filename != clone.filename
     assert clone.uid in clone.filename
+    assert todo.related_to == clone.related_to
+    assert todo.related_to_reltype == clone.related_to_reltype
 
 
 @freeze_time("2017, 3, 20")

tests/test_porcelain.py

@@ -22,7 +22,8 @@ def test_list_all(tmpdir: py.path.local, runner: CliRunner, create: Callable) ->
         "DUE;VALUE=DATE-TIME;TZID=CET:20160102T000000\n"
         "DTSTART:20160101T000000Z\n"
         "PERCENT-COMPLETE:26\n"
-        "LOCATION:Wherever\n",
+        "LOCATION:Wherever\n"
+        "RELATED-TO;RELTYPE=PARENT:123456789\n",
     )
     result = runner.invoke(cli, ["--porcelain", "list", "--status", "ANY"])
 
@@ -40,6 +41,8 @@ def test_list_all(tmpdir: py.path.local, runner: CliRunner, create: Callable) ->
             "percent": 26,
             "priority": 0,
             "recurring": False,
+            "related_to": "123456789",
+            "related_to_reltype": "PARENT",
             "start": 1451606400,
             "summary": "Do stuff",
         }
@@ -78,6 +81,8 @@ def test_list_start_date(
             "percent": 26,
             "priority": 0,
             "recurring": False,
+            "related_to": "",
+            "related_to_reltype": "",
             "start": 1451692800,
             "summary": "Do stuff",
         }
@@ -114,6 +119,8 @@ def test_list_due_date(
             "percent": 26,
             "priority": 0,
             "recurring": False,
+            "related_to": "",
+            "related_to_reltype": "",
             "start": None,
             "summary": "Do stuff",
         }
@@ -143,6 +150,8 @@ def test_list_nodue(tmpdir: py.path.local, runner: CliRunner, create: Callable)
             "location": "",
             "percent": 12,
             "recurring": False,
+            "related_to": "",
+            "related_to_reltype": "",
             "priority": 4,
             "start": None,
             "summary": "Do stuff",
@@ -216,6 +225,8 @@ def test_show(tmpdir: py.path.local, runner: CliRunner, create: Callable) -> Non
         "percent": 0,
         "priority": 5,
         "recurring": False,
+        "related_to": "",
+        "related_to_reltype": "",
         "start": None,
         "summary": "harhar",
     }
@@ -241,6 +252,8 @@ def test_simple_action(todo_factory: Callable) -> None:
         "percent": 0,
         "priority": 0,
         "recurring": False,
+        "related_to": "",
+        "related_to_reltype": "",
         "start": None,
         "summary": "YARR!",
     }

todoman/cli.py

@@ -54,7 +54,9 @@ def wrapper(*a, **kw) -> _T:
 
 
 TODO_ID_MIN = 1
-with_id_arg = click.argument("id", type=click.IntRange(min=TODO_ID_MIN))
+CLICK_TYPE_ID = click.IntRange(min=TODO_ID_MIN)
+
+with_id_arg = click.argument("id", type=CLICK_TYPE_ID)
 
 
 def _validate_lists_param(
@@ -238,6 +240,13 @@ def _todo_property_options(command: Callable) -> Callable:
         help="When the task starts.",
     )(command)
 
+    # Merges all different property arguments into one dictionary
+    # `todo_properties` argument, so that it can be directly looped through
+    # easily for directly setting the `todoman.model.Todo` class attributes
+    # from within a command function.
+    #
+    # The names of the options are the same as the
+    # `todoman.model.Todo` class attributes.
     @functools.wraps(command)
     def command_wrap(*a, **kw) -> click.Command:
         kw["todo_properties"] = {
@@ -284,6 +293,21 @@ def formatter(self) -> formatters.Formatter:
     help="Go into interactive mode before saving the task.",
 )
 
+_subtask_option = click.option(
+    "--subtask-for",
+    is_flag=False,
+    default=None,
+    type=CLICK_TYPE_ID,
+    help="Set task to be a subtask for the given id.",
+)
+
+_not_subtask_option = click.option(
+    "--not-subtask",
+    is_flag=True,
+    default=False,
+    help="Make task no longer be a subtask.",
+)
+
 
 @click.group(invoke_without_command=True)
 @click_log.simple_verbosity_option()
@@ -423,6 +447,7 @@ def repl(ctx: click.Context) -> None:
 )
 @_todo_property_options
 @_interactive_option
+@_subtask_option
 @pass_ctx
 @catch_errors
 def new(
@@ -432,6 +457,7 @@ def new(
     todo_properties: dict,
     read_description: bool,
     interactive: bool,
+    subtask_for: int | None,
 ) -> None:
     """
     Create a new task with SUMMARY.
@@ -453,6 +479,11 @@ def new(
             setattr(todo, key, value)
     todo.summary = " ".join(summary)
 
+    if subtask_for is not None:
+        parent_todo = ctx.db.todo(subtask_for)
+        todo.related_to = parent_todo.uid
+        todo.related_to_reltype = "PARENT"
+
     if read_description:
         todo.description = sys.stdin.read()
 
@@ -487,6 +518,8 @@ def new(
 )
 @_todo_property_options
 @_interactive_option
+@_subtask_option
+@_not_subtask_option
 @with_id_arg
 @catch_errors
 def edit(
@@ -496,6 +529,8 @@ def edit(
     interactive: bool,
     read_description: bool,
     raw: bool,
+    subtask_for: int | None,
+    not_subtask: bool,
 ) -> None:
     """
     Edit the task with id ID.
@@ -516,6 +551,17 @@ def edit(
         changes = True
         todo.description = sys.stdin.read()
 
+    if subtask_for is not None and not_subtask is False:
+        changes = True
+        parent_todo = ctx.db.todo(subtask_for)
+        todo.related_to = parent_todo.uid
+        todo.related_to_reltype = "PARENT"
+
+    if not_subtask:
+        changes = True
+        todo.related_to = ""
+        todo.related_to_reltype = ""
+
     if interactive or (not changes and interactive is None):
         ui = TodoEditor(todo, ctx.db.lists(), ctx.ui_formatter)
         ui.edit()
@@ -528,6 +574,7 @@ def edit(
     ctx.db.save(todo)
     if old_list != new_list:
         ctx.db.move(todo, new_list=new_list, from_list=old_list)
+
     click.echo(ctx.formatter.detailed(todo))