Added creating new project to a specific directory

Author: eadwinCode

ellar_cli/file_scaffolding.py

@@ -1,6 +1,7 @@
 import os
 import typing as t
 from abc import abstractmethod
+from pathlib import Path
 
 from jinja2 import Environment
 
@@ -27,16 +28,21 @@ def __init__(
         working_directory: str,
         scaffold_ellar_template_root_path: str,
         ellar_cli_service: t.Optional[EllarCLIService] = None,
+        specified_directory: str = None,
     ) -> None:
+        self._specified_directory = specified_directory
         self._schema = schema
-        self._working_project_name = working_project_name
-        self._ctx = ProjectScaffoldContext(
-            Environment(), **self.get_scaffolding_context(working_project_name)
-        )
-        self._working_directory = working_directory
+        self._ctx = ProjectScaffoldContext(Environment())
         self._scaffold_ellar_template_root_path = scaffold_ellar_template_root_path
         self.ellar_cli_service = ellar_cli_service
-        self.validate_project_name()
+
+        if self._specified_directory:
+            _cwd_path = Path(self._get_working_cwd(working_directory))
+            self._working_project_name = _cwd_path.name
+            self._working_directory = str(_cwd_path.parent)
+        else:
+            self._working_directory = working_directory
+            self._working_project_name = working_project_name
 
     def get_scaffolding_context(self, working_project_name: str) -> t.Dict:
         return {}
@@ -61,6 +67,8 @@ def create_file(self, base_path: str, file_name: str, content: t.Any) -> None:
             fw.writelines(refined_content)
 
     def scaffold(self) -> None:
+        self.validate_project_name()
+        self._ctx = self.get_templating_context()
         self.on_scaffold_started()
         for file in self._schema.files:
             self.create_directory(
@@ -108,3 +116,22 @@ def create_directory(
     def validate_project_name(self) -> None:
         # Check it's a valid directory name.
         pass
+
+    def _get_working_cwd(self, working_directory: str) -> str:
+        if self._specified_directory:
+            return self._handle_directory_change(working_directory)
+        return working_directory
+
+    def _handle_directory_change(self, working_directory: str) -> str:
+        if self._specified_directory == ".":
+            return working_directory
+
+        _specified_directory = (
+            self._specified_directory.lower()  # type:ignore[union-attr]
+        )
+        return os.path.join(working_directory, _specified_directory)
+
+    def get_templating_context(self) -> ProjectScaffoldContext:
+        return ProjectScaffoldContext(
+            Environment(), **self.get_scaffolding_context(self._working_project_name)
+        )

ellar_cli/manage_commands/new.py

@@ -24,8 +24,10 @@ class NewTemplateScaffold(FileTemplateScaffold):
     unwanted_chars = "".join(["-", ";", "!", "*", ":", " "])
 
     def __init__(self, project_name: str = None, **kwargs: t.Any) -> None:
+        super(NewTemplateScaffold, self).__init__(
+            working_project_name=project_name, **kwargs
+        )
         self._project_name = project_name
-        super(NewTemplateScaffold, self).__init__(**kwargs)
 
     def on_scaffold_completed(self) -> None:
         popen_res = subprocess.run(
@@ -36,9 +38,18 @@ def on_scaffold_completed(self) -> None:
         )
         if popen_res.returncode == 0:
             project_working_project_name = self.get_project_name()
+
+            log_1 = f"- cd {self._working_project_name}"
+            if self._specified_directory:
+                log_1 = (
+                    f"- cd {self._specified_directory.lower()}"
+                    if self._specified_directory != "."
+                    else ""
+                )
+
             print(
-                f"`{self._working_project_name}` project created successfully.\n"
-                f"- cd {self._working_project_name}"
+                f"`{project_working_project_name}` project created successfully.\n"
+                f"{log_1}"
             )
             print("To start your server, run the command below")
             print(
@@ -47,13 +58,35 @@ def on_scaffold_completed(self) -> None:
         else:
             print(popen_res.stderr.decode("utf8"))
 
+    def is_directory_empty(self) -> bool:
+        """
+        Check if the given directory is empty.
+        """
+        # Get the list of files and directories in the directory
+        working_project_dir = os.path.join(
+            self._working_directory, self._working_project_name
+        )
+        if os.path.isdir(working_project_dir):
+            items = os.listdir(working_project_dir)
+            return len(items) == 0
+        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
+            )
+            message = (
+                f"Scaffolding Project Directory is not empty. - {working_project_dir}"
+            )
+            raise EllarCLIException(message)
+
         project_working_project_name = self.get_project_name()
         if not project_working_project_name.isidentifier():
             message = (
@@ -78,10 +111,14 @@ def get_project_cwd(self) -> str:
 
 
 def new_command(
-    folder_name: str,
-    project_name: t.Optional[str] = typer.Option(
+    project_name: str = typer.Argument(
+        None,
+        help="Project Module Name. Defaults to `project-name` if not set",
+        show_default=False,
+    ),
+    directory: t.Optional[str] = typer.Argument(
         None,
-        help="Project Module Name. Defaults to `folder-name` if not set",
+        help="The name of a new directory to scaffold the project into. Scaffolding into an existing directory is only allowed if the directory is empty",
         show_default=False,
     ),
 ):
@@ -91,7 +128,7 @@ def new_command(
         schema=schema,
         working_directory=os.getcwd(),
         scaffold_ellar_template_root_path=root_scaffold_template_path,
-        working_project_name=folder_name.lower(),
         project_name=project_name,
+        specified_directory=directory,
     )
     init_template_scaffold.scaffold()

tests/test_ellar_commands/test_new_command.py

@@ -9,7 +9,7 @@ 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"
+        "`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"
@@ -26,6 +26,55 @@ def test_new_command_works(tmpdir, process_runner):
     }
 
 
+def test_new_command_works_with_specific_directory(tmpdir, process_runner):
+    result = process_runner(["ellar", "new", "ellar-project-new", "Another/me"])
+    assert result.returncode == 0
+    assert result.stdout.decode("utf8") == (
+        "`ellar_project_new` project created successfully.\n"
+        "- cd another/me\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 / "another/me"))
+    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_case_1(tmpdir, process_runner):
+    result = process_runner(["ellar", "new", "ellar-project-new", "Another/me"])
+    assert result.returncode == 0
+    result = process_runner(["ellar", "new", "ellar-project-new", "Another/me"])
+    assert result.returncode == 1
+    assert "Scaffolding Project Directory is not empty." in result.stderr.decode("utf8")
+
+
+def test_new_command_works_with_specific_directory_case_2(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\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_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"])
@@ -49,7 +98,7 @@ def test_new_template_scaffold_get_project_name():
         schema=EllarScaffoldSchema.schema_example(),
         working_directory=os.getcwd(),
         scaffold_ellar_template_root_path="",
-        working_project_name="folder-name".lower(),
+        project_name="folder-name".lower(),
     )
     assert init_template_scaffold.get_project_name() == "folder_name"
     init_template_scaffold._project_name = "folder-name!;-:*"
@@ -62,6 +111,6 @@ def test_new_template_scaffold_get_project_cwd():
         schema=EllarScaffoldSchema.schema_example(),
         working_directory="working-directory",
         scaffold_ellar_template_root_path="",
-        working_project_name="folder-name".lower(),
+        project_name="folder-name".lower(),
     )
     assert init_template_scaffold.get_project_cwd() == "working-directory/folder-name"