Merge pull request #129 from treussart/add_git_branch_option

Add git branch option

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Lukáš Mešťan
+Copyright (c) 2021 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

README.md

@@ -178,6 +178,14 @@ export _GIT_MERGE_VIEW="enable"
 export _GIT_MERGE_VIEW="exclusive"
 ```
 
+### Git branch
+
+You can set the variable `_GIT_BRANCH` to set the branch of the stats. Works with commands `--git-stats-by-branch`. 
+
+```bash
+export _GIT_BRANCH="master"
+```
+
 ### Color themes
 
 You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`

git-quick-stats

@@ -14,7 +14,7 @@ _since=${_GIT_SINCE:-}
 if [[ -n "${_since}" ]]; then
     _since="--since=$_since"
 else
-    _since="--since=1970-01-01"
+    _since="--since=2005-04-07"
 fi
 
 # End of git log date. Respects all git datetime formats
@@ -61,7 +61,7 @@ fi
 _log_options=${_GIT_LOG_OPTIONS:-}
 if [[ -n "${_log_options}" ]]; then
     _log_options=$_log_options
-else 
+else
     _log_options=""
 fi
 
@@ -158,7 +158,9 @@ ADDITIONAL USAGE
     You can also set _GIT_MERGE_VIEW to only show merge commits
         ex: export _GIT_MERGE_VIEW=exclusive
     You can set _MENU_THEME to display the legacy color scheme
-        ex: export _MENU_THEME=legacy"
+        ex: export _MENU_THEME=legacy
+    You can set _GIT_BRANCH to set the branch of the stats
+        ex: export _GIT_BRANCH=master"
 }
 
 ################################################################################
@@ -224,12 +226,9 @@ showMenu() {
 # 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"}
+    local msg=${*:-"Error: No message passed"}
 
-    echo -e "${bold}${red}${msg}${reset}\n"
+    echo -e "${msg}\n"
 }
 
 ################################################################################
@@ -380,11 +379,13 @@ function jsonOutput() {
 function commitsByMonth() {
     optionPicked "Git commits by month:"
     echo -e "\tmonth\tsum"
+    local startYear=$(echo "$_since" | grep -Eo "[0-9]{4}")
+    local endYear=$(echo "$_until" | grep -Eo "[0-9]{4}")
     for i in Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
     do
         echo -en "\t$i\t"
         git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
-            "$_since" "$_until" $_log_options | grep " $i " | wc -l
+            "$_since" "$_until" $_log_options | grep -E "($startYear|$endYear)" | grep " $i " | wc -l
     done | awk '{
         count[$1] = $2
         total += $2
@@ -411,12 +412,14 @@ function commitsByMonth() {
 function commitsByWeekday() {
     optionPicked "Git commits by weekday:"
     echo -e "\tday\tsum"
+    local startYear=$(echo "$_since" | grep -Eo "[0-9]{4}")
+    local endYear=$(echo "$_until" | grep -Eo "[0-9]{4}")
     local counter=1
     for i in Mon Tue Wed Thu Fri Sat Sun
     do
         echo -en "\t$counter\t$i\t"
         git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
-            "$_since" "$_until" $_log_options | grep "$i " | wc -l
+            "$_since" "$_until" $_log_options | grep -E "($startYear|$endYear)" | grep "$i " | wc -l
         counter=$((counter+1))
     done | awk '{
     }
@@ -456,11 +459,14 @@ function commitsByHour() {
         _author="--author=${author}"
     fi
     echo -e "\thour\tsum"
+
+    local startYear=$(echo "$_since" | grep -Eo "[0-9]{4}")
+    local endYear=$(echo "$_until" | grep -Eo "[0-9]{4}")
     for i in $(seq -w 0 23)
     do
         echo -ne "\t$i\t"
             git -c log.showSignature=false shortlog -n $_merges --format='%ad %s' \
-                "${_author}" "$_since" "$_until" $_log_options | grep ' '$i: | wc -l
+                "${_author}" "$_since" "$_until" $_log_options | grep -E "($startYear|$endYear)" | grep ' '$i: | wc -l
     done | awk '{
         count[$1] = $2
         total += $2
@@ -542,7 +548,7 @@ function myDailyStats() {
                        --author="$(git config user.name)" $_merges \
                        --since=$(date "+%Y-%m-%dT00:00:00") \
                        --until=$(date "+%Y-%m-%dT23:59:59") --reverse $_log_options \
-                       | grep commit | wc -l) "commits"
+                       | grep -E "commit [a-f0-9]{40}" | wc -l) "commits"
 }
 
 ################################################################################
@@ -629,7 +635,7 @@ if [[ "$#" -eq 1 ]]; then
         -r|--suggest-reviewers) suggestReviewers;;
         -T|--detailed-git-stats) detailedGitStats;;
         -R|--git-stats-by-branch)
-            branch=""
+            branch="${_GIT_BRANCH:-}"
             while [[ -z "${branch}" ]]; do
                 read -r -p "Which branch? " branch
             done

git-quick-stats.1

@@ -1,13 +1,13 @@
 .TH git-quick-stats "1" "January 2020" "git-quick-stats" "User Commands"
 .SH NAME
-.B git\-quick\-stats 
+.B git\-quick\-stats
 \- Simple and efficient way to access various stats in a git repository.
 .SH SYNOPSIS
 .PP
-For non\-interactive mode: 
+For non\-interactive mode:
 .B git\-quick\-stats [OPTIONS]
 .PP
-For interactive mode: 
+For interactive mode:
 .B git-quick-stats
 .PP
 .SH DESCRIPTION
@@ -131,6 +131,10 @@ You can also set _GIT_MERGE_VIEW to only show merge commits, example:
 You can switch to the legacy color scheme, example:
 .PP
 .B export _MENU_THEME=legacy
+.PP
+You can set _GIT_BRANCH to set the branch of the stats, example:
+.PP
+.B  export _GIT_BRANCH="master"
 .
 .fi
 

tests/assert.sh

@@ -17,12 +17,16 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+set -o nounset
+
 export DISCOVERONLY=${DISCOVERONLY:-}
 export DEBUG=${DEBUG:-}
 export STOP=${STOP:-}
 export INVARIANT=${INVARIANT:-}
 export CONTINUE=${CONTINUE:-}
 
+GREP=${GREP:-grep}
+
 args="$(getopt -n "$0" -l \
     verbose,help,stop,discover,invariant,continue vhxdic $*)" \
 || exit -1
@@ -132,12 +136,12 @@ assert_raises() {
 _assert_with_grep() {
     local grep_modifier="$1"
     local output="$($2)"
-    local exitcode="$4" || 0
+    local exitcode=0
     shift 2
 
     while [ $# != 0 ]; do
-    	assert_raises "echo '$output' | $GREP $grep_modifier '$1'" $exitcode || return 1
-    	shift
+        assert_raises "echo '$output' | $GREP $grep_modifier '$1'" $exitcode || return 1
+        shift
     done
 }
 

tests/commands_test.sh

@@ -69,17 +69,19 @@ ADDITIONAL USAGE
     You can also set _GIT_MERGE_VIEW to only show merge commits
         ex: export _GIT_MERGE_VIEW=exclusive
     You can set _MENU_THEME to display the legacy color scheme
-        ex: export _MENU_THEME=legacy"
+        ex: export _MENU_THEME=legacy
+    You can set _GIT_BRANCH to set the branch of the stats
+        ex: export _GIT_BRANCH=master"
 
 assert_raises "$src fail" 1
 
-assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)" 127
+assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)"
 assert_raises "$src --suggest-reviewers" 0
 
-assert_contains "$src --detailed-git-stats" "Contribution stats" 127
+assert_contains "$src --detailed-git-stats" "Contribution stats"
 assert_raises "$src --detailed-git-stats" 0
 
-assert_contains "$src --commits-per-day" "Git commits per date" 127
+assert_contains "$src --commits-per-day" "Git commits per date"
 assert_raises "$src --commits-per-day" 0
 
 assert_end