]> Sergey Matveev's repositories - zsh-autoenv.git/commitdiff
Use AUTOENV prefix
authorDaniel Hahler <git@thequod.de>
Fri, 21 Nov 2014 21:51:28 +0000 (22:51 +0100)
committerDaniel Hahler <git@thequod.de>
Mon, 24 Nov 2014 19:13:18 +0000 (20:13 +0100)
 - s/DOTENV_/AUTOENV_/
 - s/dotenv_/autoenv_/

Ref: https://github.com/Tarrasch/zsh-autoenv/issues/6

autoenv.zsh
tests/autoenv.t
tests/cwd.t
tests/leave.t
tests/setup.sh
tests/varstash.t

index 19891b688eed8bf5f1b49dc5dd03152c2240654c..e996ca2e2b368cd7fcc61cf9bb1f3a236d332bed 100644 (file)
@@ -4,25 +4,25 @@
 export AUTOENV_ENV_FILENAME=$HOME/.env_auth
 
 # Name of file to look for when entering directories.
-: ${DOTENV_FILE_ENTER:=.env}
+: ${AUTOENV_FILE_ENTER:=.env}
 
 # Name of file to look for when leaving directories.
-# Requires DOTENV_HANDLE_LEAVE=1.
-: ${DOTENV_FILE_LEAVE:=.env.leave}
+# Requires AUTOENV_HANDLE_LEAVE=1.
+: ${AUTOENV_FILE_LEAVE:=.env.leave}
 
 # Look for .env in parent dirs?
-: ${DOTENV_LOOK_UPWARDS:=1}
+: ${AUTOENV_LOOK_UPWARDS:=1}
 
 # Handle leave events when changing away from a subtree, where an "enter"
 # event was handled?
-: ${DOTENV_HANDLE_LEAVE:=1}
+: ${AUTOENV_HANDLE_LEAVE:=1}
 
 
 # Internal: stack of entered (and handled) directories.
-_dotenv_stack_entered=()
+_autoenv_stack_entered=()
 
 
-_dotenv_hash_pair() {
+_autoenv_hash_pair() {
   local env_file=$1
   if (( $+2 )); then
     env_shasum=$2
@@ -32,20 +32,20 @@ _dotenv_hash_pair() {
   echo "$env_file:$env_shasum:1"
 }
 
-_dotenv_authorized_env_file() {
+_autoenv_authorized_env_file() {
   local env_file=$1
-  local pair=$(_dotenv_hash_pair $env_file)
+  local pair=$(_autoenv_hash_pair $env_file)
   test -f $AUTOENV_ENV_FILENAME \
     && \grep -qF $pair $AUTOENV_ENV_FILENAME
 }
 
-_dotenv_authorize() {
+_autoenv_authorize() {
   local env_file=$1
-  _dotenv_deauthorize $env_file
-  _dotenv_hash_pair $env_file >> $AUTOENV_ENV_FILENAME
+  _autoenv_deauthorize $env_file
+  _autoenv_hash_pair $env_file >> $AUTOENV_ENV_FILENAME
 }
 
-_dotenv_deauthorize() {
+_autoenv_deauthorize() {
   local env_file=$1
   if [[ -f $AUTOENV_ENV_FILENAME ]]; then
     echo $(\grep -vF $env_file $AUTOENV_ENV_FILENAME) > $AUTOENV_ENV_FILENAME
@@ -53,18 +53,18 @@ _dotenv_deauthorize() {
 }
 
 # This function can be mocked in tests
-_dotenv_read_answer() {
+_autoenv_read_answer() {
   local answer
   read $=_AUTOENV_TEST_READ_ARGS -q answer
   echo $answer
 }
 
 # Args: 1: absolute path to env file (resolved symlinks).
-_dotenv_check_authorized_env_file() {
+_autoenv_check_authorized_env_file() {
   if ! [[ -f $1 ]]; then
     return 1
   fi
-  if ! _dotenv_authorized_env_file $1; then
+  if ! _autoenv_authorized_env_file $1; then
     echo "Attempting to load unauthorized env file: $1"
     echo ""
     echo "**********************************************"
@@ -75,101 +75,101 @@ _dotenv_check_authorized_env_file() {
     echo ""
     echo -n "Would you like to authorize it? [y/N] "
 
-    local answer=$(_dotenv_read_answer)
+    local answer=$(_autoenv_read_answer)
     echo
     if [[ $answer != 'y' ]]; then
       return 1
     fi
 
-    _dotenv_authorize $1
+    _autoenv_authorize $1
   fi
   return 0
 }
 
-# Initialize $_dotenv_sourced_varstash, but do not overwrite an existing one
+# Initialize $_autoenv_sourced_varstash, but do not overwrite an existing one
 # from e.g. `exec zsh` (to reload your shell config).
-: ${_dotenv_sourced_varstash:=0}
+: ${_autoenv_sourced_varstash:=0}
 
 # Get directory of this file (absolute, with resolved symlinks).
-_dotenv_this_dir=${0:A:h}
+_autoenv_this_dir=${0:A:h}
 
-_dotenv_source() {
+_autoenv_source() {
   local env_file=$1
-  _dotenv_event=$2
-  _dotenv_envfile_dir=$3
-  _dotenv_from_dir=$_dotenv_chpwd_prev_dir
-  _dotenv_to_dir=$PWD
+  _autoenv_event=$2
+  _autoenv_envfile_dir=$3
+  _autoenv_from_dir=$_autoenv_chpwd_prev_dir
+  _autoenv_to_dir=$PWD
 
   # Source varstash library once.
-  if [[ $_dotenv_sourced_varstash == 0 ]]; then
-    source $_dotenv_this_dir/lib/varstash
-    export _dotenv_sourced_varstash=1
+  if [[ $_autoenv_sourced_varstash == 0 ]]; then
+    source $_autoenv_this_dir/lib/varstash
+    export _autoenv_sourced_varstash=1
     # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
     # ${env_file:h}.
   fi
 
   # Change to directory of env file, source it and cd back.
   local new_dir=$PWD
-  builtin cd -q $_dotenv_envfile_dir
+  builtin cd -q $_autoenv_envfile_dir
   source $env_file
   builtin cd -q $new_dir
 
-  unset _dotenv_event _dotenv_from_dir
+  unset _autoenv_event _autoenv_from_dir
 }
 
-_dotenv_chpwd_prev_dir=$PWD
-_dotenv_chpwd_handler() {
-  local env_file="$PWD/$DOTENV_FILE_ENTER"
+_autoenv_chpwd_prev_dir=$PWD
+_autoenv_chpwd_handler() {
+  local env_file="$PWD/$AUTOENV_FILE_ENTER"
 
   # 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 [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
+    for prev_dir in ${_autoenv_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
+        local env_file_leave=$prev_dir/$AUTOENV_FILE_LEAVE
+        if _autoenv_check_authorized_env_file $env_file_leave; then
+          _autoenv_source $env_file_leave leave $prev_dir
         fi
         # Remove this entry from the stack.
-        _dotenv_stack_entered=(${_dotenv_stack_entered#$prev_dir})
+        _autoenv_stack_entered=(${_autoenv_stack_entered#$prev_dir})
       fi
     done
   fi
 
-  if ! [[ -f $env_file ]] && [[ $DOTENV_LOOK_UPWARDS == 1 ]]; then
+  if ! [[ -f $env_file ]] && [[ $AUTOENV_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))
+    m=((../)#${AUTOENV_FILE_ENTER}(N))
     if (( $#m )); then
       env_file=${${m[1]}:A}
     else
-      _dotenv_chpwd_prev_dir=$PWD
+      _autoenv_chpwd_prev_dir=$PWD
       return
     fi
   fi
 
-  if ! _dotenv_check_authorized_env_file $env_file; then
-    _dotenv_chpwd_prev_dir=$PWD
+  if ! _autoenv_check_authorized_env_file $env_file; then
+    _autoenv_chpwd_prev_dir=$PWD
     return
   fi
 
   # Load the env file only once: check if $env_file's parent
-  # is in $_dotenv_stack_entered.
+  # is in $_autoenv_stack_entered.
   local env_file_dir=${env_file:A:h}
-  if (( ${+_dotenv_stack_entered[(r)${env_file_dir}]} )); then
-    _dotenv_chpwd_prev_dir=$PWD
+  if (( ${+_autoenv_stack_entered[(r)${env_file_dir}]} )); then
+    _autoenv_chpwd_prev_dir=$PWD
     return
   fi
 
-  _dotenv_stack_entered+=(${env_file_dir})
+  _autoenv_stack_entered+=(${env_file_dir})
 
-  _dotenv_source $env_file enter $PWD
+  _autoenv_source $env_file enter $PWD
 
-  _dotenv_chpwd_prev_dir=$PWD
+  _autoenv_chpwd_prev_dir=$PWD
 }
 
 autoload -U add-zsh-hook
-add-zsh-hook chpwd _dotenv_chpwd_handler
+add-zsh-hook chpwd _autoenv_chpwd_handler
 
 # Look in current directory already.
-_dotenv_chpwd_handler
+_autoenv_chpwd_handler
index f477c1377ef9e0dd1b1068f1a06253c4012a1557..f78560a8e905a68aa08a46dafe99ceb57e45ce6d 100644 (file)
@@ -12,9 +12,9 @@ Manually create auth file
 
 Now try to make it accept it
 
-  $ unset _dotenv_stack_entered
+  $ unset _autoenv_stack_entered
   $ rm $AUTOENV_ENV_FILENAME
-  $ _dotenv_read_answer() { echo 'y' }
+  $ _autoenv_read_answer() { echo 'y' }
   $ cd .
   Attempting to load unauthorized env file: /tmp/cramtests-??????/autoenv.t/.env (glob)
   
@@ -35,11 +35,11 @@ The last "ENTERED" is because it executed the command
 
 Now lets see that it actually checks the shasum value
 
-  $ unset _dotenv_stack_entered
+  $ unset _autoenv_stack_entered
   $ cd .
   ENTERED
 
-  $ unset _dotenv_stack_entered
+  $ unset _autoenv_stack_entered
   $ rm $AUTOENV_ENV_FILENAME
   $ test_autoenv_add_to_env $PWD/.env mischief
   $ cd .
@@ -60,9 +60,9 @@ Now lets see that it actually checks the shasum value
 
 Now, will it take no for an answer?
 
-  $ unset _dotenv_stack_entered
+  $ unset _autoenv_stack_entered
   $ rm $AUTOENV_ENV_FILENAME
-  $ _dotenv_read_answer() { echo 'n' }
+  $ _autoenv_read_answer() { echo 'n' }
   $ cd .
   Attempting to load unauthorized env file: /tmp/cramtests-??????/autoenv.t/.env (glob)
   
index d6b39028a8a738aae20c81de23fd12770675adbe..e8dc6a41913640ba55d2ce8092fe322dc8815259 100644 (file)
@@ -1,14 +1,14 @@
-Test $PWD, $_dotenv_from_dir and _dotenv_to_dir.
+Test $PWD, $_autoenv_from_dir and _autoenv_to_dir.
 
   $ source $TESTDIR/setup.sh
 
 Setup env actions / output.
 
-  $ DOTENV_LOOK_UPWARDS=1
+  $ AUTOENV_LOOK_UPWARDS=1
   $ mkdir -p sub/sub2
   $ cd sub
-  $ echo 'echo ENTERED: PWD:${PWD:t} from:${_dotenv_from_dir:t} to:${_dotenv_to_dir:t}' > .env
-  $ echo 'echo LEFT: PWD:${PWD:t} from:${_dotenv_from_dir:t} to:${_dotenv_to_dir:t}' > .env.leave
+  $ echo 'echo ENTERED: PWD:${PWD:t} from:${_autoenv_from_dir:t} to:${_autoenv_to_dir:t}' > .env
+  $ echo 'echo LEFT: PWD:${PWD:t} from:${_autoenv_from_dir:t} to:${_autoenv_to_dir:t}' > .env.leave
 
 Manually create auth files.
 
index 9a56f9084fe0dbdce0e52b4ce92018ed49d2cd7c..d5531b142d9c7ae1eae5f04bc95e84b63384fbfc 100644 (file)
@@ -9,7 +9,7 @@ Lets set a simple .env action
 
 Change to the directory.
 
-  $ _dotenv_read_answer() { echo 'y' }
+  $ _autoenv_read_answer() { echo 'y' }
   $ cd .
   Attempting to load unauthorized env file: /tmp/cramtests-??????/leave.t/sub/.env (glob)
   
@@ -25,7 +25,7 @@ Change to the directory.
 
 Leave the directory and answer "no".
 
-  $ _dotenv_read_answer() { echo 'n' }
+  $ _autoenv_read_answer() { echo 'n' }
   $ cd ..
   Attempting to load unauthorized env file: /tmp/cramtests-??????/leave.t/sub/.env.leave (glob)
   
@@ -40,7 +40,7 @@ Leave the directory and answer "no".
 
   $ cd sub
   ENTERED
-  $ _dotenv_read_answer() { echo 'y' }
+  $ _autoenv_read_answer() { echo 'y' }
   $ cd ..
   Attempting to load unauthorized env file: /tmp/cramtests-??????/leave.t/sub/.env.leave (glob)
   
@@ -56,7 +56,7 @@ Leave the directory and answer "no".
 
 Now check with subdirs, looking upwards.
 
-  $ DOTENV_LOOK_UPWARDS=1
+  $ AUTOENV_LOOK_UPWARDS=1
   $ mkdir sub/child
   $ cd sub/child
   ENTERED
@@ -68,7 +68,7 @@ Now check with subdirs, looking upwards.
 
 Now check with subdirs, not looking at parent dirs.
 
-  $ DOTENV_LOOK_UPWARDS=0
+  $ AUTOENV_LOOK_UPWARDS=0
   $ cd sub/child
   $ cd ..
   ENTERED
@@ -77,10 +77,10 @@ Now check with subdirs, not looking at parent dirs.
   LEFT
 
 
-Test that .env is sourced only once with DOTENV_HANDLE_LEAVE=0.
+Test that .env is sourced only once with AUTOENV_HANDLE_LEAVE=0.
 
-  $ unset _dotenv_stack_entered
-  $ DOTENV_HANDLE_LEAVE=0
+  $ unset _autoenv_stack_entered
+  $ AUTOENV_HANDLE_LEAVE=0
   $ cd sub
   ENTERED
   $ cd ..
index a7da1b46b5d811485f8b404de959c2d4a58c59c8..9134af05133888eee3aa030d92c1c5a061634f1e 100644 (file)
@@ -7,12 +7,12 @@
 _AUTOENV_TEST_READ_ARGS='-t 1'
 
 test_autoenv_add_to_env() {
-  _dotenv_hash_pair $1 $2 >> $AUTOENV_ENV_FILENAME
+  _autoenv_hash_pair $1 $2 >> $AUTOENV_ENV_FILENAME
 }
 
 # Add enter and leave env files to authentication file.
 test_autoenv_auth_env_files() {
   echo -n > $AUTOENV_ENV_FILENAME
-  test_autoenv_add_to_env $PWD/$DOTENV_FILE_ENTER
-  test_autoenv_add_to_env $PWD/$DOTENV_FILE_LEAVE
+  test_autoenv_add_to_env $PWD/$AUTOENV_FILE_ENTER
+  test_autoenv_add_to_env $PWD/$AUTOENV_FILE_LEAVE
 }
index 9bce05ce9b8e0c24cf54d4a19452761dc22db529..621e93fc9ed9c6dad54c3f42c68a37174065a77a 100644 (file)
@@ -6,8 +6,8 @@ Setup test environment.
 
   $ mkdir sub
   $ cd sub
-  $ echo "autostash FOO=baz" > $DOTENV_FILE_ENTER
-  $ echo "autounstash" > $DOTENV_FILE_LEAVE
+  $ echo "autostash FOO=baz" > $AUTOENV_FILE_ENTER
+  $ echo "autounstash" > $AUTOENV_FILE_LEAVE
 
 Manually create auth file