Merge pull request #167 from tomice/master

Update documentation for clarity

.gitignore

@@ -7,4 +7,7 @@
 .Spotlight*
 .Trash*
 **/*~
-nbproject/*
+nbproject/*
+/tests/test-git/.git/
+#/tests/test-git/*
+!/tests/test-git/resetgit

README.md

@@ -1,13 +1,13 @@
+# GIT quick statistics [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Simple%20and%20efficient%20way%20to%20access%20various%20statistics%20in%20git%20repository&url=https://github.com/arzzen/git-quick-stat&via=arzzen&hashtags=git,stats,tool,statistics,developers)
 
-# GIT quick statistics [![Backers on Open Collective](https://opencollective.com/git-quick-stats/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/git-quick-stats/sponsors/badge.svg)](#sponsors) [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Simple%20and%20efficient%20way%20to%20access%20various%20statistics%20in%20git%20repository&url=https://github.com/arzzen/git-quick-stat&via=arzzen&hashtags=git,stats,tool,statistics,developers) [![Travis](https://api.travis-ci.org/arzzen/git-quick-stats.svg?branch=master)](https://travis-ci.org/arzzen/git-quick-stats) [![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/git-quick-stats.svg)](https://formulae.brew.sh/formula/git-quick-stats#default) [![Linuxbrew package](https://repology.org/badge/version-for-repo/linuxbrew/git-quick-stats.svg)](https://repology.org/metapackage/git-quick-stats/packages)
+[![Backers on Open Collective](https://opencollective.com/git-quick-stats/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/git-quick-stats/sponsors/badge.svg)](#sponsors)  [![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/git-quick-stats.svg)](https://formulae.brew.sh/formula/git-quick-stats#default)
 
 > `git-quick-stats` is a simple and efficient way to access various statistics in a git repository.
 >
-> Any git repository may contain tons of information about commits, contributors, and files. Extracting this information is not always trivial, mostly because there are a gadzillion options to a gadzillion git commands – I don’t think there is a single person alive who knows them all. Probably not even [Linus Torvalds](https://github.com/torvalds) himself :).
+> Any git repository may contain tons of information about commits, contributors, and files. Extracting this information is not always trivial, mostly because there are a gadzillion options to a gadzillion git commands - I don't think there is a single person alive who knows them all. Probably not even [Linus Torvalds](https://github.com/torvalds) himself :).
 
 ![mainMenuScreenshot](https://user-images.githubusercontent.com/8818630/154823670-f42a111b-45f4-47fc-aea7-80059827c8e6.png)
 
-
 ## Table of Contents
 
 [**Screenshots**](#screenshots)
@@ -126,6 +126,8 @@ LIST OPTIONS
         displays a list of commits per month
     -w, --commits-by-weekday
         displays a list of commits per weekday
+    -W, --commits-by-author-by-weekday
+        displays a list of commits per weekday by author
     -o, --commits-by-hour
         displays a list of commits per hour
     -A, --commits-by-author-by-hour
@@ -155,7 +157,7 @@ Once set, run `git quick-stats` as normal. Note that this affects all stats that
 
 ### Git log limit
 
-You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options.
+You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options. The default limit is `10`.
 
 ```bash
 export _GIT_LIMIT=20
@@ -241,12 +243,28 @@ sudo make reinstall
 
 ### macOS (homebrew)
 
+macOS requires GNU coreutils to be installed and for the non "g" aliased
+versions to be exported to your path. The following is an example of how to
+perform this if you are using Homebrew as your package manager.
+
+```bash
+brew install coreutils
+export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
+```
+
+From there, you can install via Homebrew as follows:
+
 ```bash
 brew install git-quick-stats
 ```
 
 Or you can follow the UNIX and Linux instructions if you wish.
 
+If you would like to default to using the GNU coreutils (recommended), then you
+can add `export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"` to
+your applicable `~/.bash_profile`, `~/.zprofile`, or other relevant profile
+based on the shell of your choice.
+
 ### Windows
 
 If you are installing with Cygwin, use these scripts:
@@ -274,6 +292,7 @@ awk
 basename
 cat
 column
+date
 echo
 git
 grep
@@ -288,7 +307,11 @@ uniq
 
 ### Dependencies
 
-* [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
+* [`bsdextrautils`](https://packages.debian.org/sid/bsdextrautils) `apt install bsdextrautils`
+* [`coreutils`](https://packages.debian.org/sid/coreutils) `apt install coreutils`
+* [`gawk`](https://packages.debian.org/sid/gawk) `apt install gawk`
+* [`grep`](https://packages.debian.org/sid/grep) `apt install grep`
+* [`ncurses-bin`](https://packages.debian.org/sid/ncurses-bin) `apt install ncurses-bin`
 
 ## FAQ
 
@@ -370,6 +393,3 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 [![sponsor7](https://opencollective.com/git-quick-stats/sponsor/7/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/7/website)
 [![sponsor8](https://opencollective.com/git-quick-stats/sponsor/8/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/8/website)
 [![sponsor9](https://opencollective.com/git-quick-stats/sponsor/9/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/9/website)
-
-[![61999966](https://user-images.githubusercontent.com/6382002/130024560-65bb49a6-c7e9-48f9-8427-a29d8ff2a3db.png)](https://quaestor.com/?utm_source=github&utm_category=sponsor)
-

git-quick-stats

@@ -82,13 +82,29 @@ _theme="${_MENU_THEME:=default}"
 ################################################################################
 function checkUtils() {
     readonly MSG="not found. Please make sure this is installed and in PATH."
-    readonly UTILS="awk basename cat column echo git grep head printf seq sort \
-                    tput tr uniq"
+    readonly UTILS="awk basename cat column date echo git grep head printf seq \
+                    sort tput tr uniq"
 
     for u in $UTILS
     do
         command -v "$u" >/dev/null 2>&1 || { echo >&2 "$u ${MSG}"; exit 1; }
     done
+
+    # NOTE: The --version flag is only available in GNU date which is required
+    # for how the current date/time strings are used in this shell script.
+    # To fully support the legacy BSD date found in a default install within
+    # macOS and older distributions of Linux and Unix, a handful of helper
+    # functions can probably be created to handle every case of incompatibility
+    # between the two. Until that's implemented, it is probably best to warn
+    # the user that this will not work rather than having it silently bomb out
+    # during runtime.
+    if ! date --version >/dev/null 2>&1; then
+        echo "ERROR: GNU date is required."
+        echo "If you're on macOS, please install it using 'brew install coreutils'."
+        echo "Ensure that your PATH is configured to use GNU date as well."
+        echo "See the README.md for further details."
+        exit 1
+    fi
 }
 
 ################################################################################
@@ -102,6 +118,24 @@ function optionPicked() {
     echo -e "${msg}\n"
 }
 
+################################################################################
+# DESC: Format date string
+# ARGS: $* (required): String
+# OUTS: String
+################################################################################
+function format_date() {
+    # NOTE: While this works where it's implemented within the changelogs()
+    # function the first time, it then bombs out when it reaches the -d flag
+    # in the second half of that same code as BSD date cannot handle -d, nor
+    # can it handle a string such as DATE - 1 day.
+    local date="${1}"
+    local outf="${2}"
+    local datef="${3:-"%b %d %H:%M:%S %Y %Z"}"  # Tue Oct 24 13:34:22 2023 +0300
+    local resp="$(date -d "${date}" "+${outf}")"
+
+    printf "%s" "${resp}"
+}
+
 ################################################################################
 # DESC: Help information printed to stdout during non-interactive mode
 # ARGS: None
@@ -158,6 +192,8 @@ LIST OPTIONS
         displays a list of commits per year
     -w, --commits-by-weekday
         displays a list of commits per weekday
+    -W, --commits-by-author-by-weekday
+        displays a list of commits per weekday by author
     -o, --commits-by-hour
         displays a list of commits per hour
     -A, --commits-by-author-by-hour
@@ -243,12 +279,13 @@ function showMenu() {
     printf %b "${NUMS}   13)${TEXT} Git commits per month\\n"
     printf %b "${NUMS}   14)${TEXT} Git commits per year\\n"
     printf %b "${NUMS}   15)${TEXT} Git commits per weekday\\n"
-    printf %b "${NUMS}   16)${TEXT} Git commits per hour\\n"
-    printf %b "${NUMS}   17)${TEXT} Git commits per hour by author\\n"
-    printf %b "${NUMS}   18)${TEXT} Git commits per timezone\\n"
-    printf %b "${NUMS}   19)${TEXT} Git commits per timezone by author\\n"
+    printf %b "${NUMS}   16)${TEXT} Git commits per weekday by author\\n"
+    printf %b "${NUMS}   17)${TEXT} Git commits per hour\\n"
+    printf %b "${NUMS}   18)${TEXT} Git commits per hour by author\\n"
+    printf %b "${NUMS}   19)${TEXT} Git commits per timezone\\n"
+    printf %b "${NUMS}   20)${TEXT} Git commits per timezone by author\\n"
     printf %b "\\n${TITLES} Suggest:\\n"
-    printf %b "${NUMS}   20)${TEXT} Code reviewers (based on git history)\\n"
+    printf %b "${NUMS}   21)${TEXT} Code reviewers (based on git history)\\n"
     printf %b "\\n${HELP_TXT}Please enter a menu option or ${EXIT_TXT}press Enter to exit.\\n"
     printf %b "${TEXT}> ${NORMAL}"
     read -r opt
@@ -391,11 +428,12 @@ function changelogs() {
         --date=short "${_author}" "$_since" "$_until" $_log_options $_pathspec \
         | sort -u -r | head -n $_limit \
         | while read DATE; do
-              echo -e "\n[$DATE]"
+              day=$(format_date "$DATE" "%A" "%Y-%m-%d")
+              echo -e "\n[$DATE - $day]"
               GIT_PAGER=cat git -c log.showSignature=false log \
                                 --use-mailmap $_merges \
                                 --format=" * %s (%aN)" "${_author}" \
-                                --since=$DATE --until=$next
+                                --since==$(date -d "$DATE - 1 day" +"%Y-%m-%d") --until=$next
               next=$DATE
           done
 }
@@ -519,6 +557,67 @@ function csvOutput() {
         }'
 }
 
+################################################################################
+# DESC: Transforms special multiline string sequence to a JSON string property.
+#       {propTag}{optional white space indentation}{property}
+#       {line1}
+#       {line2}
+#       ...
+#       {propTag}, (the final comma is optional)
+#       Generates: "{property}": "{line1}\n{line2}\n...",
+#       The final comma is added if present after the ending tag.
+#       Caveat: the content should not contain {propTag} at the
+#       beginning of a line.
+# ARGS: $propTag (optional) : tag at the beginning of the line to mark the
+#       beginning and the end of a special sequence. It must not contain
+#       regular expression special characters, i.e. use [a-zA-Z0-9_]+.
+#       This tag should be sufficiently random to avoid collision with
+#       the actual content. Defaults to __JSONPROP__.
+# OUTS: content with JSON string properties
+################################################################################
+function toJsonProp() {
+    local propTag="${1:-__JSONPROP__}"
+    sed -n -E '
+# transforms the special sequence.
+/^'"$propTag"'[^\r]/ {
+    # remove the special prefix, keep the property name followed by :
+    s/^'"$propTag"'([^\r]+)\r?$/\1:/g;
+    # hold in buffer, get the next line.
+    h;n
+    # loop
+    b eos
+    :eos {
+        # add in hold buffer and loop while the string is not finished.
+        /^'"$propTag"',?\r?$/ ! { H; n; b eos; }
+        # end of the string, flip buffer to current pattern.
+		# keeps the comma if any, or a space as an empty placeholder.
+		/,\r?$/ ! { x; s/\r?$/ / }
+		/,\r?$/   { x; s/\r?$/,/ }
+    }
+    # replace special JSON string chars.
+    s/["\\]/\\&/g;
+    # replace control chars, carriage returns, line feeds, tabulations, etc.
+    s/\x00/\\u0000/g; s/\x01/\\u0001/g; s/\x02/\\u0002/g; s/\x03/\\u0003/g;
+    s/\x04/\\u0004/g; s/\x05/\\u0005/g; s/\x06/\\u0006/g; s/\x07/\\u0007/g;
+    s/\x08/\\b/g;     s/\x09/\\t/g;     s/\x0a/\\n/g;     s/\x0b/\\u000b/g;
+    s/\x0c/\\f/g;     s/\x0d/\\r/g;     s/\x0e/\\u000e/g; s/\x0f/\\u000f/g;
+    s/\x10/\\u0010/g; s/\x11/\\u0011/g; s/\x12/\\u0012/g; s/\x13/\\u0013/g;
+    s/\x14/\\u0014/g; s/\x15/\\u0015/g; s/\x16/\\u0016/g; s/\x17/\\u0017/g;
+    s/\x18/\\u0018/g; s/\x19/\\u0019/g; s/\x1a/\\u001a/g; s/\x1b/\\u001b/g;
+    s/\x1c/\\u001c/g; s/\x1d/\\u001d/g; s/\x1e/\\u001e/g; s/\x1f/\\u001f/g;
+    s/\x7f/\\u007f/g;
+
+    # format the JSON property name, optionally indented, open quote for value.
+    s/^(\s*)([^:]+):\\n/\1"\2": "/g;
+    # handle the final comma if present, and close the quote for value.
+    /,$/ { s/,$/",/g; }
+    # otherwise remove final space placeholder and close the quote for value.
+    /,$/ ! { s/ $/"/g; }
+}
+# print lines.
+p'
+}
+
 ################################################################################
 # DESC: Saves the git log output in a JSON format
 # ARGS: $json_path (required): Path to where the file is saved
@@ -526,10 +625,20 @@ function csvOutput() {
 ################################################################################
 function jsonOutput() {
     optionPicked "Output log saved to file at: ${json_path}/output.json"
-    # TODO: Can we shorten this pretty format line? Quick experiment shows that
-    #       it does not properly respect \ and interprets them literally.
+    local propTag="__JSONPROP${RANDOM}__"
     git -c log.showSignature=false log --use-mailmap $_merges "$_since" "$_until" $_log_options \
-        --pretty=format:'{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n  "subject": "%s",%n  "sanitized_subject_line": "%f",%n  "body": "%b",%n  "commit_notes": "%N",%n  "author": {%n    "name": "%aN",%n    "email": "%aE",%n    "date": "%aD"%n  },%n  "commiter": {%n    "name": "%cN",%n    "email": "%cE",%n    "date": "%cD"%n  }%n},' \
+        --pretty=format:'{%n  "commit": "%H",%n  "abbreviated_commit": "%h",%n  "tree": "%T",%n'\
+'  "abbreviated_tree": "%t",%n  "parent": "%P",%n  "abbreviated_parent": "%p",%n  "refs": "%D",%n  "encoding": "%e",%n'\
+"$propTag"'  subject%n%s%n'"$propTag"',%n  "sanitized_subject_line": "%f",%n'\
+"$propTag"'  body%n%b%n'"$propTag"',%n'\
+"$propTag"'  commit_notes%n%N%n'"$propTag"',%n  "author": {%n'\
+"$propTag"'    name%n%aN%n'"$propTag"',%n'\
+"$propTag"'    email%n%aE%n'"$propTag"',%n'\
+'    "date": "%aD"%n  },%n  "commiter": {%n'\
+"$propTag"'    name%n%cN%n'"$propTag"',%n'\
+"$propTag"'    email%n%cE%n'"$propTag"',%n'\
+'    "date": "%cD"%n  }%n},' \
+        | toJsonProp "$propTag" \
         | sed "$ s/,$//" \
         | sed ':a;N;$!ba;s/\r\n\([^{]\)/\\n\1/g' \
         | awk 'BEGIN { print("[") } { print($0) } END { print("]") }' \
@@ -710,14 +819,24 @@ function commitsByMonth() {
 # OUTS: None
 ################################################################################
 function commitsByWeekday() {
-    optionPicked "Git commits by weekday:"
+    local author="${1:-}"
+    local _author=""
+
+    if [[ -z "${author}" ]]; then
+        optionPicked "Git commits by weekday:"
+        _author="--author=**"
+    else
+        optionPicked "Git commits by weekday for author '${author}':"
+        _author="--author=${author}"
+    fi
+
     echo -e "\tday\tsum"
     local i counter=1
     for i in Mon Tue Wed Thu Fri Sat Sun
     do
         echo -en "\t$counter\t$i\t"
         git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
-            "$_since" "$_until" $_log_options |
+            "${_author}" "$_since" "$_until" $_log_options |
             grep -cE "^ * $i \w\w\w [0-9]{1,2} " || continue
         counter=$((counter+1))
     done | awk '{
@@ -803,9 +922,9 @@ function commitsByTimezone() {
     fi
 
     echo -e "Commits\tTimeZone"
-    git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
+    git -c log.showSignature=false log $_merges --format='%ad %s' \
         "${_author}" "$_since" "$_until" --date=iso $_log_options $_pathspec \
-        | cut -d " " -f 12 | grep -v -e '^[[:space:]]*$' | sort | uniq -c
+        | cut -d " " -f 3 | grep -v -e '^[[:space:]]*$' | sort -n | uniq -c
 }
 
 ################################################################################
@@ -890,6 +1009,12 @@ if [[ "$#" -eq 1 ]]; then
         -Y|--commits-by-year ) commitsByYear;;
         -m|--commits-by-month) commitsByMonth;;
         -w|--commits-by-weekday) commitsByWeekday;;
+        -W|--commits-by-author-by-weekday)
+            author="${_GIT_AUTHOR:-}"
+            while [[ -z "${author}" ]]; do
+                read -r -p "Which author? " author
+            done
+            commitsByWeekday "${author}";;
         -o|--commits-by-hour) commitsByHour;;
         -A|--commits-by-author-by-hour)
             author="${_GIT_AUTHOR:-}"
@@ -898,7 +1023,7 @@ if [[ "$#" -eq 1 ]]; then
             done
             commitsByHour "${author}";;
         -z|--commits-by-timezone) commitsByTimezone;;
-        -Z|--commits-by-author-by-timezone) 
+        -Z|--commits-by-author-by-timezone)
             author="${_GIT_AUTHOR:-}"
             while [[ -z "${author}" ]]; do
                 read -r -p "Which author? " author
@@ -963,19 +1088,24 @@ while [[ "${opt}" != "" ]]; do
        13) commitsByMonth; showMenu;;
        14) commitsByYear; showMenu;;
        15) commitsByWeekday; showMenu;;
-       16) commitsByHour; showMenu;;
-       17) author=""
+       16) author=""
+           while [[ -z "${author}" ]]; do
+               read -r -p "Which author? " author
+           done
+           commitsByWeekday "${author}"; showMenu;;
+       17) commitsByHour; showMenu;;
+       18) author=""
            while [[ -z "${author}" ]]; do
                read -r -p "Which author? " author
            done
            commitsByHour "${author}"; showMenu;;
-       18) commitsByTimezone; showMenu;;
-       19) author=""
+       19) commitsByTimezone; showMenu;;
+       20) author=""
            while [[ -z "${author}" ]]; do
                read -r -p "Which author? " author
            done
            commitsByTimezone "${author}"; showMenu;;
-       20) suggestReviewers; showMenu;;
+       21) suggestReviewers; showMenu;;
        q|"\n") exit;;
        *) clear; optionPicked "Pick an option from the menu"; showMenu;;
     esac

git-quick-stats.1

@@ -1,4 +1,4 @@
-.TH git-quick-stats "1" "June 2021" "git-quick-stats" "User Commands"
+.TH git-quick-stats "1" "April 2024" "git-quick-stats" "User Commands"
 .SH NAME
 .B git\-quick\-stats
 \- Simple and efficient way to access various stats in a git repository.
@@ -95,6 +95,11 @@ displays a list of commits per year
 displays a list of commits per weekday
 .HP
 .PP
+\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
+.IP
+displays a list of commits per weekday by author
+.HP
+.PP
 \fB\-o\fR, \fB\-\-commits\-by\-hour\fR
 .IP
 displays a list of commits per hour

tests/commands_test.sh

@@ -1,5 +1,13 @@
 #!/bin/bash
 
+# Verify we are in a git repo. Create one if not
+# FIXME: All the paths are hardcoded currently and will break if anything
+# in this chain moves or gets executed elsewhere. Adjust all of these so
+# pathing does not matter as much such as creating a TOP variable that
+# does something like TOP=$(cd "$(dirname "$0")" || exit ; pwd -P)
+# or maybe leverages Make to handle these as test targets
+./tests/test-git/resetgit
+
 . tests/assert.sh -v
 
 src="./git-quick-stats"
@@ -52,6 +60,8 @@ LIST OPTIONS
         displays a list of commits per year
     -w, --commits-by-weekday
         displays a list of commits per weekday
+    -W, --commits-by-author-by-weekday
+        displays a list of commits per weekday by author
     -o, --commits-by-hour
         displays a list of commits per hour
     -A, --commits-by-author-by-hour

tests/test-git/resetgit

@@ -0,0 +1,16 @@
+#!/bin/sh
+# Initialises a new local Git repo for test purpose if one does not exist already
+if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
+    {
+        git init
+        git config user.name "$(printf %s 'Test Git,\nfor test purpose')"
+        git config user.email "TestGit\o/@example.org"
+
+        printf 'test-git\n========\n' > README.md
+        git add README.md
+        git commit -m 'added readme (o\w/o)' -m 'in markdown, no \r\n, only \n' -m 'a very "simple" readme'
+        testChars="$(printf 'tab [%b] form feed [%b] line feed [%b] carriage return [%b]' '\x09' '\x0C' '\x0A' '\x0D')"
+        git notes add -m 'Some notes' -m 'out of ascii: été au cœur' -m "$testChars"
+        git log
+    } >/dev/null 2>&1
+fi