Ensure default (built in) commands are plugins. (#25)

ntoll · web-flow · commit 9f6193782ada · 2022-08-25T15:02:52.000+01:00
Ensure default (built in) commands are plugins.
diff --git a/src/pyscript/_generator.py b/src/pyscript/_generator.py
@@ -1,7 +1,10 @@
+import datetime
 from pathlib import Path
 from typing import Optional
+from uuid import uuid4
 
 import jinja2
+import toml
 
 _env = jinja2.Environment(loader=jinja2.PackageLoader("pyscript"))
 
@@ -18,3 +21,35 @@ def file_to_html(input_path: Path, title: str, output_path: Optional[Path]) -> N
     output_path = output_path or input_path.with_suffix(".html")
     with input_path.open("r") as fp:
         string_to_html(fp.read(), title, output_path)
+
+
+def create_project(
+    app_name: str,
+    app_description: str,
+    author_name: str,
+    author_email: str,
+) -> None:
+    """
+    New files created:
+
+    manifest.toml - project metadata
+    index.html - a "Hello world" start page for the project.
+
+    TODO: more files to add to the core project start state.
+    """
+    context = {
+        "app_name": app_name,
+        "app_description": app_description,
+        "author_name": author_name,
+        "author_email": author_email,
+        "version": f"{datetime.date.today().year}.1.1",
+        "created_on": datetime.datetime.now(),
+        "id": str(uuid4()),
+    }
+    app_dir = Path(".") / app_name
+    app_dir.mkdir()
+    manifest_file = app_dir / "manifest.toml"
+    with manifest_file.open("w", encoding="utf-8") as fp:
+        toml.dump(context, fp)
+    index_file = app_dir / "index.html"
+    string_to_html('print("Hello, world!")', app_name, index_file)
diff --git a/src/pyscript/cli.py b/src/pyscript/cli.py
@@ -1,21 +1,23 @@
 """The main CLI entrypoint and commands."""
 import sys
-import time
-import webbrowser
-from pathlib import Path
 from typing import Any, Optional
 
 from pluggy import PluginManager
 
 from pyscript import __version__, app, console, plugins, typer
-from pyscript._generator import file_to_html, string_to_html
 from pyscript.plugins import hookspecs
 
-DEFAULT_PLUGINS = ["create", "delete"]
+DEFAULT_PLUGINS = ["create", "wrap"]
 
 
-def _print_version():
-    console.print(f"PyScript CLI version: {__version__}", style="bold green")
+class Abort(typer.Abort):
+    """
+    Abort with a consistent error message.
+    """
+
+    def __init__(self, msg: str, *args: Any, **kwargs: Any):
+        console.print(msg, style="red")
+        super().__init__(*args, **kwargs)
 
 
 @app.callback(invoke_without_command=True, no_args_is_help=True)
@@ -24,106 +26,28 @@ def main(
         None, "--version", help="Show project version and exit."
     )
 ):
-    """Command Line Interface for PyScript."""
+    """
+    Command Line Interface for PyScript.
+    """
     if version:
-        _print_version()
+        console.print(f"PyScript CLI version: {__version__}", style="bold green")
         raise typer.Exit()
 
 
-@app.command()
-def version() -> None:
-    """Show project version and exit."""
-    _print_version()
-
-
-_input_file_argument = typer.Argument(
-    None,
-    help="An optional path to the input .py script. If not provided, must use '-c' flag.",
-)
-_output_file_option = typer.Option(
-    None,
-    "-o",
-    "--output",
-    help="Path to the resulting HTML output file. Defaults to input_file with suffix replaced.",
-)
-_command_option = typer.Option(
-    None, "-c", "--command", help="If provided, embed a single command string."
-)
-_show_option = typer.Option(None, help="Open output file in web browser.")
-_title_option = typer.Option(None, help="Add title to HTML file.")
-
-
-class Abort(typer.Abort):
-    def __init__(self, msg: str, *args: Any, **kwargs: Any):
-        console.print(msg, style="red")
-        super().__init__(*args, **kwargs)
-
-
-@app.command()
-def wrap(
-    input_file: Optional[Path] = _input_file_argument,
-    output: Optional[Path] = _output_file_option,
-    command: Optional[str] = _command_option,
-    show: Optional[bool] = _show_option,
-    title: Optional[str] = _title_option,
-) -> None:
-    """Wrap a Python script inside an HTML file."""
-    title = title or "PyScript App"
-
-    if not input_file and not command:
-        raise Abort(
-            "Must provide either an input '.py' file or a command with the '-c' option."
-        )
-    if input_file and command:
-        raise Abort("Cannot provide both an input '.py' file and '-c' option.")
-
-    # Derive the output path if it is not provided
-    remove_output = False
-    if output is None:
-        if command and show:
-            output = Path("pyscript_tmp.html")
-            remove_output = True
-        elif not command:
-            assert input_file is not None
-            output = input_file.with_suffix(".html")
-        else:
-            raise Abort("Must provide an output file or use `--show` option")
-
-    if input_file is not None:
-        file_to_html(input_file, title, output)
-
-    if command:
-        string_to_html(command, title, output)
-
-    assert output is not None
-
-    if show:
-        console.print("Opening in web browser!")
-        webbrowser.open(f"file://{output.resolve()}")
-
-    if remove_output:
-        time.sleep(1)
-        output.unlink()
-
-
 pm = PluginManager("pyscript")
 
 pm.add_hookspecs(hookspecs)
-
 for modname in DEFAULT_PLUGINS:
     importspec = f"pyscript.plugins.{modname}"
-
     try:
         __import__(importspec)
     except ImportError as e:
         raise ImportError(
             f'Error importing plugin "{modname}": {e.args[0]}'
         ).with_traceback(e.__traceback__) from e
-
     else:
         mod = sys.modules[importspec]
         pm.register(mod, modname)
-
     loaded = pm.load_setuptools_entrypoints("pyscript")
 
 for cmd in pm.hook.pyscript_subcommand():
diff --git a/src/pyscript/plugins/create.py b/src/pyscript/plugins/create.py
@@ -1,10 +1,31 @@
-from pyscript import console, plugins
+from pyscript import app, cli, plugins
+from pyscript._generator import create_project
 
+try:
+    import rich_click.typer as typer
+except ImportError:  # pragma: no cover
+    import typer  # type: ignore
 
-def create():
-    """Creates a new PyScript Project from scratch."""
-    console.print("pyscript create cmd not yet available..", style="bold green")
-    return True
+
+@app.command()
+def create(
+    app_name: str = typer.Argument(..., help="The name of your new app."),
+    app_description: str = typer.Option(..., prompt=True),
+    author_name: str = typer.Option(..., prompt=True),
+    author_email: str = typer.Option(..., prompt=True),
+):
+    """
+    Create a new pyscript project with the passed in name, creating a new
+    directory in the current directory.
+    Inspired by Sphinx guided setup.
+    TODO: Agree on the metadata to be collected from the user.
+    """
+    try:
+        create_project(app_name, app_description, author_name, author_email)
+    except FileExistsError:
+        raise cli.Abort(
+            f"A directory called {app_name} already exists in this location."
+        )
 
 
 @plugins.register
diff --git a/src/pyscript/plugins/delete.py b/src/pyscript/plugins/delete.py
diff --git a/src/pyscript/plugins/wrap.py b/src/pyscript/plugins/wrap.py
@@ -0,0 +1,69 @@
+import time
+import webbrowser
+from pathlib import Path
+from typing import Optional
+
+from pyscript import app, cli, console, plugins
+from pyscript._generator import file_to_html, string_to_html
+
+try:
+    import rich_click.typer as typer
+except ImportError:  # pragma: no cover
+    import typer  # type: ignore
+
+
+@app.command()
+def wrap(
+    input_file: Optional[Path] = typer.Argument(
+        None,
+        help="An optional path to the input .py script. If not provided, must use '-c' flag.",
+    ),
+    output: Optional[Path] = typer.Option(
+        None,
+        "-o",
+        "--output",
+        help="Path to the resulting HTML output file. Defaults to input_file with suffix replaced.",
+    ),
+    command: Optional[str] = typer.Option(
+        None, "-c", "--command", help="If provided, embed a single command string."
+    ),
+    show: Optional[bool] = typer.Option(None, help="Open output file in web browser."),
+    title: Optional[str] = typer.Option(None, help="Add title to HTML file."),
+) -> None:
+    """Wrap a Python script inside an HTML file."""
+    title = title or "PyScript App"
+
+    if not input_file and not command:
+        raise cli.Abort(
+            "Must provide either an input '.py' file or a command with the '-c' option."
+        )
+    if input_file and command:
+        raise cli.Abort("Cannot provide both an input '.py' file and '-c' option.")
+
+    # Derive the output path if it is not provided
+    remove_output = False
+    if output is None:
+        if command and show:
+            output = Path("pyscript_tmp.html")
+            remove_output = True
+        elif not command:
+            assert input_file is not None
+            output = input_file.with_suffix(".html")
+        else:
+            raise cli.Abort("Must provide an output file or use `--show` option")
+    if input_file is not None:
+        file_to_html(input_file, title, output)
+    if command:
+        string_to_html(command, title, output)
+    if output:
+        if show:
+            console.print("Opening in web browser!")
+            webbrowser.open(f"file://{output.resolve()}")
+        if remove_output:
+            time.sleep(1)
+            output.unlink()
+
+
+@plugins.register
+def pyscript_subcommand():
+    return wrap
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -0,0 +1,33 @@
+from pathlib import Path
+from typing import Any
+
+import pytest
+from _pytest.monkeypatch import MonkeyPatch
+
+
+@pytest.fixture()
+def tmp_cwd(monkeypatch: MonkeyPatch, tmp_path: Path) -> Path:
+    """Create & return a temporary directory after setting current working directory to it."""
+    monkeypatch.chdir(tmp_path)
+    return tmp_path
+
+
+@pytest.fixture(scope="session")
+def is_not_none() -> Any:
+    """
+    An object that can be used to test whether another is None.
+
+    This is particularly useful when testing contents of collections, e.g.:
+
+    ```python
+    def test_data(data, is_not_none):
+        assert data == {"some_key": is_not_none, "some_other_key": 5}
+    ```
+
+    """
+
+    class _NotNone:
+        def __eq__(self, other):
+            return other is not None
+
+    return _NotNone()
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -30,9 +30,9 @@ def f(*args: str) -> Result:
     return f
 
 
-@pytest.mark.parametrize("cli_arg", ["version", "--version"])
-def test_version(invoke_cli: CLIInvoker, cli_arg: str) -> None:
-    result = invoke_cli(cli_arg)
+def test_version() -> None:
+    runner = CliRunner()
+    result = runner.invoke(app, "--version")
     assert result.exit_code == 0
     assert f"PyScript CLI version: {__version__}" in result.stdout
 
@@ -117,7 +117,7 @@ def test_wrap_show(
     else:
         args = additional_args
 
-    with unittest.mock.patch("pyscript.cli.webbrowser.open") as browser_mock:
+    with unittest.mock.patch("pyscript.plugins.wrap.webbrowser.open") as browser_mock:
         result = invoke_cli("wrap", "--show", *args)
 
     assert result.exit_code == 0
diff --git a/tests/test_generator.py b/tests/test_generator.py
