Clean up paths code. Add more tests for startunicorn.

Author: adamghill

django_unicorn/management/commands/startunicorn.py

@@ -1,6 +1,6 @@
 import os
+import webbrowser
 from pathlib import Path
-from webbrowser import open
 
 from django.conf import settings
 from django.core.management.base import BaseCommand, CommandError
@@ -45,11 +45,16 @@ def handle(self, *args, **options):
             # Fallback to the current directory
             base_path = os.getcwd()
 
+        base_path = Path(base_path)
+
+        if "app_name" not in options:
+            raise CommandError("An application name is required.")
+
         if "component_names" not in options:
-            raise CommandError("Pass in at least one component name.")
+            raise CommandError("At least one component name is required.")
 
         app_name = options["app_name"]
-        app_directory = Path(base_path) / Path(app_name)
+        app_directory = base_path / app_name
 
         is_app_directory_correct = input(
             f"\nUse '{app_directory}' for the app directory? [Y/n] "
@@ -64,10 +69,11 @@ def handle(self, *args, **options):
         if not app_directory.exists():
             is_new_app = True
             app_directory.mkdir()
-            (app_directory / Path("__init__.py")).touch(exist_ok=True)
+
+        (app_directory / "__init__.py").touch(exist_ok=True)
 
         # Create component
-        component_base_path = app_directory / Path("components")
+        component_base_path = app_directory / "components"
 
         if not component_base_path.exists():
             component_base_path.mkdir()
@@ -78,15 +84,13 @@ def handle(self, *args, **options):
 
             is_first_component = True
 
-        (component_base_path / Path("__init__.py")).touch(exist_ok=True)
+        (component_base_path / "__init__.py").touch(exist_ok=True)
 
         for component_name in options["component_names"]:
             snake_case_component_name = convert_to_snake_case(component_name)
             pascal_case_component_name = convert_to_pascal_case(component_name)
 
-            component_path = component_base_path / Path(
-                f"{snake_case_component_name}.py"
-            )
+            component_path = component_base_path / f"{snake_case_component_name}.py"
 
             if component_path.exists():
                 self.stdout.write(
@@ -103,15 +107,15 @@ def handle(self, *args, **options):
                 self.stdout.write(self.style.SUCCESS(f"Created {component_path}."))
 
             # Create template
-            template_base_path = app_directory / Path("templates") / Path("unicorn")
+            template_base_path = app_directory / "templates" / "unicorn"
 
             if not template_base_path.exists():
-                if not (app_directory / Path("templates")).exists():
-                    (app_directory / Path("templates")).mkdir()
+                if not (app_directory / "templates").exists():
+                    (app_directory / "templates").mkdir()
 
                 template_base_path.mkdir()
 
-            template_path = template_base_path / Path(f"{component_name}.html")
+            template_path = template_base_path / f"{component_name}.html"
 
             if template_path.exists():
                 self.stdout.write(
@@ -156,15 +160,17 @@ def handle(self, *args, **options):
 """
                     )
 
-                    open("https://github.com/adamghill/django-unicorn", new=2)
+                    webbrowser.open(
+                        "https://github.com/adamghill/django-unicorn", new=2
+                    )
                 else:
                     self.stdout.write(
                         self.style.ERROR(
                             "That's a bummer, but I understand. I hope you will star it for me later!"
                         )
                     )
 
-            if is_new_app or app_name not in settings.INSTALLED_APPS:
+            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,3 +1,4 @@
+import io
 import os
 
 from django.core.management.base import CommandError
@@ -17,3 +18,171 @@ def test_handle_no_args(settings):
 
     with pytest.raises(CommandError):
         Command().handle()
+
+
+def test_handle_new_app(settings, tmp_path, monkeypatch, capsys):
+    settings.BASE_DIR = tmp_path
+
+    # Reply "y" then "n"
+    monkeypatch.setattr("sys.stdin", io.StringIO("y\nn\n"))
+
+    app_name = "test123"
+    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()
+
+    captured = capsys.readouterr()
+    assert "Starring the GitHub repo " in captured.out
+    assert f'Make sure to add `"{app_name}",` to your' in captured.out
+
+
+def test_handle_existing_app(settings, tmp_path, monkeypatch, capsys):
+    settings.BASE_DIR = tmp_path
+
+    app_name = "test123"
+    (tmp_path / app_name).mkdir()
+
+    # Reply "y" then "n"
+    monkeypatch.setattr("sys.stdin", io.StringIO("y\nn\n"))
+
+    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()
+
+    captured = capsys.readouterr()
+    assert "Starring the GitHub repo " in captured.out
+    assert "That's a bummer" in captured.out
+    assert "Make sure to add " not in captured.out
+
+
+def test_handle_existing_component(settings, tmp_path, monkeypatch, capsys):
+    settings.BASE_DIR = tmp_path
+
+    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"]
+    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()
+
+    captured = capsys.readouterr()
+    assert "Starring the GitHub repo " not in captured.out
+    assert "Make sure to add " not in captured.out
+
+
+def test_handle_existing_templates(settings, tmp_path, monkeypatch, capsys):
+    settings.BASE_DIR = tmp_path
+
+    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"]
+    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()
+
+    captured = capsys.readouterr()
+    assert "Starring the GitHub repo " not in captured.out
+    assert "Make sure to add " not in captured.out
+
+
+def test_handle_existing_unicorn_templates(settings, tmp_path, monkeypatch, capsys):
+    settings.BASE_DIR = tmp_path
+
+    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"))
+
+    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()
+
+    captured = capsys.readouterr()
+    assert "Starring the GitHub repo " not 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 "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)
+
+    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 "Make sure to add " not in captured.out
+
+    # Reply "no"
+    monkeypatch.setattr("sys.stdin", io.StringIO("no\n"))
+
+    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 "Make sure to add " not in captured.out
+
+
+def test_handle_reply_yes_star(settings, tmp_path, monkeypatch, capsys):
+    settings.BASE_DIR = tmp_path
+
+    # Reply "y" then "y"
+    monkeypatch.setattr("sys.stdin", io.StringIO("y\ny\n"))
+
+    # Patch opening a webbrowser
+    def webbrowser_open(url, **kwargs):
+        assert url == "https://github.com/adamghill/django-unicorn"
+
+    monkeypatch.setattr("webbrowser.open", webbrowser_open)
+
+    app_name = "test123"
+    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()
+
+    captured = capsys.readouterr()
+    assert "Starring the GitHub repo " in captured.out
+    assert "That's a bummer" not in captured.out
+    assert "Thank you for helping spread the" in captured.out
+    assert f'Make sure to add `"{app_name}",` to your' in captured.out