Call startapp management command if the app doesn't already exist.

Author: adamghill

django_unicorn/management/commands/startunicorn.py

@@ -2,9 +2,10 @@
 import webbrowser
 from pathlib import Path
 
+from django.apps import apps
 from django.conf import settings
+from django.core.management import call_command
 from django.core.management.base import BaseCommand, CommandError
-from django.apps import apps
 
 from django_unicorn.components.unicorn_view import (
     convert_to_pascal_case,
@@ -25,6 +26,14 @@ class {pascal_case_component_name}View(UnicornView):
 """
 
 
+def get_app_path(app_name: str) -> Path:
+    """
+    Gets the directory path for an installed application.
+    """
+
+    return Path(apps.get_app_config(app_name).path)
+
+
 class Command(BaseCommand):
     help = "Creates a new component for `django-unicorn`"
 
@@ -55,18 +64,31 @@ def handle(self, *args, **options):
             raise CommandError("At least one component name is required.")
 
         app_name = options["app_name"]
+        is_new_app = False
+
         try:
-            app_directory = Path(apps.get_app_config(app_name).path)
+            app_directory = get_app_path(app_name)
         except LookupError:
-            # this app does not exist yet
-            raise CommandError(
-                f"An app named '{app_name}' does not exist yet. "
-                "You have to create it first."
+            should_create_app = input(
+                f"\n'{app_name}' cannot be found. Should it be created automatically with `startapp {app_name}`? [y/N] "
             )
 
+            if should_create_app.strip().lower() in ("y", "yes"):
+                call_command(
+                    "startapp", app_name, verbosity=0,
+                )
+                app_directory = base_path / app_name
+
+                is_new_app = True
+            else:
+                raise CommandError(
+                    f"An app named '{app_name}' does not exist yet. You might need to create it first."
+                )
+
         is_first_component = False
 
-        (app_directory / "__init__.py").touch(exist_ok=True)
+        if not app_directory.exists():
+            app_directory.mkdir()
 
         # Create component
         component_base_path = app_directory / "components"
@@ -75,7 +97,7 @@ def handle(self, *args, **options):
             component_base_path.mkdir()
 
             self.stdout.write(
-                self.style.SUCCESS(f"Created your first component in {app_name}! ✨\n")
+                self.style.SUCCESS(f"Created your first component in '{app_name}'! ✨\n")
             )
 
             is_first_component = True
@@ -165,3 +187,10 @@ def handle(self, *args, **options):
                             "That's a bummer, but I understand. I hope you will star it for me later!"
                         )
                     )
+
+            if is_new_app:
+                self.stdout.write(
+                    self.style.WARNING(
+                        f'\nMake sure to add `"{app_name}",` to your INSTALLED_APPS list in your settings file if necessary.'
+                    )
+                )

tests/management/commands/startunicorn/test_handle.py

@@ -1,5 +1,6 @@
 import io
 import os
+import uuid
 
 from django.core.management.base import CommandError
 
@@ -23,16 +24,24 @@ def test_handle_no_args(settings):
 def test_handle_new_app(settings, tmp_path, monkeypatch, capsys):
     settings.BASE_DIR = tmp_path
 
-    # Reply "y" then "n"
+    # Reply "y" to create new app then "n" to star the repo
     monkeypatch.setattr("sys.stdin", io.StringIO("y\nn\n"))
 
-    app_name = "test123"
-    component_names = ["hello-world"]
+    # Prevent the `startapp` command from actually creating a new app
+    monkeypatch.setattr(
+        "django_unicorn.management.commands.startunicorn.call_command",
+        lambda *args, **kwargs: None,
+    )
+
+    app_name = f"test-{uuid.uuid4()}".replace("-", "_")
+    component_names = [
+        "hello-world",
+    ]
     Command().handle(app_name=app_name, component_names=component_names)
 
-    assert (tmp_path / f"{app_name}/components/__init__.py").exists()
-    assert (tmp_path / f"{app_name}/components/hello_world.py").exists()
-    assert (tmp_path / f"{app_name}/templates/unicorn/hello-world.html").exists()
+    assert (tmp_path / app_name / "components/__init__.py").exists()
+    assert (tmp_path / app_name / "components/hello_world.py").exists()
+    assert (tmp_path / app_name / "templates/unicorn/hello-world.html").exists()
 
     captured = capsys.readouterr()
     assert "Starring the GitHub repo " in captured.out
@@ -41,19 +50,24 @@ def test_handle_new_app(settings, tmp_path, monkeypatch, capsys):
 
 def test_handle_existing_app(settings, tmp_path, monkeypatch, capsys):
     settings.BASE_DIR = tmp_path
+    app_name = f"test-{uuid.uuid4()}".replace("-", "_")
 
-    app_name = "test123"
-    (tmp_path / app_name).mkdir()
+    monkeypatch.setattr(
+        "django_unicorn.management.commands.startunicorn.get_app_path",
+        lambda a: tmp_path / app_name,
+    )
 
-    # Reply "y" then "n"
-    monkeypatch.setattr("sys.stdin", io.StringIO("y\nn\n"))
+    # Reply "n" to starring question
+    monkeypatch.setattr("sys.stdin", io.StringIO("n\n"))
 
-    component_names = ["hello-world"]
+    component_names = [
+        "hello-world",
+    ]
     Command().handle(app_name=app_name, component_names=component_names)
 
-    assert (tmp_path / f"{app_name}/components/__init__.py").exists()
-    assert (tmp_path / f"{app_name}/components/hello_world.py").exists()
-    assert (tmp_path / f"{app_name}/templates/unicorn/hello-world.html").exists()
+    assert (tmp_path / app_name / "components/__init__.py").exists()
+    assert (tmp_path / app_name / "components/hello_world.py").exists()
+    assert (tmp_path / app_name / "templates/unicorn/hello-world.html").exists()
 
     captured = capsys.readouterr()
     assert "Starring the GitHub repo " in captured.out
@@ -63,20 +77,24 @@ def test_handle_existing_app(settings, tmp_path, monkeypatch, capsys):
 
 def test_handle_existing_component(settings, tmp_path, monkeypatch, capsys):
     settings.BASE_DIR = tmp_path
+    app_name = f"test-{uuid.uuid4()}".replace("-", "_")
+
+    monkeypatch.setattr(
+        "django_unicorn.management.commands.startunicorn.get_app_path",
+        lambda a: tmp_path / app_name,
+    )
 
-    app_name = "test123"
     (tmp_path / app_name).mkdir()
     (tmp_path / app_name / "components").mkdir()
 
-    # Reply "y"
-    monkeypatch.setattr("sys.stdin", io.StringIO("y\n"))
-
-    component_names = ["hello-world"]
+    component_names = [
+        "hello-world",
+    ]
     Command().handle(app_name=app_name, component_names=component_names)
 
-    assert (tmp_path / f"{app_name}/components/__init__.py").exists()
-    assert (tmp_path / f"{app_name}/components/hello_world.py").exists()
-    assert (tmp_path / f"{app_name}/templates/unicorn/hello-world.html").exists()
+    assert (tmp_path / app_name / "components/__init__.py").exists()
+    assert (tmp_path / app_name / "components/hello_world.py").exists()
+    assert (tmp_path / app_name / "templates/unicorn/hello-world.html").exists()
 
     captured = capsys.readouterr()
     assert "Starring the GitHub repo " not in captured.out
@@ -85,21 +103,25 @@ def test_handle_existing_component(settings, tmp_path, monkeypatch, capsys):
 
 def test_handle_existing_templates(settings, tmp_path, monkeypatch, capsys):
     settings.BASE_DIR = tmp_path
+    app_name = f"test-{uuid.uuid4()}".replace("-", "_")
+
+    monkeypatch.setattr(
+        "django_unicorn.management.commands.startunicorn.get_app_path",
+        lambda a: tmp_path / app_name,
+    )
 
-    app_name = "test123"
     (tmp_path / app_name).mkdir()
     (tmp_path / app_name / "components").mkdir()
     (tmp_path / app_name / "templates").mkdir()
 
-    # Reply "y"
-    monkeypatch.setattr("sys.stdin", io.StringIO("y\n"))
-
-    component_names = ["hello-world"]
+    component_names = [
+        "hello-world",
+    ]
     Command().handle(app_name=app_name, component_names=component_names)
 
-    assert (tmp_path / f"{app_name}/components/__init__.py").exists()
-    assert (tmp_path / f"{app_name}/components/hello_world.py").exists()
-    assert (tmp_path / f"{app_name}/templates/unicorn/hello-world.html").exists()
+    assert (tmp_path / app_name / "components/__init__.py").exists()
+    assert (tmp_path / app_name / "components/hello_world.py").exists()
+    assert (tmp_path / app_name / "templates/unicorn/hello-world.html").exists()
 
     captured = capsys.readouterr()
     assert "Starring the GitHub repo " not in captured.out
@@ -108,17 +130,21 @@ def test_handle_existing_templates(settings, tmp_path, monkeypatch, capsys):
 
 def test_handle_existing_unicorn_templates(settings, tmp_path, monkeypatch, capsys):
     settings.BASE_DIR = tmp_path
+    app_name = f"test-{uuid.uuid4()}".replace("-", "_")
+
+    monkeypatch.setattr(
+        "django_unicorn.management.commands.startunicorn.get_app_path",
+        lambda a: tmp_path / app_name,
+    )
 
-    app_name = "test123"
     (tmp_path / app_name).mkdir()
     (tmp_path / app_name / "components").mkdir()
     (tmp_path / app_name / "templates").mkdir()
-    (tmp_path / app_name / "templates" / "unicorn").mkdir()
-
-    # Reply "y"
-    monkeypatch.setattr("sys.stdin", io.StringIO("y\n"))
+    (tmp_path / app_name / "templates/unicorn").mkdir()
 
-    component_names = ["hello-world"]
+    component_names = [
+        "hello-world",
+    ]
     Command().handle(app_name=app_name, component_names=component_names)
 
     assert (tmp_path / f"{app_name}/components/__init__.py").exists()
@@ -130,33 +156,49 @@ def test_handle_existing_unicorn_templates(settings, tmp_path, monkeypatch, caps
     assert "Make sure to add " not in captured.out
 
 
-def test_handle_reply_no(settings, tmp_path, monkeypatch, capsys):
+def test_handle_reply_n(settings, tmp_path, monkeypatch, capsys):
     settings.BASE_DIR = tmp_path
 
     # Reply "n"
     monkeypatch.setattr("sys.stdin", io.StringIO("n\n"))
 
-    app_name = "test123"
-    component_names = ["hello-world"]
-    Command().handle(app_name=app_name, component_names=component_names)
+    app_name = f"test-{uuid.uuid4()}".replace("-", "_")
+    component_names = [
+        "hello-world",
+    ]
+
+    with pytest.raises(CommandError):
+        Command().handle(app_name=app_name, component_names=component_names)
 
     assert not (tmp_path / f"{app_name}/components/__init__.py").exists()
     assert not (tmp_path / f"{app_name}/components/hello_world.py").exists()
     assert not (tmp_path / f"{app_name}/templates/unicorn/hello-world.html").exists()
 
     captured = capsys.readouterr()
+    assert "cannot be found." in captured.out
     assert "Make sure to add " not in captured.out
 
+
+def test_handle_reply_no(settings, tmp_path, monkeypatch, capsys):
+    settings.BASE_DIR = tmp_path
+
     # Reply "no"
     monkeypatch.setattr("sys.stdin", io.StringIO("no\n"))
 
-    Command().handle(app_name=app_name, component_names=component_names)
+    app_name = f"test-{uuid.uuid4()}".replace("-", "_")
+    component_names = [
+        "hello-world",
+    ]
+
+    with pytest.raises(CommandError):
+        Command().handle(app_name=app_name, component_names=component_names)
 
     assert not (tmp_path / f"{app_name}/components/__init__.py").exists()
     assert not (tmp_path / f"{app_name}/components/hello_world.py").exists()
     assert not (tmp_path / f"{app_name}/templates/unicorn/hello-world.html").exists()
 
     captured = capsys.readouterr()
+    assert "cannot be found." in captured.out
     assert "Make sure to add " not in captured.out
 
 
@@ -172,14 +214,22 @@ def webbrowser_open(url, **kwargs):
 
     monkeypatch.setattr("webbrowser.open", webbrowser_open)
 
-    app_name = "test123"
-    component_names = ["hello-world"]
+    # Prevent the `startapp` command from actually creating a new app
+    monkeypatch.setattr(
+        "django_unicorn.management.commands.startunicorn.call_command",
+        lambda *args, **kwargs: None,
+    )
+
+    app_name = f"test-{uuid.uuid4()}".replace("-", "_")
+    component_names = [
+        "hello-world",
+    ]
 
     Command().handle(app_name=app_name, component_names=component_names)
 
-    assert (tmp_path / f"{app_name}/components/__init__.py").exists()
-    assert (tmp_path / f"{app_name}/components/hello_world.py").exists()
-    assert (tmp_path / f"{app_name}/templates/unicorn/hello-world.html").exists()
+    assert (tmp_path / app_name / "components/__init__.py").exists()
+    assert (tmp_path / app_name / "components/hello_world.py").exists()
+    assert (tmp_path / app_name / "templates/unicorn/hello-world.html").exists()
 
     captured = capsys.readouterr()
     assert "Starring the GitHub repo " in captured.out