Merge pull request #35 from eadwinCode/command_fixes

Command Directory Args Fix

Author: eadwinCode

ellar_cli/file_scaffolding.py

@@ -28,6 +28,7 @@ def __init__(
         specified_directory: t.Optional[str] = None,
     ) -> None:
         self._specified_directory = specified_directory
+
         self._schema = schema
         self._ctx = ProjectScaffoldContext(Environment())
         self._scaffold_ellar_template_root_path = scaffold_ellar_template_root_path
@@ -79,7 +80,9 @@ def on_scaffold_completed(self) -> None:
 
     def on_scaffold_started(self) -> None:
         for context in self._schema.context:
-            assert self._ctx[context], f"{context} template context is missing."
+            assert (
+                self._ctx.get(context) is not None
+            ), f"{context} template context is missing."
 
     def create_directory(
         self,
@@ -125,7 +128,7 @@ def _handle_directory_change(self, working_directory: str) -> str:
         _specified_directory = (
             self._specified_directory.lower()  # type:ignore[union-attr]
         )
-        return os.path.join(working_directory, _specified_directory)
+        return os.path.join(str(working_directory), _specified_directory)
 
     def get_templating_context(self) -> ProjectScaffoldContext:
         return ProjectScaffoldContext(

ellar_cli/manage_commands/create_project.py

@@ -1,7 +1,8 @@
 import os
+import secrets
 import typing as t
-import uuid
 from importlib import import_module
+from pathlib import Path
 
 import typer
 from ellar.common.helper.module_loading import module_dir
@@ -22,14 +23,42 @@
 
 
 class ProjectTemplateScaffold(FileTemplateScaffold):
-    def __init__(self, ellar_cli_service: EllarCLIService, **kwargs: t.Any) -> None:
-        super().__init__(**kwargs)
+    def __init__(
+        self,
+        ellar_cli_service: EllarCLIService,
+        working_project_name: str,
+        working_directory: str,
+        **kwargs: t.Any,
+    ) -> None:
+        super().__init__(
+            **kwargs,
+            working_project_name=working_project_name,
+            working_directory=working_directory,
+        )
         self.ellar_cli_service = ellar_cli_service
+        self._working_project_name = working_project_name
+        if self._specified_directory:
+            _cwd_path = Path(self._get_working_cwd(working_directory))
+            self._working_directory = str(_cwd_path)
+        else:
+            self._working_directory = working_directory
+
+        self.prefix: t.Optional[str] = None
+        if self._specified_directory and "." not in self._specified_directory:
+            self.prefix = self._specified_directory.replace("/", ".").lower()
+
+            if self.prefix.startswith("."):  # pragma: no cover
+                self.prefix = self.prefix[1:]
+
+            if self.prefix.endswith("."):  # pragma: no cover
+                self.prefix = self.prefix[:-1]
 
     def get_scaffolding_context(self, working_project_name: str) -> t.Dict:
+        _prefix = f"{self.prefix}." if self.prefix else ""
         template_context = {
             "project_name": working_project_name,
-            "secret_key": f"ellar_{uuid.uuid4()}",
+            "secret_key": f"ellar_{secrets.token_hex(32)}",
+            "config_prefix": _prefix,
         }
         return template_context
 
@@ -60,8 +89,10 @@ def validate_project_name(self) -> None:
             raise EllarCLIException(message)
 
     def on_scaffold_completed(self) -> None:
+        _working_project_name = self._working_project_name
+
         self.ellar_cli_service.create_ellar_project_meta(
-            project_name=self._working_project_name
+            project_name=_working_project_name, prefix=self.prefix
         )
         print(
             f"`{self._working_project_name}` project scaffold completed. To start your server, run the command below"
@@ -70,7 +101,15 @@ def on_scaffold_completed(self) -> None:
         print("Happy coding!")
 
 
-def create_project(ctx: typer.Context, project_name: str):
+def create_project(
+    ctx: typer.Context,
+    project_name: str,
+    directory: t.Optional[str] = typer.Argument(
+        None,
+        help="The name of a new directory to scaffold the project into.",
+        show_default=False,
+    ),
+):
     """- Scaffolds Ellar Application -"""
 
     ellar_project_meta = t.cast(t.Optional[EllarCLIService], ctx.meta.get(ELLAR_META))
@@ -86,6 +125,7 @@ def create_project(ctx: typer.Context, project_name: str):
         working_directory=os.getcwd(),
         scaffold_ellar_template_root_path=root_scaffold_template_path,
         ellar_cli_service=ellar_project_meta,
+        specified_directory=directory,
         working_project_name=project_name.lower(),
     )
     project_template_scaffold.scaffold()

ellar_cli/manage_commands/new.py

@@ -85,12 +85,6 @@ def is_directory_empty(self) -> bool:
         return True
 
     def validate_project_name(self) -> None:
-        if os.path.exists(self._working_project_name):
-            message = "A folder with same name exist '{name}' ".format(
-                name=self._working_project_name
-            )
-            raise EllarCLIException(message)
-
         if not self.is_directory_empty():
             working_project_dir = os.path.join(
                 self._working_directory, self._working_project_name

ellar_cli/scaffolding/project_template/project_name/server.ellar

@@ -8,7 +8,7 @@ from .root_module import ApplicationModule
 application = AppFactory.create_from_app_module(
     ApplicationModule,
     config_module=os.environ.get(
-        ELLAR_CONFIG_MODULE, "{{project_name}}.config:DevelopmentConfig"
+        ELLAR_CONFIG_MODULE, "{{config_prefix}}{{project_name}}.config:DevelopmentConfig"
     ),
     global_guards=[]
 )

ellar_cli/scaffolding/project_template/setup.json

@@ -1,5 +1,5 @@
 {
-  "context": ["project_name", "secret_key"],
+  "context": ["project_name", "secret_key", "config_prefix"],
   "files": [
     {
       "name": "project_name",

ellar_cli/service.py

@@ -139,7 +139,9 @@ def import_project_meta(
             )
         return None
 
-    def create_ellar_project_meta(self, project_name: str) -> None:
+    def create_ellar_project_meta(
+        self, project_name: str, prefix: t.Optional[str] = None
+    ) -> None:
         pyproject_table = EllarCLIService.read_py_project(self.py_project_path)
         if pyproject_table is None:
             raise EllarCLIException("Could not locate `pyproject.toml`")
@@ -156,12 +158,18 @@ def create_ellar_project_meta(self, project_name: str) -> None:
         if not ellar_py_project.has_default_project:
             ellar_py_project.default_project = project_name.lower()
 
+        _prefix = f"{prefix}." if prefix else ""
+
         ellar_new_project = ellar_py_project.get_or_create_project(project_name.lower())
         ellar_new_project.add("project-name", project_name.lower())
-        ellar_new_project.add("application", f"{project_name}.server:application")
-        ellar_new_project.add("config", f"{project_name}.config:DevelopmentConfig")
         ellar_new_project.add(
-            "root-module", f"{project_name}.root_module:ApplicationModule"
+            "application", f"{_prefix}{project_name}.server:application"
+        )
+        ellar_new_project.add(
+            "config", f"{_prefix}{project_name}.config:DevelopmentConfig"
+        )
+        ellar_new_project.add(
+            "root-module", f"{_prefix}{project_name}.root_module:ApplicationModule"
         )
 
         # TODO: lock pyproject.toml file

pyproject.toml

@@ -43,7 +43,7 @@ dependencies = [
     # exclude 0.11.2 and 0.11.3 due to https://github.com/sdispater/tomlkit/issues/225
     "tomlkit >=0.11.1,<1.0.0,!=0.11.2,!=0.11.3",
     "uvicorn[standard] == 0.22.0",
-    "ellar >= 0.3.8"
+    "ellar >= 0.4.4"
 ]
 
 [project.scripts]

tests/test_ellar_commands/test_create_project_command.py

@@ -1,6 +1,6 @@
 import os
 
-from ellar.core import App
+from ellar.core import App, Config
 
 from ellar_cli.service import EllarCLIService
 
@@ -79,3 +79,27 @@ def test_create_project_command_works(tmpdir, process_runner, write_empty_py_pro
 
     application = ellar_cli_service.import_application()
     assert isinstance(application, App)
+
+
+def test_create_project_command_works_with_specific_directory(
+    tmpdir, process_runner, write_empty_py_project
+):
+    result = process_runner(["ellar", "create-project", "ellar_project", "Another/me"])
+    assert result.returncode == 0
+    assert result.stdout.decode("utf8") == (
+        "`ellar_project` project scaffold completed. To start your server, run the command below\n"
+        "ellar --project ellar_project runserver --reload\n"
+        "Happy coding!\n"
+    )
+    ellar_cli_service = EllarCLIService.import_project_meta()
+    assert ellar_cli_service._meta.dict() == {
+        "project_name": "ellar_project",
+        "application": "another.me.ellar_project.server:application",
+        "config": "another.me.ellar_project.config:DevelopmentConfig",
+        "root_module": "another.me.ellar_project.root_module:ApplicationModule",
+    }
+    application = ellar_cli_service.import_application()
+    assert isinstance(application, App)
+    config = ellar_cli_service.get_application_config()
+    assert isinstance(config, Config)
+    assert ellar_cli_service.import_root_module()

tests/test_ellar_commands/test_new_command.py

@@ -25,7 +25,7 @@ def test_new_command_works(tmpdir, process_runner):
     }
 
 
-def test_new_command_works_with_specific_directory(tmpdir, process_runner):
+def test_new_command_works_with_specific_directory_case_1(tmpdir, process_runner):
     result = process_runner(["ellar", "new", "ellar-project-new", "Another/me"])
     assert result.returncode == 0
     assert result.stdout.decode("utf8") == (
@@ -45,6 +45,17 @@ def test_new_command_works_with_specific_directory(tmpdir, process_runner):
     }
 
 
+def test_new_command_works_with_specific_directory_case_3(tmpdir, process_runner):
+    _path = tmpdir / "23-August-2023"
+    os.makedirs(_path)
+    result = process_runner(["ellar", "new", "ellar-project-new", str(_path)])
+    assert result.returncode == 0
+    assert (
+        "ellar --project ellar_project_new runserver --reload"
+        in result.stdout.decode("utf8")
+    )
+
+
 def test_new_command_fails_case_1(tmpdir, process_runner):
     result = process_runner(["ellar", "new", "ellar-project-new", "Another/me"])
     assert result.returncode == 0
@@ -72,13 +83,13 @@ def test_new_command_works_with_specific_directory_case_2(tmpdir, process_runner
     }
 
 
-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_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):