Cache: Read "zprofile" in the correct context in "zshrc" stage

[ax-zsh.git] / ax.zsh

diff --git a/ax.zsh b/ax.zsh
index 59e172d46197f64a770782a08777d1dbd3e02072..a841af58ccd0d10eb5aea4ccb8580e4ca141a128 100644 (file)
--- a/ax.zsh
+++ b/ax.zsh
@@ -1,5 +1,5 @@
 # AX-ZSH: Alex' Modular ZSH Configuration
-# Copyright (c) 2015-2016 Alexander Barton <alex@barton.de>
+# Copyright (c) 2015-2017 Alexander Barton <alex@barton.de>
 
 script_name="${${(%):-%N}:t}"
 script_type="$script_name[2,-1]"
@@ -7,11 +7,19 @@ script_type="$script_name[2,-1]"
 # Load plugin code of a given type.
 # - $1: plugin name
 # - $2: plugin type (optional; defaults to "zshrc")
+# - $3: cache file (optional)
 function axzsh_load_plugin {
-       dname="$1:A"
-       plugin="$dname:t"
-       [[ -z "$2" ]] && type="zshrc" || type="$2"
-       fname="$dname/$plugin.$type"
+       local dname="$1:A"
+       local plugin="$dname:t"
+       [[ -z "$2" ]] && local type="zshrc" || local type="$2"
+       local fname="$dname/$plugin.$type"
+       local cache_file="$3"
+
+       # Strip repository prefix (like "alexbarton#test-plugin"):
+       [[ "$plugin" =~ "#" ]] && plugin=$(echo $plugin | cut -d'#' -f2-)
+
+       # "short plugin name": strip ".zsh" suffix:
+       plugin_short=${plugin%.zsh}
 
        if [[ ! -d "$dname" ]]; then
                # Plugin not found!
@@ -29,28 +37,47 @@ function axzsh_load_plugin {
                if [[ -r "$dname/$plugin.zprofile" || -r "$dname/$plugin.zlogout" ]]; then
                        # Native AX-ZSH plugin, but for different stage. Skip it!
                        :
-               elif [[ -r "$dname/$plugin.plugin.zsh" ]]; then
+               elif [[ -r "$dname/${plugin_short}.plugin.zsh" ]]; then
                        # Oh My ZSH plugin
                        type="plugin.zsh"
-                       fname="$dname/$plugin.plugin.zsh"
+                       fname="$dname/${plugin_short}.plugin.zsh"
                elif [[ -r "$dname/init.zsh" ]]; then
                        # Prezto module
                        type="init.zsh"
                        fname="$dname/init.zsh"
                else
                        echo "AX-ZSH plugin type of \"$plugin\" unknown, skipped!" >&2
+                       return 0
                fi
        fi
 
        if [[ "$type" == "zprofile" && -d "$dname/functions" ]]; then
                # Add plugin function path when folder exists
+               [[ -n "$AXZSH_DEBUG" ]] \
+                       && echo "   - $plugin ($type): functions ..."
                axzsh_fpath+=("$dname/functions")
        fi
 
        if [[ -r "$fname" ]]; then
+               # Read plugin ...
                [[ -n "$AXZSH_DEBUG" ]] \
                        && echo "   - $plugin ($type) ..."
                source "$fname"
+
+               if [[ -n "$cache_file" ]]; then
+                       # Add plugin data to cache
+                       printf "# BEGIN: %s\ninit()\n{\n" "$fname" >>"$cache_file"
+                       case "$fname" in
+                               *"/repos/"*)
+                                       echo "[[ -n \"\$AXZSH_DEBUG\" ]] && echo '     - $plugin ($type): \"$fname\" ...'" >>$cache_file
+                                       echo "source '$fname'" >>$cache_file
+                                       ;;
+                               *)
+                                       echo "[[ -n \"\$AXZSH_DEBUG\" ]] && echo '     - $plugin ($type, cached) ...'" >>$cache_file
+                                       "$cat_cmd" "$fname" >>"$cache_file"
+                       esac
+                       printf "}\ninit\n# END: %s\n\n" "$fname" >>"$cache_file"
+               fi
        fi
 
        # It is a success, even if only the plugin directory (and no script!)
@@ -58,6 +85,16 @@ function axzsh_load_plugin {
        return 0
 }
 
+# Make sure that "my" (=ZSH) directory is in the search path ...
+if [[ -z "$AXZSH" ]]; then
+       _p="${0:h}"
+       [[ "$_p" != "." ]] && PATH="$PATH:${0:h}"
+       unset _p
+fi
+
+# Make sure that "SHELL" variable is set and exported
+[[ -n "$SHELL" ]] || export SHELL=$(command -v zsh)
+
 # Make sure that "AXZSH" variable is set and exported
 if [[ -z "$AXZSH" ]]; then
        export AXZSH="$HOME/.axzsh"
@@ -71,18 +108,50 @@ fi
 
 [[ -n "$AXZSH_DEBUG" ]] && echo "» $script_name:"
 
-# Setup list of plugins to load:
-typeset -U plugin_list
-plugin_list=(
-       "$AXZSH/core/"[0-5]*
-       "$AXZSH/active_plugins/"*(N)
-       "$AXZSH/core/"[6-9]*
-)
-
-# Read in all the plugins for the current "type":
-for plugin ($plugin_list); do
-       axzsh_load_plugin "$plugin" "$script_type"
-done
+# Initialize cache
+mkdir -p "$AXZSH/cache"
+cache_file="$AXZSH/cache/$script_type.cache"
+
+cat_cmd=${commands[cat]:-cat}
+
+if [[ -r "$cache_file" ]]; then
+       # Cache file exists, use it!
+       # But when in the "zshrc" stage, make sure that the "zprofile" stage
+       # has already been handled (this uses the "01_zprofile" plugin which
+       # is used in the "zshrc.cache" as well, but can't be used successfully
+       # there because it becomes sourced inside of a ZSH function; so we have
+       # to source it here in the global context manually ...):
+       [[ -z "$AXZSH_ZPROFILE_READ" && "$script_type" = "zshrc" ]] \
+               && source "$AXZSH/core/01_zprofile/01_zprofile.zshrc"
+       [[ -n "$AXZSH_DEBUG" ]] \
+               && echo "   - Reading cache file \"$cache_file\" ..."
+       source "$cache_file"
+else
+       # No cache file available.
+       # Setup list of plugins to load:
+       typeset -U plugin_list
+       plugin_list=(
+               "$AXZSH/core/"[0-5]*
+               "$AXZSH/active_plugins/"*(N)
+               "$AXZSH/core/"[6-9]*
+       )
+
+       # Create new cache file:
+       if [[ -n "$cache_file" ]]; then
+               [[ -n "$AXZSH_DEBUG" ]] \
+                       && echo "   (Writing new cache file to \"$cache_file\" ...)"
+               printf "# %s\n\n" "$(LC_ALL=C date)" >"$cache_file"
+       fi
+
+       # Read in all the plugins for the current "type":
+       for plugin ($plugin_list); do
+               axzsh_load_plugin "$plugin" "$script_type" "$cache_file"
+       done
+fi
+
+# Clean up ...
 unfunction axzsh_load_plugin
 unset script_name script_type plugin
 unset plugin_list
+unset cache_file
+unset cat_cmd