Added new command test and some code refactoring

Author: eadwinCode

ellar_cli/file_scaffolding.py

@@ -26,7 +26,7 @@ def __init__(
         working_project_name: str,
         working_directory: str,
         scaffold_ellar_template_root_path: str,
-        ellar_cli_service: EllarCLIService,
+        ellar_cli_service: t.Optional[EllarCLIService] = None,
     ) -> None:
         self._schema = schema
         self._working_project_name = working_project_name
@@ -55,7 +55,7 @@ def create_root_path(self) -> str:
 
     def create_file(self, base_path: str, file_name: str, content: t.Any) -> None:
         with open(
-            os.path.join(base_path, file_name.replace("ellar", "py")), mode="w"
+            os.path.join(base_path, file_name.replace(".ellar", ".py")), mode="w"
         ) as fw:
             refined_content = self._ctx.environment.from_string(content).render()
             fw.writelines(refined_content)

ellar_cli/main.py

@@ -10,13 +10,13 @@
 from typer import Typer
 from typer.models import CommandInfo
 
-from .manage_commands import create_module, create_project, runserver
+from .manage_commands import create_module, create_project, new_command, runserver
 from .service import EllarCLIService
 
 __all__ = ["build_typers", "_typer", "typer_callback"]
 
 _typer = Typer(name="ellar")
-
+_typer.command(name="new")(new_command)
 _typer.command()(runserver)
 _typer.command(name="create-project")(create_project)
 _typer.command(name="create-module")(create_module)

ellar_cli/py.typed

@@ -14,7 +14,7 @@ class EllarPyProjectSerializer(Serializer):
 
 class EllarScaffoldList(Serializer):
     name: str
-    is_directory: bool
+    is_directory: bool = False
     name_in_context: t.Optional[bool] = Field(default=None, alias="name-context")
     files: t.Optional[t.List["EllarScaffoldList"]]
 
@@ -34,7 +34,6 @@ def schema_example(cls) -> "EllarScaffoldSchema":
                 dict(name="sample.ellar", is_directory=False),
                 dict(
                     name="sample",
-                    is_directory=False,
                     files=[
                         dict(
                             dict(name="sample.ellar", is_directory=False),

ellar_cli/schema.py

@@ -60,15 +60,15 @@ def test_help_command(cli_runner):
     assert result.returncode == 0
     assert (
         result.stdout
-        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
+        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  new                - Runs a complete Ellar project scaffold and creates...\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
     )
     result = subprocess.run(
         ["ellar", "-p", "example_project", "--help"], stdout=subprocess.PIPE
     )
     assert result.returncode == 0
     assert (
         result.stdout
-        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
+        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  new                - Runs a complete Ellar project scaffold and creates...\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
     )
 
     result = subprocess.run(
@@ -77,5 +77,5 @@ def test_help_command(cli_runner):
     assert result.returncode == 0
     assert (
         result.stdout
-        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  project-2-command  Project 2 Custom Command\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
+        == b"Usage: Ellar, Python Web framework [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -p, --project TEXT              Run Specific Command on a specific project\n  --install-completion [bash|zsh|fish|powershell|pwsh]\n                                  Install completion for the specified shell.\n  --show-completion [bash|zsh|fish|powershell|pwsh]\n                                  Show completion for the specified shell, to\n                                  copy it or customize the installation.\n  --help                          Show this message and exit.\n\nCommands:\n  create-module      - Scaffolds Ellar Application Module -\n  create-project     - Scaffolds Ellar Application -\n  db\n  new                - Runs a complete Ellar project scaffold and creates...\n  project-2-command  Project 2 Custom Command\n  runserver          - Starts Uvicorn Server -\n  say-hi\n  whatever-you-want  Whatever you want\n"
     )

tests/test_build_typers.py

@@ -46,6 +46,21 @@ def test_create_project_fails_for_existing_module_project_name(
     )
 
 
+def test_create_project_works_for_existing_folder_with_same_project_name(
+    tmpdir, cli_runner, write_empty_py_project
+):
+    module_name = "new_project_module_2"
+    os.makedirs(os.path.join(tmpdir, module_name), exist_ok=True)
+
+    result = cli_runner.invoke_ellar_command(["create-project", module_name])
+    assert result.exit_code == 0
+    assert result.output == (
+        "`new_project_module_2` project scaffold completed. To start your server, run the command below\n"
+        "ellar --project new_project_module_2 runserver --reload\n"
+        "Happy coding!\n"
+    )
+
+
 def test_create_project_command_works(tmpdir, process_runner, write_empty_py_project):
     result = process_runner(["ellar", "create-project", "ellar_project"])
     assert result.returncode == 0

tests/test_ellar_commands/test_create_project_command.py

@@ -0,0 +1,67 @@
+import os
+
+from ellar_cli.manage_commands.new import NewTemplateScaffold
+from ellar_cli.schema import EllarScaffoldSchema
+from ellar_cli.service import EllarCLIService
+
+
+def test_new_command_works(tmpdir, process_runner):
+    result = process_runner(["ellar", "new", "ellar-project-new"])
+    assert result.returncode == 0
+    assert result.stdout.decode("utf8") == (
+        "`ellar-project-new` project created successfully.\n"
+        "- cd ellar-project-new\n"
+        "To start your server, run the command below\n"
+        "- ellar --project ellar_project_new runserver --reload\n"
+        "Happy coding!\n"
+    )
+    os.chdir(os.path.join(tmpdir, "ellar-project-new"))
+    ellar_cli_service = EllarCLIService.import_project_meta()
+    assert ellar_cli_service._meta.dict() == {
+        "project_name": "ellar_project_new",
+        "application": "ellar_project_new.server:application",
+        "config": "ellar_project_new.config:DevelopmentConfig",
+        "root_module": "ellar_project_new.root_module:ApplicationModule",
+        "apps_module": "ellar_project_new.apps",
+    }
+
+
+def test_new_command_fails_for_existing_folder_name(tmp_path, process_runner):
+    os.makedirs(tmp_path / "ellar-project-exist", exist_ok=True)
+    result = process_runner(["ellar", "new", "ellar-project-exist"])
+    assert result.returncode == 1
+    assert result.stderr.decode("utf8") == (
+        "Error: A folder with same name exist 'ellar-project-exist' \n"
+    )
+
+
+def test_new_command_fails_for_invalid_project_name(tmp_path, process_runner):
+    result = process_runner(["ellar", "new", "ellar-project-exist&^"])
+    assert result.returncode == 1
+    assert result.stderr.decode("utf8") == (
+        "Error: 'ellar-project-exist&^' is not a valid project-name. "
+        "Please make sure the project-name is a valid identifier.\n"
+    )
+
+
+def test_new_template_scaffold_get_project_name():
+    init_template_scaffold = NewTemplateScaffold(
+        schema=EllarScaffoldSchema.schema_example(),
+        working_directory=os.getcwd(),
+        scaffold_ellar_template_root_path="",
+        working_project_name="folder-name".lower(),
+    )
+    assert init_template_scaffold.get_project_name() == "folder_name"
+    init_template_scaffold._project_name = "folder-name!;-:*"
+    assert init_template_scaffold.get_project_name() == "folder_name_____"
+    assert init_template_scaffold.get_project_name().isidentifier()
+
+
+def test_new_template_scaffold_get_project_cwd():
+    init_template_scaffold = NewTemplateScaffold(
+        schema=EllarScaffoldSchema.schema_example(),
+        working_directory="working-directory",
+        scaffold_ellar_template_root_path="",
+        working_project_name="folder-name".lower(),
+    )
+    assert init_template_scaffold.get_project_cwd() == "working-directory/folder-name"