Merge branch 'main' into switch

Signed-off-by: Jacob Stopak <jacob@initialcommit.io>

Author: initialcommit-io

README.md

@@ -28,6 +28,7 @@ Example: `$ git-sim merge <branch>`
 - Run a one-liner git-sim command in the terminal to generate a custom Git command visualization (.jpg) from your repo
 - Supported commands: `log`, `status`, `add`, `restore`, `commit`, `stash`, `branch`, `tag`, `reset`, `revert`, `merge`, `rebase`, `cherry-pick`
 - Generate an animated video (.mp4) instead of a static image using the `--animate` flag (note: significant performance slowdown, it is recommended to use `--low-quality` to speed up testing and remove when ready to generate presentation-quality video)
+- Color commits by parameter, such as author the `--color-by=author` option
 - Choose between dark mode (default) and light mode
 - Specify output formats of either jpg, png, mp4, or webm
 - Combine with bundled command [git-dummy](https://github.com/initialcommit-com/git-dummy) to generate a dummy Git repo and then simulate operations on it
@@ -133,13 +134,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.  
+`-n <number>`: Number of commits to display from each branch head.  
+`--all`: Display all local branches in the log output.  
 `--animate`: Instead of outputting a static image, animate the Git command behavior in a .mp4 video.  
+`--color-by author`: Color commits by parameter, such as author.  
+`--invert-branches`: Invert positioning of branches by reversing order of multiple parents where applicable.  
+`--hide-merged-branches`: Hide commits from merged branches, i.e. only display mainline commits.  
 `--media-dir`: The path at which to store the simulated output media files.  
 `-d`: Disable the automatic opening of the image/video file after generation. Useful to avoid errors in console mode with no GUI.  
+`--light-mode`: Use a light mode color scheme instead of default dark mode.  
 `--reverse, -r`: Display commit history in the reverse direction.  
 `--img-format`: Output format for the image file, i.e. `jpg` or `png`. Default output format is `jpg`.  
-`--stdout`: Write raw image data to stdout while suppressing all other program output.
+`--stdout`: Write raw image data to stdout while suppressing all other program output.  
+`--output-only-path`: Only output the path to the generated media file to stdout. Useful for other programs to ingest.  
+`--quiet, -q`: Suppress all output except errors.
 
 Animation-only global options (to be used in conjunction with `--animate`):
 
@@ -158,9 +166,11 @@ The `[subcommand options]` are like regular Git options specific to the specifie
 The following is a list of Git commands that can be simulated and their corresponding options/flags.
 
 ### git log
-Usage: `git-sim log`
+Usage: `git-sim log [-n <number>] [--all]`
 
 - Simulated output will show the most recent 5 commits on the active branch by default
+- Use `-n <number>` to set number of commits to display from each branch head
+- Set `--all` to display all local branches in the log output
 
 ![git-sim-log_01-05-23_22-02-39](https://user-images.githubusercontent.com/49353917/210940300-aadd14c6-72ab-4529-a1be-b494ed5dd4c9.jpg)
 
@@ -445,7 +455,7 @@ $ docker build -t git-sim .
 Optional: On MacOS / Linux / or GitBash in Windows, create an alias for the long docker command so your can run it as a normal `git-sim` command. To do so add the following line to your `.bashrc` or equivalent, then restart your terminal:
 
 ```bash
-git-sim() { docker run --rm -v $(pwd):/usr/src/git-sim git-sim "$@" }
+git-sim() { docker run --rm -v $(pwd):/usr/src/git-sim git-sim "$@"; }
 ```
 
 This will enable you to run git-sim subcommands as [described above](#commands).

git_sim/__main__.py

@@ -33,6 +33,11 @@ def main(
         settings.animate,
         help="Animate the simulation and output as an mp4 video",
     ),
+    n: int = typer.Option(
+        settings.n,
+        "-n",
+        help="Number of commits to display from each branch head",
+    ),
     auto_open: bool = typer.Option(
         settings.auto_open,
         "--auto-open",
@@ -108,8 +113,35 @@ def main(
         settings.stdout,
         help="Write raw image data to stdout while suppressing all other program output",
     ),
+    output_only_path: bool = typer.Option(
+        settings.output_only_path,
+        help="Only output the path to the generated media file to stdout (useful for other programs to ingest)",
+    ),
+    quiet: bool = typer.Option(
+        settings.quiet,
+        "--quiet",
+        "-q",
+        help="Suppress all output except errors",
+    ),
+    invert_branches: bool = typer.Option(
+        settings.invert_branches,
+        help="Invert positioning of branches by reversing order of multiple parents where applicable",
+    ),
+    hide_merged_branches: bool = typer.Option(
+        settings.hide_merged_branches,
+        help="Hide commits from merged branches, i.e. only display mainline commits",
+    ),
+    all: bool = typer.Option(
+        settings.all,
+        help="Display all local branches in the log output",
+    ),
+    color_by: str = typer.Option(
+        settings.color_by,
+        help="Color commits by parameter, such as author",
+    ),
 ):
     settings.animate = animate
+    settings.n = n
     settings.auto_open = auto_open
     settings.img_format = img_format
     settings.light_mode = light_mode
@@ -127,6 +159,12 @@ def main(
     settings.title = title
     settings.video_format = video_format
     settings.stdout = stdout
+    settings.output_only_path = output_only_path
+    settings.quiet = quiet
+    settings.invert_branches = invert_branches
+    settings.hide_merged_branches = hide_merged_branches
+    settings.all = all
+    settings.color_by = color_by
 
     if sys.platform == "linux" or sys.platform == "darwin":
         repo_name = git.repo.Repo(

git_sim/add.py

@@ -16,6 +16,8 @@ def __init__(self, files: List[str]):
         self.hide_first_tag = True
         self.allow_no_commits = True
         self.files = files
+        settings.hide_merged_branches = True
+        self.n = self.n_default
 
         try:
             self.selected_branches.append(self.repo.active_branch.name)
@@ -30,14 +32,13 @@ def __init__(self, files: List[str]):
                 sys.exit()
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path and not settings.quiet:
             print(
                 f"{settings.INFO_STRING} {type(self).__name__.lower()} {' '.join(self.files)}"
             )
 
         self.show_intro()
-        self.get_commits()
-        self.parse_commits(self.commits[0])
+        self.parse_commits()
         self.recenter_frame()
         self.scale_frame()
         self.vsplit_frame()
@@ -89,5 +90,6 @@ def add(
         help="The names of one or more files to add to Git's staging area",
     )
 ):
+    settings.hide_first_tag = True
     scene = Add(files=files)
     handle_animations(scene=scene)

git_sim/animations.py

@@ -47,12 +47,23 @@ def handle_animations(scene: Scene) -> None:
                 os.path.join(settings.media_dir, "images"), image_file_name
             )
             cv2.imwrite(image_file_path, image)
-            if not settings.stdout:
+            if (
+                not settings.stdout
+                and not settings.output_only_path
+                and not settings.quiet
+            ):
                 print("Output image location:", image_file_path)
-            if settings.stdout:
+            elif (
+                not settings.stdout and settings.output_only_path and not settings.quiet
+            ):
+                print(image_file_path)
+            if settings.stdout and not settings.quiet:
                 sys.stdout.buffer.write(cv2.imencode(".jpg", image)[1].tobytes())
     else:
-        print("Output video location:", scene.renderer.file_writer.movie_file_path)
+        if not settings.stdout and not settings.output_only_path and not settings.quiet:
+            print("Output video location:", scene.renderer.file_writer.movie_file_path)
+        elif not settings.stdout and settings.output_only_path and not settings.quiet:
+            print(scene.renderer.file_writer.movie_file_path)
 
     if settings.auto_open and not settings.stdout:
         try:

git_sim/branch.py

@@ -12,14 +12,13 @@ def __init__(self, name: str):
         self.name = name
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path and not settings.quiet:
             print(f"{settings.INFO_STRING} {type(self).__name__.lower()} {self.name}")
 
         self.show_intro()
-        self.get_commits()
-        self.parse_commits(self.commits[0])
-        self.recenter_frame()
-        self.scale_frame()
+        self.parse_commits()
+        self.parse_all()
+        self.center_frame_on_commit(self.get_commit())
 
         branchText = m.Text(
             self.name,
@@ -48,6 +47,9 @@ def construct(self):
         self.toFadeOut.add(branchRec, branchText)
         self.drawnRefs[self.name] = fullbranch
 
+        self.recenter_frame()
+        self.scale_frame()
+        self.color_by()
         self.fadeout()
         self.show_outro()
 

git_sim/cherrypick.py

@@ -34,7 +34,7 @@ def __init__(self, commit: str, edit: str):
             pass
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path and not settings.quiet:
             print(
                 f"{settings.INFO_STRING} cherry-pick {self.commit}"
                 + ((' -e "' + self.edit + '"') if self.edit else "")
@@ -53,20 +53,21 @@ def construct(self):
             sys.exit(1)
 
         self.show_intro()
-        self.get_commits()
-        self.parse_commits(self.commits[0])
-        self.orig_commits = self.commits
-        self.get_commits(start=self.commit)
-        self.parse_commits(self.commits[0], shift=4 * m.DOWN)
-        self.center_frame_on_commit(self.orig_commits[0])
+        head_commit = self.get_commit()
+        self.parse_commits(head_commit)
+        cherry_picked_commit = self.get_commit(self.commit)
+        self.parse_commits(cherry_picked_commit, shift=4 * m.DOWN)
+        self.parse_all()
+        self.center_frame_on_commit(head_commit)
         self.setup_and_draw_parent(
-            self.orig_commits[0],
-            self.edit if self.edit else self.commits[0].message,
+            head_commit,
+            self.edit if self.edit else cherry_picked_commit.message,
         )
-        self.draw_arrow_between_commits(self.commits[0].hexsha, "abcdef")
+        self.draw_arrow_between_commits(cherry_picked_commit.hexsha, "abcdef")
         self.recenter_frame()
         self.scale_frame()
         self.reset_head_branch("abcdef")
+        self.color_by(offset=2)
         self.fadeout()
         self.show_outro()
 

git_sim/commit.py

@@ -15,9 +15,11 @@ def __init__(self, message: str, amend: bool):
         self.message = message
         self.amend = amend
 
-        self.defaultNumCommits = 4 if not self.amend else 5
-        self.numCommits = 4 if not self.amend else 5
+        self.n_default = 4 if not self.amend else 5
+        self.n = self.n_default
+
         self.hide_first_tag = True
+        settings.hide_merged_branches = True
 
         try:
             self.selected_branches.append(self.repo.active_branch.name)
@@ -31,7 +33,7 @@ def __init__(self, message: str, amend: bool):
             sys.exit(1)
 
     def construct(self):
-        if not settings.stdout:
+        if not settings.stdout and not settings.output_only_path and not settings.quiet:
             print(
                 f"{settings.INFO_STRING } {type(self).__name__.lower()} {'--amend ' if self.amend else ''}"
                 + '-m "'
@@ -40,7 +42,7 @@ def construct(self):
             )
 
         self.show_intro()
-        self.get_commits()
+        head_commit = self.get_commit()
 
         if self.amend:
             tree = self.repo.tree()
@@ -49,17 +51,17 @@ def construct(self):
                 tree,
                 self.message,
             )
-            self.commits[0] = amended
+            head_commit = amended
 
-        self.parse_commits(self.commits[self.i])
-        self.center_frame_on_commit(self.commits[0])
+        self.parse_commits(head_commit)
+        self.center_frame_on_commit(head_commit)
 
         if not self.amend:
-            self.setup_and_draw_parent(self.commits[0], self.message)
+            self.setup_and_draw_parent(head_commit, self.message)
         else:
-            self.draw_ref(self.commits[0], self.drawnCommitIds[amended.hexsha])
+            self.draw_ref(head_commit, self.drawnCommitIds[amended.hexsha])
             self.draw_ref(
-                self.commits[0],
+                head_commit,
                 self.drawnRefs["HEAD"],
                 text=self.repo.active_branch.name,
                 color=m.GREEN,
@@ -114,5 +116,6 @@ def commit(
         help="Amend the last commit message, must be used with the --message flag",
     ),
 ):
+    settings.hide_first_tag = True
     scene = Commit(message=message, amend=amend)
     handle_animations(scene=scene)