migrate scaffold command

Author: amol-

gearbox/commands/scaffold.py

@@ -5,7 +5,6 @@
 
 from gearbox.command import Command
 from gearbox.template import GearBoxTemplate
-from gearbox.utils.plugins import find_egg_info_dir
 
 
 class ScaffoldCommand(Command):
@@ -61,6 +60,7 @@ def get_parser(self, prog_name):
             "-np",
             "--no-package",
             dest="nopackage",
+            action="store_true",
             help="When using subdir option do not create python "
             "packages, but plain directories.",
         )
@@ -77,27 +77,6 @@ def _lookup(self, template, where):
                     break
         return template_filename
 
-    def _find_toplevel_packages(self):
-        egg_info_dir = find_egg_info_dir(os.getcwd())
-        if egg_info_dir is None:
-            print(
-                "Unable to find distribution egg-info, did you run setup.py egg_info or develop?"
-            )
-            return []
-
-        modules = os.path.join(egg_info_dir, "top_level.txt")
-        try:
-            modules = open(modules).readlines()
-        except Exception:
-            print("Unable to detect distribution top level packages.")
-            return []
-
-        modules = map(lambda x: x.strip().replace(os.sep, "."), modules)
-        modules = filter(
-            lambda x: not x.startswith("test"), modules
-        )  # Remove test suite modules
-        return list(modules)
-
     def take_action(self, opts):
         for template in opts.scaffold_name:
             template_filename = None
@@ -136,7 +115,7 @@ def take_action(self, opts):
 
             if not os.path.exists(output_dir):
                 os.makedirs(output_dir)
-                if opts.subdir:
+                if opts.subdir and not opts.nopackage:
                     package_init = os.path.join(output_dir, "__init__.py")
                     if not os.path.exists(package_init):
                         with open(package_init, "w") as pif:
@@ -157,7 +136,6 @@ def take_action(self, opts):
                             "subdir": opts.subdir,
                             "subpackage": subdir_as_package,
                             "dotted_subpackage": "." + subdir_as_package,
-                            "packages": self._find_toplevel_packages(),
                         },
                     )
                 except NameError as e:

tests/test_commands.py

@@ -8,7 +8,6 @@
 
 from gearbox.commandmanager import CommandManager
 from gearbox.commands.help import HelpAction
-from gearbox.commands.scaffold import ScaffoldCommand
 from gearbox.commands.serve import ServeCommand
 from gearbox.commands.setup_app import SetupAppCommand
 from gearbox.main import GearBox, main
@@ -193,6 +192,96 @@ def test_scaffold(tmp_path):
     assert "class Testmodel" in content
 
 
+def test_scaffold_derives_output_extension_from_template_name(tmp_path):
+    lookup_dir = tmp_path / "scaffolds"
+    lookup_dir.mkdir()
+    template_file = lookup_dir / "controller.py.template"
+    template_file.write_text("class {{target.capitalize()}}:\n    pass\n")
+    project_dir = tmp_path / "project"
+    project_dir.mkdir()
+
+    with patch.object(
+        sys,
+        "argv",
+        [
+            "gearbox",
+            "scaffold",
+            "controller",
+            "Demo",
+            "-l",
+            str(lookup_dir),
+            "-p",
+            str(project_dir),
+        ],
+    ):
+        main()
+
+    output_file = project_dir / "Demo.py"
+    assert output_file.is_file()
+    assert "class Demo" in output_file.read_text()
+
+
+def test_scaffold_no_package_prevents_subdir_init_file(tmp_path):
+    lookup_dir = tmp_path / "scaffolds"
+    lookup_dir.mkdir()
+    template_file = lookup_dir / "controller.py.template"
+    template_file.write_text("class {{target.capitalize()}}:\n    pass\n")
+    project_dir = tmp_path / "project"
+    project_dir.mkdir()
+
+    with patch.object(
+        sys,
+        "argv",
+        [
+            "gearbox",
+            "scaffold",
+            "controller",
+            "Demo",
+            "-l",
+            str(lookup_dir),
+            "-p",
+            str(project_dir),
+            "-s",
+            "admin",
+            "--no-package",
+        ],
+    ):
+        main()
+
+    assert (project_dir / "admin" / "Demo.py").is_file()
+    assert not (project_dir / "admin" / "__init__.py").exists()
+
+
+def test_scaffold_subdir_creates_package_init_by_default(tmp_path):
+    lookup_dir = tmp_path / "scaffolds"
+    lookup_dir.mkdir()
+    template_file = lookup_dir / "controller.py.template"
+    template_file.write_text("class {{target.capitalize()}}:\n    pass\n")
+    project_dir = tmp_path / "project"
+    project_dir.mkdir()
+
+    with patch.object(
+        sys,
+        "argv",
+        [
+            "gearbox",
+            "scaffold",
+            "controller",
+            "Demo",
+            "-l",
+            str(lookup_dir),
+            "-p",
+            str(project_dir),
+            "-s",
+            "admin",
+        ],
+    ):
+        main()
+
+    assert (project_dir / "admin" / "Demo.py").is_file()
+    assert (project_dir / "admin" / "__init__.py").is_file()
+
+
 # --- Test for patch command ---
 def test_patch(tmp_path):
     test_file = tmp_path / "test.txt"