From 55cacf1c890c47f99a3e9c9dbd86a8fffe464568 Mon Sep 17 00:00:00 2001 From: Alex Palaistras Date: Sat, 31 Dec 2016 18:19:50 +0000 Subject: [PATCH] Fix bugs, styling, README.md --- README.md | 47 ++++++++++++--- grawkit | 98 +++++++++++++++++++------------ tests/01-initial.svg | 13 +---- tests/02-master.svg | 14 ++--- tests/03-branch.svg | 28 ++++----- tests/04-merge.svg | 37 ++++++------ tests/05-multi-branch.svg | 73 +++++++++++++++--------- tests/06-feature-branch.svg | 111 ++++++++++++++++++++++++++++++++++++ 8 files changed, 300 insertions(+), 121 deletions(-) create mode 100644 tests/06-feature-branch.svg diff --git a/README.md b/README.md index 2d1ee7d..5329e4b 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Grawkit has basic support for common `git` commands such as `git branch`, `git t 
git commit -m "Adding a new commit"
 git commit
- Master Branch + 
git commit -m "Commit on master"
@@ -34,13 +34,12 @@ git commit
 
 git checkout master
 git commit
- Simple Branching + - 

-git commit -m "Commit on master"
+		
git branch test-merging
 
-git branch test-merging
+git commit -m "Commit on master"
 git commit -m "Still on master"
 
 git checkout test-merging
@@ -50,7 +49,7 @@ git checkout master
 git commit -m "Another master commit"
 
 git merge test-merging

-		Simple Merging
+		
 	
 	
 		
git commit -m "Commit on master"
@@ -64,14 +63,46 @@ git tag v.1.0.0
 git checkout test-first
 git commit
 
+git branch test-third
+
 git checkout test-second
 git commit
 git merge test-first
 git tag v.2.0.0-rc1
 
 git checkout master
-git merge test-second

-		Merging and Tagging Multiple Branches
+git merge test-second
+
+git checkout test-third
+git commit
+ + + + 
git branch develop
+git checkout develop
+git commit
+
+git branch feature/XYZ-12_fix-foo
+git checkout feature/XYZ-12_fix-foo
+git commit
+git commit
+
+git checkout develop
+git branch feature/ZZ-704_take-it-to-the-limit
+git checkout feature/ZZ-704_take-it-to-the-limit
+git commit
+
+git checkout develop
+git merge feature/XYZ-12_fix-foo
+
+git branch feature/ABC-66_make-bar
+git checkout feature/ABC-66_make-bar
+git commit
+git commit
+
+git checkout develop
+git merge feature/ZZ-704_take-it-to-the-limit
+ diff --git a/grawkit b/grawkit index b98484e..cc7b2da 100755 --- a/grawkit +++ b/grawkit @@ -20,17 +20,25 @@ function addbranch(name) { branches[len["branches"],"name"] = name branches[len["branches"],"refs"] = "" - branches[len["branches"],"merges"] = state["branch"] "|" state["HEAD"] branches[len["branches"],"tags"] = "" + # Branches created before the first commit is established extend to the + # beginning of time. + if (state["HEAD"] != "") { + branches[len["branches"],"merges"] = state["branch"] "|" state["HEAD"] + } else { + branches[len["branches"],"merges"] = len["branches"] "|0" + } + len["branches"] += 1 } -# > Function `addcommit` adds a new commit, with a specific message, to the -# > internal list of commits to render. -function addcommit(message) { +# > Function `addcommit` adds a new commit, with a specific type and message, +# > to the internal list of commits to render. +function addcommit(type, message) { # Add commit information. - commits[len["commits"],"message"] = msg + commits[len["commits"],"type"] = type + commits[len["commits"],"message"] = message # Update commit references. if (branches[state["branch"],"refs"] == "") { @@ -43,6 +51,12 @@ function addcommit(message) { len["commits"] += 1 } +# > Function `normalize` removes invalid characters and makes string lower-case. +function normalize(text) { + text = gensub("[/_. ]", "-", "g", tolower(text)) + return text +} + # > Function `branch` renders pre-defined branch under a specific name to its # > SVG representation. function branch(idx, _, buf, tmp, refs, tags, t, i, hspc, vspc) { @@ -56,7 +70,7 @@ function branch(idx, _, buf, tmp, refs, tags, t, i, hspc, vspc) { hspc = idx * style["branch/spacing"] # Print branch root element. - buf = sprintf(svg["g"], "branch-" branches[idx,"name"]) + buf = "\n" sprintf(svg["g"], "branch-" normalize(branches[idx,"name"])) # Add path for branch. tmp = "M" hspc "," refs[1] * style["commit/spacing"] @@ -89,9 +103,11 @@ function branch(idx, _, buf, tmp, refs, tags, t, i, hspc, vspc) { # > Function `label` adds a sidebar label at commit index, with a specific class # > and label name. Multiple labels for the same index will be placed side-by-side. function label(idx, class, name, _, buf, w, h, hspc, vspc) { - # Calculate width and height for label rectangle. - w = (style["label/spacing"] * length(name)) + style["label/spacing"] - h = style["label/spacing"] * 2.5 + # Calculate width and height for label rectangle. Pitch size is set to 0.525 + # here, which is approximately right for 'Inconsolata', but may vary for other + # fonts, as fixed width fonts are usually twice as tall as they are wide. + w = ((style["label/font-size"] * 0.525) * length(name)) + style["label/spacing"] + h = style["label/font-size"] + style["label/spacing"] # Calculate label offsets. hspc = (len["branches"] * style["branch/spacing"]) + label_offset[idx] @@ -102,8 +118,8 @@ function label(idx, class, name, _, buf, w, h, hspc, vspc) { # Draw label elements. buf = buf "\n\t" sprintf(svg["gg"], "label-" class, hspc, vspc) - buf = buf "\n\t\t" sprintf(svg["rect"], 0, style["label/spacing"] * -1.5, w, h, style["label/round"]) - buf = buf "\n\t\t" sprintf(svg["text"], style["label/spacing"], style["label/spacing"] / 4, name) + buf = buf "\n\t\t" sprintf(svg["rect"], 0, style["label/font-size"] * -1, w, h, style["label/round"]) + buf = buf "\n\t\t" sprintf(svg["text"], style["label/spacing"] / 2, style["label/spacing"] / 4, name) buf = buf "\n\t" svg["/g"] return buf @@ -121,10 +137,11 @@ function merge(idx, _, buf, tmp, refs, fields, m, i, hspc) { hspc = idx * style["branch/spacing"] # Print branch root element. - buf = "\n\t" sprintf(svg["g"], "branch-" branches[idx,"name"]) + buf = "\n\t" sprintf(svg["g"], normalize("branch-" branches[idx,"name"])) # Add merge paths for branch, if any. split(branches[idx,"merges"], fields, ",") + for (i in fields) { split(fields[i], m, "|") @@ -150,15 +167,16 @@ function merge(idx, _, buf, tmp, refs, fields, m, i, hspc) { BEGIN { # Errors. - error["branch/no-name"] = "Empty name for `git branch`, line %d\n" - error["branch/duplicate"] = "Unable to create duplicate branch '%s', line %d\n" + error["branch/no-name"] = "Empty name for `git branch`, line %d\n" + error["branch/duplicate"] = "Unable to create duplicate branch '%s', line %d\n" + error["checkout/no-branch"] = "No branch with name '%s', line %d\n" + error["checkout/no-name"] = "Empty name for `git checkout`, line %d\n" - error["checkout/no-name"] = "Empty name for `git checkout`, line %d\n" - error["merge/no-name"] = "Empty name for `git merge`, line %d\n" - error["label/no-name"] = "Empty name for `git tag`, line %d\n" + error["merge/no-name"] = "Empty name for `git merge`, line %d\n" + error["label/no-name"] = "Empty name for `git tag`, line %d\n" - # rule matching. + # Rule matching. rule["commit"] = "^git commit" rule["commit/message"] = "(--message|-m)[ ]+['|\"]([^'\"]+)['|\"]" @@ -189,7 +207,7 @@ BEGIN { style["label/fill"] = "#333" style["label/text"] = "#fff" style["label/font"] = "Inconsolata, Consolas, monospace" - style["label/font-size"] = "18px" + style["label/font-size"] = "14" # Color scheme, based on `base16-solarized-dark` style["pallete"] = "#002b36,#268bd2,#859900,#cb4b16,#2aa198,#dc322f,#d33682,#6c71c4,#b58900" @@ -207,18 +225,19 @@ BEGIN { # Branch definitions. branches[0,"name"] = "master" - branches[0,"refs"] = 0 + branches[0,"refs"] = "" branches[0,"merges"] = "" branches[0,"tags"] = "" len["branches"] = 1 # Commit definitions. - commits[0,"message"] = "Initial commit" - len["commits"] = 1 + commits[0,"type"] = "" + commits[0,"message"] = "" + len["commits"] = 0 # Tracks the state across calls. state["branch"] = 0 - state["HEAD"] = 0 + state["HEAD"] = "" } # Rule Definitions @@ -234,7 +253,7 @@ $0 ~ rule["commit"] { match($0, rule["commit/message"], m) # Add new commit. - addcommit((2 in m) ? m[2] : "Empty message") + addcommit("commit", (2 in m) ? m[2] : "Empty message") next } @@ -285,6 +304,10 @@ $0 ~ rule["checkout"] { # Set internal state. state["branch"] = i + + split(branches[i,"refs"], refs, ",") + state["HEAD"] = refs[length(refs)] + next } @@ -312,7 +335,7 @@ $0 ~ rule["merge"] { } # Add a merge commit to current branch. - addcommit("Merge commit") + addcommit("merge", "Merge commit") # Add merge reference to target branch. if (branches[i,"merges"] == "") { @@ -350,7 +373,7 @@ $0 ~ rule["tag"] { # internal state, as defined in the command-line provided. END { - # Pre-build SVG body. + w = 0 body = "" # Print merge paths for branches. @@ -365,24 +388,27 @@ END { # Print each branch and corresponding commits in turn. for (i = len["branches"] - 1; i >= 0; i--) { - body = body "\n" branch(i) + body = body branch(i) } - # Calculate SVG canvas dimensions. - h = (style["commit/spacing"] * (len["commits"] - 1)) + (style["commit/stroke-width"] * 4) - xy = style["branch/stroke-width"] * -1 + # Calculate SVG canvas size, removing `master` branch from X offset if it + # contains no commits. + x = style["branch/stroke-width"] * -1 + x += (branches[0,"refs"] == "") ? style["branch/spacing"] : 0 + y = style["branch/stroke-width"] * -1 # Calculate canvas width from largest combined label offset. - w = 0 - for (i in label_offset) { w = (label_offset[i] > w) ? label_offset[i] : w; } w += style["branch/spacing"] * len["branches"] + w -= (branches[0,"refs"] == "") ? style["branch/spacing"] : 0 + + h = (style["commit/spacing"] * (len["commits"] - 1)) + (style["commit/stroke-width"] * 4) # Print SVG header. - printf svg["svg"], xy, xy, w, h + printf svg["svg"], x, y, w, h printf "\n" # Print inline style definitions. @@ -390,6 +416,7 @@ END { print ".branch {" print "\tfill: " style["branch/fill"] ";" print "\tstroke-width: " style["branch/stroke-width"] ";" + print "\tstroke-linecap: round;" print "}" print ".commit {" print "\tfill: " style["commit/fill"] ";" @@ -403,7 +430,7 @@ END { print "}" print ".label-text {" print "\tfont-family: " style["label/font"] ";" - print "\tfont-size: " style["label/font-size"] ";" + print "\tfont-size: " style["label/font-size"] "px;" print "\tfill: " style["label/text"] ";" print "\tstroke: none;" print "}" @@ -412,7 +439,8 @@ END { # Print color scheme definitions for branches. for (i = 0; i < len["branches"]; i++) { - print ".branch-" branches[i,"name"] " {stroke: " pallete[i + 1] "; fill: " pallete[i + 1] "}" + printf ".branch-" normalize(branches[i,"name"]) " {" + printf "stroke: " pallete[i + 1] "; fill: " pallete[i + 1] "}\n" } print "]]>" diff --git a/tests/01-initial.svg b/tests/01-initial.svg index ff4ae5e..71bc334 100644 --- a/tests/01-initial.svg +++ b/tests/01-initial.svg @@ -4,11 +4,12 @@ --> - + - - - - - - master - - diff --git a/tests/02-master.svg b/tests/02-master.svg index 5c1066d..4d3b923 100644 --- a/tests/02-master.svg +++ b/tests/02-master.svg @@ -7,11 +7,12 @@ git commit --> - + - + - - - - master + + + master diff --git a/tests/03-branch.svg b/tests/03-branch.svg index fbab5c1..a215b5d 100644 --- a/tests/03-branch.svg +++ b/tests/03-branch.svg @@ -18,11 +18,12 @@ git commit --> - + - + - + + - - - - test-stuff + + + test-stuff - + - - - - - master + + + + master diff --git a/tests/04-merge.svg b/tests/04-merge.svg index 37d8325..7132113 100644 --- a/tests/04-merge.svg +++ b/tests/04-merge.svg @@ -1,11 +1,10 @@ - + - - + + - - - - - test-merging + + + + + test-merging - + - + - - - - master + + + master diff --git a/tests/05-multi-branch.svg b/tests/05-multi-branch.svg index 5c7036b..80f6c54 100644 --- a/tests/05-multi-branch.svg +++ b/tests/05-multi-branch.svg @@ -13,6 +13,8 @@ git tag v.1.0.0 git checkout test-first git commit +git branch test-third + git checkout test-second git commit git merge test-first @@ -21,13 +23,17 @@ git tag v.2.0.0-rc1 git checkout master git merge test-second +git checkout test-third +git commit + --> - + + + + - - + + - - + + + + + + + + + + test-third - + + - - - - v.2.0.0-rc1 + + + v.2.0.0-rc1 - - - test-second + + + test-second - - - - - test-first + + + + + test-first - + - - - - - v.1.0.0 + + + + v.1.0.0 - - - master + + + master diff --git a/tests/06-feature-branch.svg b/tests/06-feature-branch.svg new file mode 100644 index 0000000..c81a460 --- /dev/null +++ b/tests/06-feature-branch.svg @@ -0,0 +1,111 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + feature/ABC-66_make-bar + + + + + + + + feature/ZZ-704_take-it-to-the-limit + + + + + + + + + feature/XYZ-12_fix-foo + + + + + + + + + + develop + + +