Merge pull request #80 from cbandera/feature/stash_indicator

Feature/stash indicator

6 files changed, 107 insertions, 3 deletions

diff --git a/README.md b/README.md
index 7686edb..2f508a8 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ last few years. Maybe it can help you too.
   - [Files status](#files-status)
   - [Local commits status](#local-commits-status)
   - [Remote commits status](#remote-commits-status)
+  - [Stash status](#stash-status)
   - [(Optional) Auto-fetch repos](#optional-auto-fetch-repos)
 - [Customise your prompt](#customise-your-prompt)
 - [Support](#support)
@@ -156,6 +157,13 @@ Prompt                     | Meaning
 The use of feature is controlled by the `GIT_RADAR_FORMAT` environment variable.
 See [Customise your prompt](#customise-your-prompt) for how to personalise this.
 
+### Stash status
+The prompt will show you whether and how many stashes you have stored.
+
+Prompt                     | Meaning
+---------------------------|---------------
+![git:(master) 1≡]         | We have one stash
+
 If you don't rely on this status, you can always hide this part of the prompt by
 [customising your prompt](#customise-your-prompt)
 
@@ -194,6 +202,7 @@ Remote commits | `%{remote}`
 Local commits  | `%{local}`
 Branch         | `%{branch}`
 File changes   | `%{changes}`
+Stashes        | `%{stash}`
 
 You can create any prompt shape you prefer by exporting `GIT_RADAR_FORMAT` with
 your preferred shape. The control strings above will be replaced with the output
@@ -510,6 +519,18 @@ tracked by git.
 It is unset by `GIT_RADAR_COLOR_CHANGES_RESET` which you can set if you want
 a different background colour to return to.
 
+##### Colouring the stash status
+
+**GIT_RADAR_COLOR_STASH='[colour code]'**
+```
+git:(my-branch) 1≡
+                 ^
+```
+The colour to use for the lines that indicates how many stashes you have stored.
+
+It is unset by `GIT_RADAR_COLOR_STASH_RESET` which you can set if you want
+a different background colour to return to.
+
 ## License
 
 Git Radar is licensed under the MIT license.
@@ -517,6 +538,7 @@ Git Radar is licensed under the MIT license.
 See [LICENSE] for the full license text.
 
 [LICENSE]: https://github.com/michaeldfallen/git-radar/blob/master/LICENSE
+[git:(master) 1≡]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/stash.png
 [git:(master) 3A]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/untracked.png
 [git:(master) 2D2M]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/unstaged.png
 [git:(master) 1M1R]: https://raw.githubusercontent.com/michaeldfallen/git-radar/master/images/added.png
diff --git a/git-radar b/git-radar
index 67b8460..a8dd72e 100755
--- a/git-radar
+++ b/git-radar
@@ -30,6 +30,7 @@ if [[ -z $@ ]]; then
   _conflicted_them="\033[1;33mT\033[0m"
   _ahead_master="\xF0\x9D\x98\xAE \033[1;32m←\033[0m"
   _local_diverged="\033[1;33m⇵\033[0m"
+  _stash="\033[1;33m≡\033[0m"
   echo "git-radar - a heads up display for git"
   echo ""
   echo "examples:"
@@ -51,6 +52,8 @@ if [[ -z $@ ]]; then
   echo "   # rebase complete, our rewritten commits now need pushed up"
   printf "  $_git$_ahead_master 3 $_my_branch$_endgit"
   echo "         # origin/my-branch is up to date with master and has our 3 commits waiting merge"
+  printf "  $_git$_master$_endgit 3$_stash"
+  echo "               # You have 3 stashes stored"
 
   echo ""
   echo "usage:"
diff --git a/images/stash.png b/images/stash.png
new file mode 100644
index 0000000..072ca16
--- /dev/null
+++ b/images/stash.png
diff --git a/radar-base.sh b/radar-base.sh
index 258e5b1..c355f3c 100755
--- a/radar-base.sh
+++ b/radar-base.sh
@@ -36,15 +36,19 @@ prepare_bash_colors() {
   COLOR_CHANGES_CONFLICTED="\x01${GIT_RADAR_COLOR_CHANGES_CONFLICTED:-"\\033[1;33m"}\x02"
   COLOR_CHANGES_UNTRACKED="\x01${GIT_RADAR_COLOR_CHANGES_UNTRACKED:-"\\033[1;37m"}\x02"
 
+  COLOR_STASH="\x01${GIT_RADAR_COLOR_STASH:-"\\033[1;33m"}\x02"
+
   COLOR_BRANCH="\x01${GIT_RADAR_COLOR_BRANCH:-"\\033[0m"}\x02"
   MASTER_SYMBOL="${GIT_RADAR_MASTER_SYMBOL:-"\\x01\\033[0m\\x02\\xF0\\x9D\\x98\\xAE\\x01\\033[0m\\x02"}"
 
-  PROMPT_FORMAT="${GIT_RADAR_FORMAT:-" \\x01\\033[1;30m\\x02git:(\\x01\\033[0m\\x02%{remote: }%{branch}%{ :local}\\x01\\033[1;30m\\x02)\\x01\\033[0m\\x02%{ :changes}"}"
+  PROMPT_FORMAT="${GIT_RADAR_FORMAT:-" \\x01\\033[1;30m\\x02git:(\\x01\\033[0m\\x02%{remote: }%{branch}%{ :local}\\x01\\033[1;30m\\x02)\\x01\\033[0m\\x02%{ :stash}%{ :changes}"}"
 
   RESET_COLOR_LOCAL="\x01${GIT_RADAR_COLOR_LOCAL_RESET:-"\\033[0m"}\x02"
   RESET_COLOR_REMOTE="\x01${GIT_RADAR_COLOR_REMOTE_RESET:-"\\033[0m"}\x02"
   RESET_COLOR_CHANGES="\x01${GIT_RADAR_COLOR_CHANGES_RESET:-"\\033[0m"}\x02"
   RESET_COLOR_BRANCH="\x01${GIT_RADAR_COLOR_BRANCH_RESET:-"\\033[0m"}\x02"
+  RESET_COLOR_STASH="\x01${GIT_RADAR_COLOR_STASH:-"\\033[0m"}\x02"
+  
 }
 
 prepare_zsh_colors() {
@@ -70,17 +74,20 @@ prepare_zsh_colors() {
   COLOR_CHANGES_CONFLICTED="%{${GIT_RADAR_COLOR_CHANGES_CONFLICTED:-$fg_bold[yellow]}%}"
   COLOR_CHANGES_UNTRACKED="%{${GIT_RADAR_COLOR_CHANGES_UNTRACKED:-$fg_bold[white]}%}"
 
+  COLOR_STASH="%{${GIT_RADAR_COLOR_STASH:-$fg_bold[yellow]}%}"
+  
   local italic_m="$(printf '\xF0\x9D\x98\xAE')"
 
   COLOR_BRANCH="%{${GIT_RADAR_COLOR_BRANCH:-$reset_color}%}"
   MASTER_SYMBOL="${GIT_RADAR_MASTER_SYMBOL:-"%{$reset_color%}$italic_m%{$reset_color%}"}"
 
-  PROMPT_FORMAT="${GIT_RADAR_FORMAT:-" %{$fg_bold[grey]%}git:(%{$reset_color%}%{remote: }%{branch}%{ :local}%{$fg_bold[grey]%})%{$reset_color%}%{ :changes}"}"
+  PROMPT_FORMAT="${GIT_RADAR_FORMAT:-" %{$fg_bold[grey]%}git:(%{$reset_color%}%{remote: }%{branch}%{ :local}%{$fg_bold[grey]%})%{$reset_color%}%{ :stash}%{ :changes}"}"
 
   RESET_COLOR_LOCAL="%{${GIT_RADAR_COLOR_LOCAL_RESET:-$reset_color}%}"
   RESET_COLOR_REMOTE="%{${GIT_RADAR_COLOR_REMOTE_RESET:-$reset_color}%}"
   RESET_COLOR_CHANGES="%{${GIT_RADAR_COLOR_CHANGES_RESET:-$reset_color}%}"
   RESET_COLOR_BRANCH="%{${GIT_RADAR_COLOR_BRANCH_RESET:-$reset_color}%}"
+  RESET_COLOR_STASH="%{${GIT_RADAR_COLOR_STASH:-$reset_color}%}"
 }
 
 in_current_dir() {
@@ -495,12 +502,24 @@ show_remote_status() {
   return 0
 }
 
+stashed_status() {
+  printf '%s' "$(git stash list | wc -l 2>/dev/null | grep -oEi '[0-9][0-9]*')"
+}
+
+stash_status() {
+  local number_stashes="$(stashed_status)"
+  if [ $number_stashes -gt 0 ]; then
+    printf $PRINT_F_OPTION "$number_stashes$COLOR_STASH≡$RESET_COLOR_STASH"
+  fi
+}
+
 render_prompt() {
   output="$PROMPT_FORMAT"
   branch_sed=""
   remote_sed=""
   local_sed=""
   changes_sed=""
+  stash_sed=""
 
 
   if_pre="%\{([^%{}]{1,}:){0,1}"
@@ -540,10 +559,19 @@ render_prompt() {
       changes_sed="s/${sed_pre}changes${sed_post}//"
     fi
   fi
+  if [[ $PROMPT_FORMAT =~ ${if_pre}stash${if_post} ]]; then
+    stash_result="$(stash_status)"
+    if [[ -n "$stash_result" ]]; then
+      stash_sed="s/${sed_pre}stash${sed_post}/\2${stash_result}\4/"
+    else
+      stash_sed="s/${sed_pre}stash${sed_post}//"
+    fi
+  fi
 
   printf '%b' "$output" | sed \
                             -e "$remote_sed" \
                             -e "$branch_sed" \
                             -e "$changes_sed" \
-                            -e "$local_sed"
+                            -e "$local_sed" \
+                            -e "$stash_sed"
 }
diff --git a/test b/test
index 87cba9b..ab5eb14 100755
--- a/test
+++ b/test
@@ -6,5 +6,6 @@
 ./test-branches.sh
 ./test-files.sh
 ./test-status.sh
+./test-stash.sh
 ./test-colors.sh
 ./test-format-config.sh
diff --git a/test-stash.sh b/test-stash.sh
new file mode 100755
index 0000000..aecd83c
--- /dev/null
+++ b/test-stash.sh
@@ -0,0 +1,50 @@
+#!/bin/bash
+scriptDir="$(cd "$(dirname "$0")"; pwd)"
+
+source "$scriptDir/radar-base.sh"
+
+tmpfile=""
+
+cd_to_tmp() {
+  tmpfile="/tmp/git-prompt-tests-$(time_now)$1"
+  mkdir -p "$tmpfile"
+  cd "$tmpfile"
+}
+
+rm_tmp() {
+  cd $scriptDir
+  rm -rf /tmp/git-prompt-tests*
+}
+
+test_unstashed_status() {
+  cd_to_tmp
+  git init --quiet
+
+  assertEquals "0" "$(stashed_status)"
+
+  rm_tmp
+}
+
+test_stashed_status() {
+  cd_to_tmp
+  git init --quiet
+
+  touch foo
+  git add --all
+  git commit -m "Initial commit"  >/dev/null
+  echo "test">foo
+  git stash > /dev/null
+  assertEquals "1" "$(stashed_status)"
+  
+  echo "test2">foo
+  git stash > /dev/null
+  assertEquals "2" "$(stashed_status)"
+
+  git stash drop > /dev/null
+  assertEquals "1" "$(stashed_status)"
+
+
+  rm_tmp
+}
+
+. ./shunit/shunit2