added leftover cleaners

Author: a-jean-andreasian

not_gitmodules/core.py

@@ -1,11 +1,16 @@
 import os
-from .parts import delete_git_folder, ensure_dir_exists, extract_repo_name_from_url, clone_repo, read_yaml
+from .parts import delete_git_folder, ensure_dir_exists, clone_repo, read_yaml, clean_github_leftovers
 
 
 def initializer(
     yaml_config_path: str = 'notgitmodules.yaml',
     root_dir_name="my_gitmodules"
 ):
+    # Read yaml
+    # Ensure root_dir exists
+    # Clone the repo to root dir
+    # Clean-up
+
     """
     :param yaml_config_path: The path to notgitmodules.yaml file
     :param root_dir_name: The name of directory where modules will be downloaded to.
@@ -15,10 +20,8 @@ def initializer(
     ensure_dir_exists(root_dir_name)
 
     for directory, repo_url in not_gitmodules.items():
-        delete_git_folder(root_dir_name)
-
         clone_repo(root_dir_name, directory, repo_url)
-        repo_name = extract_repo_name_from_url(repo_url)
 
-        repo = os.path.join(root_dir_name, repo_name)
-        delete_git_folder(repo)
+        module_path = os.path.join(root_dir_name, directory)
+        delete_git_folder(module_path)
+        clean_github_leftovers(module_path)

not_gitmodules/parts/__init__.py

@@ -5,4 +5,5 @@
 from .clone_repo import clone_repo
 from .move_folder import move_folder
 from .yaml_reader import read_yaml
+from .clean_repo import clean_github_leftovers
 

not_gitmodules/parts/clean_repo.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+import shutil
+
+LEFTOVER_FILES = '.gitignore', 'README.md', 'LICENSE'
+LEFTOVER_FOLDERS = '.github',
+
+
+def clean_github_leftovers(module_path):
+    """
+    Deletes files like .gitignore, README.md, LICENSE and folders like .github from the cloned module.
+    """
+    module_path = Path(module_path)
+
+    for file_name in LEFTOVER_FILES:
+        file_path = module_path / file_name
+        if file_path.exists():
+            file_path.unlink()
+
+    for folder_name in LEFTOVER_FOLDERS:
+        folder_path = module_path / folder_name
+        if folder_path.exists() and folder_path.is_dir():
+            shutil.rmtree(folder_path)
+
+    print('Leftover files were successfully removed.')

not_gitmodules/parts/delete_git.py

@@ -1,16 +1,12 @@
 import os, shutil, stat
-import subprocess
-
-
-def delete_using_subprocess(path):
-    subprocess.run(["rm", path, "-r", "-f"], check=True)
+from pathlib import Path
 
 
 def drop_read_only(path):
     try:
         os.chmod(path, stat.S_IWRITE)
     except PermissionError:
-        delete_using_subprocess(path)
+        ...
 
 
 def delete_git_folder(directory):
@@ -20,15 +16,10 @@ def delete_git_folder(directory):
     if os.path.exists(git_folder_path):
         try:
             shutil.rmtree(git_folder_path)
-        except PermissionError:
-            drop_read_only(git_folder_path)
-            shutil.rmtree(git_folder_path)
-
-
-def force_del_file(path):
-    return delete_using_subprocess(path)
-
-
-def force_del_folder(path):
-    while os.path.exists(path):
-        subprocess.run(["rm", "-r", path, "-f"], check=True)
+        except PermissionError as err:
+            read_only_fp = str(err).split('denied:')[1].strip().strip("'")
+            p = Path(read_only_fp)
+            drop_read_only(p)
+            return delete_git_folder(directory)
+        else:
+            print(git_folder_path, 'was successfully deleted.')