Change Inheritance structure (#42)

Refactor inheritance model to make GitSimBaseCommand a manim scene subclass

Author: paketb0te

git_sim/__main__.py

@@ -1,14 +1,65 @@
-import git_sim.git_sim as gs
-import os, sys
 import argparse
+import datetime
+import os
 import pathlib
-import time, datetime
+import subprocess
+import sys
+import time
+from argparse import Namespace
+from typing import Type
+
 import cv2
 import git
-import subprocess
-from manim import config, WHITE
+from manim import WHITE, config
 from manim.utils.file_ops import open_file as open_media_file
 
+from git_sim.git_sim_add import GitSimAdd
+from git_sim.git_sim_base_command import GitSimBaseCommand
+from git_sim.git_sim_branch import GitSimBranch
+from git_sim.git_sim_cherrypick import GitSimCherryPick
+from git_sim.git_sim_commit import GitSimCommit
+from git_sim.git_sim_log import GitSimLog
+from git_sim.git_sim_merge import GitSimMerge
+from git_sim.git_sim_rebase import GitSimRebase
+from git_sim.git_sim_reset import GitSimReset
+from git_sim.git_sim_restore import GitSimRestore
+from git_sim.git_sim_revert import GitSimRevert
+from git_sim.git_sim_stash import GitSimStash
+from git_sim.git_sim_status import GitSimStatus
+from git_sim.git_sim_tag import GitSimTag
+
+
+def get_scene_for_command(args: Namespace) -> Type[GitSimBaseCommand]:
+
+    if args.subcommand == "log":
+        return GitSimLog
+    elif args.subcommand == "status":
+        return GitSimStatus
+    elif args.subcommand == "add":
+        return GitSimAdd
+    elif args.subcommand == "restore":
+        return GitSimRestore
+    elif args.subcommand == "commit":
+        return GitSimCommit
+    elif args.subcommand == "stash":
+        return GitSimStash
+    elif args.subcommand == "branch":
+        return GitSimBranch
+    elif args.subcommand == "tag":
+        return GitSimTag
+    elif args.subcommand == "reset":
+        return GitSimReset
+    elif args.subcommand == "revert":
+        return GitSimRevert
+    elif args.subcommand == "merge":
+        return GitSimMerge
+    elif args.subcommand == "rebase":
+        return GitSimRebase
+    elif args.subcommand == "cherry-pick":
+        return GitSimCherryPick
+
+    raise NotImplementedError(f"command '{args.subcommand}' is not yet implemented.")
+
 
 def main():
     parser = argparse.ArgumentParser(
@@ -257,7 +308,8 @@ def main():
     if args.light_mode:
         config.background_color = WHITE
 
-    scene = gs.GitSim(args)
+    scene_class = get_scene_for_command(args=args)
+    scene = scene_class(args=args)
     scene.render()
 
     if args.video_format == "webm":

git_sim/git_sim.py

@@ -1,4 +1,5 @@
 import sys
+from argparse import Namespace
 
 import git
 import manim as m
@@ -7,8 +8,8 @@
 
 
 class GitSimAdd(GitSimBaseCommand):
-    def __init__(self, scene):
-        super().__init__(scene)
+    def __init__(self, args: Namespace):
+        super().__init__(args=args)
         self.maxrefs = 2
         self.hide_first_tag = True
         self.allow_no_commits = True
@@ -18,19 +19,16 @@ def __init__(self, scene):
         except TypeError:
             pass
 
-        for name in self.scene.args.name:
+        for name in self.args.name:
             if name not in [x.a_path for x in self.repo.index.diff(None)] + [
                 z for z in self.repo.untracked_files
             ]:
                 print("git-sim error: No modified file with name: '" + name + "'")
                 sys.exit()
 
-    def execute(self):
+    def construct(self):
         print(
-            "Simulating: git "
-            + self.scene.args.subcommand
-            + " "
-            + " ".join(self.scene.args.name)
+            "Simulating: git " + self.args.subcommand + " " + " ".join(self.args.name)
         )
 
         self.show_intro()
@@ -55,11 +53,11 @@ def populate_zones(
         for x in self.repo.index.diff(None):
             if "git-sim_media" not in x.a_path:
                 secondColumnFileNames.add(x.a_path)
-                for name in self.scene.args.name:
+                for name in self.args.name:
                     if name == x.a_path:
                         thirdColumnFileNames.add(x.a_path)
                         secondColumnArrowMap[x.a_path] = m.Arrow(
-                            stroke_width=3, color=self.scene.fontColor
+                            stroke_width=3, color=self.fontColor
                         )
         try:
             for y in self.repo.index.diff("HEAD"):
@@ -73,9 +71,9 @@ def populate_zones(
         for z in self.repo.untracked_files:
             if "git-sim_media" not in z:
                 firstColumnFileNames.add(z)
-                for name in self.scene.args.name:
+                for name in self.args.name:
                     if name == z:
                         thirdColumnFileNames.add(z)
                         firstColumnArrowMap[z] = m.Arrow(
-                            stroke_width=3, color=self.scene.fontColor
+                            stroke_width=3, color=self.fontColor
                         )