Clean up existing commands

Author: woojiahao

app/commands/download.py

@@ -39,80 +39,7 @@
 )
 
 
-def setup_exercise_folder(download_time: datetime, config: ExerciseConfig) -> None:
-    exercise = config.exercise_name
-    formatted_exercise = config.formatted_exercise_name
-
-    config.downloaded_at = download_time.timestamp()
-
-    with open(".gitmastery-exercise.json", "w") as gitmastery_exercise_file:
-        gitmastery_exercise_file.write(config.to_json())
-
-    if config.exercise_repo.repo_type == "local":
-        info("Creating custom exercise folder")
-        os.makedirs(config.exercise_repo.repo_name, exist_ok=True)
-    elif config.exercise_repo.repo_type == "remote":
-        # We have to assume that Github is checked
-        info("Retrieving exercise from Github")
-
-        username = get_username()
-        exercise_repo = f"git-mastery/{config.exercise_repo.repo_title}"
-        if config.exercise_repo.create_fork:
-            info("Checking if you already have a fork")
-            fork_name = config.exercise_fork_name(username)
-            if has_fork(fork_name):
-                info("You already have a fork, deleting it")
-                delete_repo(fork_name)
-            info("Creating fork of exercise repository")
-            fork(exercise_repo, fork_name)
-            info("Creating clone of your fork")
-            clone_with_custom_name(
-                f"{username}/{fork_name}", config.exercise_repo.repo_name
-            )
-        else:
-            info("Creating clone of repository")
-            clone_with_custom_name(exercise_repo, config.exercise_repo.repo_name)
-
-    os.chdir(config.exercise_repo.repo_name)
-    download_resources: Optional[Dict[str, str]] = get_variable_from_url(
-        formatted_exercise, "download.py", "__resources__", {}
-    )
-    if download_resources and len(download_resources) > 0:
-        info("Downloading resources for the exercise...")
-
-    if download_resources:
-        for resource, path in download_resources.items():
-            os.makedirs(Path(path).parent, exist_ok=True)
-            is_binary = Path(path).suffix in [".png", ".jpg", ".jpeg", ".gif"]
-            # Download and load all of these resources
-            download_file(
-                get_gitmastery_file_path(f"{formatted_exercise}/res/{resource}"),
-                path,
-                is_binary,
-            )
-
-    if config.exercise_repo.init:
-        init()
-        initial_commit_message = "Set initial state"
-        if download_resources:
-            add_all()
-            commit(initial_commit_message)
-        else:
-            empty_commit(initial_commit_message)
-
-    info("Executing download setup")
-    execute_py_file_function_from_url(
-        formatted_exercise,
-        "download.py",
-        "setup",
-        {"verbose": get_verbose()},
-    )
-
-    success(f"Completed setting up {click.style(exercise, bold=True, italic=True)}")
-    info("Start working on it:")
-
-
-def download_exercise(
+def _download_exercise(
     exercise: str, formatted_exercise: str, download_time: datetime
 ) -> None:
     info(f"Checking if {exercise} is available")
@@ -197,7 +124,7 @@ def download_exercise(
             gitmastery_exercise_file.write(config.to_json())
 
 
-def download_hands_on(hands_on: str, formatted_hands_on: str) -> None:
+def _download_hands_on(hands_on: str, formatted_hands_on: str) -> None:
     info(f"Checking if {hands_on} is available")
 
     hands_on_without_prefix = (
@@ -263,6 +190,79 @@ def download_hands_on(hands_on: str, formatted_hands_on: str) -> None:
     success(f"Completed setting up {click.style(hands_on, bold=True, italic=True)}")
 
 
+def setup_exercise_folder(download_time: datetime, config: ExerciseConfig) -> None:
+    exercise = config.exercise_name
+    formatted_exercise = config.formatted_exercise_name
+
+    config.downloaded_at = download_time.timestamp()
+
+    with open(".gitmastery-exercise.json", "w") as gitmastery_exercise_file:
+        gitmastery_exercise_file.write(config.to_json())
+
+    if config.exercise_repo.repo_type == "local":
+        info("Creating custom exercise folder")
+        os.makedirs(config.exercise_repo.repo_name, exist_ok=True)
+    elif config.exercise_repo.repo_type == "remote":
+        # We have to assume that Github is checked
+        info("Retrieving exercise from Github")
+
+        username = get_username()
+        exercise_repo = f"git-mastery/{config.exercise_repo.repo_title}"
+        if config.exercise_repo.create_fork:
+            info("Checking if you already have a fork")
+            fork_name = config.exercise_fork_name(username)
+            if has_fork(fork_name):
+                info("You already have a fork, deleting it")
+                delete_repo(fork_name)
+            info("Creating fork of exercise repository")
+            fork(exercise_repo, fork_name)
+            info("Creating clone of your fork")
+            clone_with_custom_name(
+                f"{username}/{fork_name}", config.exercise_repo.repo_name
+            )
+        else:
+            info("Creating clone of repository")
+            clone_with_custom_name(exercise_repo, config.exercise_repo.repo_name)
+
+    os.chdir(config.exercise_repo.repo_name)
+    download_resources: Optional[Dict[str, str]] = get_variable_from_url(
+        formatted_exercise, "download.py", "__resources__", {}
+    )
+    if download_resources and len(download_resources) > 0:
+        info("Downloading resources for the exercise...")
+
+    if download_resources:
+        for resource, path in download_resources.items():
+            os.makedirs(Path(path).parent, exist_ok=True)
+            is_binary = Path(path).suffix in [".png", ".jpg", ".jpeg", ".gif"]
+            # Download and load all of these resources
+            download_file(
+                get_gitmastery_file_path(f"{formatted_exercise}/res/{resource}"),
+                path,
+                is_binary,
+            )
+
+    if config.exercise_repo.init:
+        init()
+        initial_commit_message = "Set initial state"
+        if download_resources:
+            add_all()
+            commit(initial_commit_message)
+        else:
+            empty_commit(initial_commit_message)
+
+    info("Executing download setup")
+    execute_py_file_function_from_url(
+        formatted_exercise,
+        "download.py",
+        "setup",
+        {"verbose": get_verbose()},
+    )
+
+    success(f"Completed setting up {click.style(exercise, bold=True, italic=True)}")
+    info("Start working on it:")
+
+
 # TODO: Think about streamlining the config location
 # TODO: Maybe store the random "keys" in config
 @click.command()
@@ -276,6 +276,6 @@ def download(exercise: str) -> None:
 
     must_be_in_gitmastery_root()
     if is_hands_on:
-        download_hands_on(exercise, formatted_exercise)
+        _download_hands_on(exercise, formatted_exercise)
     else:
-        download_exercise(exercise, formatted_exercise, download_time)
+        _download_exercise(exercise, formatted_exercise, download_time)

app/commands/progress/constants.py

@@ -1,3 +1,3 @@
 PROGRESS_REPOSITORY_NAME = "git-mastery/progress"
 STUDENT_PROGRESS_FORK_NAME = "{username}-gitmastery-progress"
-LOCAL_FOLDER_NAME = "progress"
+PROGRESS_LOCAL_FOLDER_NAME = "progress"

app/commands/progress/reset.py

@@ -25,7 +25,6 @@
 
 @click.command()
 def reset() -> None:
-    # TODO: This command should work even if the user does not have syncing on - only check if Github is set up when it is necessary
     """
     Resets the progress of the current exercise.
     """
@@ -36,14 +35,18 @@ def reset() -> None:
     gitmastery_config = is_in_gitmastery_root()
     exercise_config = must_be_in_exercise_root()
 
+    is_remote_type = exercise_config.exercise_repo.repo_type == "remote"
+    has_remote_progress = gitmastery_config.progress_remote
+
     invoke_command(git)
-    invoke_command(github)
+    if has_remote_progress or is_remote_type:
+        invoke_command(github)
 
     exercise_name = exercise_config.exercise_name
 
     os.chdir(exercise_config.path)
     info("Resetting the exercise folder")
-    if exercise_config.exercise_repo.create_fork:
+    if is_remote_type and exercise_config.exercise_repo.create_fork:
         # Remove the fork first
         exercise_fork_name = (
             f"{username}-gitmastery-{exercise_config.exercise_repo.repo_title}"
@@ -91,8 +94,7 @@ def reset() -> None:
     with open("progress.json", "w") as progress_file:
         progress_file.write(json.dumps(clean_progress, indent=2))
 
-    progress_remote = gitmastery_config.progress_remote
-    if progress_remote:
+    if has_remote_progress:
         info("Updating your remote progress as well")
         add_all()
         commit(f"Reset progress for {exercise_name}")

app/commands/progress/show.py

@@ -49,7 +49,6 @@ def show() -> None:
         )
 
     if config.progress_remote:
-        invoke_command(github)
         username = get_username()
         dashboard_url = (
             f"https://git-mastery.github.io/progress-dashboard/#/dashboard/{username}"

app/commands/progress/sync/off.py

@@ -7,7 +7,7 @@
 from app.commands.check.git import git
 from app.commands.check.github import github
 from app.commands.progress.constants import (
-    LOCAL_FOLDER_NAME,
+    PROGRESS_LOCAL_FOLDER_NAME,
     STUDENT_PROGRESS_FORK_NAME,
 )
 from app.utils.cli import rmtree
@@ -42,11 +42,11 @@ def off() -> None:
         config_file.write(json.dumps(config))
 
     local_progress = []
-    local_progress_filepath = os.path.join(LOCAL_FOLDER_NAME, "progress.json")
+    local_progress_filepath = os.path.join(PROGRESS_LOCAL_FOLDER_NAME, "progress.json")
     with open(local_progress_filepath, "r") as file:
         local_progress = json.load(file)
 
-    rmtree(LOCAL_FOLDER_NAME)
+    rmtree(PROGRESS_LOCAL_FOLDER_NAME)
 
     # Re-create just the progress folder
     with open(local_progress_filepath, "a") as progress_file: