From 70481f71cb0ba18e4ef2dc34e661e0c6d7f175ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A9=20Villar?= <goolic@gmail.com>
Date: Thu, 14 Apr 2011 17:48:06 -0300
Subject: [PATCH] Added plugin z, based on the z function by Rupa Deadwyler

---
 plugins/z/z.1          |  73 ++++++++++++++++
 plugins/z/z.plugin.zsh |   9 ++
 plugins/z/z.sh         | 183 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 265 insertions(+)
 create mode 100644 plugins/z/z.1
 create mode 100644 plugins/z/z.plugin.zsh
 create mode 100755 plugins/z/z.sh

diff --git a/plugins/z/z.1 b/plugins/z/z.1
new file mode 100644
index 000000000..c774f70a0
--- /dev/null
+++ b/plugins/z/z.1
@@ -0,0 +1,73 @@
+.TH Z "1" "February 2011" "z" "User Commands"
+
+.SH NAME
+z \- jump around
+
+.SH SYNOPSIS
+z [\-h] [\-l] [\-r] [\-t] [regex1 regex2 ... regexn]
+
+.SH AVAILABILITY
+bash, zsh
+
+.SH DESCRIPTION
+Tracks your most used directories, based on 'frecency'.
+.P
+After a short learning phase, \fBz\fR will take you to the most 'frecent'
+directory that matches ALL of the regexes given on the command line.
+
+.SH OPTIONS
+\fB\-h\fR show a brief help message
+.br
+\fB\-l\fR list only
+.br
+\fB\-r\fR match by rank only
+.br
+\fB\-t\fR match by recent access only
+
+.SH EXAMPLES
+\fBz foo\fR     cd to most frecent dir matching foo
+.br
+\fBz foo bar\fR cd to most frecent dir matching foo and bar
+.br
+\fBz -r foo\fR  cd to highest ranked dir matching foo
+.br
+\fBz -t foo\fR  cd to most recently accessed dir matching foo
+.br
+\fBz -l foo\fR  list all dirs matching foo (by frecency)
+
+.SH NOTES
+
+\fBInstallation:\fR
+.P
+put something like this in your $HOME/.bashrc:
+.P
+ . /path/to/z.sh
+.P
+put something like this in your $HOME/.zshrc:
+.P
+ . /path/to/z.sh
+ function precmd () {
+   z --add "$(pwd -P)"
+ }
+.P
+cd around for a while to build up the db.
+.br
+PROFIT!!
+
+\fBFrecency:\fR
+.P
+Frecency is a portmantaeu of 'recent' and 'frequency'. It is a weighted rank
+that depends on 'how often' and 'how recently' something occured. As far as I
+know, Mozilla came up with the term.
+.P
+In \fBz\fR, a directory that has low ranking but has been accessed recently
+will quickly have higher rank than a directory accessed frequently a long time
+ago.
+
+.SH FILES
+data is stored in \fB$HOME/.z\fR
+
+.SH SEE ALSO
+regex(7), cdargs, pushd, popd, autojump, cdargs
+.P
+Please file bugs at https://github.com/rupa/z/
diff --git a/plugins/z/z.plugin.zsh b/plugins/z/z.plugin.zsh
new file mode 100644
index 000000000..03a78a65d
--- /dev/null
+++ b/plugins/z/z.plugin.zsh
@@ -0,0 +1,9 @@
+# Copyright (c) 2011 goolic under the WTFPL license
+# Using the z function created by rupa deadwyler on https://github.com/rupa/z
+
+
+source $ZSH/plugins/z/z.sh
+
+function precmd () {
+   z --add "$(pwd -P)"
+ }
diff --git a/plugins/z/z.sh b/plugins/z/z.sh
new file mode 100755
index 000000000..ae704c703
--- /dev/null
+++ b/plugins/z/z.sh
@@ -0,0 +1,183 @@
+# Copyright (c) 2009 rupa deadwyler under the WTFPL license
+
+# maintains a jump-list of the directories you actually use
+#
+# INSTALL:
+#   * put something like this in your .bashrc:
+#     . /path/to/z.sh
+#   * put something like this in your .zshrc:
+#     . /path/to/z.sh
+#     function precmd () {
+#       z --add "$(pwd -P)"
+#     }
+#   * cd around for a while to build up the db
+#   * PROFIT!!
+#
+# USE:
+#   * z foo     # cd to most frecent dir matching foo
+#   * z foo bar # cd to most frecent dir matching foo and bar
+#   * z -r foo  # cd to highest ranked dir matching foo
+#   * z -t foo  # cd to most recently accessed dir matching foo
+#   * z -l foo  # list all dirs matching foo (by frecency)
+
+z() {
+
+ local datafile="$HOME/.z"
+
+ # bail out if we don't own ~/.z (we're another user but our ENV is still set)
+ [ "$(ls -l "$datafile" | cut -d' ' -f 3)" = "$USER" ] || return
+
+ # add entries
+ if [ "$1" = "--add" ]; then
+  shift
+
+  # $HOME isn't worth matching
+  [ "$*" = "$HOME" ] && return
+
+  # maintain the file
+  local tempfile="$(mktemp $datafile.XXXXXX)" || return
+  awk -v path="$*" -v now="$(date +%s)" -F"|" '
+   BEGIN {
+    rank[path] = 1
+    time[path] = now
+   }
+   $2 >= 1 {
+    if( $1 == path ) {
+     rank[$1] = $2 + 1
+     time[$1] = now
+    } else {
+     rank[$1] = $2
+     time[$1] = $3
+    }
+    count += $2
+   }
+   END {
+    if( count > 1000 ) {
+     for( i in rank ) print i "|" 0.9*rank[i] "|" time[i] # aging
+    } else for( i in rank ) print i "|" rank[i] "|" time[i]
+   }
+  ' "$datafile" 2>/dev/null >| "$tempfile"
+  env mv -f "$tempfile" "$datafile"
+
+ # tab completion
+ elif [ "$1" = "--complete" ]; then
+  awk -v q="$2" -F"|" '
+   BEGIN {
+    if( q == tolower(q) ) nocase = 1
+    split(substr(q,3),fnd," ")
+   }
+   {
+    if( system("test -d \"" $1 "\"") ) next
+    if( nocase ) {
+     for( i in fnd ) tolower($1) !~ tolower(fnd[i]) && $1 = ""
+     if( $1 ) print $1
+    } else {
+     for( i in fnd ) $1 !~ fnd[i] && $1 = ""
+     if( $1 ) print $1
+    }
+   }
+  ' "$datafile" 2>/dev/null
+
+ else
+  # list/go
+  while [ "$1" ]; do case "$1" in
+   -h) echo "z [-h][-l][-r][-t] args" >&2; return;;
+   -l) local list=1;;
+   -r) local typ="rank";;
+   -t) local typ="recent";;
+   --) while [ "$1" ]; do shift; local fnd="$fnd $1";done;;
+    *) local fnd="$fnd $1";;
+  esac; local last=$1; shift; done
+  [ "$fnd" ] || local list=1
+
+  # if we hit enter on a completion just go there
+  [ -d "$last" ] && cd "$last" && return
+
+  # no file yet
+  [ -f "$datafile" ] || return
+
+  local tempfile="$(mktemp $datafile.XXXXXX)" || return
+  local cd="$(awk -v t="$(date +%s)" -v list="$list" -v typ="$typ" -v q="$fnd" -v tmpfl="$tempfile" -F"|" '
+   function frecent(rank, time) {
+    dx = t-time
+    if( dx < 3600 ) return rank*4
+    if( dx < 86400 ) return rank*2
+    if( dx < 604800 ) return rank/2
+    return rank/4
+   }
+   function output(files, toopen, override) {
+    if( list ) {
+     if( typ == "recent" ) {
+      cmd = "sort -nr >&2"
+     } else cmd = "sort -n >&2"
+     for( i in files ) if( files[i] ) printf "%-10s %s\n", files[i], i | cmd
+     if( override ) printf "%-10s %s\n", "common:", override > "/dev/stderr"
+    } else {
+     if( override ) toopen = override
+     print toopen
+    }
+   }
+   function common(matches, fnd, nc) {
+    for( i in matches ) {
+     if( matches[i] && (!short || length(i) < length(short)) ) short = i
+    }
+    if( short == "/" ) return
+    for( i in matches ) if( matches[i] && i !~ short ) x = 1
+    if( x ) return
+    if( nc ) {
+     for( i in fnd ) if( tolower(short) !~ tolower(fnd[i]) ) x = 1
+    } else for( i in fnd ) if( short !~ fnd[i] ) x = 1
+    if( !x ) return short
+   }
+   BEGIN { split(q, a, " ") }
+   {
+    if( system("test -d \"" $1 "\"") ) next
+    print $0 >> tmpfl
+    if( typ == "rank" ) {
+     f = $2
+    } else if( typ == "recent" ) {
+     f = t-$3
+    } else f = frecent($2, $3)
+    wcase[$1] = nocase[$1] = f
+    for( i in a ) {
+     if( $1 !~ a[i] ) delete wcase[$1]
+     if( tolower($1) !~ tolower(a[i]) ) delete nocase[$1]
+    }
+    if( wcase[$1] > oldf ) {
+     cx = $1
+     oldf = wcase[$1]
+    } else if( nocase[$1] > noldf ) {
+     ncx = $1
+     noldf = nocase[$1]
+    }
+   }
+   END {
+    if( cx ) {
+     output(wcase, cx, common(wcase, a, 0))
+    } else if( ncx ) output(nocase, ncx, common(nocase, a, 1))
+   }
+  ' "$datafile")"
+  if [ $? -gt 0 ]; then
+   env rm -f "$tempfile"
+  else
+   env mv -f "$tempfile" "$datafile"
+   [ "$cd" ] && cd "$cd"
+  fi
+ fi
+}
+
+if complete &> /dev/null; then
+  # bash tab completion
+  complete -C 'z --complete "$COMP_LINE"' z
+  # populate directory list. avoid clobbering other PROMPT_COMMANDs.
+  echo $PROMPT_COMMAND | grep -q "z --add"
+  [ $? -gt 0 ] && PROMPT_COMMAND='z --add "$(pwd -P 2>/dev/null)" 2>/dev/null;'"$PROMPT_COMMAND"
+elif compctl &> /dev/null; then
+  # zsh tab completion
+  _z_zsh_tab_completion() {
+    local compl
+    read -l compl
+    reply=(`z --complete "$compl"`)
+  }
+  compctl -U -K _z_zsh_tab_completion z
+fi