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

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

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

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

@@ -9,7 +9,7 @@ from pathlib import Path
 
 CACHE_HOME_PER_PLATFORM = {
     "darwin": Path.home() / "Library" / "Caches",
-    "linux": Path(os.getenv("XDG_CACHE_HOME", f"{Path.home()}/.config")),
+    "linux": Path(os.getenv("XDG_CACHE_HOME", f"{Path.home()}/.cache")),
     "windows": Path("c:/", "Users", os.getlogin(), "AppData", "Local", "Temp"),
 }
 

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

@@ -18,7 +18,55 @@ VARIADIC = -1  # Used for click variadic arguments
 atexit.register(cache.dump)
 
 
-@click.group()
+class AliasedCommandGroup(click.Group):
+    """Custom CLI group allowing the replaement of aliases commands on the fly
+
+    For example if we have the following configuraion:
+    [aliases]
+    done = move --column 'Done' --milestone
+
+    then calling `phable done T123456` will actually call
+    `phable move --column Done --milestone T123456` under the hood.
+
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._aliases = config.data.get("aliases", {})
+
+    def make_context(self, info_name, args, parent=None, **extra):
+        # First, let's parse the command and handle aliases
+        parsed_args = self.parse_command(info_name, args)
+
+        # Then create the context with the possibly modified args
+        ctx = super().make_context(
+            info_name=parsed_args[0], args=parsed_args[1:], parent=parent, **extra
+        )
+        return ctx
+
+    def parse_command(self, ctx_name, args):
+        """Parse command line arguments and handle aliases"""
+        if not args:
+            return [ctx_name]
+
+        # Check if the first argument is an alias
+        if args[0] in self._aliases:
+            pattern = self._aliases[args[0]]
+            # Split the pattern and combine with remaining args
+            pattern_parts = click.parser.split_arg_string(pattern)
+            # Replace the alias with the pattern parts
+            args = pattern_parts + args[1:]
+
+        return [ctx_name] + args
+
+    def get_command(self, ctx, cmd_name):
+        """Override to handle aliases in command lookup"""
+        if cmd_name in self._aliases:
+            return super().get_command(ctx, self._aliases[cmd_name].split()[0])
+        return super().get_command(ctx, cmd_name)
+
+
+@click.group(cls=AliasedCommandGroup)
 @click.version_option()
 def cli():
     """Manage Phabricator tasks from the comfort of your terminal"""
@@ -30,6 +78,11 @@ def _cache():
     """Manage internal cache"""
 
 
+@cli.group
+def aliases():
+    """Manage aliases"""
+
+
 class Task(int):
     @classmethod
     def from_str(cls, value: str) -> int:
@@ -83,7 +136,7 @@ def echo_task(echo: Callable[[str], None], format: str, task: dict[str, Any]) ->
         echo(json.dumps(task))
     else:
         parent_str = (
-            f"{Task.from_int(task["parent"]['id'])} - {task["parent"]['fields']['name']}"
+            f"{Task.from_int(task['parent']['id'])} - {task['parent']['fields']['name']}"
             if task.get("parent")
             else ""
         )
@@ -429,6 +482,12 @@ def report_done_tasks(milestone: bool, format: str, source: str, destination: st
         client.move_task_to_column(task["id"], column_destination_phid)
 
 
+@aliases.command()
+def list():
+    for name, alias in config.data.get("aliases", {}).items():
+        click.echo(f"{name} = {alias}")
+
+
 def runcli():
     cli(max_content_width=120)
 

phable_cli-0.1.7/phable_cli/config.py

@@ -0,0 +1,67 @@
+import os
+import sys
+from configparser import ConfigParser
+from dataclasses import dataclass, field
+from functools import partial
+from pathlib import Path
+
+import click
+
+
+_warnings = []
+
+CONFIG_HOME_PER_PLATFORM = {
+    "darwin": Path.home() / "Library" / "Preferences",
+    "linux": Path(os.getenv("XDG_CACHE_HOME", f"{Path.home()}/.config")),
+    "windows": Path("c:/", "Users", os.getlogin(), "AppData", "Local", "Programs"),
+}
+config_filepath = CONFIG_HOME_PER_PLATFORM[sys.platform] / "phable" / "config.ini"
+
+
+def os_getenv_or_raise(env_var_name: str):
+    if val := os.getenv(env_var_name):
+        return val
+    _warnings.append(f"Required environment variable {env_var_name} is not set")
+
+
+def field_with_default_from_env(env_var_name):
+    return field(default_factory=partial(os_getenv_or_raise, env_var_name))
+
+
+def read_config() -> dict:
+    if not config_filepath.parent.exists():
+        config_filepath.parent.mkdir()
+    if not config_filepath.exists():
+        return {}
+    else:
+        config = ConfigParser()
+        try:
+            config.read(config_filepath)
+        except Exception:
+            _warnings.append(
+                f"Configuration file {config_filepath} is invalid. Skipping parsing."
+            )
+            return {}
+        else:
+            return {
+                section: dict(config.items(section)) for section in config.sections()
+            }
+
+
+@dataclass()
+class Config:
+    phabricator_url: str = field_with_default_from_env("PHABRICATOR_URL")
+    phabricator_token: str = field_with_default_from_env("PHABRICATOR_TOKEN")
+    phabricator_default_project_phid: str = field_with_default_from_env(
+        "PHABRICATOR_DEFAULT_PROJECT_PHID"
+    )
+    filepath: Path = field(default=config_filepath)
+    data: dict = field(default_factory=read_config)
+
+    def __post_init__(self):
+        for warn in _warnings:
+            click.echo(click.style(warn, fg="yellow"), err=True)
+        return len(_warnings) == 0
+
+
+config = Config()

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

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

phable_cli-0.1.6/phable_cli/config.py

@@ -1,34 +0,0 @@
-import os
-from dataclasses import dataclass, field
-from functools import partial
-
-import click
-
-_warnings = []
-
-
-def os_getenv_or_raise(env_var_name: str):
-    if val := os.getenv(env_var_name):
-        return val
-    _warnings.append(f"Required environment variable {env_var_name} is not set")
-
-
-def field_with_default_from_env(env_var_name):
-    return field(default_factory=partial(os_getenv_or_raise, env_var_name))
-
-
-@dataclass(frozen=True)
-class Config:
-    phabricator_url: str = field_with_default_from_env("PHABRICATOR_URL")
-    phabricator_token: str = field_with_default_from_env("PHABRICATOR_TOKEN")
-    phabricator_default_project_phid: str = field_with_default_from_env(
-        "PHABRICATOR_DEFAULT_PROJECT_PHID"
-    )
-
-    def __post_init__(self):
-        for warn in _warnings:
-            click.echo(click.style(warn, fg="yellow"), err=True)
-        return len(_warnings) == 0
-
-
-config = Config()