Merge branch 'refactor-svn-plugin'

Closes #5462

plugins/svn/README.md

@@ -0,0 +1,67 @@
+# `svn` plugin
+
+This plugin adds some utility functions to display additional information regarding your current
+svn repository. See http://subversion.apache.org/ for the full svn documentation.
+
+To use it, add `svn` to your plugins array:
+
+```zsh
+plugins=(... svn)
+```
+
+## Functions
+
+| Command               | Description                                 |
+|:----------------------|:--------------------------------------------|
+| `svn_prompt_info`     | Shows svn prompt in themes                  |
+| `in_svn`              | Checks if we're in an svn repository        |
+| `svn_get_repo_name`   | Get repository name                         |
+| `svn_get_branch_name` | Get branch name (see [caveats](#caveats))   |
+| `svn_get_rev_nr`      | Get revision number                         |
+| `svn_dirty`           | Checks if there are changes in the svn repo |
+
+## Caveats
+
+The plugin expects the first directory to be the current branch / tag / trunk. So it returns
+the first path element if you don't use branches.
+
+## Usage on themes
+
+To use this in the `agnoster` theme follow these instructions:
+
+1. Enable the svn plugin
+
+2. Add the following lines to your `zshrc` file:
+
+    ```shell
+    prompt_svn() {
+        local rev branch
+        if in_svn; then
+            rev=$(svn_get_rev_nr)
+            branch=$(svn_get_branch_name)
+            if [[ $(svn_dirty_choose_pwd 1 0) -eq 1 ]]; then
+                prompt_segment yellow black
+                echo -n "$rev@$branch"
+                echo -n "±"
+            else
+                prompt_segment green black
+                echo -n "$rev@$branch"
+            fi
+        fi
+    }
+    ```
+
+3. Override the agnoster `build_prompt()` function:
+
+    ```zsh
+    build_prompt() {
+        RETVAL=$?
+        prompt_status
+        prompt_context
+        prompt_dir
+        prompt_git
+        prompt_svn
+        prompt_end
+    }
+    ```
+

plugins/svn/svn.plugin.zsh

@@ -1,9 +1,7 @@
-# vim:ft=zsh ts=2 sw=2 sts=2
+svn_prompt_info() {
-#
-function svn_prompt_info() {
   local _DISPLAY
   if in_svn; then
-    if [ "x$SVN_SHOW_BRANCH" = "xtrue" ]; then
+    if [[ "$SVN_SHOW_BRANCH" = true ]]; then
       unset SVN_SHOW_BRANCH
       _DISPLAY=$(svn_get_branch_name)
     else
@@ -16,23 +14,20 @@ $ZSH_THEME_REPO_NAME_COLOR$_DISPLAY$ZSH_PROMPT_BASE_COLOR$ZSH_THEME_SVN_PROMPT_S
 }
 
 
-function in_svn() {
+in_svn() {
-  if $(svn info >/dev/null 2>&1); then
+  svn info >/dev/null 2>&1
-    return 0
-  fi
-  return 1
 }
 
-function svn_get_repo_name() {
+svn_get_repo_name() {
   if in_svn; then
-    svn info | sed -n 's/Repository\ Root:\ .*\///p' | read SVN_ROOT
+    LANG=C svn info | sed -n 's/^Repository\ Root:\ .*\///p' | read SVN_ROOT
-    svn info | sed -n "s/URL:\ .*$SVN_ROOT\///p"
+    LANG=C svn info | sed -n "s/^URL:\ .*$SVN_ROOT\///p"
   fi
 }
 
-function svn_get_branch_name() {
+svn_get_branch_name() {
   local _DISPLAY=$(
-    svn info 2> /dev/null | \
+    LANG=C svn info 2> /dev/null | \
       awk -F/ \
       '/^URL:/ { \
         for (i=0; i<=NF; i++) { \
@@ -45,40 +40,27 @@ function svn_get_branch_name() {
       }'
   )
 
-  if [ "x$_DISPLAY" = "x" ]; then
+  if [[ -z "$_DISPLAY" ]]; then
     svn_get_repo_name
   else
     echo $_DISPLAY
   fi
 }
 
-function svn_get_rev_nr() {
+svn_get_rev_nr() {
   if in_svn; then
-    svn info 2> /dev/null | sed -n 's/Revision:\ //p'
+    LANG=C svn info 2> /dev/null | sed -n 's/Revision:\ //p'
   fi
 }
 
-function svn_dirty_choose() {
+svn_dirty() {
-  if in_svn; then
-    local root=`svn info 2> /dev/null | sed -n 's/^Working Copy Root Path: //p'`
-    if $(svn status $root 2> /dev/null | command grep -Eq '^\s*[ACDIM!?L]'); then
-      # Grep exits with 0 when "One or more lines were selected", return "dirty".
-      echo $1
-    else
-      # Otherwise, no lines were found, or an error occurred. Return clean.
-      echo $2
-    fi
-  fi
-}
-
-function svn_dirty() {
   svn_dirty_choose $ZSH_THEME_SVN_PROMPT_DIRTY $ZSH_THEME_SVN_PROMPT_CLEAN
 }
 
-function svn_dirty_choose_pwd () {
+svn_dirty_choose() {
   if in_svn; then
-    local root=$PWD
+    local root=$(LANG=C svn info 2> /dev/null | sed -n 's/^Working Copy Root Path: //p')
-    if $(svn status $root 2> /dev/null | command grep -Eq '^\s*[ACDIM!?L]'); then
+    if svn status $root 2> /dev/null | command grep -Eq '^\s*[ACDIM!?L]'; then
       # Grep exits with 0 when "One or more lines were selected", return "dirty".
       echo $1
     else
@@ -88,8 +70,18 @@ function svn_dirty_choose_pwd () {
   fi
 }
 
-function svn_dirty_pwd () {
+svn_dirty_pwd () {
   svn_dirty_choose_pwd $ZSH_THEME_SVN_PROMPT_DIRTY_PWD $ZSH_THEME_SVN_PROMPT_CLEAN_PWD
 }
 
-
+svn_dirty_choose_pwd () {
+  if in_svn; then
+    if svn status "$PWD" 2> /dev/null | command grep -Eq '^\s*[ACDIM!?L]'; then
+      # Grep exits with 0 when "One or more lines were selected", return "dirty".
+      echo $1
+    else
+      # Otherwise, no lines were found, or an error occurred. Return clean.
+      echo $2
+    fi
+  fi
+}