replacing _DIR with _HOME

Author: ataxexe

README.md

@@ -11,7 +11,7 @@ may be called.
 ## How To Install
 
 Just clone the git repo and place the *soda* file in your path (a symlinks works well to).
-After that, ensure you have a **$SODA_DIR** pointing to the place you clone the repo and you're
+After that, ensure you have a **$SODA_HOME** pointing to the place you clone the repo and you're
 done.
 
 ## How To Use
@@ -20,10 +20,10 @@ Create a *~/.soda* directory with the following structure:
 
 * _scripts_ - directory to put the scripts organized by namespaces
 * _config_ - directory to put the configuration files organized by namespaces
-* _resources_ - directory to put resources organized by namespaces
+* Any other directory you like, still organized by namespaces
 
-You can also use the same directory you install soda without configure the user directory. To access
-resource and configuration files, use the **exists** function.
+You can also use the same directory you install soda without configure the user directory. You can
+access any file in that directories by using the **exists** function.
 
 Inside *scripts*, any function in any script present in *scripts/common* and exposed through
 **task** can be invoked:
@@ -158,13 +158,13 @@ completion mode.
 
 ## Configuration
 
-Every namespace has it own configuration dir in $SODA_USER_DIR/config/NAMESPACE. Any configuration
+Every namespace has it own configuration dir in $SODA_USER_HOME/config/NAMESPACE. Any configuration
 file will be loaded in that directory at namespace import **before** loading script files.
 
-You can configure **soda** namespace through a **$SODA_USER_DIR/conf/soda/soda.conf** file (or any
+You can configure **soda** namespace through a **$SODA_USER_HOME/conf/soda/soda.conf** file (or any
 other name but inside that directory). The supported properties are:
 
-* **LOG_FILE** - The log file  (defaults to *$SODA_DIR/log/soda.log*)
+* **LOG_FILE** - The log file  (defaults to *$SODA_HOME/log/soda.log*)
 * **SODA_NAMESPACE_DELIMITER** - The namespace delimiter (defaults to **.**). Changing this also
 affects the bash completion
 * **SODA_TASK_BASH_COMPLETION_SUFFIX** - The suffix to build the function for custom bash completion
@@ -229,7 +229,7 @@ underscores.
 
 ### exists (type path)
 
-Checks if the file $SODA_USER_DIR/$type/$NAMESPACE/$path exists using the namespace of the invoked
+Checks if the file $SODA_USER_HOME/$type/$NAMESPACE/$path exists using the namespace of the invoked
 task or imported namespace. The file path will be stored in the $FILE variable.
 
     exists config "my-config.conf" && {

scripts/core.sh

@@ -139,11 +139,11 @@ clear_imports() {
 
 #
 # Loads all scripts in the *scripts/namespace* directory. The scripts may be in
-# $SODA_USER_DIR or $SODA_DIR.
+# $SODA_USER_HOME or $SODA_HOME.
 #
 # If a namespace was already imported, then it will not be imported again.
 #
-# Example: to import the namespace denoted by $SODA_USER_DIR/scripts/install
+# Example: to import the namespace denoted by $SODA_USER_HOME/scripts/install
 # use `import install`.
 #
 import() {
@@ -158,14 +158,14 @@ import() {
     NAMESPACES="$NAMESPACES $1"
     local OLD_NAMESPACE="$NAMESPACE"
     NAMESPACE="$1"
-    load_config "$SODA_DIR/config/$1"
-    if ! [[ "$SODA_DIR" == "$SODA_USER_DIR" ]]; then
-      load_config "$SODA_USER_DIR/config/$1"
+    load_config "$SODA_HOME/config/$1"
+    if ! [[ "$SODA_HOME" == "$SODA_USER_HOME" ]]; then
+      load_config "$SODA_USER_HOME/config/$1"
     fi
 
-    load_scripts "$SODA_DIR/scripts/$1"
-    if ! [[ "$SODA_DIR" == "$SODA_USER_DIR" ]]; then
-      load_scripts "$SODA_USER_DIR/scripts/$1"
+    load_scripts "$SODA_HOME/scripts/$1"
+    if ! [[ "$SODA_HOME" == "$SODA_USER_HOME" ]]; then
+      load_scripts "$SODA_USER_HOME/scripts/$1"
     fi
     NAMESPACE="$OLD_NAMESPACE"
   fi
@@ -182,9 +182,9 @@ _import_all() {
 }
 
 import_all_namespaces() {
-  _import_all $SODA_DIR
-  if ! [[ "$SODA_DIR" == "$SODA_USER_DIR" ]]; then
-    _import_all $SODA_USER_DIR
+  _import_all $SODA_HOME
+  if ! [[ "$SODA_HOME" == "$SODA_USER_HOME" ]]; then
+    _import_all $SODA_USER_HOME
   fi
 }
 
@@ -292,7 +292,7 @@ namespaces() {
 }
 
 exists() {
-  FILE="$SODA_USER_DIR/$1/$NAMESPACE/$2"
+  FILE="$SODA_USER_HOME/$1/$NAMESPACE/$2"
   if [[ -f "$FILE" ]]; then
     return 0
   else

soda

@@ -22,14 +22,14 @@
 # TORT  OR  OTHERWISE,  ARISING  FROM,  OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE   OR   THE   USE   OR   OTHER   DEALINGS  IN  THE  SOFTWARE.
 
-[[ -z "$SODA_DIR" ]] && SODA_DIR=$(dirname $0)
-[[ -z "$SODA_USER_DIR" ]] && SODA_USER_DIR=$HOME/.soda
+[[ -z "$SODA_HOME" ]] && SODA_HOME=$(dirname $0)
+[[ -z "$SODA_USER_HOME" ]] && SODA_USER_HOME=$HOME/.soda
 
-if ! [[ -d "$SODA_USER_DIR" ]]; then
-  SODA_USER_DIR="$SODA_DIR"
+if ! [[ -d "$SODA_USER_HOME" ]]; then
+  SODA_USER_HOME="$SODA_HOME"
 fi
 
-. "$SODA_DIR/scripts/core.sh"
+. "$SODA_HOME/scripts/core.sh"
 
 function usage {
   local task="TASK"