Source code for greatday.config

"""Contains this project's clack.Config classes."""

from __future__ import annotations

import itertools as it
from pathlib import Path
from typing import Any, Literal, Optional, Sequence

import clack
from clack import xdg

from . import APP_NAME
from .types import SavedQueryGroupMap, YesNoDefault


Command = Literal["add", "list", "tui"]

DEFAULT_DATA_DIR = xdg.get_full_dir("data", APP_NAME)


class Config(clack.Config):
    """Shared clack configuration class."""

    command: Command

    # ----- CONFIG
    data_dir: Path = DEFAULT_DATA_DIR
    database_url: str = "sqlite:///" + str(DEFAULT_DATA_DIR / "greatday.db")


class AddConfig(Config):
    """Config for the 'add' subcommand."""

    command: Literal["add"]

    # ----- ARGUMENTS
    todo_line: str

    # ----- CONFIG
    add_inbox_context: YesNoDefault = "default"


class ListConfig(Config):
    """Config for the 'list' subcommand."""

    command: Literal["list"]

    # ----- ARGUMENTS
    query: Optional[str] = None


class TUIConfig(Config):
    """Config for the 'tui' subcommand."""

    command: Literal["tui"]

    # ----- CONFIG
    default_query_group: str
    saved_query_groups: SavedQueryGroupMap = {}


def clack_parser(argv: Sequence[str]) -> dict[str, Any]:
    """Parser we pass to the `main_factory()` `parser` kwarg."""
    # HACK: Make 'tui' the default sub-command.
    if not list(it.dropwhile(lambda x: x.startswith("-"), argv[1:])):
        argv = list(argv) + ["tui"]

    parser = clack.Parser(
        description="Don't have a good day. Have a great day."
    )

    new_command = clack.new_command_factory(parser)

    # ----- 'add' command
    add_parser = new_command("add", help="Add a new todo to your inbox.")
    add_parser.add_argument(
        "todo_line",
        metavar="TODO",
        help=(
            "A valid todo string (i.e. a string that conforms to the standard"
            " todo.txt format)."
        ),
    )

    # ----- 'list' command
    list_parser = new_command("list", help="Query the todo database.")
    list_parser.add_argument(
        "query",
        nargs="?",
        help=(
            "The todo search query that will be used to filter todos. If not"
            " provided, all todos are selected."
        ),
    )

    # ----- 'tui' command (default)
    new_command(
        "tui",
        help=(
            "Render greatday's text-based user interface (TUI). This is the"
            " default command."
        ),
    )

    args = parser.parse_args(argv[1:])
    kwargs = clack.filter_cli_args(args)

    return kwargs