Updating README.md

Merge pull request #67 from joshuadeguzman/feature-request/contribution-stats-by-branch
Add non-interactive detailed git stats for a specific branch
2025-12-16 12:00:12 +01:00 · 2019-05-10 13:18:12 -04:00 · 2019-05-10 12:48:55 -04:00 · 2019-05-10 23:59:12 +08:00 · 2019-05-10 23:50:32 +08:00 · 2019-05-10 18:57:04 +08:00
6 changed files with 342 additions and 164 deletions
--- a/2
+++ b/2
@@ -1,6 +1,6 @@
 MIT License

-Copyright (c) 2018 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
--- a/29
+++ b/29
@@ -1,42 +1,39 @@
 PREFIX ?= /usr/local
 TASK_DONE = echo -e "\n✓ $@ done\n"
-# files that need mode 755
-EXEC_FILES=git-quick-stats

 .PHONY: test

 all:
-	@echo "usage: make install"
-	@echo "       make reinstall"
-	@echo "       make uninstall"
-	@echo "       make test"
+	@echo "Usage:"
+	@echo "  make install"
+	@echo "  make reinstall"
+	@echo "  make uninstall"
+	@echo "  make test"

 help:
 	$(MAKE) all
 	@$(TASK_DONE)

 install:
-	mkdir -p $(PREFIX)/bin
-	install -m 0755 $(EXEC_FILES) $(PREFIX)/bin/$(EXEC_FILES)
-	git config --global alias.quick-stats '! $(PREFIX)/bin/$(EXEC_FILES)'
+	install -d -m 0755 $(PREFIX)/bin
+	install -m 0755 git-quick-stats $(PREFIX)/bin/git-quick-stats
 	$(MAKE) man
 	@$(TASK_DONE)

 uninstall:
-	test -d $(PREFIX)/bin && \
-	cd $(PREFIX)/bin && \
-	rm -f $(EXEC_FILES) && \
-	git config --global --unset alias.quick-stats
+	rm -f $(PREFIX)/bin/git-quick-stats
+	rm -f $(PREFIX)/share/man/man1/git-quick-stats.1
 	@$(TASK_DONE)

 reinstall:
-	@curl -s https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats > git-quick-stats
-	$(MAKE) uninstall && \
+	@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats
+	@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats.1
 	$(MAKE) install
 	@$(TASK_DONE)

 man:
-	install -g 0 -o 0 -m 0644 git-quick-stats.1 /usr/share/man/man1/
+	install -d -m 0755 $(PREFIX)/share/man/man1/
+	install -m 0644 git-quick-stats.1 $(PREFIX)/share/man/man1/

 test:
 	tests/commands_test.sh
--- a/README.md
+++ b/README.md
@@ -1,14 +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)](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)
-[![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)
-
-> `git quick-stats` is a simple and efficient way to access various statistics in git repository.
+> `git-quick-stats` is a simple and efficient way to access various statistics in git repository.

 > 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 – 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/57544421-4891a700-7325-11e9-9cdd-034a6619ae0f.png)
+
+
 ## Table of Contents

 [**Screenshots**](#screenshots)
@@ -36,28 +35,20 @@

 ## 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/57544420-4891a700-7325-11e9-876a-15df90bce420.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/57544419-47f91080-7325-11e9-82d3-57e4f98be240.png)


 ## Usage

 ```bash
-git quick-stats
-# or
 git-quick-stats
 ```

 Or you can use (non-interactive) direct execution:

-`git quick-stats <optional-command-to-execute-directly>`
+`git-quick-stats <optional-command-to-execute-directly>`

 Possible arguments in short and long form:

@@ -66,6 +57,8 @@ Possible arguments in short and long form:
    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
@@ -211,3 +204,33 @@ MIT see [LICENSE][] for the full license text.
   [landing page]: http://arzzen.github.io/git-quick-stats
   [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"></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>
+
+
--- a/410
+++ b/410
@@ -1,4 +1,8 @@
 #!/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
@@ -20,25 +24,35 @@ else
    _limit=10
 fi

+################################################################################
+# DESC: Checks to make sure the user has the appropriate utilities installed
+# ARGS: None
+# OUTS: None
+################################################################################
 function check_utils() {
-    local HELP_MSG="not found. Please make sure this is installed and in PATH."
+    local msg="not found. Please make sure this is installed and in PATH."

-    command -v awk >/dev/null 2>&1 || { echo >&2 "awk ${HELP_MSG}"; exit 1; }
-    command -v basename >/dev/null 2>&1 || { echo >&2 "basename ${HELP_MSG}"; exit 1; }
-    command -v cat > /dev/null 2>&1 || { echo >&2 "cat ${HELP_MSG}"; exit 1; }
-    command -v column > /dev/null 2>&1 || { echo >&2 "column ${HELP_MSG}"; exit 1; }
-    command -v echo > /dev/null 2>&1 || { echo >&2 "echo ${HELP_MSG}"; exit 1; }
-    command -v git > /dev/null 2>&1 || { echo >&2 "git ${HELP_MSG}"; exit 1; }
-    command -v grep > /dev/null 2>&1 || { echo >&2 "grep ${HELP_MSG}"; exit 1; }
-    command -v head > /dev/null 2>&1 || { echo >&2 "head ${HELP_MSG}"; exit 1; }
-    command -v seq > /dev/null 2>&1 || { echo >&2 "seq ${HELP_MSG}"; exit 1; }
-    command -v sort > /dev/null 2>&1 || { echo >&2 "sort ${HELP_MSG}"; exit 1; }
-    command -v tput > /dev/null 2>&1 || { echo >&2 "tput ${HELP_MSG}"; exit 1; }
-    command -v tr > /dev/null 2>&1 || { echo >&2 "tr ${HELP_MSG}"; exit 1; }
-    command -v uniq > /dev/null 2>&1 || { echo >&2 "uniq ${HELP_MSG}"; exit 1; }
-    command -v wc > /dev/null 2>&1 || { echo >&2 "wc ${HELP_MSG}"; exit 1; }
+    command -v awk >/dev/null 2>&1 || { echo >&2 "awk ${msg}"; exit 1; }
+    command -v basename >/dev/null 2>&1 || { echo >&2 "basename ${msg}"; exit 1; }
+    command -v cat >/dev/null 2>&1 || { echo >&2 "cat ${msg}"; exit 1; }
+    command -v column >/dev/null 2>&1 || { echo >&2 "column ${msg}"; exit 1; }
+    command -v echo >/dev/null 2>&1 || { echo >&2 "echo ${msg}"; exit 1; }
+    command -v git >/dev/null 2>&1 || { echo >&2 "git ${msg}"; exit 1; }
+    command -v grep >/dev/null 2>&1 || { echo >&2 "grep ${msg}"; exit 1; }
+    command -v head >/dev/null 2>&1 || { echo >&2 "head ${msg}"; exit 1; }
+    command -v seq >/dev/null 2>&1 || { echo >&2 "seq ${msg}"; exit 1; }
+    command -v sort >/dev/null 2>&1 || { echo >&2 "sort ${msg}"; exit 1; }
+    command -v tput >/dev/null 2>&1 || { echo >&2 "tput ${msg}"; exit 1; }
+    command -v tr >/dev/null 2>&1 || { echo >&2 "tr ${msg}"; exit 1; }
+    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; }
 }

+################################################################################
+# DESC: Help information printed to stdout during non-interactive mode
+# ARGS: None
+# OUTS: None
+################################################################################
 function usage() { 
    local program=$(basename "$0")

@@ -62,6 +76,8 @@ OPTIONS
        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
@@ -98,110 +114,162 @@ ADDITIONAL USAGE
        ex: export _GIT_PATHSPEC=':!directory'"
 }

+################################################################################
+# 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 show_menu() {
-    local NORMAL=$(tput sgr0)
-    local CYAN_TEXT=$(tput setaf 6)
-    local RED_TEXT=$(tput setaf 1)
-    local YELLOW_TEXT=$(tput setaf 3)
+    local normal=$(tput sgr0)
+    local cyan=$(tput setaf 6)
+    local red=$(tput setaf 1)
+    local yellow=$(tput setaf 3)
    
-    echo -e "\n${RED_TEXT} Generate: ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  1)${CYAN_TEXT} Contribution stats (by author) ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  2)${CYAN_TEXT} Git changelogs (last $_limit days)${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  3)${CYAN_TEXT} Git changelogs by author ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  4)${CYAN_TEXT} My daily status ${NORMAL}"
-    echo -e "${RED_TEXT} List: ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  5)${CYAN_TEXT} Branch tree view (last $_limit)${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  6)${CYAN_TEXT} All branches (sorted by most recent commit) ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  7)${CYAN_TEXT} All contributors (sorted by name) ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  8)${CYAN_TEXT} Git commits per author ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT}  9)${CYAN_TEXT} Git commits per date ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 10)${CYAN_TEXT} Git commits per month ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 11)${CYAN_TEXT} Git commits per weekday ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 12)${CYAN_TEXT} Git commits per hour ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 13)${CYAN_TEXT} Git commits by author per hour ${NORMAL}"
-    echo -e "${RED_TEXT} Suggest: ${NORMAL}"
-    echo -e "${CYAN_TEXT} ${YELLOW_TEXT} 14)${CYAN_TEXT} Code reviewers (based on git history) ${NORMAL}"
-    echo -e "\n${YELLOW_TEXT}Please enter a menu option or ${RED_TEXT}press enter to exit. ${NORMAL}"
+    echo -e "\n${red} Generate: ${normal}"
+    echo -e "${cyan} ${yellow}  1)${cyan} Contribution stats (by author) ${normal}"
+    echo -e "${cyan} ${yellow}  2)${cyan} Contribution stats (by author) on a specific branch ${normal}"
+    echo -e "${cyan} ${yellow}  3)${cyan} Git changelogs (last $_limit days)${normal}"
+    echo -e "${cyan} ${yellow}  4)${cyan} Git changelogs by author ${normal}"
+    echo -e "${cyan} ${yellow}  5)${cyan} My daily status ${normal}"
+    echo -e "${red} List: ${normal}"
+    echo -e "${cyan} ${yellow}  6)${cyan} Branch tree view (last $_limit)${normal}"
+    echo -e "${cyan} ${yellow}  7)${cyan} All branches (sorted by most recent commit) ${normal}"
+    echo -e "${cyan} ${yellow}  8)${cyan} All contributors (sorted by name) ${normal}"
+    echo -e "${cyan} ${yellow}  9)${cyan} Git commits per author ${normal}"
+    echo -e "${cyan} ${yellow} 10)${cyan} Git commits per date ${normal}"
+    echo -e "${cyan} ${yellow} 11)${cyan} Git commits per month ${normal}"
+    echo -e "${cyan} ${yellow} 12)${cyan} Git commits per weekday ${normal}"
+    echo -e "${cyan} ${yellow} 13)${cyan} Git commits per hour ${normal}"
+    echo -e "${cyan} ${yellow} 14)${cyan} Git commits by author per hour ${normal}"
+    echo -e "${red} Suggest: ${normal}"
+    echo -e "${cyan} ${yellow} 15)${cyan} Code reviewers (based on git history) ${normal}"
+    echo -e "\n${yellow}Please enter a menu option or ${red}press enter to exit. ${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 option_picked() {
-    local BOLD=$(tput bold)
-    local RED_TEXT=$(tput setaf 1)
-    local COLOR="${BOLD}${RED_TEXT}"
-    local RESET=$(tput sgr0)
-    local MESSAGE=${*:-"${RESET}Error: No message passed"}
+    local bold=$(tput bold)
+    local red=$(tput setaf 1)
+    local reset=$(tput sgr0)
+    local msg=${*:-"${reset}Error: No message passed"}
    
-    echo -e "${COLOR}${MESSAGE}${RESET}\n"
+    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: None
+# OUTS: None
+################################################################################
 function detailedGitStats() {
-    option_picked "Contribution stats (by author):"
-    git log --use-mailmap --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 '
-    function printStats(author) {
-      printf "\t%s:\n", 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

-      if( more["total"] > 0 ) {
-        printf "\t  insertions:    %d (%.0f%%)\n", more[author], (more[author] / more["total"] * 100)
-      }
+    # Prompt message
+    if [[ $is_branch_existing && -n "${_branch}" ]]; then
+        option_picked "Contribution stats (by author) on ${_branch} branch:"
+    elif [[ -n "${branch}" && -z "${_branch}" ]]; then
+        option_picked "Branch \"${branch}\" does not exist.\nContribution stats (by author) on the current branch:"
+    else
+        option_picked "Contribution stats (by author) on the current branch:"
+    fi

-      if( less["total"] > 0 ) {
-        printf "\t  deletions:     %d (%.0f%%)\n", less[author], (less[author] / less["total"] * 100)
-      }
+    git -c log.showSignature=false log ${_branch} --use-mailmap --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 '
+        function printStats(author) {
+        printf "\t%s:\n", author

-      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)
+        if(more["total"] > 0) {
+            printf "\t  insertions:    %d (%.0f%%)\n", more[author], \
+                (more[author] / more["total"] * 100)
        }
-      }
-      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):"
-    git log --use-mailmap --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) {
@@ -210,13 +278,19 @@ function suggestReviewers() {
    }' | column -t -s,
 }

+################################################################################
+# DESC: Displays a horizontal bar graph based on total commits per month
+# ARGS: None
+# OUTS: None
+################################################################################
 function commitsByMonth() {
    option_picked "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"
-        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 
@@ -235,13 +309,19 @@ function commitsByMonth() {
    }' | 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:"
    echo -e "\tday\tsum"
    for i in Mon Tue Wed Thu Fri Sat Sun
    do
        echo -en "\t$i\t"
-        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 '{

    }
@@ -265,6 +345,11 @@ function commitsByWeekday() {
    }' | 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=""
@@ -280,7 +365,8 @@ function commitsByHour() {
    for i in $(seq -w 0 23)
    do
        echo -ne "\t$i\t"
-            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 
@@ -299,14 +385,28 @@ function commitsByHour() {
    }' | 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:";
-    git log --use-mailmap --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:"
-    git shortlog $_since $_until --no-merges -n -s | sort -nr | LC_ALL=C awk '
+    git -c log.showSignature=false shortlog $_since $_until --no-merges -n -s \
+        | sort -nr | LC_ALL=C awk '
    { args[NR] = $0; sum += $0 }
    END {
      for (i = 1; i <= NR; ++i) {
@@ -315,6 +415,11 @@ function commitsPerAuthor()  {
    }' | 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:"
    git diff --shortstat '@{0 day ago}' | sort -nr | tr ',' '\n' | LC_ALL=C awk '
@@ -325,25 +430,53 @@ function myDailyStats() {
      }
    }'

-    echo -e "\t" $(git 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"
+    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):"
-    git log --use-mailmap --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:"
-    git 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))
+    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):"
-    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=""
@@ -357,14 +490,24 @@ function changelogs() {
    fi

    NEXT=$(date +%F)
-    git log --use-mailmap --no-merges --format="%cd" --date=short "${_author}" $_since $_until $_pathspec | sort -u -r | head -n $_limit | while read DATE ; do
-        echo
-        echo "[$DATE]"
-        GIT_PAGER=cat git log --use-mailmap --no-merges --format=" * %s (%aN)" "${_author}" --since=$DATE --until=$NEXT
+    git -c log.showSignature=false log \
+        --use-mailmap \
+        --no-merges \
+        --format="%cd" \
+        --date=short "${_author}" $_since $_until $_pathspec \
+        | sort -u -r | head -n $_limit | 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
 check_utils

@@ -376,6 +519,12 @@ if [[ "$#" -eq 1 ]]; then
    case "$1" in
        -r|--suggest-reviewers) suggestReviewers;;
        -T|--detailed-git-stats) detailedGitStats;;
+        -R|--git-stats-by-branch)
+            branch=""
+            while [[ -z "${branch}" ]]; do 
+                read -r -p "Which branch? " branch
+            done
+            detailedGitStats "${branch}";;
        -b|--branch-tree) branchTree;;
        -d|--commits-per-day) commitsPerDay;;
        -a|--commits-per-author) commitsPerAuthor;;
@@ -413,27 +562,32 @@ while [[ "${opt}" != "" ]]; do
    clear
    case "${opt}" in
        1) detailedGitStats; show_menu;;
-        2) changelogs; show_menu;;
-        3) author=""
+        2) branch=""
+           while [[ -z "${branch}" ]]; do 
+               read -r -p "Which branch? " branch
+           done
+           detailedGitStats "${branch}"; show_menu;;
+        3) changelogs; show_menu;;
+        4) author=""
           while [[ -z "${author}" ]]; do 
               read -r -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=""
+        5) myDailyStats; show_menu;;
+        6) branchTree; show_menu;;
+        7) branchesByDate; show_menu;;
+        8) contributors; show_menu;;
+        9) commitsPerAuthor; show_menu;;
+       10) commitsPerDay; show_menu;;
+       11) commitsByMonth; show_menu;;
+       12) commitsByWeekday; show_menu;;
+       13) commitsByHour; show_menu;;
+       14) author=""
           while [[ -z "${author}" ]]; do 
               read -r -p "Which author? " author
           done
           commitsByHour "${author}"; show_menu;;
-       14) suggestReviewers; show_menu;;
+       15) suggestReviewers; show_menu;;
       q|"\n") exit;;
       *) clear; option_picked "Pick an option from the menu"; show_menu;;
    esac
--- a/git-quick-stats.1
+++ b/git-quick-stats.1
@@ -24,12 +24,16 @@ This program allows you to see detailed information about a git repository.
 show the best people to contact to review code
 .HP
 .PP
-.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
--- a/tests/commands_test.sh
+++ b/tests/commands_test.sh
@@ -4,7 +4,7 @@

 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    suggestReviewers - see best people to contact to review code\n    detailedGitStats - displays a detailed list of git status\n    commitsPerDay - displays a list of commits per day\n    commitsByMonth - displays a list of commits per month\n    commitsByWeekday - displays a list of commits per weekday\n    commitsByHour - displays a list of commits per hour\n    commitsByAuthorByHour - see a list of commits per hour by author\n    commitsPerAuthor - displays a list of commits per author\n    myDailyStats - see your current daily stats\n    contributors - see a list of all contributors\n    branchTree - see an ASCII graph of the git repo\n    branchesByDate - show branches by date\n    changelogs - see changelogs\n    changelogsByAuthor - see changelogs by author\n\nADDITIONAL USAGE\n    You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log\n        ex: export _GIT_SINCE=2017-20-01\n    You can set _GIT_LIMIT for limited output log\n        ex: export _GIT_LIMIT=20\n    You can exclude a directory from the stats by using pathspec\n        ex: export _GIT_PATHSPEC=':!directory'\n    \nCONTRIBUTION\n    For details regarding contribution, please see the contribution.md document\n\nLICENSE\n    This is under the MIT license. See LICENSE in the repo for more info"
-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    -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    -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-20-01\"\n    You can set _GIT_LIMIT for limited output log\n        ex: export _GIT_LIMIT=20\n    You can exclude a directory from the stats by using pathspec\n        ex: export _GIT_PATHSPEC=':!directory'"
+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    -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-20-01\"\n    You can set _GIT_LIMIT for limited output log\n        ex: export _GIT_LIMIT=20\n    You can exclude a directory from the stats by using pathspec\n        ex: export _GIT_PATHSPEC=':!directory'"
 assert_raises "$src fail" 1

 assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
Author	SHA1	Message	Date
Tom Ice	1282e4b46f	Updating README.md	2019-05-10 13:18:12 -04:00
Tom Ice	96de74cf4f	Merge pull request #67 from joshuadeguzman/feature-request/contribution-stats-by-branch Add non-interactive detailed git stats for a specific branch	2019-05-10 12:48:55 -04:00
Joshua de Guzman	096fd86324	Add new feature in man page	2019-05-10 23:59:12 +08:00
Joshua de Guzman	dd6a23568e	Add new feature in README	2019-05-10 23:50:32 +08:00
jdeguzman	48c062f8fa	Prevent logging refs when checking branch existence	2019-05-10 18:57:04 +08:00
jdeguzman	c3194f77e3	Add interactive menu for the detailed stats by branch	2019-05-10 18:08:38 +08:00
jdeguzman	52f4eff27c	Add on the current branch	2019-05-10 18:00:25 +08:00
jdeguzman	c7d456465e	Optimize branch existence validator	2019-05-10 11:00:38 +08:00
Joshua de Guzman	e9f085f20e	Add git stats by branch to the options and update unit test	2019-05-10 01:08:53 +08:00
Joshua de Guzman	625ec404bc	Update validation rules	2019-05-10 00:24:16 +08:00
jdeguzman	e6ffee5850	Add branch existence validation	2019-05-09 20:17:57 +08:00
jdeguzman	2422a010c6	Add non interactive request for detailed stats by branch	2019-05-09 19:41:47 +08:00
Lukáš Mešťan	3d86fa9664	Merge pull request #64 from opencollective/opencollective Activating Open Collective	2019-03-05 07:44:32 +01:00
Jess	a6a65faa8d	Added backers and sponsors on the README	2019-03-02 10:12:36 -08:00
Lukáš Mešťan	0cc67fd4ac	Merge pull request #63 from laurence6/master Fix some items are not displayed	2019-02-19 19:13:22 +01:00
Laurence	3344a05237	Fix some items are not displayed	2019-02-18 19:58:26 -05:00
Lukáš Mešťan	da78123ca8	Update README.md	2019-02-07 21:27:25 +01:00
Lukáš Mešťan	ad50a915b0	Merge pull request #60 from loonies/makefile Makefile improvements	2019-02-04 14:05:28 +01:00
Miodrag Tokić	88f970632f	Add man page to reinstall target Update man page on reinstall as well. Also remove unnecessary uninstall as the "install" command handles this gracefully.	2019-02-04 12:42:21 +01:00
Miodrag Tokić	7f3220abb7	Remove unnecessary Git alias Git is able to find binary by the prefixed "git" name.	2019-02-04 12:41:22 +01:00
Miodrag Tokić	7a9e9c7f85	Improve man install / uninstall - Create man directory prior to installing the page - Do not force root ownership of the man page - Remove man page when uninstalling	2019-02-03 18:10:06 +01:00
Miodrag Tokić	190ae631e5	Straightforward binary removal Remove binary using the full path instead of jumping to directory.	2019-02-03 18:06:31 +01:00
Miodrag Tokić	94ea505dbd	Replace "mkdir" with "install" Favour "install" over "mkdir" in installation scripts.	2019-02-03 18:04:13 +01:00
Miodrag Tokić	601986fbe1	Remove EXEC_FILES Variable doesn't make much sense and makes the code more convoluted.	2019-02-03 17:57:28 +01:00
Miodrag Tokić	01f60821ea	Help formatting	2019-02-03 17:44:18 +01:00
Lukáš Mešťan	6579c31047	Merge pull request #59 from tomice/master Added internal documentation and minor cleanup	2019-02-02 19:47:58 +01:00
Tom Ice	e82339b777	Added internal documentation and minor cleanup * All internal functions now have documentation describing what they are, what arguments they take, and what external variables are set in an effort to help others understand the codebase more quickly * Changed a few lines where grep \| wc -l occurred, as grep has a built-in option to do this: grep -c * Removed a $* where the suggestReviewers function expected a string but never received one during the life of the program * Adjusted some lines so they weren't quite as long, adjusted some variable names, and other minor cleanup	2019-02-01 13:51:21 -05:00
Lukáš Mešťan	f3f0ab4730	Update LICENSE	2019-01-19 13:37:04 +01:00
Lukáš Mešťan	258b52eda8	Merge pull request #58 from tomice/master Fixed issue where signatures were parsed in logs	2019-01-17 14:43:49 +01:00
Tom Ice	187c03ae98	Fixed issue where signatures were parsed in logs * When someone has the showSignature=true flag set in their .gitconfig file, gpg verifying signature related text would be parsed as if it was actual log information. This change ignores signature-related text by passing the -c log.showSignature=false option to git so it ignores a user's custom .gitconfig showSignature flag regardless as to what it is set to. Resolves: Issue #52	2019-01-16 18:10:59 -05:00