Refactor numCommits variable to a more general n

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

Author: initialcommit-io

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",
@@ -117,6 +122,7 @@ def main(
     ),
 ):
     settings.animate = animate
+    settings.n = n
     settings.auto_open = auto_open
     settings.img_format = img_format
     settings.light_mode = light_mode

git_sim/commit.py

@@ -15,8 +15,9 @@ 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_chains = True
 

git_sim/git_sim_base_command.py

@@ -25,8 +25,9 @@ def __init__(self):
         self.trimmed = False
         self.prevRef = None
         self.topref = None
-        self.numCommits = settings.commits
-        self.defaultNumCommits = settings.commits
+        self.n_default = settings.n_default
+        self.n = settings.n
+        self.n_orig = self.n
         self.selected_branches = []
         self.stop = False
         self.zone_title_offset = 2.6 if platform.system() == "Windows" else 2.6
@@ -50,9 +51,9 @@ def construct(self):
         self.show_outro()
 
     def get_commits(self, start="HEAD"):
-        if not self.numCommits:
+        if not self.n:
             if settings.allow_no_commits:
-                self.numCommits = self.defaultNumCommits
+                self.n = self.n_default
                 self.commits = ["dark"] * 5
                 self.zone_title_offset = 2
                 return
@@ -63,29 +64,27 @@ def get_commits(self, start="HEAD"):
         try:
             self.commits = (
                 list(self.repo.iter_commits(start))
-                if self.numCommits == 1
+                if self.n == 1
                 else list(
-                    self.repo.iter_commits(
-                        start + "~" + str(self.numCommits) + "..." + start
-                    )
+                    self.repo.iter_commits(start + "~" + str(self.n) + "..." + start)
                 )
             )
-            if len(self.commits) < self.defaultNumCommits:
+            if len(self.commits) < self.n_default:
                 self.commits = list(self.repo.iter_commits(start))
-            while len(self.commits) < self.defaultNumCommits:
+            while len(self.commits) < self.n_default:
                 self.commits.append(self.create_dark_commit())
-            self.numCommits = self.defaultNumCommits
+            self.n = self.n_orig
 
         except GitCommandError:
-            self.numCommits -= 1
+            self.n -= 1
             self.get_commits(start=start)
 
     def parse_commits(
         self, commit, i, prevCircle=None, shift=numpy.array([0.0, 0.0, 0.0])
     ):
         isNewCommit = commit.hexsha not in self.drawnCommits
 
-        if i < self.numCommits and commit in self.commits:
+        if i < self.n and commit in self.commits:
             commitId, circle, arrow, hide_refs = self.draw_commit(
                 commit, i, prevCircle, shift
             )
@@ -113,7 +112,7 @@ def parse_commits(
                 if i == 0 and len(self.drawnRefs) < 2:
                     self.draw_dark_ref()
 
-            if i < self.numCommits:  # len(self.commits) - 1:
+            if i < self.n:
                 i += 1
                 commitParents = list(commit.parents)
                 if len(commitParents) > 0:

git_sim/log.py

@@ -8,10 +8,18 @@
 
 
 class Log(GitSimBaseCommand):
-    def __init__(self, commits: int, all: bool):
+    def __init__(self, ctx: typer.Context, n: int, all: bool):
         super().__init__()
-        self.numCommits = commits
-        self.defaultNumCommits = commits
+
+        n_command = ctx.parent.params.get("n")
+        n_subcommand = n
+        if n_subcommand:
+            n = n_subcommand
+        else:
+            n = n_command
+        self.n = n
+        self.n_orig = self.n
+
         try:
             self.selected_branches.append(self.repo.active_branch.name)
         except TypeError:
@@ -37,15 +45,17 @@ def construct(self):
 
 
 def log(
-    commits: int = typer.Option(
-        default=settings.commits,
-        help="The number of commits to display in the simulated log output",
+    ctx: typer.Context,
+    n: int = typer.Option(
+        settings.n_subcommand,
+        "-n",
+        help="Number of commits to display from branch heads",
         min=1,
     ),
     all: bool = typer.Option(
-        default=False,
+        False,
         help="Display all local branches in the log output",
     ),
 ):
-    scene = Log(commits=commits, all=all)
+    scene = Log(ctx=ctx, n=n, all=all)
     handle_animations(scene=scene)

git_sim/revert.py

@@ -25,8 +25,9 @@ def __init__(self, commit: str):
             )
             sys.exit(1)
 
-        self.defaultNumCommits = 4
-        self.numCommits = 4
+        self.n_default = 4
+        self.n = self.n_default
+
         self.hide_first_tag = True
         self.zone_title_offset += 0.1
 

git_sim/settings.py

@@ -19,7 +19,9 @@ class Settings(BaseSettings):
     allow_no_commits = False
     animate = False
     auto_open = True
-    commits = 5
+    n_default = 5
+    n = 5
+    n_subcommand: Union[int, None] = None
     files: Union[List[pathlib.Path], None] = None
     hide_first_tag = False
     img_format: ImgFormat = ImgFormat.jpg