Merge pull request #136 from dotmpe/master

Misc. fixes on filtering, added commits-by-year

.github/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/

.github/FUNDING.yml

@@ -0,0 +1,6 @@
+# These are supported funding model platforms
+
+github: [arzzen]
+open_collective: git-quick-stats
+ko_fi: lukasmestan 
+custom: ['https://lukasmestan.com/thanks/']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/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.
+
+

.gitignore

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

.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

@@ -0,0 +1,32 @@
+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

Dockerfile

@@ -0,0 +1,27 @@
+FROM alpine
+
+# Copy sources
+COPY . /app
+
+# Install required packages & build git-quick-stats
+RUN     apk add --no-cache bash git make ncurses util-linux \
+    &&  cd /app \
+    &&  make install \
+    &&  rm -rf /app \
+    &&  apk del --no-cache make \
+    &&  mkdir -p /usr/local/bin \
+    &&  echo -en "#!/bin/bash\nset -e\n[[ \"\${1::1}\" == '-' ]] && set -- /usr/bin/git quick-stats \"\$@\"\nexec \"\$@\"" \
+            > /usr/local/bin/docker-entrypoint \
+    &&  chmod +x /usr/local/bin/docker-entrypoint
+
+# Declare all variables usables by git-quick-stats
+ENV _GIT_SINCE= \
+    _GIT_UNTIL= \
+    _GIT_LIMIT= \
+    _GIT_PATHSPEC= \
+    _MENU_THEME=default \
+    TERM=xterm-256color
+
+WORKDIR /git
+ENTRYPOINT [ "/usr/local/bin/docker-entrypoint" ]
+CMD [ "/usr/bin/git", "quick-stats" ]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 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

Makefile

@@ -1,18 +1,44 @@
-prefix=/usr/local
+PREFIX ?= /usr/local
+_INSTDIR ?= $(DESTDIR)$(PREFIX)
+BINDIR ?= $(_INSTDIR)/bin
+MANDIR ?= $(_INSTDIR)/share/man
+TASK_DONE = echo -e "\n✓ $@ done\n"
+SHELL := $(shell which bash)
 
-# files that need mode 755
-EXEC_FILES=git-quick-stats
+.PHONY: test
 
 all:
-	@echo "usage: make install"
+	@echo "Usage:"
+	@echo "  make install"
+	@echo "  make reinstall"
 	@echo "  make uninstall"
+	@echo "  make test"
+
+help:
+	$(MAKE) all
+	@$(TASK_DONE)
 
 install:
-	install -m 0755 $(EXEC_FILES) $(prefix)/bin
-	git config --global alias.quick-stats '! $(prefix)/bin/$(EXEC_FILES)'
+	install -d -m 0755 $(BINDIR)
+	install -m 0755 git-quick-stats $(BINDIR)/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 $(BINDIR)/git-quick-stats
+	rm -f $(MANDIR)/man1/git-quick-stats.1
+	@$(TASK_DONE)
+
+reinstall:
+	@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 -d -m 0755 $(MANDIR)/man1/
+	install -m 0644 git-quick-stats.1 $(MANDIR)/man1/
+
+test:
+	tests/commands_test.sh
+	@$(TASK_DONE)

README.md

@@ -1,80 +1,318 @@
 
-## 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)](https://formulae.brew.sh/formula/git-quick-stats#default) [![Linuxbrew package](https://repology.org/badge/version-for-repo/linuxbrew/git-quick-stats.svg)](https://repology.org/metapackage/git-quick-stats/packages)
 
-> `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 a git repository.
+>
+> Any git repository may contain tons of information about commits, contributors, and files. Extracting this information is not always trivial, mostly because there are a gadzillion options to a gadzillion git commands – I don’t think there is a single person alive who knows them all. Probably not even [Linus Torvalds](https://github.com/torvalds) himself :).
 
-## Example
-
-Suggested code reviewers (based on git history):
-![screenshot from 2017-02-04 22-00-30](https://cloud.githubusercontent.com/assets/6382002/22621490/62257c30-eb25-11e6-8608-9cfe17509464.png)
-
-Asciinema preview:
-[![asciicast](https://asciinema.org/a/6fsugv3m2vygykk49bk7l49ut.png)](https://asciinema.org/a/6fsugv3m2vygykk49bk7l49ut)
+![mainMenuScreenshot](https://user-images.githubusercontent.com/8818630/154823670-f42a111b-45f4-47fc-aea7-80059827c8e6.png)
 
 
-Want to contribute? Great! First, [read this page][].
+## Table of Contents
 
+[**Screenshots**](#screenshots)
+
+[**Usage**](#usage)
+
+* [**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 log options**](#git-log-options)
+* [**Git pathspec**](#git-pathspec)
+* [**Git merge view strategy**](#git-merge-view-strategy)
+* [**Color themes**](#color-themes)
+
+[**Installation**](#installation)
+
+* [**UNIX and Linux**](#unix-and-linux)
+* [**macOS**](#macos-homebrew)
+* [**Windows**](#windows)
+* [**Docker**](#docker)
+
+[**System requirements**](#system-requirements)
+
+* [**Dependencies**](#dependencies)
+
+[**FAQ**](#faq)
+
+[**Contribution**](#contribution)
+
+* [**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
+
+![commitsByWeekdayScreenshot](https://user-images.githubusercontent.com/8818630/154823677-e34ca867-ae61-4755-bf89-c877f809c591.png)
+
+![commitsByHourScreenshot](https://user-images.githubusercontent.com/8818630/154823679-bdadc26c-c644-4a01-b625-85e330f85d41.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>`
+```bash
+git quick-stats
+```
 
-> Possible arguments: 
-> suggestReviewers, detailedGitStats, commitsByHour, commitsByWeekday, commitsByMonth, commitsPerDay, commitsPerAuthor, myDailyStats, contributors,
-branchTree, branchesByDate, 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:
 
-You can set variable `_GIT_SINCE`, `_GIT_UNTIL` and limit the git log
+```bash
+git-quick-stats <optional-command-to-execute-directly>
+```
 
-eg:
+Or
 
-`export _GIT_SINCE="2017-20-01"`
+```bash
+git quick-stats <optional-command-to-execute-directly>
+```
 
-`export _GIT_UNTIL="2017-22-01"`
+### Command-line arguments
 
-then run `git quick-stats` (affect all stats, except "My daily status" and "Git changelogs" )
+Possible arguments in short and long form:
+
+```bash
+GENERATE OPTIONS
+    -T, --detailed-git-stats
+        give a detailed list of git stats
+    -R, --git-stats-by-branch
+        see detailed list of git stats by branch
+    -c, --changelogs
+        see changelogs
+    -L, --changelogs-by-author
+        see changelogs by author
+    -S, --my-daily-stats
+        see your current daily stats
+    -V, --csv-output-by-branch
+        output daily stats by branch in CSV format
+    -j, --json-output
+        save git log as a JSON formatted file to a specified area
+
+LIST OPTIONS
+    -b, --branch-tree
+        show an ASCII graph of the git repo branch history
+    -D, --branches-by-date
+        show branches by date
+    -C, --contributors
+        see a list of everyone who contributed to the repo
+    -a, --commits-per-author
+        displays a list of commits per author
+    -d, --commits-per-day
+        displays a list of commits per day
+    -Y, --commits-by-year
+        displays a list of commits per year
+    -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
+    -z, --commits-by-timezone
+        displays a list of commits per timezone
+    -Z, --commits-by-author-by-timezone
+        displays a list of commits per timezone by author
+
+SUGGEST OPTIONS
+    -r, --suggest-reviewers
+        show the best people to contact to review code
+    -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 log options
+
+You can set `_GIT_LOG_OPTIONS` for [git log options](https://git-scm.com/docs/git-log#_options):
+
+```bash
+export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
+```
+
+### Git pathspec
+
+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'
+```
+
+### Git merge view strategy
+
+You can set the variable `_GIT_MERGE_VIEW` to enable merge commits to be part of the stats by setting `_GIT_MERGE_VIEW` to `enable`. You can also choose to only show merge commits by setting `_GIT_MERGE_VIEW` to `exclusive`. Default is to not show merge commits. These work similar to git's built-in `--merges` and `--no-merges` log options.
+
+```bash
+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` and `--csv-output-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`
+
+```bash
+export _MENU_THEME="legacy"
+```
+
+![legacyThemeScreenshot](https://user-images.githubusercontent.com/8818630/154823711-3dd0c268-f3cb-42e5-9094-0eb8e45d1761.png)
 
 ## Installation
 
+### Debian and Ubuntu
+
+If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
+
+```bash
+apt install git-quick-stats
 ```
+
+### UNIX and Linux
+
+```bash
 git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
 sudo make install
 ```
 
 For uninstalling, open up the cloned directory and run
 
-```
+```bash
 sudo make uninstall
 ```
 
-#### Cygwin installation
+For update/reinstall
+
+```bash
+sudo make reinstall
+```
+
+### macOS (homebrew)
+
+```bash
+brew install git-quick-stats
+```
+
+Or you can follow the UNIX and Linux instructions if you wish.
+
+### 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.
+
+### Docker
+
+You can use the Docker image provided:
+
+* Build: `docker build -t arzzen/git-quick-stats .`
+* Run interactive menu: `docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats`
+* Docker pull command: `docker pull arzzen/git-quick-stats` [docker repository](https://hub.docker.com/r/arzzen/git-quick-stats)
+
 ## System requirements
 
-* Unix like OS with a proper shell
-* Tools we use: git ; awk ; sed ; tr ; echo ; grep ; cut ; sort ; head ; uniq ; column.
+* An OS with a Bash shell
+* Tools we use:
+
+```bash
+awk
+basename
+cat
+column
+echo
+git
+grep
+head
+printf
+seq
+sort
+tput
+tr
+uniq
+```
+
+### 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.
+
+*Q:* How they could be used in a project with many git projects and statistics would show a summary of all git projects?
+
+*A:* If you want to include submodule logs, you can try using the following: `export _GIT_LOG_OPTIONS="-p --submodule=log"`
+(more info about [git log --submodule](https://git-scm.com/docs/git-log#Documentation/git-log.txt---submoduleltformatgt))
 
 ## Contribution
 
 Want to contribute? Great! First, read this page.
 
-#### Code reviews
-All submissions, including submissions by project members, require review. 
-We use Github pull requests for this purpose.
+### Code reviews
 
-#### Some tips for good pull requests:
-* Use our code
+All submissions, including submissions by project members, require review.</br>
+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:
@@ -86,13 +324,52 @@ 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
+
+[![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/.github/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.
+
+[![contributors](https://opencollective.com/git-quick-stats/contributors.svg?width=890&button=false)](https://github.com/arzzen/git-quick-stats/graphs/contributors)
+
+### Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-quick-stats#backer)]
+
+[![backers](https://opencollective.com/git-quick-stats/backers.svg?width=890)](https://opencollective.com/git-quick-stats#backers)
+
+### 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)]
+
+[![sponsor0](https://opencollective.com/git-quick-stats/sponsor/0/avatar.svg?v=1)](https://opencollective.com/git-quick-stats/sponsor/0/website)
+[![sponsor1](https://opencollective.com/git-quick-stats/sponsor/1/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/1/website)
+[![sponsor2](https://opencollective.com/git-quick-stats/sponsor/2/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/2/website)
+[![sponsor3](https://opencollective.com/git-quick-stats/sponsor/3/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/3/website)
+[![sponsor4](https://opencollective.com/git-quick-stats/sponsor/4/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/4/website)
+[![sponsor5](https://opencollective.com/git-quick-stats/sponsor/5/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/5/website)
+[![sponsor6](https://opencollective.com/git-quick-stats/sponsor/6/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/6/website)
+[![sponsor7](https://opencollective.com/git-quick-stats/sponsor/7/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/7/website)
+[![sponsor8](https://opencollective.com/git-quick-stats/sponsor/8/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/8/website)
+[![sponsor9](https://opencollective.com/git-quick-stats/sponsor/9/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/9/website)
+
+[![61999966](https://user-images.githubusercontent.com/6382002/130024560-65bb49a6-c7e9-48f9-8427-a29d8ff2a3db.png)](https://quaestor.com/?utm_source=github&utm_category=sponsor)
+

git-quick-stats.1

@@ -0,0 +1,161 @@
+.TH git-quick-stats "1" "June 2021" "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 GENERATE OPTIONS
+.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\-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\-S\fR, \fB\-\-my\-daily\-stats\fR
+.IP
+see your current daily stats
+.HP
+.PP
+\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
+.IP
+output daily stats by branch in CSV format
+.HP
+.PP
+\fB\-j\fR, \fB\-\-json\-output\fR
+.IP
+save git log as a JSON formatted file to a specified area
+.HP
+.SH LIST OPTIONS
+.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\-\-contributors\fR
+.IP
+see a list of everyone who contributed to the repo
+.HP
+.PP
+\fB\-a\fR, \fB\-\-commits\-per\-author\fR
+.IP
+displays a list of commits per author
+.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\-Y\fR, \fB\-\-commits\-by\-year\fR
+.IP
+displays a list of commits per year
+.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\-z\fR, \fB\-\-commits\-by\-timezone\fR
+.IP
+displays a list of commits per timezone
+.HP
+.PP
+\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
+.IP
+displays a list of commits per timezone by author
+.HP
+.SH SUGGEST OPTIONS
+.PP
+\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
+.IP
+show the best people to contact to review code
+.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:
+.PP
+.B  export _GIT_SINCE="2017\-01\-20"
+.PP
+You can set _GIT_LIMIT for limited output log, example:
+.PP
+.B  export _GIT_LIMIT=20
+.PP
+You can set _GIT_LOG_OPTIONS for git log options, example:
+.PP
+.B  export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
+.PP
+You can exclude directories or files from the stats by using pathspec, example:
+.PP
+.B export _GIT_PATHSPEC=':!pattern'
+.PP
+You can set _GIT_MERGE_VIEW to show merge commits with normal commits, example:
+.PP
+.B  export _GIT_MERGE_VIEW="enable"
+.PP
+You can also set _GIT_MERGE_VIEW to only show merge commits, example:
+.PP
+.B  export _GIT_MERGE_VIEW="exclusive"
+.PP
+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

@@ -0,0 +1,223 @@
+#!/bin/bash
+# assert.sh 1.1 - bash unit testing framework
+# Copyright (C) 2009-2015 Robert Lehmann
+#
+# http://github.com/lehmannro/assert.sh
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# 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
+for arg in $args; do
+    case "$arg" in
+        -h)
+            echo "$0 [-vxidc]" \
+                "[--verbose] [--stop] [--invariant] [--discover] [--continue]"
+            echo "`sed 's/./ /g' <<< "$0"` [-h] [--help]"
+            exit 0;;
+        --help)
+            cat <<EOF
+Usage: $0 [options]
+Language-agnostic unit tests for subprocesses.
+
+Options:
+  -v, --verbose    generate output for every individual test case
+  -x, --stop       stop running tests after the first failure
+  -i, --invariant  do not measure timings to remain invariant between runs
+  -d, --discover   collect test suites only, do not run any tests
+  -c, --continue   do not modify exit code to test suite status
+  -h               show brief usage information and exit
+  --help           show this help message and exit
+EOF
+            exit 0;;
+        -v|--verbose)
+            DEBUG=1;;
+        -x|--stop)
+            STOP=1;;
+        -i|--invariant)
+            INVARIANT=1;;
+        -d|--discover)
+            DISCOVERONLY=1;;
+        -c|--continue)
+            CONTINUE=1;;
+    esac
+done
+
+_indent=$'\n\t' # local format helper
+
+_assert_reset() {
+    tests_ran=0
+    tests_failed=0
+    tests_errors=()
+    tests_starttime="$(date +%s%N)" # nanoseconds_since_epoch
+}
+
+assert_end() {
+    # assert_end [suite ..]
+    tests_endtime="$(date +%s%N)"
+    # required visible decimal place for seconds (leading zeros if needed)
+    local tests_time="$( \
+        printf "%010d" "$(( ${tests_endtime/%N/000000000}
+                            - ${tests_starttime/%N/000000000} ))")"  # in ns
+    tests="$tests_ran ${*:+$* }tests"
+    [[ -n "$DISCOVERONLY" ]] && echo "collected $tests." && _assert_reset && return
+    [[ -n "$DEBUG" ]] && echo
+    # to get report_time split tests_time on 2 substrings:
+    #   ${tests_time:0:${#tests_time}-9} - seconds
+    #   ${tests_time:${#tests_time}-9:3} - milliseconds
+    [[ -z "$INVARIANT" ]] \
+        && report_time=" in ${tests_time:0:${#tests_time}-9}.${tests_time:${#tests_time}-9:3}s" \
+        || report_time=
+
+    if [[ "$tests_failed" -eq 0 ]]; then
+        echo "all $tests passed$report_time."
+    else
+        for error in "${tests_errors[@]}"; do echo "$error"; done
+        echo "$tests_failed of $tests failed$report_time."
+    fi
+    tests_failed_previous=$tests_failed
+    [[ $tests_failed -gt 0 ]] && tests_suite_status=1
+    _assert_reset
+}
+
+assert() {
+    # assert <command> <expected stdout> [stdin]
+    (( tests_ran++ )) || :
+    [[ -z "$DISCOVERONLY" ]] || return 0
+    expected=$(echo -ne "${2:-}")
+    result="$(eval 2>/dev/null $1 <<< ${3:-})" || true
+    if [[ "$result" == "$expected" ]]; then
+        [[ -z "$DEBUG" ]] || echo -n .
+        return
+    fi
+    result="$(sed -e :a -e '$!N;s/\n/\\n/;ta' <<< "$result")"
+    [[ -z "$result" ]] && result="nothing" || result="\"$result\""
+    [[ -z "$2" ]] && expected="nothing" || expected="\"$2\""
+    _assert_fail "expected $expected${_indent}got $result" "$1" "${3:-}"
+}
+
+assert_raises() {
+    # assert_raises <command> <expected code> [stdin]
+    (( tests_ran++ )) || :
+    [[ -z "$DISCOVERONLY" ]] || return 0
+    status=0
+    (eval $1 <<< ${3:-}) > /dev/null 2>&1 || status=$?
+    expected=${2:-0}
+    if [[ "$status" -eq "$expected" ]]; then
+        [[ -z "$DEBUG" ]] || echo -n .
+        return
+    fi
+    _assert_fail "program terminated with code $status instead of $expected" "$1" "${3:-}"
+}
+
+assert_success() {
+    # assert_success <command>
+    assert_raises "$1" 0
+}
+
+# _assert_with_grep <grep modifiers> <command> <expected output...>
+_assert_with_grep() {
+    local grep_modifier="$1"
+    local output="$($2)"
+    local exitcode=0
+    shift 2
+
+    while [ $# != 0 ]; do
+        assert_raises "echo '$output' | $GREP $grep_modifier '$1'" $exitcode || return 1
+        shift
+    done
+}
+
+# assert_startswith <command> <expected start to stdout>
+assert_startswith() {
+	assert_success "[[ '$($1)' == '$2'* ]]"
+}
+
+# assert_endswith <command> <expected start to stdout>
+assert_endswith() {
+	assert_success "[[ '$($1)' == *'$2' ]]"
+}
+
+# assert_contains <command> <expected output...>
+assert_contains() {
+	_assert_with_grep '-F' "$@"
+}
+
+_assert_fail() {
+    # _assert_fail <failure> <command> <stdin>
+    [[ -n "$DEBUG" ]] && echo -n X
+    report="test #$tests_ran \"$2${3:+ <<< $3}\" failed:${_indent}$1"
+    if [[ -n "$STOP" ]]; then
+        [[ -n "$DEBUG" ]] && echo
+        echo "$report"
+        exit 1
+    fi
+    tests_errors[$tests_failed]="$report"
+    (( tests_failed++ )) || :
+}
+
+skip_if() {
+    # skip_if <command ..>
+    (eval $@) > /dev/null 2>&1 && status=0 || status=$?
+    [[ "$status" -eq 0 ]] || return
+    skip
+}
+
+skip() {
+    # skip  (no arguments)
+    shopt -q extdebug && tests_extdebug=0 || tests_extdebug=1
+    shopt -q -o errexit && tests_errexit=0 || tests_errexit=1
+    # enable extdebug so returning 1 in a DEBUG trap handler skips next command
+    shopt -s extdebug
+    # disable errexit (set -e) so we can safely return 1 without causing exit
+    set +o errexit
+    tests_trapped=0
+    trap _skip DEBUG
+}
+_skip() {
+    if [[ $tests_trapped -eq 0 ]]; then
+        # DEBUG trap for command we want to skip.  Do not remove the handler
+        # yet because *after* the command we need to reset extdebug/errexit (in
+        # another DEBUG trap.)
+        tests_trapped=1
+        [[ -z "$DEBUG" ]] || echo -n s
+        return 1
+    else
+        trap - DEBUG
+        [[ $tests_extdebug -eq 0 ]] || shopt -u extdebug
+        [[ $tests_errexit -eq 1 ]] || set -o errexit
+        return 0
+    fi
+}
+
+
+_assert_reset
+: ${tests_suite_status:=0}  # remember if any of the tests failed so far
+_assert_cleanup() {
+    local status=$?
+    # modify exit code if it's not already non-zero
+    [[ $status -eq 0 && -z $CONTINUE ]] && exit $tests_suite_status
+}
+trap _assert_cleanup EXIT

tests/commands_test.sh

@@ -0,0 +1,106 @@
+#!/bin/bash
+
+. tests/assert.sh -v
+
+src="./git-quick-stats"
+assert "$src fail" "Invalid argument
+
+NAME
+    git-quick-stats - Simple and efficient way to access various stats in a git repo
+
+SYNOPSIS
+    For non-interactive mode: git-quick-stats [OPTIONS]
+    For interactive mode: git-quick-stats
+
+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.
+
+GENERATE OPTIONS
+    -T, --detailed-git-stats
+        give a detailed list of git stats
+    -R, --git-stats-by-branch
+        see detailed list of git stats by branch
+    -c, --changelogs
+        see changelogs
+    -L, --changelogs-by-author
+        see changelogs by author
+    -S, --my-daily-stats
+        see your current daily stats
+    -V, --csv-output-by-branch
+        output daily stats by branch in CSV format
+    -j, --json-output
+        save git log as a JSON formatted file to a specified area
+
+LIST OPTIONS
+    -b, --branch-tree
+        show an ASCII graph of the git repo branch history
+    -D, --branches-by-date
+        show branches by date
+    -C, --contributors
+        see a list of everyone who contributed to the repo
+    -a, --commits-per-author
+        displays a list of commits per author
+    -d, --commits-per-day
+        displays a list of commits per day
+    -m, --commits-by-month
+        displays a list of commits per month
+    -Y, --commits-by-year
+        displays a list of commits per year
+    -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
+    -z, --commits-by-timezone
+        displays a list of commits per timezone
+    -Z, --commits-by-author-by-timezone
+        displays a list of commits per timezone by author
+
+SUGGEST OPTIONS
+    -r, --suggest-reviewers
+        show the best people to contact to review code
+    -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 set _GIT_LOG_OPTIONS for git log options
+        ex: export _GIT_LOG_OPTIONS=\"--ignore-all-space --ignore-blank-lines\"
+    You can exclude directories or files from the stats by using pathspec
+        ex: export _GIT_PATHSPEC=':!pattern'
+    You can set _GIT_MERGE_VIEW to view merge commits with normal commits
+        ex: export _GIT_MERGE_VIEW=enable
+    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
+    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)"
+assert_success "$src --suggest-reviewers"
+
+assert_contains "$src --detailed-git-stats" "Contribution stats"
+assert_success "$src --detailed-git-stats"
+
+assert_contains "$src --commits-per-day" "Git commits per date"
+assert_success "$src --commits-per-day"
+
+assert_startswith "$src --commits-by-year" "Git commits by year"
+assert_success "$src --commits-by-year"
+
+export LC_TIME=POSIX
+assert_startswith "$src --commits-by-year" "Git commits by year"
+assert_success "$src --commits-by-year"
+
+assert_end