Merge pull request #81 from lightopenid/gh-68

update travis yml

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: [arzzen]
+open_collective: git-quick-stats

.gitignore

@@ -0,0 +1,9 @@
+*.json
+*.db
+.DS_Store*
+._*
+.*.swp
+.*.swo
+.Spotlight*
+.Trash*
+**/*~

.mailmap

@@ -0,0 +1,3 @@
+Lukas Mestan <lukas.mestan@gmail.com> Lukáš Mešťan <arzzen@users.noreply.github.com> 
+Lukas Mestan <lukas.mestan@gmail.com> arzzen 
+

.travis.yml

@@ -1,2 +1,32 @@
-language: bash
+language: generic
+
+sudo: required
+
+addons:
+  apt:
+    packages:
+      - libcurl4-openssl-dev
+      - libelf-dev
+      - libdw-dev
+      - cmake
+
+install:
+  - git rev-parse HEAD
+
 script: make test
+
+after_success: |
+  wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz &&
+  tar xzf master.tar.gz &&
+  cd kcov-master &&
+  mkdir build &&
+  cd build &&
+  cmake .. &&
+  make &&
+  sudo make install &&
+  cd ../.. &&
+  rm -rf kcov-master &&
+  mkdir -p coverage &&
+  kcov coverage git-quick-stats suggestReviewers && bash <(curl -s https://codecov.io/bash) -cF suggestReviewers &&
+  kcov coverage git-quick-stats detailedGitStats && bash <(curl -s https://codecov.io/bash) -cF detailedGitStats &&
+  kcov coverage git-quick-stats commitsPerDay && bash <(curl -s https://codecov.io/bash) -cF commitsPerDay

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lukas.mestan@googlemail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Lukáš Mešťan
+Copyright (c) 2019 Lukáš Mešťan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,31 +1,43 @@
-prefix=/usr/local
+PREFIX ?= /usr/local
+_INSTDIR ?= $(DESTDIR)$(PREFIX)
+BINDIR ?= $(_INSTDIR)/bin
+MANDIR ?= $(_INSTDIR)/share/man
+TASK_DONE = echo -e "\n✓ $@ done\n"
 
-# files that need mode 755
+.PHONY: test
-EXEC_FILES=git-quick-stats
 
 all:
-	@echo "usage: make install"
+	@echo "Usage:"
-	@echo "       make reinstall"
+	@echo "  make install"
-	@echo "       make uninstall"
+	@echo "  make reinstall"
-	@echo "       make test"
+	@echo "  make uninstall"
+	@echo "  make test"
 
 help:
 	$(MAKE) all
+	@$(TASK_DONE)
 
 install:
-	install -m 0755 $(EXEC_FILES) $(prefix)/bin
+	install -d -m 0755 $(BINDIR)
-	git config --global alias.quick-stats '! $(prefix)/bin/$(EXEC_FILES)'
+	install -m 0755 git-quick-stats $(BINDIR)/git-quick-stats
+	$(MAKE) man
+	@$(TASK_DONE)
 
 uninstall:
-	test -d $(prefix)/bin && \
+	rm -f $(BINDIR)/git-quick-stats
-	cd $(prefix)/bin && \
+	rm -f $(MANDIR)/man1/git-quick-stats.1
-	rm -f $(EXEC_FILES) && \
+	@$(TASK_DONE)
-	git config --global --unset alias.quick-stats
 
 reinstall:
-	git pull origin master
+	@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats
-	$(MAKE) uninstall && \
+	@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats.1
 	$(MAKE) install
+	@$(TASK_DONE)
+
+man:
+	install -d -m 0755 $(MANDIR)/man1/
+	install -m 0644 git-quick-stats.1 $(MANDIR)/man1/
 
 test:
 	tests/commands_test.sh
+	@$(TASK_DONE)

README.md

@@ -1,95 +1,176 @@
 
-## GIT quick statistics 
+# 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)](http://braumeister.org/formula/git-quick-stats) [![Linuxbrew package](https://repology.org/badge/version-for-repo/linuxbrew/git-quick-stats.svg)](https://repology.org/metapackage/git-quick-stats/packages)
 
-[![Travis](https://api.travis-ci.org/arzzen/git-quick-stats.svg?branch=master)](https://travis-ci.org/arzzen/git-quick-stats) 
+> `git-quick-stats` is a simple and efficient way to access various statistics in a git repository.
-[![homebrew](https://img.shields.io/homebrew/v/git-quick-stats.svg)]()
+>
+> 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 :).
 
-> `git quick-stats` is a simple and efficient way to access various statistics in git repository.
+![mainMenuScreenshot](https://user-images.githubusercontent.com/8818630/58364013-61e53800-7e7b-11e9-87f9-790d6744fbd5.png)
 
 ## Table of Contents
 
 [**Screenshots**](#screenshots)
 
-[**Installation**](#installation)
-* [**Unix OS**](#unix-like-os)
-* [**OS X**](#os-x-homebrew)
-* [**Windows**](#windows-cygwin)
-
 [**Usage**](#usage)
-* [**Git log since/unitl**](#git-log-since-until)
+
+* [**Interactive**](#interactive)
+* [**Non-interactive**](#non-interactive)
+* [**Command-line arguments**](#command-line-arguments)
+* [**Git log since and until**](#git-log-since-and-until)
 * [**Git log limit**](#git-log-limit)
 * [**Git pathspec**](#git-pathspec)
-* [**Tests**](#tests)
+* [**Color themes**](#color-themes)
+
+[**Installation**](#installation)
+
+* [**UNIX and Linux**](#unix-and-linux)
+* [**macOS**](#macos-homebrew)
+* [**Windows**](#windows)
 
 [**System requirements**](#system-requirements)
 
+* [**Dependencies**](#dependencies)
+
+[**FAQ**](#faq)
+
 [**Contribution**](#contribution)
 
-[**License**](#licensing)
+* [**Code reviews**](#code-reviews)
+* [**Some tips for good pull requests**](#some-tips-for-good-pull-requests)
+* [**Formatting**](#formatting)
 
+[**Tests**](#tests)
+
+[**Licensing**](#licensing)
+
+[**Contributors**](#contributors)
+
+* [**Backers**](#backers)
+* [**Sponsors**](#sponsors)
 
 ## Screenshots
 
-![screenshot from 2017-04-02 17-10-21](https://cloud.githubusercontent.com/assets/6382002/24588459/bef0a1b8-17c8-11e7-8525-3ab5983b81dc.png)
+![commitsByWeekdayScreenshot](https://user-images.githubusercontent.com/8818630/58364011-61e53800-7e7b-11e9-9417-16cbb241ac2e.png)
-
-![screenshot from 2017-04-02 17-09-13](https://cloud.githubusercontent.com/assets/6382002/24588456/bec1278a-17c8-11e7-8835-39273da7bc99.png)
-
-![screenshot from 2017-04-02 17-09-31](https://cloud.githubusercontent.com/assets/6382002/24588457/beece9f6-17c8-11e7-80a4-274ecd314a7e.png)
-
-![screenshot from 2017-04-02 17-09-45](https://cloud.githubusercontent.com/assets/6382002/24588458/bef03656-17c8-11e7-82e6-30a5a11cfbb0.png)
-
-![screenshot from 2017-04-02 17-08-28](https://cloud.githubusercontent.com/assets/6382002/24588460/bef0c2e2-17c8-11e7-88b2-a4033593c5d0.png)
 
+![commitsByHourScreenshot](https://user-images.githubusercontent.com/8818630/58364010-61e53800-7e7b-11e9-8711-a40b50aebf52.png)
 
 ## Usage
 
+### Interactive
+
+git-quick-stats has a built-in interactive menu that can be executed as such:
+
 ```bash
-git quick-stats
-# or 
 git-quick-stats
 ```
 
-Or you can use (non-interactive) direct execution:
+Or
-
-`git quick-stats <optional-command-to-execute-directly>`
-
-Possible arguments: 
-> suggestReviewers, detailedGitStats, commitsByHour, commitsByWeekday, commitsByMonth, commitsPerDay, commitsPerAuthor, myDailyStats, contributors,
-branchTree, branchesByDate, changelogs, changelogsByAuthor
-
-
-#### Git log since / until
-
-You can set variable `_GIT_SINCE`, `_GIT_UNTIL` and limit the git log
 
 ```bash
-export _GIT_SINCE="2017-20-01"
+git quick-stats
-export _GIT_UNTIL="2017-22-01"
 ```
 
-then run `git quick-stats` (affect all stats, except "My daily status" and "Git changelogs" )
+### Non-interactive
 
+For those who prefer to utilize command-line options, `git-quick-stats` also has a non-interactive mode supporting both short and long options:
 
-#### Git log limit 
+```bash
+git-quick-stats <optional-command-to-execute-directly>
+```
 
-You can set variable `_GIT_LIMIT` for limited output (it will affect: "Git changelogs" and "Branch tree view" )
+Or
+
+```bash
+git quick-stats <optional-command-to-execute-directly>
+```
+
+### Command-line arguments
+
+Possible arguments in short and long form:
+
+```bash
+-r, --suggest-reviewers
+    show the best people to contact to review code
+-T, --detailed-git-stats
+    give a detailed list of git stats
+-R, --git-stats-by-branch
+    see detailed list of git stats by branch
+-d, --commits-per-day
+    displays a list of commits per day
+-m, --commits-by-month
+    displays a list of commits per month
+-w, --commits-by-weekday
+    displays a list of commits per weekday
+-o, --commits-by-hour
+    displays a list of commits per hour
+-A, --commits-by-author-by-hour
+    displays a list of commits per hour by author
+-a, --commits-per-author
+    displays a list of commits per author
+-S, --my-daily-stats
+    see your current daily stats
+-C, --contributors
+    see a list of everyone who contributed to the repo
+-b, --branch-tree
+    show an ASCII graph of the git repo branch history
+-D, --branches-by-date
+    show branches by date
+-c, --changelogs
+    see changelogs
+-L, --changelogs-by-author
+    see changelogs by author
+-j, --json-output
+    save git log as a JSON formatted file to a specified area
+-h, -?, --help
+    display this help text in the terminal
+```
+
+### Git log since and until
+
+You can set the variables `_GIT_SINCE` and/or `_GIT_UNTIL` before running `git-quick-stats` to limit the git log. These work similar to git's built-in `--since` and `--until` log options.
+
+```bash
+export _GIT_SINCE="2017-01-20"
+export _GIT_UNTIL="2017-01-22"
+```
+
+Once set, run `git quick-stats` as normal. Note that this affects all stats that parse the git log history until unset.
+
+### Git log limit
+
+You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options.
 
 ```bash
 export _GIT_LIMIT=20
 ```
 
-#### Git pathspec
+### Git pathspec
 
-You can exclude directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
+You can exclude a directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
 
 ```bash
 export _GIT_PATHSPEC=':!directory'
 ```
 
+You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.
+
+```bash
+export _GIT_PATHSPEC=':!package-lock.json'
+```
+
+### Color themes
+
+You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`
+
+```bash
+export _MENU_THEME=legacy
+```
+
+![legacyThemeScreenshot](https://user-images.githubusercontent.com/8818630/58364012-61e53800-7e7b-11e9-910a-aaff836260eb.png)
 
 ## Installation
 
-#### Unix like OS
+### UNIX and Linux
 
 ```bash
 git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
@@ -108,33 +189,50 @@ For update/reinstall
 sudo make reinstall
 ```
 
-#### OS X (homebrew)
+### macOS (homebrew)
 
 ```bash
 brew install git-quick-stats
 ```
 
-#### Windows (cygwin)
+Or you can follow the UNIX and Linux instructions if you wish.
 
-* [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245) 
+### Windows
+
+If you are installing with Cygwin, use these scripts:
+
+* [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
 * [uninstaller](https://gist.github.com/arzzen/21c660014d0663b6c5710014714779d6)
 
+If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
 
 ## System requirements
 
-* Unix like OS with a proper shell
+* An OS with a Bash shell
-* Tools we use: git ; awk ; sed ; tr ; echo ; grep ; cut ; sort ; head ; uniq ; column.
+* Tools we use: awk ; basename ; cat ; column ; echo ; git ; grep ; head ; seq ; sort ; tput ; tr ; uniq ; wc
 
-## Contribution 
+### Dependencies
+
+* [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
+
+## FAQ
+
+*Q:* I get some errors after run git-quick-stats in cygwin like `/usr/local/bin/git-quick-stats: line 2: $'\r': command not found`
+
+*A:* You can run the dos2unix app in cygwin as follows: `/bin/dos2unix.exe /usr/local/bin/git-quick-stats`. This will convert the script from the CR-LF convention that Microsoft uses to the LF convention that UNIX, OS X, and Linux use. You should then should be able to run it as normal.
+
+## Contribution
 
 Want to contribute? Great! First, read this page.
 
-#### Code reviews
+### Code reviews
-All submissions, including submissions by project members, require review. 
-We use Github pull requests for this purpose.
 
-#### Some tips for good pull requests:
+All submissions, including submissions by project members, require review.</br>
-* Use our code
+We use GitHub pull requests for this purpose.
+
+### Some tips for good pull requests
+
+* Use our code </br>
   When in doubt, try to stay true to the existing code of the project.
 * Write a descriptive commit message. What problem are you solving and what
   are the consequences? Where and what did you test? Some good tips:
@@ -146,20 +244,48 @@ We use Github pull requests for this purpose.
   HEAD. This make reviewing the code so much easier, and our history more
   readable.
 
-#### Formatting
+### Formatting
 
 This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
 
-#### Tests
+## Tests
+
+[![codecov](https://codecov.io/gh/arzzen/git-quick-stats/branch/master/graph/badge.svg)](https://codecov.io/gh/arzzen/git-quick-stats)
 
 ```bash
 make test
 ```
 
 ## Licensing
+
 MIT see [LICENSE][] for the full license text.
 
-   [read this page]: http://github.com/arzzen/git-quick-stats/blob/master/CONTRIBUTING.md
+   [read this page]: http://github.com/arzzen/git-quick-stats/blob/master/docs/CONTRIBUTING.md
    [landing page]: http://arzzen.github.io/git-quick-stats
-   [LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE.txt
+   [LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE
 
+## Contributors
+
+This project exists thanks to all the people who contribute.
+<a href="https://github.com/arzzen/git-quick-stats/graphs/contributors"><img src="https://opencollective.com/git-quick-stats/contributors.svg?width=890&button=false" /></a>
+
+### Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-quick-stats#backer)]
+
+<a href="https://opencollective.com/git-quick-stats#backers" target="_blank"><img src="https://opencollective.com/git-quick-stats/backers.svg?width=890"></a>
+
+### Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/git-quick-stats#sponsor)]
+
+<a href="https://opencollective.com/git-quick-stats/sponsor/0/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/0/avatar.svg?v=1"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/1/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/2/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/3/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/4/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/5/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/6/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/7/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/8/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/git-quick-stats/sponsor/9/website" target="_blank"><img src="https://opencollective.com/git-quick-stats/sponsor/9/avatar.svg"></a>

docs/index.html

@@ -17,6 +17,7 @@
 	<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
 	<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
 	<![endif]-->
+	<meta http-equiv="refresh" content="0;url=https://lukasmestan.com/git-quick-stats/">
     </head>
     <body id="page-top">
 	<header>

docs/issue_template.md

@@ -0,0 +1,9 @@
+#### Expected behavior and actual behavior.
+
+
+#### Steps to reproduce the problem.
+    
+    
+#### Specifications like the version of the project, operating system, or hardware.
+
+

git-quick-stats

@@ -1,136 +1,308 @@
 #!/usr/bin/env bash
+#
+# Simple and efficient way to access various statistics in a git repository
+################################################################################
+# GLOBALS AND SHELL OPTIONS
 
 set -o nounset
 set -o errexit
 
 _since=${_GIT_SINCE:-}
-if [ ! -z ${_since} ]
+[[ -n "${_since}" ]] && _since="--since=$_since"
-    then _since="--since=$_since"
-fi
 
 _until=${_GIT_UNTIL:-}
-if [ ! -z ${_until} ]
+[[ -n "${_until}" ]] && _until="--until=$_until"
-    then _until="--until=$_until"
-fi
 
 _pathspec=${_GIT_PATHSPEC:-}
-if [ ! -z "${_pathspec}" ]
+[[ -n "${_pathspec}" ]] && _pathspec="-- $_pathspec"
-    then _pathspec="-- $_pathspec"
+
-fi
 
 _limit=${_GIT_LIMIT:-}
-if [ ! -z ${_limit} ]
+if [[ -n "${_limit}" ]]; 
     then _limit=$_limit
 else
     _limit=10
 fi
 
-show_menu() {
+# Default menu theme
-    NORMAL=`echo "\033[m"`
+# Set the legacy theme by typing "export _MENU_THEME=legacy"
-    MENU=`echo "\033[36m"`
+_theme="${_MENU_THEME:=default}"
-    NUMBER=`echo "\033[33m"`
-    FGRED=`echo "\033[41m"`
-    RED_TEXT=`echo "\033[31m"`
-    ENTER_LINE=`echo "\033[33m"`
 
-    echo -e ""
+################################################################################
-    echo -e "${RED_TEXT} Generate: ${NORMAL}"
+# DESC: Checks to make sure the user has the appropriate utilities installed
-    echo -e "${MENU} ${NUMBER} 1)${MENU} Contribution stats (by author) ${NORMAL}"
+# ARGS: None
-    echo -e "${MENU} ${NUMBER} 2)${MENU} Git changelogs (last $_limit)${NORMAL}"
+# OUTS: None
-    echo -e "${MENU} ${NUMBER} 3)${MENU} Git changelogs by author ${NORMAL}"
+################################################################################
-    echo -e "${MENU} ${NUMBER} 4)${MENU} My daily status ${NORMAL}"
+function checkUtils() {
-    echo -e "${RED_TEXT} List: ${NORMAL}"
+    local -r msg="not found. Please make sure this is installed and in PATH."
-    echo -e "${MENU} ${NUMBER} 5)${MENU} Branch tree view (last $_limit)${NORMAL}"
+
-    echo -e "${MENU} ${NUMBER} 6)${MENU} All branches (sorted by most recent commit) ${NORMAL}"
+    command -v awk >/dev/null 2>&1 || { echo >&2 "awk ${msg}"; exit 1; }
-    echo -e "${MENU} ${NUMBER} 7)${MENU} All contributors (sorted by name) ${NORMAL}"
+    command -v basename >/dev/null 2>&1 || { echo >&2 "basename ${msg}"; exit 1; }
-    echo -e "${MENU} ${NUMBER} 8)${MENU} Git commits per author ${NORMAL}"
+    command -v cat >/dev/null 2>&1 || { echo >&2 "cat ${msg}"; exit 1; }
-    echo -e "${MENU} ${NUMBER} 9)${MENU} Git commits per date ${NORMAL}"
+    command -v column >/dev/null 2>&1 || { echo >&2 "column ${msg}"; exit 1; }
-    echo -e "${MENU} ${NUMBER} 10)${MENU} Git commits per month ${NORMAL}"
+    command -v echo >/dev/null 2>&1 || { echo >&2 "echo ${msg}"; exit 1; }
-    echo -e "${MENU} ${NUMBER} 11)${MENU} Git commits per weekday ${NORMAL}"
+    command -v git >/dev/null 2>&1 || { echo >&2 "git ${msg}"; exit 1; }
-    echo -e "${MENU} ${NUMBER} 12)${MENU} Git commits per hour ${NORMAL}"
+    command -v grep >/dev/null 2>&1 || { echo >&2 "grep ${msg}"; exit 1; }
-    echo -e "${MENU} ${NUMBER} 13)${MENU} Git commits by author per hour ${NORMAL}"
+    command -v head >/dev/null 2>&1 || { echo >&2 "head ${msg}"; exit 1; }
-    echo -e "${RED_TEXT} Suggest: ${NORMAL}"
+    command -v seq >/dev/null 2>&1 || { echo >&2 "seq ${msg}"; exit 1; }
-    echo -e "${MENU} ${NUMBER} 14)${MENU} Code reviewers (based on git history) ${NORMAL}"
+    command -v sort >/dev/null 2>&1 || { echo >&2 "sort ${msg}"; exit 1; }
-    echo -e ""
+    command -v tput >/dev/null 2>&1 || { echo >&2 "tput ${msg}"; exit 1; }
-    echo -e "${ENTER_LINE}Please enter a menu option or ${RED_TEXT}press enter to exit. ${NORMAL}"
+    command -v tr >/dev/null 2>&1 || { echo >&2 "tr ${msg}"; exit 1; }
-    read opt
+    command -v uniq >/dev/null 2>&1 || { echo >&2 "uniq ${msg}"; exit 1; }
+    command -v wc >/dev/null 2>&1 || { echo >&2 "wc ${msg}"; exit 1; }
 }
 
-function option_picked() {
+################################################################################
-    COLOR='\033[01;31m'
+# DESC: Help information printed to stdout during non-interactive mode
-    RESET='\033[00;00m'
+# ARGS: None
-    MESSAGE=${@:-"${RESET}Error: No message passed"}
+# OUTS: None
-    echo -e "${COLOR}${MESSAGE}${RESET}"
+################################################################################
-    echo ""
+function usage() { 
+    local -r program=$(basename "$0")
+
+    echo "
+NAME
+    ${program} - Simple and efficient way to access various stats in a git repo
+
+SYNOPSIS
+    For non-interactive mode: ${program} [OPTIONS]
+    For interactive mode: ${program}
+
+DESCRIPTION
+    Any git repository contains tons of information about commits, contributors,
+    and files. Extracting this information is not always trivial, mostly because
+    of a gadzillion options to a gadzillion git commands.
+
+    This program allows you to see detailed information about a git repository.
+
+OPTIONS
+    -r, --suggest-reviewers
+        show the best people to contact to review code
+    -T, --detailed-git-stats
+        give a detailed list of git stats
+    -R, --git-stats-by-branch
+        see detailed list of git stats by branch
+    -d, --commits-per-day
+        displays a list of commits per day
+    -m, --commits-by-month
+        displays a list of commits per month
+    -w, --commits-by-weekday
+        displays a list of commits per weekday
+    -o, --commits-by-hour
+        displays a list of commits per hour
+    -A, --commits-by-author-by-hour
+        displays a list of commits per hour by author
+    -a, --commits-per-author
+        displays a list of commits per author
+    -S, --my-daily-stats
+        see your current daily stats
+    -C, --contributors
+        see a list of everyone who contributed to the repo
+    -b, --branch-tree
+        show an ASCII graph of the git repo branch history
+    -D, --branches-by-date
+        show branches by date
+    -c, --changelogs
+        see changelogs
+    -L, --changelogs-by-author
+        see changelogs by author
+    -j, --json-output
+        save git log as a JSON formatted file to a specified area
+    -h, -?, --help
+        display this help text in the terminal
+
+ADDITIONAL USAGE
+    You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log
+        ex: export _GIT_SINCE=\"2017-01-20\"
+    You can set _GIT_LIMIT for limited output log
+        ex: export _GIT_LIMIT=20
+    You can exclude directories or files from the stats by using pathspec
+        ex: export _GIT_PATHSPEC=':!pattern'
+    You can set _MENU_THEME to display the legacy color scheme
+        ex: export _MENU_THEME=legacy"
 }
 
+################################################################################
+# DESC: Displays the interactive menu and saves the user supplied option
+# ARGS: None
+# OUTS: $opt: Option selected by the user based on menu choice
+################################################################################
+function showMenu() {
+    local -r normal=$(tput sgr0)
+    local -r cyan=$(tput setaf 6)
+    local -r bold=$(tput bold)
+    local -r red=$(tput setaf 1)
+    local -r yellow=$(tput setaf 3)
+    local -r white=$(tput setaf 7)
+    local titles=""
+    local text=""
+    local nums=""
+    local help_txt=""
+    local exit_txt=""
+
+    # Adjustable color menu option
+    if [[ "${_theme}" == "legacy" ]]; then
+        titles="${bold}${red}" && readonly titles
+        text="${normal}${cyan}" && readonly text
+        nums="${bold}${yellow}" && readonly nums
+        help_txt="${normal}${yellow}" && readonly help_txt
+        exit_txt="${bold}${red}" && readonly exit_txt
+    else
+        titles="${bold}${cyan}" && readonly titles
+        text="${normal}${white}" && readonly text
+        nums="${normal}${bold}${white}" && readonly nums
+        help_txt="${normal}${cyan}" && readonly help_txt
+        exit_txt="${bold}${cyan}" && readonly exit_txt
+    fi
+    
+    echo -e "\n${titles} Generate:${normal}"
+    echo -e "${nums}    1)${text} Contribution stats (by author)"
+    echo -e "${nums}    2)${text} Contribution stats (by author) on a specific branch"
+    echo -e "${nums}    3)${text} Git changelogs (last $_limit days)"
+    echo -e "${nums}    4)${text} Git changelogs by author"
+    echo -e "${nums}    5)${text} My daily status"
+    echo -e "${nums}    6)${text} Save git log output in JSON format"
+    echo -e "\n${titles} List:"
+    echo -e "${nums}    7)${text} Branch tree view (last $_limit)"
+    echo -e "${nums}    8)${text} All branches (sorted by most recent commit)"
+    echo -e "${nums}    9)${text} All contributors (sorted by name)"
+    echo -e "${nums}   10)${text} Git commits per author"
+    echo -e "${nums}   11)${text} Git commits per date"
+    echo -e "${nums}   12)${text} Git commits per month"
+    echo -e "${nums}   13)${text} Git commits per weekday"
+    echo -e "${nums}   14)${text} Git commits per hour"
+    echo -e "${nums}   15)${text} Git commits by author per hour"
+    echo -e "\n${titles} Suggest:"
+    echo -e "${nums}   16)${text} Code reviewers (based on git history)"
+    echo -e "\n${help_txt}Please enter a menu option or ${exit_txt}press Enter to exit."
+    echo -n "${text}> ${normal}"
+    read -r opt
+}
+
+################################################################################
+# DESC: Prints a formatted message of the selected option by the user to stdout
+# ARGS: $* (required): String to print (usually provided by other functions)
+# OUTS: None
+################################################################################
+function optionPicked() {
+    local -r bold=$(tput bold)
+    local -r red=$(tput setaf 1)
+    local -r reset=$(tput sgr0)
+    local msg=${*:-"${reset}Error: No message passed"}
+    
+    echo -e "${bold}${red}${msg}${reset}\n"
+}
+
+################################################################################
+# DESC: Shows detailed contribution stats per author by parsing every commit in
+#       the repo and outputting their contribution stats
+# ARGS: $branch (optional): Users can specify an alternative branch instead of
+#                           the current default one
+# OUTS: None
+################################################################################
 function detailedGitStats() {
-    option_picked "Contribution stats (by author):"
+    local is_branch_existing=false
+    local branch="${1:-}"
+    local _branch=""
+    
+    # Check if requesting for a specific branch
+    if [[ -n "${branch}" ]]; then
+        # Check if branch exist
+        if [[ $(git show-ref refs/heads/"${branch}") ]] ; then
+            is_branch_existing=true
+            _branch="${branch}"
+        else
+            is_branch_existing=false
+            _branch=""
+        fi
+    fi
 
-    git log --no-merges --numstat --pretty="format:commit %H%nAuthor: %an <%ae>%nDate:   %ad%n%n%w(0,4,4)%B%n" $_since $_until $_pathspec | LC_ALL=C awk '
+    # Prompt message
-    function printStats(author) {
+    if [[ "${is_branch_existing}" && -n "${_branch}" ]]; then
-      printf "\t%s:\n", author
+        optionPicked "Contribution stats (by author) on ${_branch} branch:"
+    elif [[ -n "${branch}" && -z "${_branch}" ]]; then
+        optionPicked "Branch ${branch} does not exist.\nContribution stats (by author) on the current branch:"
+    else
+        optionPicked "Contribution stats (by author) on the current branch:"
+    fi
 
-      if( more["total"] > 0 ) {
+    git -c log.showSignature=false log ${_branch} --use-mailmap --no-merges --numstat \
-        printf "\t  insertions:    %d (%.0f%%)\n", more[author], (more[author] / more["total"] * 100)
+        --pretty="format:commit %H%nAuthor: %aN <%aE>%nDate:   %ad%n%n%w(0,4,4)%B%n" \
-      }
+        $_since $_until $_pathspec | LC_ALL=C awk '
+        function printStats(author) {
+        printf "\t%s:\n", author
 
-      if( less["total"] > 0 ) {
+        if(more["total"] > 0) {
-        printf "\t  deletions:     %d (%.0f%%)\n", less[author], (less[author] / less["total"] * 100)
+            printf "\t  insertions:    %d (%.0f%%)\n", more[author], \
-      }
+                (more[author] / more["total"] * 100)
-
-      if( file["total"] > 0 ) {
-        printf "\t  files:         %d (%.0f%%)\n", file[author], (file[author] / file["total"] * 100)
-      }
-
-      if(commits["total"] > 0) {
-      	printf "\t  commits:       %d (%.0f%%)\n", commits[author], (commits[author] / commits["total"] * 100)
-      }
-
-      if ( first[author] != "" ) {
-        printf "\t  lines changed: %s\n", more[author] + less[author]
-        printf "\t  first commit:  %s\n", first[author]
-        printf "\t  last commit:   %s\n", last[author]
-      }
-
-      printf "\n"
-    }
-
-    /^Author:/ {
-      author = $2 " " $3
-      commits[author] += 1
-      commits["total"] += 1
-    }
-
-    /^Date:/ {
-      $1="";
-      first[author] = substr($0, 2)
-      if(last[author] == "" ) { last[author] = first[author] }
-    }
-
-    /^[0-9]/ {
-      more[author] += $1
-      less[author] += $2
-      file[author] += 1
-
-      more["total"]  += $1
-      less["total"]  += $2
-      file["total"]  += 1
-    }
-
-    END {
-      for (author in commits) {
-        if (author != "total") {
-          printStats(author)
         }
-      }
+
-      printStats("total")
+        if(less["total"] > 0) {
-    }'
+            printf "\t  deletions:     %d (%.0f%%)\n", less[author], \
+                (less[author] / less["total"] * 100)
+        }
+
+        if(file["total"] > 0) {
+            printf "\t  files:         %d (%.0f%%)\n", file[author], \
+                (file[author] / file["total"] * 100)
+        }
+
+        if(commits["total"] > 0) {
+            printf "\t  commits:       %d (%.0f%%)\n", commits[author], \
+                (commits[author] / commits["total"] * 100)
+        }
+
+        if (first[author] != "") {
+            printf "\t  lines changed: %s\n", more[author] + less[author]
+            printf "\t  first commit:  %s\n", first[author]
+            printf "\t  last commit:   %s\n", last[author]
+        }
+
+        printf "\n"
+        }
+
+        /^Author:/ {
+        $1 = ""
+        author = $0
+        commits[author] += 1
+        commits["total"] += 1
+        }
+
+        /^Date:/ {
+        $1="";
+        first[author] = substr($0, 2)
+        if(last[author] == "" ) { last[author] = first[author] }
+        }
+
+        /^[0-9]/ {
+        more[author] += $1
+        less[author] += $2
+        file[author] += 1
+
+        more["total"]  += $1
+        less["total"]  += $2
+        file["total"]  += 1
+        }
+
+        END {
+        for (author in commits) {
+            if (author != "total") {
+            printStats(author)
+            }
+        }
+        printStats("total")
+        }'
 }
 
+################################################################################
+# DESC: Displays the authors in order of total contribution to the repo
+# ARGS: None
+# OUTS: None
+################################################################################
 function suggestReviewers() {
-    option_picked "Suggested code reviewers (based on git history):"
+    optionPicked "Suggested code reviewers (based on git history):"
-    git log --no-merges $_since $_until --pretty=%an $_pathspec $* | head -n 100 | sort | uniq -c | sort -nr | LC_ALL=C awk '
+    git -c log.showSignature=false log --use-mailmap --no-merges $_since $_until \
+        --pretty=%aN $_pathspec | head -n 100 | sort | uniq -c | sort -nr | LC_ALL=C awk '
     { args[NR] = $0; }
     END {
       for (i = 1; i <= NR; ++i) {
@@ -139,13 +311,34 @@ function suggestReviewers() {
     }' | column -t -s,
 }
 
+################################################################################
+# DESC: Saves the git log output in a JSON format
+# ARGS: $json_path (required): Path to where the file is saved
+# OUTS: A JSON formatted file
+################################################################################
+function jsonOutput() {
+    optionPicked "Output log saved to file at: ${json_path:?}/output.json"
+    git -c log.showSignature=false log --use-mailmap --no-merges $_since $_until \
+        --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},' \
+        | sed "$ s/,$//" \
+        | sed ':a;N;$!ba;s/\r\n\([^{]\)/\\n\1/g' \
+        | awk 'BEGIN { print("[") } { print($0) } END { print("]") }' \
+        > "${json_path:?}"/output.json
+}
+
+################################################################################
+# DESC: Displays a horizontal bar graph based on total commits per month
+# ARGS: None
+# OUTS: None
+################################################################################
 function commitsByMonth() {
-    option_picked "Git commits by month:"
+    optionPicked "Git commits by month:"
     echo -e "\tmonth\tsum"
     for i in Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
     do
         echo -en "\t$i\t"
-        echo $(git shortlog -n --no-merges --format='%ad %s' $_since $_until | grep " $i " | wc -l)
+        git -c log.showSignature=false shortlog -n --no-merges --format='%ad %s' \
+            $_since $_until | grep " $i " | wc -l
     done | awk '{ 
         count[$1] = $2 
         total += $2 
@@ -153,23 +346,30 @@ function commitsByMonth() {
     END{ 
         for (month in count) {
             s="|";
-            percent = ((count[month] / total) * 100) / 1.25;
+            if (total > 0) {
-            for (i = 1; i <= percent; ++i) {
+                percent = ((count[month] / total) * 100) / 1.25;
-                s=s"█"
+                for (i = 1; i <= percent; ++i) {
+                    s=s"█"
+                }
+                printf( "\t%s\t%-0s\t%s\n", month, count[month], s );
             }
-
-            printf( "\t%s\t%-0s\t%s\n", month, count[month], s );
         }
     }' | LC_TIME="en_EN.UTF-8" sort -M
 }
 
+################################################################################
+# DESC: Displays a horizontal bar graph based on total commits per weekday
+# ARGS: None
+# OUTS: None
+################################################################################
 function commitsByWeekday() {
-    option_picked "Git commits by weekday:"
+    optionPicked "Git commits by weekday:"
     echo -e "\tday\tsum"
     for i in Mon Tue Wed Thu Fri Sat Sun
     do
         echo -en "\t$i\t"
-        echo $(git shortlog -n --no-merges --format='%ad %s' $_since $_until | grep "$i " | wc -l)
+        git -c log.showSignature=false shortlog -n --no-merges --format='%ad %s' \
+            $_since $_until | grep "$i " | wc -l
     done | awk '{
 
     }
@@ -182,29 +382,39 @@ function commitsByWeekday() {
         
         for (day in count) {
             s="|";
-            percent = ((count[day] / total) * 100) / 1.25;
+            if (total > 0) {
-            for (i = 1; i <= percent; ++i) {
+                percent = ((count[day] / total) * 100) / 1.25;
-                s=s"█"
+                for (i = 1; i <= percent; ++i) {
+                    s=s"█"
+                }
+                printf( "\t%s\t%-0s\t%s\n", day, count[day], s );
             }
-            printf( "\t%s\t%-0s\t%s\n", day, count[day], s );
         }
     }' | sort -k 2 -n -r
 }
 
+################################################################################
+# DESC: Displays a horizontal bar graph based on total commits per hour
+# ARGS: $author (optional): Can focus on a single author. Default is all authors
+# OUTS: None
+################################################################################
 function commitsByHour() {
     local author="${1:-}"
-    local _author=''
+    local _author=""
-    if [ -z "$author" ]; then
+
-        option_picked "Git commits by hour:"
+    if [[ -z "${author}" ]]; then
+        optionPicked "Git commits by hour:"
+        _author="--author=**"
     else
-        option_picked "Git commits by hour for author '$author':"
+        optionPicked "Git commits by hour for author '${author}':"
-        _author="--author=$author"
+        _author="--author=${author}"
     fi
     echo -e "\thour\tsum"
-    for i in `seq -w 0 23`
+    for i in $(seq -w 0 23)
     do
         echo -ne "\t$i\t"
-        echo $(git shortlog -n --no-merges --format='%ad %s' $_author $_since $_until | grep " $i:" | wc -l)
+            git -c log.showSignature=false shortlog -n --no-merges --format='%ad %s' \
+                "${_author}" $_since $_until | grep ' '$i: | wc -l
     done | awk '{ 
         count[$1] = $2 
         total += $2 
@@ -212,33 +422,68 @@ function commitsByHour() {
     END{ 
         for (hour in count) {
             s="|";
-            percent = ((count[hour] / total) * 100) / 1.25;
+            if (total > 0) {
-            for (i = 1; i <= percent; ++i) {
+                percent = ((count[hour] / total) * 100) / 1.25;
-                s=s"█"
+                for (i = 1; i <= percent; ++i) {
+                    s=s"█"
+                }
+                printf( "\t%s\t%-0s\t%s\n", hour, count[hour], s );
             }
-            printf( "\t%s\t%-0s\t%s\n", hour, count[hour], s );
         }
     }' | sort
 }
 
+################################################################################
+# DESC: Shows the number of commits that were committed per date recorded in the
+#       repo's log history
+# ARGS: None
+# OUTS: None
+################################################################################
 function commitsPerDay() {
-    option_picked "Git commits per date:";
+    optionPicked "Git commits per date:";
-    git log --no-merges $_since $_until --date=short --format='%ad' $_pathspec | sort | uniq -c
+    git -c log.showSignature=false log --use-mailmap --no-merges $_since $_until \
+        --date=short --format='%ad' $_pathspec | sort | uniq -c
 }
 
+################################################################################
+# DESC: Displays the number of commits and percentage contributed to the repo
+#       per author and sorts them by contribution percentage
+# ARGS: None
+# OUTS: None
+################################################################################
 function commitsPerAuthor()  {
-    option_picked "Git commits per author:"
+    optionPicked "Git commits per author:"
-    git shortlog $_since $_until --no-merges -n -s | sort -nr | LC_ALL=C awk '
+    local authorCommits=$(git -c log.showSignature=false log --use-mailmap --no-merges \
-    { args[NR] = $0; sum += $0 }
+      $_since $_until | grep -i Author: | cut -c9-)
-    END {
+    local coAuthorCommits=$(git -c log.showSignature=false log --use-mailmap --no-merges \
-      for (i = 1; i <= NR; ++i) {
+    $_since $_until | grep -i Co-Authored-by: | cut -c21-)
-        printf "%s,%2.1f%%\n", args[i], 100 * args[i] / sum
+
-      }
+    if [[ -z "${coAuthorCommits}" ]]
-    }' | column -t -s, 
+    then
+      allCommits="${authorCommits}"
+    else
+      allCommits="${authorCommits}\n${coAuthorCommits}"
+    fi
+
+    echo -e "${allCommits}" | awk '
+      { $NF=""; author[NR] = $0 }
+      END {
+        for(i in author) {
+          sum[author[i]]++; name[author[i]] = author[i]; total++;
+        }
+        for(i in sum) {
+          printf "\t%d,%s,%2.1f%%\n", sum[i], name[i], (100 * sum[i] / total)
+        }
+      }' | sort -n -r | column -t -s,
 }
 
+################################################################################
+# DESC: Shows git shortstats on the current user's changes for current day
+# ARGS: None
+# OUTS: None
+################################################################################
 function myDailyStats() {
-    option_picked "My daily status:"
+    optionPicked "My daily status:"
     git diff --shortstat '@{0 day ago}' | sort -nr | tr ',' '\n' | LC_ALL=C awk '
     { args[NR] = $0; }
     END {
@@ -247,192 +492,185 @@ function myDailyStats() {
       }
     }'
 
-    echo -e "\t" $(git log --author="$(git config user.name)" --no-merges --since=$(date "+%Y-%m-%dT00:00:00") --until=$(date "+%Y-%m-%dT23:59:59") --reverse | grep commit | wc -l) "commits"
+    echo -e "\t" $(git -c log.showSignature=false log --use-mailmap \
+                       --author="$(git config user.name)" --no-merges \
+                       --since=$(date "+%Y-%m-%dT00:00:00") \
+                       --until=$(date "+%Y-%m-%dT23:59:59") --reverse \
+                       | grep commit | wc -l) "commits"
 }
 
+################################################################################
+# DESC: Lists all contributors to a repo sorted by alphabetical order
+# ARGS: None
+# OUTS: None
+################################################################################
 function contributors() {
-    option_picked "All contributors (sorted by name):"
+    optionPicked "All contributors (sorted by name):"
-    git log --no-merges $_since $_until --format='%aN' $_pathspec | sort -u | cat -n
+    git -c log.showSignature=false log --use-mailmap --no-merges $_since $_until \
+        --format='%aN' $_pathspec | sort -u | cat -n
 }
 
+################################################################################
+# DESC: Shows an abbreviated ASCII graph based off of commit history
+# ARGS: None
+# OUTS: None
+################################################################################
 function branchTree() {
-    option_picked "Branching tree view:"
+    optionPicked "Branching tree view:"
-    git log --graph --abbrev-commit $_since $_until --decorate --format=format:'--+ Commit:  %h %n  | Date:    %aD (%ar) %n''  | Message: %s %d %n''  + Author:  %an %n' --all | head -n $((_limit*5))
+    git -c log.showSignature=false log --use-mailmap --graph --abbrev-commit \
+        $_since $_until --decorate \
+        --format=format:'--+ Commit:  %h %n  | Date:    %aD (%ar) %n''  | Message: %s %d %n''  + Author:  %aN %n' \
+        --all | head -n $((_limit*5))
 }
 
-
+################################################################################
+# DESC: Lists all branches sorted by their most recent commit
+# ARGS: None
+# OUTS: None
+################################################################################
 function branchesByDate() {
-    option_picked "All branches (sorted by most recent commit):"
+    optionPicked "All branches (sorted by most recent commit):"
-    git for-each-ref --sort=committerdate refs/heads/ --format='[%(authordate:relative)] %(authorname) %(refname:short)' | cat -n
+    git for-each-ref --sort=committerdate refs/heads/ \
+        --format='[%(authordate:relative)] %(authorname) %(refname:short)' | cat -n
 }
 
+################################################################################
+# DESC: Displays the latest commit history in an easy to read format by date
+# ARGS: $author (optional): Can focus on a single author. Default is all authors
+# OUTS: None
+################################################################################
 function changelogs() {
     local author="${1:-}"
-    local _author=''
+    local _author=""
-    if [ -z "$author" ]; then
+    local next=$(date +%F)
-        option_picked "Git changelogs:"
+
+    if [[ -z "${author}" ]]; then
+        optionPicked "Git changelogs:"
+        _author="--author=**"
     else
-        option_picked "Git changelogs for author '$author':"
+        optionPicked "Git changelogs for author '${author}':"
-        _author="--author=$author"
+        _author="--author=${author}"
     fi
 
-    NEXT=$(date +%F)
+    git -c log.showSignature=false log \
-    git log --no-merges --format="%cd" --date=short $_author $_since $_until $_pathspec | sort -u -r | head -n $_limit | while read DATE ; do
+        --use-mailmap \
-        echo
+        --no-merges \
-        echo "[$DATE]"
+        --format="%cd" \
-        GIT_PAGER=cat git log --no-merges --format=" * %s (%an)" $_author --since=$DATE --until=$NEXT
+        --date=short "${_author}" $_since $_until $_pathspec \
-        NEXT=$DATE
+        | sort -u -r | head -n $_limit \
-    done
+        | while read DATE; do
+              echo -e "\n[$DATE]"
+              GIT_PAGER=cat git -c log.showSignature=false log \
+                                --use-mailmap --no-merges \
+                                --format=" * %s (%aN)" "${_author}" \
+                                --since=$DATE --until=$next
+              next=$DATE
+          done
 }
 
+################################################################################
+# MAIN
+
+# Check to make sure all utilities required for this script are installed
+checkUtils
+
 # Check if we are currently in a git repo.
 git rev-parse --is-inside-work-tree > /dev/null
 
-if [ $# -eq 1 ]
+# Parse non-interative commands
-  then
+if [[ "$#" -eq 1 ]]; then
-     case $1 in
+    case "$1" in
-        "suggestReviewers")
+        -r|--suggest-reviewers) suggestReviewers;;
-           suggestReviewers
+        -T|--detailed-git-stats) detailedGitStats;;
-           ;;
+        -R|--git-stats-by-branch)
-        "detailedGitStats")
+            branch=""
-           detailedGitStats
+            while [[ -z "${branch}" ]]; do 
-           ;;
+                read -r -p "Which branch? " branch
-        "branchTree")
+            done
-           branchTree
+            detailedGitStats "${branch}";;
-           ;;
+        -b|--branch-tree) branchTree;;
-        "commitsPerDay")
+        -d|--commits-per-day) commitsPerDay;;
-           commitsPerDay
+        -a|--commits-per-author) commitsPerAuthor;;
-           ;;
+        -S|--my-daily-stats) myDailyStats;;
-        "commitsPerAuthor")
+        -C|--contributors) contributors;;
-           commitsPerAuthor
+        -D|--branches-by-date) branchesByDate;;
-           ;;
+        -c|--changelogs) changelogs;;
-        "myDailyStats")
+        -L|--changelogs-by-author)
-           myDailyStats
+            author="${_GIT_AUTHOR:-}"
-           ;;
+            while [[ -z "${author}" ]]; do 
-        "contributors")
+                read -r -p "Which author? " author
-           contributors
+            done
-           ;;
+            changelogs "${author}";;
-        "branchesByDate")
+        -w|--commits-by-weekday) commitsByWeekday;;
-           branchesByDate
+        -o|--commits-by-hour) commitsByHour;;
-           ;;
+        -A|--commits-by-author-by-hour)
-        "changelogs")
+            author="${_GIT_AUTHOR:-}"
-           changelogs
+            while [[ -z "${author}" ]]; do 
-           ;;
+                read -r -p "Which author? " author
-        "changelogsByAuthor")
+            done
-           author="${_GIT_AUTHOR:-}"
+            commitsByHour "${author}";;
-           while [ -z "$author" ]; do read -p "Which author? " author; done
+        -m|--commits-by-month) commitsByMonth;;
-           changelogs "$author"
+        -j|--json-output) 
-           ;;
+            json_path=""
-        "commitsByWeekday")
+            while [[ -z "${json_path}" ]]; do
-           commitsByWeekday
+                read -r -p "Path to save JSON file: " json_path
-           ;;
+                if [[ ! -w "${json_path}" ]]; then
-        "commitsByHour")
+                    echo "Invalid path or permission denied to write to given area."
-           commitsByHour
+                    json_path=""
-           ;;
+                fi
-        "commitsByAuthorByHour")
+            done
-           author="${_GIT_AUTHOR:-}"
+            jsonOutput "${json_path}";;
-	   while [ -z "$author" ]; do read -p "Which author? " author; done
+        -h|-\?|--help) usage;;
-           commitsByHour "$author"
+        *) echo "Invalid argument"; usage; exit 1;;
-           ;;
-        "commitsByMonth")
-           commitsByMonth
-           ;;
-        *)
-           echo "Invalid argument. Possible arguments: suggestReviewers, detailedGitStats, commitsPerDay, commitsByMonth, commitsByWeekday, commitsByHour, commitsByAuthorByHour, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs, changelogsByAuthor"
-           exit 1
-           ;;
-     esac
-     exit 0;
-fi
-
-if [ $# -gt 1 ]
-    then
-    echo "Usage: git quick-stats <optional-command-to-execute-directly>";
-    exit 1;
-fi
-
-clear
-show_menu
-
-while [ opt != '' ]
-    do
-    if [[ $opt = "" ]]; then
-        exit;
-    else
-        clear
-        case $opt in
-        1)
-           detailedGitStats
-           show_menu
-           ;;
-        2)
-           changelogs
-           show_menu
-           ;;
-        3)
-           author=''
-           while [ -z "$author" ]; do read -p "Which author? " author; done
-           changelogs "$author"
-           show_menu
-           ;;
-        4)
-           myDailyStats
-           show_menu
-           ;;
-        5)
-           branchTree
-           show_menu
-           ;;
-        6)
-           branchesByDate
-           show_menu
-           ;;
-        7)
-           contributors
-           show_menu
-           ;;
-        8)
-           commitsPerAuthor
-           show_menu
-           ;;
-        9)
-           commitsPerDay
-           show_menu
-           ;;
-        10)
-           commitsByMonth
-           show_menu
-           ;;
-        11)
-           commitsByWeekday
-           show_menu
-           ;;
-        12)
-           commitsByHour
-           show_menu
-           ;;
-        13)
-           author=''
-	   while [ -z "$author" ]; do read -p "Which author? " author; done
-           commitsByHour "$author"
-           show_menu
-           ;;
-        14)
-           suggestReviewers
-           show_menu
-           ;;
-        q)
-           exit
-           ;;
-        \n)
-           exit
-           ;;
-        *)
-           clear
-           option_picked "Pick an option from the menu"
-           show_menu
-           ;;
-
     esac
+    exit 0;
 fi
+[[ "$#" -gt 1 ]] && { echo "Invalid arguments"; usage; exit 1; }
+
+# Parse interactive commands
+clear
+showMenu
+
+while [[ "${opt}" != "" ]]; do
+    clear
+    case "${opt}" in
+        1) detailedGitStats; showMenu;;
+        2) branch=""
+           while [[ -z "${branch}" ]]; do 
+               read -r -p "Which branch? " branch
+           done
+           detailedGitStats "${branch}"; showMenu;;
+        3) changelogs; showMenu;;
+        4) author=""
+           while [[ -z "${author}" ]]; do 
+               read -r -p "Which author? " author
+           done
+           changelogs "${author}"; showMenu;;
+        5) myDailyStats; showMenu;;
+        6) json_path=""
+           while [[ -z "${json_path}" ]]; do
+               read -r -p "Path to save JSON file: " json_path
+               if [[ ! -w "${json_path}" ]]; then
+                   echo "Invalid path or permission denied to write to given area."
+                   json_path=""
+               fi
+           done
+           jsonOutput "${json_path}"; showMenu;;
+        7) branchTree; showMenu;;
+        8) branchesByDate; showMenu;;
+        9) contributors; showMenu;;
+       10) commitsPerAuthor; showMenu;;
+       11) commitsPerDay; showMenu;;
+       12) commitsByMonth; showMenu;;
+       13) commitsByWeekday; showMenu;;
+       14) commitsByHour; showMenu;;
+       15) author=""
+           while [[ -z "${author}" ]]; do 
+               read -r -p "Which author? " author
+           done
+           commitsByHour "${author}"; showMenu;;
+       16) suggestReviewers; showMenu;;
+       q|"\n") exit;;
+       *) clear; optionPicked "Pick an option from the menu"; showMenu;;
+    esac
 done

git-quick-stats.1

@@ -0,0 +1,126 @@
+.TH git-quick-stats "1" "January 2019" "git-quick-stats" "User Commands"
+.SH NAME
+.B git\-quick\-stats 
+\- Simple and efficient way to access various stats in a git repository.
+.SH SYNOPSIS
+.PP
+For non\-interactive mode: 
+.B git\-quick\-stats [OPTIONS]
+.PP
+For interactive mode: 
+.B git-quick-stats
+.PP
+.SH DESCRIPTION
+.PP
+Any git repository contains tons of information about commits, contributors,
+and files. Extracting this information is not always trivial, mostly because
+of a gadzillion options to a gadzillion git commands.
+This program allows you to see detailed information about a git repository.
+.PP
+.SH OPTIONS
+.HP
+\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
+.IP
+show the best people to contact to review code
+.HP
+.PP
+\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
+.IP
+give a detailed list of git stats
+.HP
+.PP
+\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
+.IP
+see detailed list of git stats by branch
+.HP
+.PP
+\fB\-d\fR, \fB\-\-commits\-per\-day\fR
+.IP
+displays a list of commits per day
+.HP
+.PP
+\fB\-m\fR, \fB\-\-commits\-by\-month\fR
+.IP
+displays a list of commits per month
+.HP
+.PP
+\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
+.IP
+displays a list of commits per weekday
+.HP
+.PP
+\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
+.IP
+displays a list of commits per hour
+.HP
+.PP
+\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
+.IP
+displays a list of commits per hour by author
+.HP
+.PP
+\fB\-a\fR, \fB\-\-commits\-per\-author\fR
+.IP
+displays a list of commits per author
+.HP
+.PP
+\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
+.IP
+see your current daily stats
+.HP
+.PP
+\fB\-C\fR, \fB\-\-contributors\fR
+.IP
+see a list of everyone who contributed to the repo
+.HP
+.PP
+\fB\-b\fR, \fB\-\-branch\-tree\fR
+.IP
+show an ASCII graph of the git repo branch history
+.HP
+.PP
+\fB\-D\fR, \fB\-\-branches\-by\-date\fR
+.IP
+show branches by date
+.HP
+.PP
+\fB\-c\fR, \fB\-\-changelogs\fR
+.IP
+see changelogs
+.HP
+.PP
+\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
+.IP
+see changelogs by author
+.HP
+.PP
+\fB\-j\fR, \fB\-\-json\-output\fR
+.IP
+save git log as a JSON formatted file to a specified area
+.HP
+.PP
+\fB\-h\fR, \-?, \fB\-\-help\fR
+.IP
+display this help text in the terminal
+.PP
+.SH ADDITIONAL USAGE
+You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
+.IP
+.PP
+.B  export _GIT_SINCE="2017\-01\-20"
+.IP
+.PP
+You can set _GIT_LIMIT for limited output log, example:
+.PP
+.B  export _GIT_LIMIT=20
+.PP
+You can exclude directories or files from the stats by using pathspec, example:
+.PP
+.B export _GIT_PATHSPEC=':!pattern'
+.PP
+You can switch to the legacy color scheme, example:
+.PP
+.B export _MENU_THEME=legacy
+.
+.fi
+

tests/commands_test.sh

@@ -3,17 +3,16 @@
 . tests/assert.sh -v
 
 src="./git-quick-stats"
-
+assert "$src fail" "Invalid argument\n\nNAME\n    git-quick-stats - Simple and efficient way to access various stats in a git repo\n\nSYNOPSIS\n    For non-interactive mode: git-quick-stats [OPTIONS]\n    For interactive mode: git-quick-stats\n\nDESCRIPTION\n    Any git repository contains tons of information about commits, contributors,\n    and files. Extracting this information is not always trivial, mostly because\n    of a gadzillion options to a gadzillion git commands.\n\n    This program allows you to see detailed information about a git repository.\n\nOPTIONS\n    -r, --suggest-reviewers\n        show the best people to contact to review code\n    -T, --detailed-git-stats\n        give a detailed list of git stats\n    -R, --git-stats-by-branch\n        see detailed list of git stats by branch\n    -d, --commits-per-day\n        displays a list of commits per day\n    -m, --commits-by-month\n        displays a list of commits per month\n    -w, --commits-by-weekday\n        displays a list of commits per weekday\n    -o, --commits-by-hour\n        displays a list of commits per hour\n    -A, --commits-by-author-by-hour\n        displays a list of commits per hour by author\n    -a, --commits-per-author\n        displays a list of commits per author\n    -S, --my-daily-stats\n        see your current daily stats\n    -C, --contributors\n        see a list of everyone who contributed to the repo\n    -b, --branch-tree\n        show an ASCII graph of the git repo branch history\n    -D, --branches-by-date\n        show branches by date\n    -c, --changelogs\n        see changelogs\n    -L, --changelogs-by-author\n        see changelogs by author\n    -j, --json-output\n        save git log as a JSON formatted file to a specified area\n    -h, -?, --help\n        display this help text in the terminal\n\nADDITIONAL USAGE\n    You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log\n        ex: export _GIT_SINCE=\"2017-01-20\"\n    You can set _GIT_LIMIT for limited output log\n        ex: export _GIT_LIMIT=20\n    You can exclude directories or files from the stats by using pathspec\n        ex: export _GIT_PATHSPEC=':!pattern'\n    You can set _MENU_THEME to display the legacy color scheme\n        ex: export _MENU_THEME=legacy"
-assert "$src fail" "Invalid argument. Possible arguments: suggestReviewers, detailedGitStats, commitsPerDay, commitsByMonth, commitsByWeekday, commitsByHour, commitsByAuthorByHour, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs, changelogsByAuthor"
 assert_raises "$src fail" 1
 
-assert_contains "$src suggestReviewers" "Suggested code reviewers (based on git history)" 127
+assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
-assert_raises "$src suggestReviewers" 0
+assert_raises "$src --suggest-reviewers" 0
 
-assert_contains "$src detailedGitStats" "Contribution stats" 127
+assert_contains "$src --detailed-git-stats" "Contribution stats" 127
-assert_raises "$src detailedGitStats" 0
+assert_raises "$src --detailed-git-stats" 0
 
-assert_contains "$src commitsPerDay" "Git commits per date" 127
+assert_contains "$src --commits-per-day" "Git commits per date" 127
-assert_raises "$src commitsPerDay" 0
+assert_raises "$src --commits-per-day" 0
 
 assert_end