Add a dfetch remove command

Fixes #26

Author: spoorcc

dfetch/__main__.py

@@ -17,6 +17,7 @@
 import dfetch.commands.freeze
 import dfetch.commands.import_
 import dfetch.commands.init
+import dfetch.commands.remove
 import dfetch.commands.report
 import dfetch.commands.update
 import dfetch.commands.update_patch
@@ -52,6 +53,7 @@ def create_parser() -> argparse.ArgumentParser:
     dfetch.commands.freeze.Freeze.create_menu(subparsers)
     dfetch.commands.import_.Import.create_menu(subparsers)
     dfetch.commands.init.Init.create_menu(subparsers)
+    dfetch.commands.remove.Remove.create_menu(subparsers)
     dfetch.commands.report.Report.create_menu(subparsers)
     dfetch.commands.update.Update.create_menu(subparsers)
     dfetch.commands.update_patch.UpdatePatch.create_menu(subparsers)

dfetch/commands/remove.py

@@ -0,0 +1,46 @@
+import argparse
+import os
+import shutil
+
+import dfetch.commands.command
+from dfetch import DEFAULT_MANIFEST_NAME
+from dfetch.log import get_logger
+from dfetch.manifest.manifest import get_manifest
+from dfetch.util.util import in_directory, safe_rm
+
+logger = get_logger(__name__)
+
+
+class Remove(dfetch.commands.command.Command):
+    """Remove a project from the manifest,
+
+    Backup manifest, and remove project directory from disk.
+    """
+
+    @staticmethod
+    def create_menu(subparsers: dfetch.commands.command.SubparserActionType) -> None:
+        """Add the menu for the update action."""
+        parser = dfetch.commands.command.Command.parser(subparsers, Remove)
+        parser.add_argument(
+            "projects",
+            metavar="<project>",
+            type=str,
+            nargs="*",
+            help="Specific project(s) to remove",
+        )
+
+    def __call__(self, args: argparse.Namespace) -> None:
+        """Perform the remove action."""
+
+        manifest, path = get_manifest()
+
+        with in_directory(os.path.dirname(path)):
+            for project in args.projects:
+
+                manifest.remove(project)
+                logger.info(f"Project '{project}' removed from manifest.")
+
+                safe_rm(project)
+
+            shutil.move(DEFAULT_MANIFEST_NAME, DEFAULT_MANIFEST_NAME + ".backup")
+            manifest.dump(path)

dfetch/manifest/manifest.py

@@ -322,6 +322,14 @@ def selected_projects(self, names: Sequence[str]) -> Sequence[ProjectEntry]:
         self._check_all_names_found(names, projects)
         return projects
 
+    def remove(self, project_name: str) -> None:
+        """Remove a project from the manifest."""
+        if project_name not in self._projects:
+            possibles = [project.name for project in self._projects.values()]
+            raise RequestedProjectNotFoundError(project_name, possibles)
+
+        del self._projects[project_name]
+
     def _check_all_names_found(
         self, names: Sequence[str], projects: Sequence[ProjectEntry]
     ) -> None:

features/remove-project.feature

@@ -0,0 +1,30 @@
+Feature: Remove a project from the manifest
+
+  Scenario: Remove an existing project
+     Given the manifest 'dfetch.yaml'
+            """
+            manifest:
+              version: '0.0'
+
+              projects:
+                - name: ext/test-repo-tag
+                  url: https://github.com/dfetch-org/test-repo
+                  tag: v1
+
+            """
+    And all projects are updated
+    When I run "dfetch remove ext/test-repo-tag"
+    Then the manifest 'dfetch.yaml' is replaced with
+            """
+            manifest:
+              version: '0.0'
+
+              projects: []
+            """     
+    And the directory 'ext/test-repo-tag' should be removed from disk
+    And the output shows
+            """
+            Dfetch (0.10.0)
+              ext/test-repo-tag: removed
+            """
+        

features/steps/generic_steps.py

@@ -457,3 +457,9 @@ def step_impl(context, path):
     assert expected_dir == actual_dir, os.linesep.join(
         ["", "Expected:", expected_dir, "", "Actual:", actual_dir]
     )
+
+
+@then("the directory '{path' should be removed from disk")
+def step_impl(_, path):
+    """Check if a directory is removed."""
+    assert not os.path.exists(path), f"Directory {path} still exists!"