Merge branch 'diverse-branching-structure'

Signed-off-by: Jacob Stopak <[email protected]>

Author: initialcommit-io

README.md

@@ -133,10 +133,14 @@ $ 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.  
+`--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.  
@@ -160,9 +164,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)
 

git_sim/__main__.py

@@ -32,6 +32,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",
@@ -116,9 +121,21 @@ def main(
         "--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",
     ),
 ):
     settings.animate = animate
+    settings.n = n
     settings.auto_open = auto_open
     settings.img_format = img_format
     settings.light_mode = light_mode
@@ -138,6 +155,9 @@ def main(
     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
 
     if sys.platform == "linux" or sys.platform == "darwin":
         repo_name = git.repo.Repo(

git_sim/add.py

@@ -16,6 +16,7 @@ def __init__(self, files: List[str]):
         self.hide_first_tag = True
         self.allow_no_commits = True
         self.files = files
+        settings.hide_merged_branches = True
 
         try:
             self.selected_branches.append(self.repo.active_branch.name)
@@ -36,8 +37,7 @@ def construct(self):
             )
 
         self.show_intro()
-        self.get_commits()
-        self.parse_commits(self.commits[0])
+        self.parse_commits()
         self.recenter_frame()
         self.scale_frame()
         self.vsplit_frame()

git_sim/branch.py

@@ -16,10 +16,9 @@ def construct(self):
             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,8 @@ def construct(self):
         self.toFadeOut.add(branchRec, branchText)
         self.drawnRefs[self.name] = fullbranch
 
+        self.recenter_frame()
+        self.scale_frame()
         self.fadeout()
         self.show_outro()
 

git_sim/cherrypick.py

@@ -53,17 +53,17 @@ 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")

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)
@@ -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,