From b16d73b5a745e43ca72959af3d4aaba79fe4bf43 Mon Sep 17 00:00:00 2001
From: Tyler Akins <fidian@rumkin.com>
Date: Thu, 27 Aug 2015 09:44:04 -0500
Subject: [PATCH] Updates for how to source "mo" and then use it

When you source mo, it adds the "mo" function to the environment.
---
 README.md                          | 5 +++--
 demo/associative-arrays            | 3 ++-
 demo/embedded-template             | 3 ++-
 demo/function-for-advanced-looping | 4 ++--
 demo/important-file                | 3 ++-
 demo/using-arrays                  | 3 ++-
 demo/using-strings                 | 3 +++
 run-tests                          | 3 ++-
 8 files changed, 18 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index cd358a2..4613772 100644
--- a/README.md
+++ b/README.md
@@ -47,14 +47,15 @@ Using arrays adds a slight level of complexity.  *You must source `mo`.*  Look a
     #!/bin/bash
     cd "$(dirname "$0")" # Go to the script's directory
     export ARRAY=( one two "three three three" four five )
-    cat << EOF | . ../mo
+    . ../mo # This loads the "mo" function
+    cat << EOF | mo
     Here are the items in the array:
     {{#ARRAY}}
         * {{.}}
     {{/ARRAY}}
     EOF
 
-The result?  You get a list of the five elements in the array.  Take a look at the line that executes `mo`.  You'll see that we went from `../mo` to using `. ../mo`.  That is very important when you want arrays to work, since you can not execute a command and have arrays passed to that command's environment.  Instead, we source the file.  `. ../mo` is identical to `source ../mo` and you can find more about that in bash's man page.
+The result?  You get a list of the five elements in the array.  It is vital that you source `mo` and run the function when you want arrays to work because you can not execute a command and have arrays passed to that command's environment.  Instead, we first source the file to load the function and then run the function directly.
 
 There are more scripts available in the [demos directory](demo/) that could help illustrate how you would use this program.
 
diff --git a/demo/associative-arrays b/demo/associative-arrays
index 924485d..81e7f0b 100755
--- a/demo/associative-arrays
+++ b/demo/associative-arrays
@@ -4,8 +4,9 @@ cd "$(dirname "$0")" # Go to the script's directory
 
 declare -A DATA
 DATA=([one]=111 [two]=222)
+. ../mo
 
-cat <<EOF | . ../mo
+cat <<EOF | mo
 Accessing data directly:
     DATA: {{DATA}}
     One: {{DATA.one}}
diff --git a/demo/embedded-template b/demo/embedded-template
index 7a0aeb8..5896652 100755
--- a/demo/embedded-template
+++ b/demo/embedded-template
@@ -11,7 +11,8 @@ export OPTIONS=(
     "Call a service representative at 1-800-000-0000 to discuss payment options"
     "Return the vehicle immediately and pay a fine of 1 million dollars"
 )
-sed '0,/^# END/ d' "$(basename "$0")" | . ../mo
+. ../mo
+sed '0,/^# END/ d' "$(basename "$0")" | mo
 exit
 
 # END
diff --git a/demo/function-for-advanced-looping b/demo/function-for-advanced-looping
index 49e9a1d..c097f15 100755
--- a/demo/function-for-advanced-looping
+++ b/demo/function-for-advanced-looping
@@ -28,8 +28,8 @@ declare -A resque hub rip
 resque=([name]=Resque [url]=http://example.com/resque)
 hub=([name]=Hub [url]=http://example.com/hub)
 rip=([name]=Rip [url]=http://example.com/rip)
-
-cat <<EOF | . ../mo
+. ../mo
+cat <<EOF | mo
 {{#EVERY_REPO}}
 The repo is __REPO__
     Name:  {{__REPO__.name}}
diff --git a/demo/important-file b/demo/important-file
index e043da1..662697c 100755
--- a/demo/important-file
+++ b/demo/important-file
@@ -8,7 +8,8 @@ wrapper() { echo -n "*** $1 ***"; }
 export IP=127.0.0.1
 export ALLOWED_HOSTS=( 192.168.0.1 192.168.0.2 192.168.0.3 )
 
-cat <<EOF | . mo
+. mo  # Keep in mind this script is executing in the parent directory
+cat <<EOF | mo
 # {{#wrapper}}OH SO IMPORTANT{{/wrapper}}
 # This file automatically generated at {{date-string}}
 home_ip={{IP}}
diff --git a/demo/using-arrays b/demo/using-arrays
index 2e829e2..ff27f28 100755
--- a/demo/using-arrays
+++ b/demo/using-arrays
@@ -1,7 +1,8 @@
 #!/bin/bash
 cd "$(dirname "$0")" # Go to the script's directory
 export ARRAY=( one two "three three three" four five )
-cat << EOF | . ../mo
+. ../mo
+cat << EOF | mo
 Here are the items in the array:
 {{#ARRAY}}
     * {{.}}
diff --git a/demo/using-strings b/demo/using-strings
index 12db6d6..bec05d7 100755
--- a/demo/using-strings
+++ b/demo/using-strings
@@ -1,4 +1,7 @@
 #!/bin/bash
+#
+# This example does not source `mo` and is intentionally restricted to
+# variables that are not arrays.
 cd "$(dirname "$0")" # Go to the script's directory
 export TEST="This is a test"
 echo "Your message:  {{TEST}}" | ../mo
diff --git a/run-tests b/run-tests
index 137b555..c88ce1d 100755
--- a/run-tests
+++ b/run-tests
@@ -2,6 +2,7 @@
 
 cd "$(dirname $0)"
 
+. ./mo
 PASS=0
 FAIL=0
 
@@ -11,7 +12,7 @@ for TEST in tests/*.expected; do
     echo -n "$BASE ... "
     echo "Do not read this input" | (
         . "${BASE}.env"
-        . ./mo "${BASE}.template"
+        mo "${BASE}.template"
     ) | diff -wU5 - "${TEST}" > "${BASE}.diff"
 
     if [[ $? -ne 0 ]]; then