]> Sergey Matveev's repositories - zsh-autoenv.git/blobdiff - autoenv.zsh
Usage examples
[zsh-autoenv.git] / autoenv.zsh
index 317217f43a048ac6870696cabb8b33b610a6e824..4b0530aca1c42102018ea9535fc041418a08f669 100644 (file)
-# Initially based on
-# https://github.com/joshuaclayton/dotfiles/blob/master/zsh_profile.d/autoenv.zsh
-
-export AUTOENV_ENV_FILENAME=$HOME/.env_auth
-
-# Name of file to look for when entering directories.
-: ${DOTENV_FILE_ENTER:=.env}
-
-# Name of file to look for when leaving directories.
-# Requires DOTENV_HANDLE_LEAVE=1.
-: ${DOTENV_FILE_LEAVE:=.env.leave}
-
-# Look for .env in parent dirs?
-: ${DOTENV_LOOK_UPWARDS:=1}
-
-# Handle leave events when changing away from a subtree, where an "enter"
-# event was handled?
-: ${DOTENV_HANDLE_LEAVE:=1}
-
-
-# Internal: stack of entered (and handled) directories.
-_dotenv_stack_entered=()
-
-
-_dotenv_hash_pair() {
-  local env_file=$1
-  if (( $+2 )); then
-    env_shasum=$2
-  else
-    env_shasum=$(shasum $env_file | cut -d' ' -f1)
-  fi
-  echo "$env_file:$env_shasum:1"
+: ${AUTOENV_AUTH_FILE:=~/.env_auth}
+: ${AUTOENV_FILE_ENTER:=.autoenv.zsh}
+: ${AUTOENV_FILE_LEAVE:=.autoenv_leave.zsh}
+: ${AUTOENV_LOOK_UPWARDS:=1}
+: ${AUTOENV_HANDLE_LEAVE:=1}
+: ${AUTOENV_DISABLED:=0}
+
+typeset -a _autoenv_stack_entered
+typeset -A _autoenv_stack_entered_ctime
+typeset -a _autoenv_ctime
+
+zmodload -F zsh/stat b:zstat
+_autoenv_get_file_ctime() {
+    zstat -a _autoenv_ctime +ctime $1 2>/dev/null || _autoenv_ctime=(0)
 }
 
-_dotenv_authorized_env_file() {
-  local env_file=$1
-  local pair=$(_dotenv_hash_pair $env_file)
-  test -f $AUTOENV_ENV_FILENAME \
-    && \grep -qF $pair $AUTOENV_ENV_FILENAME
+_autoenv_stack_entered_remove() {
+    local env_file=$1
+    _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
+    _autoenv_stack_entered_ctime[$env_file]=
 }
 
-_dotenv_authorize() {
-  local env_file=$1
-  _dotenv_deauthorize $env_file
-  _dotenv_hash_pair $env_file >> $AUTOENV_ENV_FILENAME
+_autoenv_stack_entered_add() {
+    local env_file=$1
+    _autoenv_stack_entered_remove $env_file
+    _autoenv_stack_entered+=($env_file)
+    _autoenv_get_file_ctime $env_file
+    _autoenv_stack_entered_ctime[$env_file]=${_autoenv_ctime[1]}
 }
 
-_dotenv_deauthorize() {
-  local env_file=$1
-  if [[ -f $AUTOENV_ENV_FILENAME ]]; then
-    echo $(\grep -vF $env_file $AUTOENV_ENV_FILENAME) > $AUTOENV_ENV_FILENAME
-  fi
+_autoenv_stack_entered_contains() {
+    local env_file=$1
+    local f i
+    if (( ${+_autoenv_stack_entered[(r)${env_file}]} )); then
+        f=$env_file
+    else
+        local env_file_abs=${env_file:A}
+        for i ($_autoenv_stack_entered) {
+            [[ ${i:A} == ${env_file_abs} ]] && {
+                f=$i
+                break
+            }
+        }
+    fi
+    [[ -n $f ]] || return 1
+    _autoenv_get_file_ctime $f
+    [[ ${_autoenv_stack_entered_ctime[$f]} == ${_autoenv_ctime[1]} ]] || return 1
 }
 
-# This function can be mocked in tests
-_dotenv_read_answer() {
-  local answer
-  read $=_AUTOENV_TEST_READ_ARGS -q answer
-  echo $answer
+_autoenv_hash_pair() {
+    local env_file=${1:A}
+    env_cksum=${${:-$(cksum "$env_file")}[1]}
+    ret_pair=":${env_file}:${env_cksum}"
 }
 
-# Args: 1: absolute path to env file (resolved symlinks).
-_dotenv_check_authorized_env_file() {
-  if ! [[ -f $1 ]]; then
-    return 1
-  fi
-  if ! _dotenv_authorized_env_file $1; then
-    echo "Attempting to load unauthorized env file: $1"
-    echo ""
-    echo "**********************************************"
-    echo ""
-    cat $1
-    echo ""
-    echo "**********************************************"
-    echo ""
-    echo -n "Would you like to authorize it? [y/N] "
-
-    local answer=$(_dotenv_read_answer)
-    echo
-    if [[ $answer != 'y' ]]; then
-      return 1
-    fi
-
-    _dotenv_authorize $1
-  fi
-  return 0
+_autoenv_authorized_env_file() {
+    local env_file=$1
+    local env_file_abs=${env_file:A}
+    local ret_pair
+    local -a lines
+    [[ -s $AUTOENV_AUTH_FILE ]] &&
+        lines=( ${(M)"${(f@)"$(< $AUTOENV_AUTH_FILE)"}":#:$env_file_abs:*} )
+    [[ -z $lines ]] && return 1
+    line=${lines[-1]}
+    _autoenv_hash_pair $env_file
+    [[ $line == $ret_pair ]] || return 1
 }
 
-# Initialize $_dotenv_sourced_varstash, but do not overwrite an existing one
-# from e.g. `exec zsh` (to reload your shell config).
-: ${_dotenv_sourced_varstash:=0}
-
-# Get directory of this file (absolute, with resolved symlinks).
-_dotenv_this_dir=${0:A:h}
-
-_dotenv_source() {
-  local env_file=$1
-  _dotenv_event=$2
-  _dotenv_cwd=$3
-
-  # Source varstash library once.
-  if [[ $_dotenv_sourced_varstash == 0 ]]; then
-    source $_dotenv_this_dir/lib/varstash
-    export _dotenv_sourced_varstash=1
-    # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
-    # ${env_file:h}.
-  fi
+_autoenv_authorize() {
+    local env_file=${1:A}
+    _autoenv_deauthorize $env_file
+    [[ -d ${AUTOENV_AUTH_FILE:h} ]] || mkdir -p ${AUTOENV_AUTH_FILE:h}
+    local ret_pair
+    _autoenv_hash_pair $env_file && print "$ret_pair" >>| $AUTOENV_AUTH_FILE
+}
 
-  # Change to directory of env file, source it and cd back.
-  local new_dir=$PWD
-  builtin cd -q $_dotenv_cwd
-  source $env_file
-  builtin cd -q $new_dir
+_autoenv_deauthorize() {
+    local env_file=${1:A}
+    [[ -s $AUTOENV_AUTH_FILE ]] || return
+    perl -i -ne "print unless m[:${env_file}:]" $AUTOENV_AUTH_FILE
+}
 
-  unset _dotenv_event _dotenv_cwd
+_autoenv_check_authorized_env_file() {
+    local env_file=$1
+    [[ -f $env_file ]] || return 1
+    _autoenv_authorized_env_file $1 && return
+    command ls -l $1 >&2
+    local answer
+    setopt localtraps
+    trap "return 1" INT
+    read -q answer\?"Authorize? "
+    print
+    [[ $answer == "y" ]] || return 1
+    _autoenv_authorize $1
 }
 
-_dotenv_chpwd_handler() {
-  local env_file="$PWD/$DOTENV_FILE_ENTER"
+_autoenv_source() {
+    local autoenv_env_file=$1
+    local autoenv_event=$2
+    print "autoenv: $autoenv_env_file" >&2
+    (( $+functions[autostash] )) || source ${${funcsourcetrace[1]%:*}:h}/lib/varstash
+    varstash_dir=${autoenv_env_file:h} source $autoenv_env_file
+    [[ $autoenv_event == enter ]] && _autoenv_stack_entered_add $autoenv_env_file
+}
 
-  # Handle leave event for previously sourced env files.
-  if [[ $DOTENV_HANDLE_LEAVE == 1 ]] && (( $#_dotenv_stack_entered )); then
-    for prev_dir in ${_dotenv_stack_entered}; do
-      if ! [[ ${PWD}/ == ${prev_dir}/* ]]; then
-        local env_file_leave=$prev_dir/$DOTENV_FILE_LEAVE
-        if _dotenv_check_authorized_env_file $env_file_leave; then
-          _dotenv_source $env_file_leave leave $prev_dir
-        fi
-        # Remove this entry from the stack.
-        _dotenv_stack_entered=(${_dotenv_stack_entered#$prev_dir})
-      fi
-    done
-  fi
+_autoenv_get_file_upwards() {
+    setopt EXTENDED_GLOB NO_NOMATCH
+    found=( (../)#$AUTOENV_FILE_ENTER(Y1:A) )
+    env_file=${found[1]}
+}
 
-  if ! [[ -f $env_file ]] && [[ $DOTENV_LOOK_UPWARDS == 1 ]]; then
-    # Look for files in parent dirs, using an extended Zsh glob.
-    setopt localoptions extendedglob
-    local m
-    m=((../)#${DOTENV_FILE_ENTER}(N))
-    if (( $#m )); then
-      env_file=${${m[1]}:A}
-    else
-      return
+_autoenv_chpwd_handler() {
+    emulate -L zsh
+    (( $AUTOENV_DISABLED )) && return
+    local env_file="$PWD/$AUTOENV_FILE_ENTER"
+    if [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
+        local prev_file prev_dir
+        for prev_file in ${_autoenv_stack_entered}; do
+            prev_dir=${prev_file:h}
+            if ! [[ ${PWD}/ == ${prev_dir}/* ]]; then
+                local env_file_leave=$prev_dir/$AUTOENV_FILE_LEAVE
+                if _autoenv_check_authorized_env_file $env_file_leave; then
+                    varstash_dir=$prev_dir _autoenv_source $env_file_leave leave $prev_dir
+                fi
+                (( $+functions[autostash] )) && varstash_dir=$prev_dir autounstash
+                _autoenv_stack_entered_remove $prev_file
+            fi
+        done
     fi
-  fi
-
-  if ! _dotenv_check_authorized_env_file $env_file; then
-    return
-  fi
-
-  # Load the env file only once: check if $env_file's parent
-  # is in $_dotenv_stack_entered.
-  local env_file_dir=${env_file:A:h}
-  if (( ${+_dotenv_stack_entered[(r)${env_file_dir}]} )); then
-    return
-  fi
-
-  _dotenv_stack_entered+=(${env_file_dir})
-
-  _dotenv_source $env_file enter $PWD
+    if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
+        _autoenv_get_file_upwards $PWD
+        [[ -f $env_file ]] || return
+    fi
+    _autoenv_stack_entered_contains $env_file && return
+    _autoenv_check_authorized_env_file $env_file || return
+    _autoenv_source $env_file enter
 }
 
 autoload -U add-zsh-hook
-add-zsh-hook chpwd _dotenv_chpwd_handler
-
-# Look in current directory already.
-_dotenv_chpwd_handler
+add-zsh-hook chpwd _autoenv_chpwd_handler
+_autoenv_chpwd_handler