phable-cli 0.1.4__tar.gz → 0.1.6__tar.gz

{phable_cli-0.1.4 → phable_cli-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: phable-cli
-Version: 0.1.4
+Version: 0.1.6
 Summary: Manage Phabricator tasks from the comfort of your terminal
 License: MIT
 Author: Balthazar Rouberol

{phable_cli-0.1.4 → phable_cli-0.1.6}/phable_cli/cache.py

@@ -23,7 +23,10 @@ class Cache:
             self.cache_dir.mkdir()
         self.cache_filepath = self.cache_dir / "cache.json"
         if self.cache_filepath.exists():
-            self.data = json.load(open(self.cache_filepath))
+            try:
+                self.data = json.load(open(self.cache_filepath))
+            except json.JSONDecodeError:
+                self.data = {}
         else:
             self.data = {}
 

{phable_cli-0.1.4 → phable_cli-0.1.6}/phable_cli/cli.py

@@ -2,7 +2,7 @@ import atexit
 import json
 import re
 from pathlib import Path
-from typing import Optional
+from typing import Optional, Any, Callable
 
 import click
 from click import Context
@@ -25,6 +25,11 @@ def cli():
     pass
 
 
+@cli.group(name="cache")
+def _cache():
+    """Manage internal cache"""
+
+
 class Task(int):
     @classmethod
     def from_str(cls, value: str) -> int:
@@ -54,59 +59,56 @@ def show_task(task_id: int, format: str = "plain"):
     """
     client = PhabricatorClient()
     if task := client.show_task(task_id):
-        author = client.show_user(phid=task["fields"]["authorPHID"])
-        if owner_id := task["fields"]["ownerPHID"]:
-            owner = client.show_user(phid=owner_id)["fields"]["username"]
-        else:
-            owner = "Unassigned"
-        if project_ids := task["attachments"]["projects"]["projectPHIDs"]:
-            tags = [
-                (
-                    f"{project['fields']['parent']['name']} - {project['fields']['name']}"
-                    if project["fields"]["parent"]
-                    else project["fields"]["name"]
-                )
-                for project in client.show_projects(phids=project_ids)
-            ]
-        else:
-            tags = []
-        subtasks = client.find_subtasks(parent_id=task_id)
-        task["subtasks"] = subtasks
-        parent = client.find_parent_task(subtask_id=task_id)
-        task["parent"] = parent
-        if format == "json":
-            click.echo(json.dumps(task))
-        else:
-            parent_str = (
-                f"{Task.from_int(parent['id'])} - {parent['fields']['name']}"
-                if parent
-                else ""
-            )
-            click.echo(f"URL: {client.base_url}/{Task.from_int(task_id)}")
-            click.echo(f"Task: {Task.from_int(task_id)}")
-            click.echo(f"Title: {task['fields']['name']}")
-            click.echo(f"Author: {author['fields']['username']}")
-            click.echo(f"Owner: {owner}")
-            click.echo(f"Tags: {', '.join(tags)}")
-            click.echo(f"Status: {task['fields']['status']['name']}")
-            click.echo(f"Priority: {task['fields']['priority']['name']}")
-            click.echo(f"Description: {task['fields']['description']['raw']}")
-            click.echo(f"Parent: {parent_str}")
-            click.echo("Subtasks:")
-            if subtasks:
-                for subtask in subtasks:
-                    status = f"{'[x]' if subtask['fields']['status']['value'] == 'resolved' else '[ ]'}"
-                    if subtask_owner_id := subtask["fields"]["ownerPHID"]:
-                        owner = client.show_user(subtask_owner_id)["fields"]["username"]
-                    else:
-                        owner = ""
-                    click.echo(
-                        f"{status} - {Task.from_int(subtask['id'])} - @{owner:<10} - {subtask['fields']['name']}"
-                    )
+        task = client.enrich_task(
+            task,
+            with_author_owner=True,
+            with_tags=True,
+            with_subtasks=True,
+            with_parent=True,
+        )
+        echo_task(click.echo, format, task)
     else:
         click.echo(f"Task {Task.from_int(task_id)} not found")
 
 
+def echo_task(echo: Callable[[str], None], format: str, task: dict[str, Any]) -> None:
+    """Print a task.
+
+    Print a task in a text or json format. The task needs to be enriched first.
+
+    To generalize the implementation and not couple it to the click library,
+    the user must pass an `echo` function that will be used to print the task.
+    """
+    if format == "json":
+        echo(json.dumps(task))
+    else:
+        parent_str = (
+            f"{Task.from_int(task["parent"]['id'])} - {task["parent"]['fields']['name']}"
+            if task.get("parent")
+            else ""
+        )
+        echo(f"URL: {task['url']}")
+        echo(f"Task: {Task.from_int(task['id'])}")
+        echo(f"Title: {task['fields']['name']}")
+        if task.get("author"):
+            echo(f"Author: {task['author']['fields']['username']}")
+        if task.get("owner"):
+            echo(f"Owner: {task['owner']}")
+        if task.get("tags"):
+            echo(f"Tags: {', '.join(task['tags'])}")
+        echo(f"Status: {task['fields']['status']['name']}")
+        echo(f"Priority: {task['fields']['priority']['name']}")
+        echo(f"Description: {task['fields']['description']['raw']}")
+        echo(f"Parent: {parent_str}")
+        echo("Subtasks:")
+        if task.get("subtasks"):
+            for subtask in task["subtasks"]:
+                status = f"{'[x]' if subtask['fields']['status']['value'] == 'resolved' else '[ ]'}"
+                echo(
+                    f"{status} - {Task.from_int(subtask['id'])} - @{subtask['owner']:<10} - {subtask['fields']['name']}"
+                )
+
+
 @cli.command(name="create")
 @click.option("--title", required=True, help="Title of the task")
 @click.option(
@@ -192,7 +194,6 @@ def create_task(
     task_params = {
         "title": title,
         "description": description,
-        "projects.add": [config.phabricator_default_project_phid],
         "priority": priority,
     }
 
@@ -222,6 +223,8 @@ def create_task(
             ctx.fail(f"Project {tag} not found")
     if tag_projects_phids:
         task_params["projects.add"] = tag_projects_phids
+    else:
+        task_params["projects.add"] = [config.phabricator_default_project_phid]
 
     if owner:
         if owner_user := client.find_user_by_username(username=owner):
@@ -236,7 +239,7 @@ def create_task(
     cc_phids = []
     for username in cc:
         if user := client.find_user_by_username(username=username):
-            cc_phids.appedn(user["phid"])
+            cc_phids.append(user["phid"])
         else:
             ctx.fail(f"User {owner} not found")
     if cc_phids:
@@ -314,6 +317,8 @@ def move_task(
 
         for task_id in task_ids:
             client.move_task_to_column(task_id=task_id, column_phid=target_column_phid)
+            if column.lower() in ("in progress", "needs review"):
+                client.mark_task_as_in_progress(task_id)
             if column.lower() == "done":
                 client.mark_task_as_resolved(task_id)
     except ValueError as ve:
@@ -362,6 +367,68 @@ def subscribe_to_task(ctx, task_ids: list[int]):
         client.add_user_to_task_subscribers(task_id=task_id, user_phid=user["phid"])
 
 
+@_cache.command()
+def show():
+    """Display the location of the internal phable cache"""
+    click.echo(cache.cache_filepath)
+
+
+@_cache.command()
+def clear():
+    """Delete the phable internal cache file"""
+    cache.cache_filepath.unlink(missing_ok=True)
+    atexit.unregister(cache.dump)  # avoid re-dumping the in-memory cache back to disk
+
+
+@cli.command(name="report-done-tasks")
+@click.option(
+    "--milestone/--no-milestone",
+    default=False,
+    help=(
+        "If --milestone is passed, the task will be moved onto the current project's associated "
+        "milestone board, instead of the project board itself"
+    ),
+)
+@click.option(
+    "--format",
+    type=click.Choice(("plain", "json")),
+    default="plain",
+    help="Output format",
+)
+@click.option(
+    "--source",
+    type=str,
+    default="Done",
+    help="",
+)
+@click.option(
+    "--destination",
+    type=str,
+    default="Reported",
+    help="",
+)
+def report_done_tasks(milestone: bool, format: str, source: str, destination: str):
+    """Print the details of all tasks in the `from` column and move them to the `to` column.
+
+    This is used to produce the weekly reports, and document the tasks as reported once the report is done.
+    """
+    client = PhabricatorClient()
+    target_project_phid = client.get_main_project_or_milestone(
+        milestone, config.phabricator_default_project_phid
+    )
+    column_source_phid = client.find_column_in_project(target_project_phid, source)
+    column_destination_phid = client.find_column_in_project(
+        target_project_phid, destination
+    )
+    tasks = client.find_tasks_in_column(column_source_phid)
+    for task in tasks:
+        task = client.enrich_task(task)
+        if format == "plain":
+            click.echo("=" * 50)
+        echo_task(click.echo, format, task)
+        client.move_task_to_column(task["id"], column_destination_phid)
+
+
 def runcli():
     cli(max_content_width=120)
 

{phable_cli-0.1.4 → phable_cli-0.1.6}/phable_cli/phabricator.py

@@ -8,6 +8,16 @@ from .config import config
 T = TypeVar("T")
 
 
+class Task(int):
+    @classmethod
+    def from_str(cls, value: str) -> int:
+        return int(value.lstrip("T"))
+
+    @classmethod
+    def from_int(cls, value: int) -> str:
+        return f"T{value}"
+
+
 class PhabricatorClient:
     """Phabricator API HTTP client.
 
@@ -86,6 +96,84 @@ class PhabricatorClient:
             },
         )["result"]["data"][0]
 
+    def enrich_task(
+        self,
+        task: dict[str, Any],
+        with_author_owner: bool = False,
+        with_tags: bool = False,
+        with_subtasks: bool = False,
+        with_parent: bool = False,
+    ) -> dict[str, Any]:
+        """Load additional data about a task.
+
+        The given task is enriched AND returned.
+
+        Some of the additional info that is loaded:
+        * projects
+        * subtasks
+        * parent tasks
+        """
+        task["url"] = f"{self.base_url}/{Task.from_int(task['id'])}"
+
+        if with_author_owner:
+            self.enrich_task_with_author_owner(task)
+        if with_tags:
+            self.enrich_task_with_tags(task)
+        if with_subtasks:
+            self.enrich_task_with_subtasks(task)
+        if with_parent:
+            self.enrich_task_with_parent(task)
+        return task
+
+    def enrich_task_with_author_owner(self, task: dict[str, Any]) -> None:
+        task["author"] = self.show_user(phid=task["fields"]["authorPHID"])
+        if owner_id := task["fields"]["ownerPHID"]:
+            owner = self.show_user(phid=owner_id)["fields"]["username"]
+        else:
+            owner = "Unassigned"
+        task["owner"] = owner
+
+    def enrich_task_with_tags(self, task: dict[str, Any]) -> None:
+        if project_ids := task["attachments"]["projects"]["projectPHIDs"]:
+            tags = [
+                (
+                    f"{project['fields']['parent']['name']} - {project['fields']['name']}"
+                    if project["fields"]["parent"]
+                    else project["fields"]["name"]
+                )
+                for project in self.show_projects(phids=project_ids)
+            ]
+        else:
+            tags = []
+        task["tags"] = tags
+
+    def enrich_task_with_subtasks(self, task: dict[str, Any]) -> None:
+        subtasks = self.find_subtasks(parent_id=task["id"])
+        if not subtasks:
+            subtasks = []
+        for subtask in subtasks:
+            if subtask_owner_id := subtask["fields"]["ownerPHID"]:
+                owner = self.show_user(subtask_owner_id)["fields"]["username"]
+            else:
+                owner = ""
+            subtask["owner"] = owner
+        task["subtasks"] = subtasks
+
+    def enrich_task_with_parent(self, task: dict[str, Any]) -> None:
+        parent = self.find_parent_task(subtask_id=task["id"])
+        task["parent"] = parent
+
+    def find_tasks_in_column(self, column_phid: str) -> list[dict[str, Any]]:
+        return self._make_request(
+            "maniphest.search",
+            params={
+                "constraints[columnPHIDs][0]": column_phid,
+                "attachments[subscribers]": "true",
+                "attachments[projects]": "true",
+                "attachments[columns]": "true",
+            },
+        )["result"]["data"]
+
     def find_subtasks(self, parent_id: int) -> list[dict[str, Any]]:
         """Return details of all Maniphest subtasks of the provided task id"""
         return self._make_request(
@@ -109,6 +197,10 @@ class PhabricatorClient:
         """Set the status of the argument task to Resolved"""
         return self.create_or_edit_task(task_id=task_id, params={"status": "resolved"})
 
+    def mark_task_as_in_progress(self, task_id: int) -> dict[str, Any]:
+        """Set the status of the argument task to in progress"""
+        return self.create_or_edit_task(task_id=task_id, params={"status": "progress"})
+
     def add_user_to_task_subscribers(
         self, task_id: int, user_phid: str
     ) -> dict[str, Any]:
@@ -182,10 +274,19 @@ class PhabricatorClient:
         )
 
         if not target_project_phid:
-            raise ValueError(f"Could not find a milestone in {project_phid}")
+            project = self.format_project_name(project_phid=project_phid)
+            raise ValueError(f"Could not find a milestone in {project}")
 
         return target_project_phid
 
+    def format_project_name(self, project_phid: str) -> str:
+        project = self.show_projects(phids=[project_phid])[0]
+        if project["fields"].get("parent"):
+            parent_project_name = project["fields"]["parent"]["name"]
+            return f"{parent_project_name} ({project['fields']['name']})"
+        else:
+            return project["fields"]["name"]
+
     @cached
     def find_column_in_project(self, project_phid: str, column_name: str) -> str:
         """Finds a column in a project.
@@ -198,8 +299,9 @@ class PhabricatorClient:
                 column_phid = col["phid"]
                 break
         else:
+            project_name = self.format_project_name(project_phid=project_phid)
             raise ValueError(
-                f"Column {column_name} not found in milestone {project_phid}"
+                f"Column {column_name} not found in milestone {project_name}"
             )
         return column_phid
 

{phable_cli-0.1.4 → phable_cli-0.1.6}/phable_cli/utils.py

@@ -4,7 +4,9 @@ import os
 from pathlib import Path
 
 
-def text_from_cli_arg_or_fs_or_editor(body_or_path: str, force_editor: bool) -> str:
+def text_from_cli_arg_or_fs_or_editor(
+    body_or_path: str, force_editor: bool = False
+) -> str:
     """Return argument text/file content, or return prompted input text.
 
     If some argument text is passed, and it matches a file path, return the file content.

{phable_cli-0.1.4 → phable_cli-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "phable-cli"
-version = "0.1.4"
+version = "0.1.6"
 description = "Manage Phabricator tasks from the comfort of your terminal"
 authors = ["Balthazar Rouberol <br@imap.cc>"]
 license = "MIT"