From: Sergey Matveev <stargrave@stargrave.org>
Date: Fri, 14 May 2021 07:54:05 +0000 (+0300)
Subject: Simplify and lower LoC
X-Git-Url: http://www.git.stargrave.org/?p=zsh-autoenv.git;a=commitdiff_plain;h=88a6982de0aaa7a05be3e95aa8849fcf5a4a3eab

Simplify and lower LoC
---

diff --git a/README b/README
new file mode 100644
index 0000000..5f42e11
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+This is simplified faster version with much more lower lines of code of
+https://github.com/Tarrasch/zsh-autoenv.
+
+Possibly harmful modifications:
+
+* Removed debugging messages. Only the fact that autoenv file is sourced
+* Removed autoenv_*_path helpers -- "path" array is already simple and
+  convenient to work with
+* Removed workaround function when zsh/stat module is lacked
+* Removed autoenv_source_parent() -- useless for me
+* Removed autoenv-edit() -- too trivial task
+* No testing provided
+
+Optimizations:
+
+* Removed old checksum format version support
+* Less subshell invocations -- only cksum is left
+* Heavily simplified and faster _autoenv_get_file_upwards() -- original
+  was compatible with an old zsh versions
+* varstash library is loaded without checking if autoenv needs it -- it
+  is faster to load it anyway, than to invoke grep every time
+* ctime is used instead of mtime, without size storage (unnecessary)
diff --git a/autoenv.zsh b/autoenv.zsh
index fe97d74..4b0530a 100644
--- a/autoenv.zsh
+++ b/autoenv.zsh
@@ -1,493 +1,141 @@
-# Initially based on
-# https://github.com/joshuaclayton/dotfiles/blob/master/zsh_profile.d/autoenv.zsh
-
-# File to store confirmed authentication into.
-# This handles the deprecated, old location(s).
-if [[ -z $AUTOENV_AUTH_FILE ]]; then
-  if [[ -n $AUTOENV_ENV_FILENAME ]]; then
-    echo "zsh-autoenv: using deprecated setting for AUTOENV_AUTH_FILE from AUTOENV_ENV_FILENAME." >&2
-    echo "Please set AUTOENV_AUTH_FILE instead." >&2
-    AUTOENV_AUTH_FILE=$AUTOENV_ENV_FILENAME
-  else
-    if [[ -n $XDG_DATA_HOME ]]; then
-      AUTOENV_AUTH_FILE=$XDG_DATA_HOME/autoenv_auth
-    else
-      AUTOENV_AUTH_FILE=~/.local/share/autoenv_auth
-    fi
-    if [[ -f ~/.env_auth ]]; then
-      echo "zsh-autoenv: using deprecated location for AUTOENV_AUTH_FILE." >&2
-      echo "Please move it: mv ~/.env_auth ${(D)AUTOENV_AUTH_FILE}" >&2
-      AUTOENV_AUTH_FILE=~/.env_auth
-    fi
-  fi
-fi
-
-# Name of the file to look for when entering directories.
+: ${AUTOENV_AUTH_FILE:=~/.env_auth}
 : ${AUTOENV_FILE_ENTER:=.autoenv.zsh}
-
-# Name of the file to look for when leaving directories.
-# Requires AUTOENV_HANDLE_LEAVE=1.
 : ${AUTOENV_FILE_LEAVE:=.autoenv_leave.zsh}
-
-# Look for zsh-autoenv "enter" files in parent dirs?
 : ${AUTOENV_LOOK_UPWARDS:=1}
-
-# Handle leave events when changing away from a subtree, where an "enter"
-# event was handled?
 : ${AUTOENV_HANDLE_LEAVE:=1}
-
-# Enable debugging. Multiple levels are supported (max 2).
-: ${AUTOENV_DEBUG:=0}
-
-# (Temporarily) disable zsh-autoenv. This gets looked at in the chpwd handler.
 : ${AUTOENV_DISABLED:=0}
 
-# Public helper functions, which can be used from your .autoenv.zsh files:
+typeset -a _autoenv_stack_entered
+typeset -A _autoenv_stack_entered_ctime
+typeset -a _autoenv_ctime
 
-# Source the next .autoenv.zsh file from parent directories.
-# This is useful if you want to use a base .autoenv.zsh file for a directory
-# subtree.
-autoenv_source_parent() {
-  local look_until=${1:-/}
-  local parent_env_file=$(_autoenv_get_file_upwards \
-    ${autoenv_env_file:h} ${AUTOENV_FILE_ENTER} $look_until)
-
-  if [[ -n $parent_env_file ]] \
-    && _autoenv_check_authorized_env_file $parent_env_file; then
-    _autoenv_debug "Calling autoenv_source_parent: parent_env_file:$parent_env_file"
-    _autoenv_source $parent_env_file enter
-  fi
+zmodload -F zsh/stat b:zstat
+_autoenv_get_file_ctime() {
+    zstat -a _autoenv_ctime +ctime $1 2>/dev/null || _autoenv_ctime=(0)
 }
 
-autoenv_append_path() {
-  local i
-  for i; do
-    (( ${path[(i)$i]} <= ${#path} )) && continue
-    path+=($i)
-  done
-}
-autoenv_prepend_path() {
-  local i
-  for i; do
-    (( ${path[(i)$i]} <= ${#path} )) && continue
-    path=($i $path)
-  done
-}
-autoenv_remove_path() {
-  local i
-  local old_path=$path
-  for i; do
-    path=("${(@)path:#$i}")
-  done
-  [[ $old_path != $path ]]
+_autoenv_stack_entered_remove() {
+    local env_file=$1
+    _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
+    _autoenv_stack_entered_ctime[$env_file]=
 }
 
-# Internal functions. {{{
-# Internal: stack of loaded env files (i.e. entered directories). {{{
-typeset -g -a _autoenv_stack_entered
-# -g: make it global, this is required when used with antigen.
-typeset -g -A _autoenv_stack_entered_mtime
-
-# Add an entry to the stack, and remember its mtime.
 _autoenv_stack_entered_add() {
-  local env_file=$1
-
-  # Remove any existing entry.
-  _autoenv_stack_entered_remove $env_file
-
-  # Append it to the stack, and remember its mtime.
-  _autoenv_debug "[stack] adding: $env_file" 2
-  _autoenv_stack_entered+=($env_file)
-  _autoenv_stack_entered_mtime[$env_file]=$(_autoenv_get_file_mtime $env_file)
+    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]}
 }
 
-# zstat_mime helper, conditionally defined.
-# Load zstat module, but only its builtin `zstat`.
-if ! zmodload -F zsh/stat b:zstat 2>/dev/null; then
-  # If the module is not available, define a wrapper around `stat`, and use its
-  # terse output instead of format, which is not supported by busybox.
-  # Assume '+mtime' as $1.
-  _autoenv_get_file_mtime() {
-    # setopt localoptions pipefail
-    local stat
-    stat=$(stat -t $1 2>/dev/null)
-    if [[ -n $stat ]]; then
-      echo ${${(s: :)stat}[13]}
-    else
-      echo 0
-    fi
-  }
-else
-  _autoenv_get_file_mtime() {
-    zstat +mtime $1 2>/dev/null || echo 0
-  }
-fi
-
-# Remove an entry from the stack.
-_autoenv_stack_entered_remove() {
-  local env_file=$1
-  _autoenv_debug "[stack] removing: $env_file" 2
-  _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
-  _autoenv_stack_entered_mtime[$env_file]=
-}
-
-# Is the given entry already in the stack?
-# This checks for the env_file ($1) as-is and with symlinks resolved.
 _autoenv_stack_entered_contains() {
-  local env_file=$1
-  local f i
-  if (( ${+_autoenv_stack_entered[(r)${env_file}]} )); then
-    # Entry is in stack.
-    f=$env_file
-  else
-    local env_file_abs=${env_file:A}
-    for i in $_autoenv_stack_entered; do
-      if [[ ${i:A} == ${env_file_abs} ]]; then
-        # Entry is in stack (compared with resolved symlinks).
-        f=$i
-        break
-      fi
-    done
-  fi
-  if [[ -n $f ]]; then
-    if [[ $_autoenv_stack_entered_mtime[$f] == $(_autoenv_get_file_mtime $f) ]]; then
-      # Entry has the expected mtime.
-      return
+    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
-  fi
-  return 1
-}
-# }}}
-
-# Internal function for debug output. {{{
-_autoenv_debug() {
-  local level=${2:-1}
-  if (( AUTOENV_DEBUG < level )); then
-    return
-  fi
-  local msg="$1"  # Might trigger a bug in Zsh 5.0.5 with shwordsplit.
-  # Load zsh color support.
-  if [[ -z $color ]]; then
-    autoload colors
-    colors
-  fi
-  # Build $indent prefix.
-  local indent=
-  if [[ $_autoenv_debug_indent -gt 0 ]]; then
-    for i in {1..${_autoenv_debug_indent}}; do
-      indent="  $indent"
-    done
-  fi
-
-  # Split $msg by \n (not newline).
-  lines=(${(ps:\\n:)msg})
-  for line in $lines; do
-    echo -n "${fg_bold[blue]}[autoenv]${fg_no_bold[default]} " >&2
-    echo ${indent}${line} >&2
-  done
+    [[ -n $f ]] || return 1
+    _autoenv_get_file_ctime $f
+    [[ ${_autoenv_stack_entered_ctime[$f]} == ${_autoenv_ctime[1]} ]] || return 1
 }
-# }}}
 
-
-# Generate hash pair for a given file ($1) and version ($2).
-# A fixed hash value can be given as 3rd arg, but is used with tests only.
-# The format is ":$file:$hash:$version".
 _autoenv_hash_pair() {
-  local env_file=${1:A}
-  local cksum_version=${2:-2}
-  local env_cksum=${3:-}
-  ret_pair=
-  if [[ -z $env_cksum ]]; then
-    if ! [[ -e $env_file ]]; then
-      echo "Missing file argument for _autoenv_hash_pair!" >&2
-      return 1
-    fi
-    if [[ $cksum_version = 2 ]]; then
-      # Get the output from `cksum` and join the first two words with a dot.
-      env_cksum=${(j:.:)${:-$(cksum "$env_file")}[1,2]}
-    elif [[ $cksum_version = 1 ]]; then
-      env_cksum=$(sha1sum $env_file | cut -d' ' -f1)
-    else
-      echo "Invalid version argument (${cksum_version}) for _autoenv_hash_pair!" >&2
-      return 1
-    fi
-  fi
-  ret_pair=":${env_file}:${env_cksum}:${cksum_version}"
+    local env_file=${1:A}
+    env_cksum=${${:-$(cksum "$env_file")}[1]}
+    ret_pair=":${env_file}:${env_cksum}"
 }
 
-
-# Check if a given env_file is authorized.
 _autoenv_authorized_env_file() {
-  local env_file=$1
-  local env_file_abs=${env_file:A}
-  local ret_pair
-
-  local -a lines
-  if [[ -f $AUTOENV_AUTH_FILE ]]; then
-    lines=( ${(M)"${(f@)"$(< $AUTOENV_AUTH_FILE)"}":#:$env_file_abs:*} )
-  fi
-  if [[ -z $lines ]]; then
-    return 1
-  fi
-
-  if (( $#lines != 1 )); then
-    echo "zsh-autoenv: found unexpected number ($#lines) of auth entries for $env_file in $AUTOENV_AUTH_FILE." >&2
-    echo $lines
-  fi
-  line=${lines[-1]}
-
-  if [[ $line == *:2 ]]; then
+    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
-    _autoenv_debug "Checking v2 pair: ${ret_pair}"
-    if [[ $line == $ret_pair ]]; then
-      return
-    fi
-  elif [[ $line == *:1 ]]; then
-    # Fallback for v1 (SHA-1) pairs
-    _autoenv_debug "Checking v1 pair: ${ret_pair}"
-    _autoenv_hash_pair $env_file 1
-    if [[ $line == $ret_pair ]]; then
-      # Upgrade v1 entries to v2
-      _autoenv_authorize $env_file
-      return
-    fi
-  fi
-  return 1
+    [[ $line == $ret_pair ]] || return 1
 }
 
 _autoenv_authorize() {
-  local env_file=${1:A}
-  _autoenv_deauthorize $env_file
-  [[ -d ${AUTOENV_AUTH_FILE:h} ]] || mkdir -p ${AUTOENV_AUTH_FILE:h}
-  {
+    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 && echo "$ret_pair"
-  } >>| $AUTOENV_AUTH_FILE
+    _autoenv_hash_pair $env_file && print "$ret_pair" >>| $AUTOENV_AUTH_FILE
 }
 
-# Deauthorize a given filename, by removing it from the auth file.
-# This uses `test -s` to only handle non-empty files.
 _autoenv_deauthorize() {
-  local env_file=${1:A}
-  if [[ -s $AUTOENV_AUTH_FILE ]]; then
-    \grep -vF :${env_file}: $AUTOENV_AUTH_FILE >| $AUTOENV_AUTH_FILE.tmp
-    \mv $AUTOENV_AUTH_FILE.tmp $AUTOENV_AUTH_FILE
-  fi
+    local env_file=${1:A}
+    [[ -s $AUTOENV_AUTH_FILE ]] || return
+    perl -i -ne "print unless m[:${env_file}:]" $AUTOENV_AUTH_FILE
 }
 
-# This function can be mocked in tests
-_autoenv_ask_for_yes() {
-  local answer
-
-  # Handle/catch Ctrl-C and return, instead of letting it potentially abort the
-  # shell setup process.
-  setopt localtraps
-  trap 'return 1' INT
-
-  read answer
-  if [[ $answer == "yes" ]]; then
-    return 0
-  else
-    return 1
-  fi
-}
-
-# Args: 1: absolute path to env file (resolved symlinks).
 _autoenv_check_authorized_env_file() {
-  if ! [[ -f $1 ]]; then
-    return 1
-  fi
-  if ! _autoenv_authorized_env_file $1; then
-    echo "Attempting to load unauthorized env file!" >&2
+    local env_file=$1
+    [[ -f $env_file ]] || return 1
+    _autoenv_authorized_env_file $1 && return
     command ls -l $1 >&2
-    echo >&2
-    echo "**********************************************" >&2
-    echo >&2
-    command cat $1 >&2
-    echo >&2
-    echo "**********************************************" >&2
-    echo >&2
-    echo -n "Would you like to authorize it? (type 'yes') " >&2
-    # echo "Would you like to authorize it?"
-    # echo "('yes' to allow, 'no' to not being asked again; otherwise ignore it for the shell) "
-
-    if ! _autoenv_ask_for_yes; then
-      return 1
-    fi
-
+    local answer
+    setopt localtraps
+    trap "return 1" INT
+    read -q answer\?"Authorize? "
+    print
+    [[ $answer == "y" ]] || return 1
     _autoenv_authorize $1
-  fi
-  return 0
 }
 
 _autoenv_source() {
-  # Public API for the .autoenv.zsh script.
-  local autoenv_env_file=$1
-  local autoenv_event=$2
-  local autoenv_from_dir=$OLDPWD
-  local autoenv_to_dir=$PWD
-
-  # Source varstash library once.
-  # XXX: pollutes environment with e.g. `stash`, and `autostash` will cause
-  # an overwritten `stash` function to be called!
-  if ! (( $+functions[autostash] )); then
-    if \grep -qE '\b(autostash|autounstash|stash|unstash)\b' $autoenv_env_file; then
-      source ${${funcsourcetrace[1]%:*}:h}/lib/varstash
-    fi
-  fi
-
-  # Source the env file.
-  _autoenv_debug "== SOURCE: $autoenv_event: ${bold_color:-}$autoenv_env_file${reset_color:-} (in $PWD)"
-  (( ++_autoenv_debug_indent ))
-
-  local restore_xtrace
-  if [[ $AUTOENV_DEBUG -gt 2 && ! -o xtrace ]]; then
-    restore_xtrace=1
-    setopt localoptions xtrace
-  fi
-
-  varstash_dir=${autoenv_env_file:h} source $autoenv_env_file
-  if (( restore_xtrace )); then
-    setopt noxtrace
-  fi
-  (( --_autoenv_debug_indent ))
-  _autoenv_debug "== END SOURCE =="
-
-  if [[ $autoenv_event == enter ]]; then
-    _autoenv_stack_entered_add $autoenv_env_file
-  fi
+    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
 }
 
 _autoenv_get_file_upwards() {
-  local look_from=${1:-$PWD}
-  local look_for=${2:-$AUTOENV_FILE_ENTER}
-  local look_until=${${3:-/}:A}
-
-  # Manually look in parent dirs. An extended Zsh glob should use Y1 for
-  # performance reasons, which is only available in zsh-5.0.5-146-g9381bb6.
-  local last
-  local parent_dir="$look_from/.."
-  local abs_parent_dir
-  while true; do
-    abs_parent_dir=${parent_dir:A}
-    if [[ $abs_parent_dir == $last ]]; then
-      break
-    fi
-    local parent_file="${parent_dir}/${look_for}"
-
-    if [[ -f $parent_file ]]; then
-      if [[ ${parent_file[1,2]} == './' ]]; then
-        echo ${parent_file#./}
-      else
-        echo ${parent_file:a}
-      fi
-      break
-    fi
-
-    if [[ $abs_parent_dir == $look_until ]]; then
-      break
-    fi
-    last=$abs_parent_dir
-    parent_dir="${parent_dir}/.."
-  done
-}
-
-autoenv-edit() {
-  emulate -L zsh
-  local env_file
-  local -a files
-  local -A check
-  check[enter]=$AUTOENV_FILE_ENTER
-  if [[ "$AUTOENV_FILE_ENTER" != "$AUTOENV_FILE_LEAVE" ]]; then
-    check[leave]=$AUTOENV_FILE_LEAVE
-  fi
-  local f t
-  for t f in ${(kv)check}; do
-    env_file="$f"
-    if ! [[ -f $env_file ]]; then
-      env_file=$(_autoenv_get_file_upwards . $f)
-      if [[ -z $env_file ]]; then
-        echo "No $f file found ($t)." >&2
-        continue
-      fi
-      if ! [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
-        echo "Note: found $env_file, but AUTOENV_LOOK_UPWARDS is disabled."
-      fi
-    fi
-    files+=($env_file)
-  done
-  if [[ -z "$files" ]]; then
-    return 1
-  fi
-  echo "Editing $files.."
-  local editor
-  editor="${${AUTOENV_EDITOR:-$EDITOR}:-vim}"
-  eval $editor "$files"
+    setopt EXTENDED_GLOB NO_NOMATCH
+    found=( (../)#$AUTOENV_FILE_ENTER(Y1:A) )
+    env_file=${found[1]}
 }
 
 _autoenv_chpwd_handler() {
-  emulate -L zsh
-  _autoenv_debug "Calling chpwd handler: PWD=$PWD"
-
-  if (( $AUTOENV_DISABLED )); then
-    _autoenv_debug "Disabled (AUTOENV_DISABLED)."
-    return
-  fi
-
-  local env_file="$PWD/$AUTOENV_FILE_ENTER"
-  _autoenv_debug "Looking for env_file: $env_file"
-
-  # Handle leave event for previously sourced env files.
-  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
-        _autoenv_debug "Handling leave event: $env_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
-
-        # Unstash any autostashed stuff.
-        if (( $+functions[autostash] )); then
-          varstash_dir=$prev_dir autounstash
-        fi
-
-        _autoenv_stack_entered_remove $prev_file
-      fi
-    done
-  fi
-
-  if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
-    env_file=$(_autoenv_get_file_upwards $PWD)
-    if [[ -z $env_file ]]; then
-      _autoenv_debug "No env_file found when looking upwards"
-      return
+    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
-    _autoenv_debug "Found env_file: $env_file"
-  fi
-
-  # Load the env file only once: check if $env_file is in the stack of entered
-  # directories.
-  if _autoenv_stack_entered_contains $env_file; then
-    _autoenv_debug "Already in stack: $env_file"
-    return
-  fi
-
-  if ! _autoenv_check_authorized_env_file $env_file; then
-    _autoenv_debug "Not authorized: $env_file"
-    return
-  fi
-
-  # Source the enter env file.
-  _autoenv_debug "Sourcing from chpwd handler: $env_file"
-  _autoenv_source $env_file enter
+    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 _autoenv_chpwd_handler
-
-# Look in current directory already.
 _autoenv_chpwd_handler