Merge branch 'main' into add-support-for-webm-output

Author: abhijitnathwani

README.md

@@ -82,19 +82,20 @@ $ git-sim [global options] <subcommand> [subcommand options]
 The `[global options]` apply to the overarching `git-sim` simulation itself, including:
 
 `--light-mode`: Use a light mode color scheme instead of default dark mode.
-`--animate`: Instead of outputting a static image, animate the Git command behavior in a .mp4 video.
-`--reverse`: Display commit history in the reverse direction.
+`--animate`: Instead of outputting a static image, animate the Git command behavior in a .mp4 video. 
+`--disable-auto-open, -d`: Disable the automatic opening of the image/video file after generation.
+`--reverse, -r`: Display commit history in the reverse direction.
 `--video-format`: Output format for the video file, i.e. `mp4` or `webm`. Default output format is `mp4`.
 
 Animation-only global options (to be used in conjunction with `--animate`):
 
-`--speed=n`: Set the multiple of animation speed of the output simulation, `n` can be an integer or float, default is 1.
-`--low-quality`: Render the animation in low quality to speed up creation time, recommended for non-presentation use.
-`--show-intro`: Add an intro sequence with custom logo and title.
-`--show-outro`: Add an outro sequence with custom logo and text.
-`--title=title`: Custom title to display at the beginning of the animation.
-`--logo=logo.png`: The path to a custom logo to use in the animation intro/outro.
-`--outro-top-text`: Custom text to display above the logo during the outro.
+`--speed=n`: Set the multiple of animation speed of the output simulation, `n` can be an integer or float, default is 1.  
+`--low-quality`: Render the animation in low quality to speed up creation time, recommended for non-presentation use.  
+`--show-intro`: Add an intro sequence with custom logo and title.  
+`--show-outro`: Add an outro sequence with custom logo and text.  
+`--title=title`: Custom title to display at the beginning of the animation.  
+`--logo=logo.png`: The path to a custom logo to use in the animation intro/outro.  
+`--outro-top-text`: Custom text to display above the logo during the outro.  
 `--outro-bottom-text`: Custom text to display below the logo during the outro.
 
 The `[subcommand options]` are like regular Git options specific to the specified subcommand (see below for a full list).
@@ -141,6 +142,7 @@ Usage: `git-sim commit -m "Commit message"`
 - Specify your commit message after the -m option
 - HEAD and the active branch will be moved to the new commit
 - Simulated output will show files in the staging area being included in the new commit
+- Supports amending the last commit with: `$ git-sim commit --amend -m "Amended commit message"`
 
 ![git-sim-commit_01-05-23_22-10-21](https://user-images.githubusercontent.com/49353917/210941149-d83677a1-3ab7-4880-bc0f-871b1f150087.jpg)
 

git_sim/__main__.py

@@ -140,6 +140,11 @@ def main():
         type=str,
         default="New commit",
     )
+    commit.add_argument(
+        "--amend",
+        help="Amend the last commit message, must be used with the -m flag",
+        action="store_true",
+    )
 
     stash = subparsers.add_parser("stash", help="stash -h")
     stash.add_argument(
@@ -279,6 +284,9 @@ def main():
                 os.path.join(config.media_dir, "images"), image_file_name
             )
             cv2.imwrite(image_file_path, image)
+            print("Output image location:", image_file_path)
+    else:
+        print("Output video location:", scene.renderer.file_writer.movie_file_path)
 
     if not args.disable_auto_open:
         try:

git_sim/git_sim_base_command.py

@@ -13,6 +13,7 @@ def __init__(self, scene):
 
         self.drawnCommits = {}
         self.drawnRefs = {}
+        self.drawnCommitIds = {}
         self.commits = []
         self.zoomOuts = 0
         self.toFadeOut = m.Group()
@@ -219,6 +220,9 @@ def draw_commit(
         )
         commitId.next_to(circle, m.UP)
 
+        if commit != "dark":
+            self.drawnCommitIds[commit.hexsha] = commitId
+
         message = m.Text(
             "\n".join(
                 commitMessage[j : j + 20] for j in range(0, len(commitMessage), 20)
@@ -256,7 +260,11 @@ def build_commit_id_and_message(self, commit, dots=False):
                 "", font="Monospace", font_size=20, color=self.scene.fontColor
             )
             commitMessage = ""
-        elif dots and commit.hexsha == self.commits[-1].hexsha:
+        elif (
+            dots
+            and self.commits[-1] != "dark"
+            and commit.hexsha == self.commits[-1].hexsha
+        ):
             commitId = m.Text(
                 "...", font="Monospace", font_size=20, color=self.scene.fontColor
             )
@@ -297,13 +305,26 @@ def draw_head(self, commit, commitId):
 
     def draw_branch(self, commit):
         x = 0
-        branches = [branch.name for branch in self.repo.heads]
+
+        remote_tracking_branches = self.get_remote_tracking_branches()
+
+        branches = [branch.name for branch in self.repo.heads] + list(
+            remote_tracking_branches.keys()
+        )
+
         for selected_branch in self.selected_branches:
             branches.insert(0, branches.pop(branches.index(selected_branch)))
 
         for branch in branches:
-
-            if commit.hexsha == self.repo.heads[branch].commit.hexsha:
+            # Use forward slash to check if branch is local or remote tracking
+            # and draw the branch label if its hexsha matches the current commit
+            if (
+                "/" not in branch  # local branch
+                and commit.hexsha == self.repo.heads[branch].commit.hexsha
+            ) or (
+                "/" in branch  # remote tracking branch
+                and commit.hexsha == remote_tracking_branches[branch]
+            ):
                 branchText = m.Text(
                     branch, font="Monospace", font_size=20, color=self.scene.fontColor
                 )
@@ -924,6 +945,15 @@ def draw_dark_ref(self):
     def trim_path(self, path):
         return (path[:5] + "..." + path[-15:]) if len(path) > 20 else path
 
+    def get_remote_tracking_branches(self):
+        remote_refs = [remote.refs for remote in self.repo.remotes]
+        remote_tracking_branches = {}
+        for reflist in remote_refs:
+            for ref in reflist:
+                if "HEAD" not in ref.name and ref.name not in remote_tracking_branches:
+                    remote_tracking_branches[ref.name] = ref.commit.hexsha
+        return remote_tracking_branches
+
 
 class DottedLine(m.Line):
     def __init__(self, *args, dot_spacing=0.4, dot_kwargs={}, **kwargs):

git_sim/git_sim_commit.py

@@ -11,38 +11,69 @@ class GitSimCommit(GitSimBaseCommand):
     def __init__(self, scene):
         super().__init__(scene)
         self.maxrefs = 2
-        self.defaultNumCommits = 4
-        self.numCommits = 4
+        self.defaultNumCommits = 4 if not self.scene.args.amend else 5
+        self.numCommits = 4 if not self.scene.args.amend else 5
         self.hide_first_tag = True
 
         try:
             self.selected_branches.append(self.repo.active_branch.name)
         except TypeError:
             pass
 
+        if self.scene.args.amend and self.scene.args.message == "New commit":
+            print(
+                "git-sim error: The --amend flag must be used with the -m flag to specify the amended commit message."
+            )
+            sys.exit(1)
+
     def execute(self):
         print(
             "Simulating: git "
             + self.scene.args.subcommand
+            + (" --amend" if self.scene.args.amend else "")
             + ' -m "'
             + self.scene.args.message
             + '"'
         )
 
         self.show_intro()
         self.get_commits()
+
+        if self.scene.args.amend:
+            tree = self.repo.tree()
+            amended = git.Commit.create_from_tree(
+                self.repo,
+                tree,
+                self.scene.args.message,
+            )
+            self.commits[0] = amended
+
         self.parse_commits(self.commits[self.i])
         self.center_frame_on_commit(self.commits[0])
-        self.setup_and_draw_parent(self.commits[0], self.scene.args.message)
+
+        if not self.scene.args.amend:
+            self.setup_and_draw_parent(self.commits[0], self.scene.args.message)
+        else:
+            self.draw_ref(self.commits[0], self.drawnCommitIds[amended.hexsha])
+            self.draw_ref(
+                self.commits[0],
+                self.drawnRefs["HEAD"],
+                text=self.repo.active_branch.name,
+                color=m.GREEN,
+            )
+
         self.recenter_frame()
         self.scale_frame()
-        self.reset_head_branch("abcdef")
-        self.vsplit_frame()
-        self.setup_and_draw_zones(
-            first_column_name="Working directory",
-            second_column_name="Staging area",
-            third_column_name="New commit",
-        )
+
+        if not self.scene.args.amend:
+            self.reset_head_branch("abcdef")
+            self.vsplit_frame()
+            self.setup_and_draw_zones(
+                first_column_name="Working directory",
+                second_column_name="Staging area",
+                third_column_name="New commit",
+            )
+
         self.fadeout()
         self.show_outro()
 

git_sim/git_sim_merge.py

@@ -56,10 +56,17 @@ def execute(self):
         self.orig_commits = self.commits
         self.get_commits(start=self.scene.args.branch[0])
 
-        if self.scene.args.branch[0] in self.repo.git.branch(
-            "--contains", self.orig_commits[0].hexsha
-        ):
-            self.ff = True
+        # Use forward slash to determine if supplied branch arg is local or remote tracking branch
+        if "/" not in self.scene.args.branch[0]:
+            if self.scene.args.branch[0] in self.repo.git.branch(
+                "--contains", self.orig_commits[0].hexsha
+            ):
+                self.ff = True
+        else:
+            if self.scene.args.branch[0] in self.repo.git.branch(
+                "-r", "--contains", self.orig_commits[0].hexsha
+            ):
+                self.ff = True
 
         if self.ff:
             self.get_commits(start=self.scene.args.branch[0])
@@ -83,7 +90,7 @@ def execute(self):
                 )
                 self.draw_ref(
                     self.commits[0],
-                    self.drawnRefs["HEAD"] if self.scene.args.no_ff else self.topref,
+                    self.drawnRefs["HEAD"],
                     text=self.repo.active_branch.name,
                     color=m.GREEN,
                 )

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="git-sim",
-    version="0.1.6",
+    version="0.1.7",
     author="Jacob Stopak",
     author_email="jacob@initialcommit.io",
     description="Simulate Git commands on your own repos by generating an image (default) or video visualization depicting the command's behavior.",