update helper

Update README to clarify permissions

Makefile

@@ -1,5 +1,5 @@
-PREFIX = /usr/local
-BINPREFIX = "$(PREFIX)/bin"
+PREFIX ?= /usr/local
+BINPREFIX ?= "$(PREFIX)/bin"
 
 LIB=git-recall
 

README.md

@@ -7,25 +7,31 @@
 ## Purpose
 
 `git-recall` is a simple tool that allows you to easily go through your commits and
-check what you or other contributors in your team did. It doesn't aim to be a replacement for the 
+check what you or other contributors in your team did. It doesn't aim to be a replacement for the
 `git log` command, but just to be a convenient way to recall what you've done from your terminal.
 
 
 ## Usage
 
 ```sh
-$ git recall   [-a <author name>] 
-	       [-d <days-ago>]
+$ git recall   [-a <author name>]
+               [-d <days-ago>]
+               [-b <branch name>]
+               [-p <paths>]
                [-f]
                [-h]
+               [-v]
 ```
 
 ##### Options description:
 
 - `-a`      - Restrict search for a specific user (use -a "all" for all users)
 - `-d`      - Display commits for the last n days
+- `-b`      - Specify branch to display commits from
+- `-p`      - Specify path/s or file/s to display commits from
 - `-f`      - Fetch the latest changes
 - `-h`      - Show help screen
+- `-v`      - Show version
 
 ##### How to use:
 
@@ -65,10 +71,10 @@ $ git recall -f
 
 ##### Without using tools
 
-```
 You can install it by simply copying the `git-recall` script into any existing path
-(e.g. /usr/local/bin) or create your own directory and add it to the 'PATH' variable.
-```
+(e.g. `/usr/local/bin`) or create your own directory and add it to the `PATH` variable.
+
+Make sure to run `chmod +x /usr/local/bin/git-recall` or the directory in which you copied it to. 
 
 ##### Using NPM
 Use `npm` to install the project.
@@ -86,6 +92,7 @@ $ sudo make install
 ```
 ## Requirements
 - OS: Linux or OSX
+- Bash 4.3 or more
 - Tools: git, less, sed
 
 ##### Optional Requirements

git-recall

@@ -7,7 +7,9 @@ usage() {
   Usage: git recall [options]
   Options:
     -d, --date              Show logs for last n days.
-    -a, --author            Author name.
+    -a, --author            Author name (use -a "all" for all users).
+    -b, --branch            Specify branch to display commits from.
+    -p  --path              Specify path or filename to display commits from.
     -f, --fetch             fetch commits.
     -h, --help              This message.
     -v, --version           Show version.
@@ -16,6 +18,7 @@ EOF
 }
 
 # Global variables
+orig_stty=$(stty -g)   # Store original terminal settings
 AUTHOR=""
 FETCH=false
 GIT_FORMAT=""
@@ -23,9 +26,11 @@ GIT_LOG=""
 COMMITS=""
 SINCE="1 days ago"     # show logs for last day by default
 COMMITS_UNCOL=()       # commits without colors
-SED_BIN=""             # Sed option to use according OS.
+SED_CMD=""             # Sed command to use according OS.
 LESSKEY=false
-VERSION="1.1.12"
+VERSION="1.2.4"
+BRANCH=""
+SEARCH_PATH=""
 
 # Set key bindings.
 au="`echo -e '\e[A'`" # arrow up
@@ -37,7 +42,7 @@ ad_1="j"              # arrow down
 nl_1="e"              # expand
 
 # Colored output.
-colored() {
+function colored() {
     GREEN=$(tput setaf 4)
     YELLOW=$(tput setaf 3)
     NORMAL=$(tput sgr0)
@@ -45,13 +50,19 @@ colored() {
 } 
 
 # Uncolored output.
-uncolored() {
+function uncolored() {
     GREEN=""
     YELLOW=""
     NORMAL=""
     REVERSE=""
 }
 
+# Clear screen from cursor to end of screen
+function clear_screen() {
+    echo -e "\E[J"
+    tput cuu1
+}
+
 # Are we in a git repo?
 if [[ ! -d ".git" ]] && ! git rev-parse --git-dir &>/dev/null; then
     echo "abort: not a git repository." 1>&2
@@ -80,6 +91,14 @@ while [[ "$1" =~ ^- && ! "$1" == "--" ]]; do
 	    usage
 	    exit
 	    ;;
+	-b | --branch )
+            BRANCH="$2"
+            shift
+            ;;
+        -p | --path )
+            SEARCH_PATH="$2"
+            shift
+            ;;
 	* )
 	    echo "abort: unknown argument" 1>&2
 	    exit 1
@@ -100,11 +119,6 @@ else
     uncolored
 fi
 
-# Check if lesskey is installed.
-if command -v lesskey &> /dev/null; then
-    LESSKEY=true
-fi
-
 # Set AUTHOR to current user if no param passed or display for all users if param equal to "all". 
 if [[ ! -n $AUTHOR ]]; then
     AUTHOR=$(git config user.name 2>/dev/null)
@@ -117,7 +131,7 @@ if [[ $FETCH == true ]]; then
     echo "${GREEN}Fetching changes...${NORMAL}"
     git fetch --all &> /dev/null
     tput cuu1
-    tput ed # clear screen
+    clear_screen
 fi
 
 # Log template.
@@ -126,7 +140,7 @@ GIT_FORMAT="%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%a
 # Log command.
 GIT_LOG="git log --pretty=format:'${GIT_FORMAT}'  
            --author \"$AUTHOR\"
-           --since \"$SINCE\" --abbrev-commit"
+           --since \"$SINCE\" --abbrev-commit --no-merges $BRANCH $SEARCH_PATH"
 
 # Change temporary the IFS to store GIT_LOG's output into an array.
 IFS=$'\n'
@@ -148,16 +162,21 @@ if [[ $NI = 0 ]]; then
     fi
 fi
 
-# Set correct sed option according OS's type
+# Check if lesskey is installed.
+if command -v lesskey &> /dev/null; then
+    LESSKEY=true
+fi
+
+# Set correct sed command according OS's type
 case "$OSTYPE" in
-    darwin*) SED_BIN="sed -E" ;;
-    *)       SED_BIN="sed -r" ;;
+    darwin*) SED_CMD="sed -E s/"$'\E'"\[([0-9]{1,2}(;[0-9]{1,2})*)?m//g" ;;
+    *)       SED_CMD="sed -r s/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g" ;;
 esac
 
 # Create array with uncolred commits (removing escape sequences using sed)
 for elt in "${COMMITS[@]}"
 do
-    ELT="$(echo "$elt" | $SED_BIN "s/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g")" # remove colors escape codes
+    ELT="$(echo "$elt" | $SED_CMD)" # remove colors escape codes
     COMMITS_UNCOL+=("$ELT")
 done
 
@@ -171,16 +190,16 @@ done
 
 # Create a temporary lesskey file to change the keybindings so the user can use the TAB key to quit less. (more convenient)  
 if [[ $LESSKEY = true ]]; then
-    echo "\t quit" | lesskey -o $HOME/.lsh_less_keys_tmp -- - &> /dev/null
+    echo "\t quit" | lesskey -o /tmp/lsh_less_keys_tmp -- - &> /dev/null
 fi
 
 # Get commit's diff.
 function get_diff() {
     ELT="$(echo "${COMMITS_UNCOL[$CP-1]}")"
     DIFF_TIP=${ELT:0:7}
-    DIFF_CMD="git show $DIFF_TIP --color=always"
+    DIFF_CMD="git show $DIFF_TIP --color=always $SEARCH_PATH"
     DIFF=$(eval ${DIFF_CMD} 2>/dev/null)
-    tmp_diff="$(echo "$DIFF" | $SED_BIN "s/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g")"
+    tmp_diff="$(echo "$DIFF" | $SED_CMD)"
     off=$(echo "$tmp_diff" | grep -c ".\{$CN\}") # Number of lines in the diff that are longer than terminal width.
     DIFF_LINES_NUMBER="$(echo "$DIFF" | wc -l)"
     DIFF_LINES_NUMBER=$(( DIFF_LINES_NUMBER + off ))
@@ -190,15 +209,17 @@ function get_diff() {
 function print_diff() {
     get_diff
     if [[ $(( TN + DIFF_LINES_NUMBER + OFFSET )) -ge $(( `tput lines` - 1 )) ]]; then
+	trap - INT
 	if [[ $LESSKEY = true ]]; then
-	    echo "$DIFF" | less -r -k $HOME/.lsh_less_keys_tmp
+	    echo "$DIFF" | less -r -k /tmp/lsh_less_keys_tmp
 	else 
 	    echo "$DIFF" | less -r
 	fi
-	tput ed # Clear screen
+	trap cleanup_and_exit INT
+	clear_screen
     else 
 	stop=false
-	tput ed
+	clear_screen
 	for i in `seq 1 $TN`
 	do
 	    echo -n "$NORMAL"
@@ -220,8 +241,7 @@ function print_diff() {
 		    ;;
 	    esac
 	done
-	[[ $END = false ]] && tput cuu $(( TN + DIFF_LINES_NUMBER + OFFSET )) && tput ed
-	[[ $END = true ]] && tput cuu 1
+	[[ $END = false ]] && tput cuu $(( TN + DIFF_LINES_NUMBER + OFFSET )) && clear_screen
     fi
 }
 
@@ -241,6 +261,21 @@ function calculate_offset {
     done
 }
 
+# Reset changes made by this script before exiting
+function cleanup_and_exit() {
+    # remove temporary less keybindings
+    [[ $LESSKEY = true ]] && rm /tmp/lsh_less_keys_tmp
+
+    tput cuu 1      # move cursor up one line. (remove extra line)
+    tput cnorm      # unhide cursor
+    echo "$NORMAL"  # normal colors
+    stty "$orig_stty" > /dev/null 2>&1
+    exit
+}
+
+# Catch a control-C interrupt and perform cleanup operations before exiting
+trap cleanup_and_exit INT
+
 { # capture stdout to stderr
 
 tput civis   # hide cursor.
@@ -291,7 +326,7 @@ do
 
    	    [[ $TN != $(( SN - 1 )) ]] && tput cuu $(( TN + OFFSET_2 ))
    	    [[ $TN == $(( SN - 1 )) ]] && tput cuu $(( TN + EXT ))
-            [[ $SI != 1 ]] && tput ed # clear screen
+            [[ $SI != 1 ]] && clear_screen
             ;;
 	"$ad" | "$ad_1")
    	    CP=$(( CP + 1 ))
@@ -300,8 +335,8 @@ do
 
    	    [[ $TN != $(( SN - 1 )) ]] && tput cuu $(( TN + OFFSET_2 ))
    	    [[ $TN == $(( SN - 1 )) ]] && tput cuu $(( TN + EXT ))
-            [[ $SI != 1 ]] && tput ed # clear screen
-            [[ $SI = 1 ]] && [[ $CP = 1 ]] && tput ed # clear screen
+            [[ $SI != 1 ]] && clear_screen
+            [[ $SI = 1 ]] && [[ $CP = 1 ]] && clear_screen
             ;;
 	"$nl" | "$nl_1")
    	    [[  $TN == $NI ]] && tput cuu $(( TN + OFFSET_2 ))
@@ -311,18 +346,13 @@ do
 	"q")
             si=false
             END=true
-   	    tput cuu 1 #move cursor up one line. (remove extra line)
             ;;
 	* )
    	    tput cuu $(( TN + OFFSET_2 ))
     esac
 done
 
-# remove temporary less keybindings
-[[ $LESSKEY = true ]] && rm $HOME/.lsh_less_keys_tmp 
-
-tput cnorm      # unhide cursor
-echo "$NORMAL"  # normal colors
+cleanup_and_exit
 
 } >&2 # END capture
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-recall",
-  "version": "1.1.12",
+  "version": "1.2.4",
   "description": "Simple and convenient Git tool to easily recall what you've done",
   "main": "",
   "scripts": {