diff --git a/API.md b/API.md index 5d6ef61..7d468e0 100644 --- a/API.md +++ b/API.md @@ -4,60 +4,94 @@ API / Function Documentation This documentation is generated automatically from the source of [mo] thanks to [tomdoc.sh]. -mo() ----- +`mo()` +------ Public: Template parser function. Writes templates to stdout. -* $0 - Name of the mo file, used for getting the help message. -* --fail-not-set - Fail upon expansion of an unset variable. Default behavior is to silently ignore and expand into empty string. -* --false - Treat "false" as an empty value. You may set the MO_FALSE_IS_EMPTY environment variable instead to a non-empty value to enable this behavior. -* --help - Display a help message. -* --source=FILE - Source a file into the environment before processint template files. -* -- - Used to indicate the end of options. You may optionally use this when filenames may start with two hyphens. -* $@ - Filenames to parse. +* $0 - Name of the mo file, used for getting the help message. +* --allow-function-arguments - Permit functions in templates to be called with additional arguments. This puts template data directly in to the path of an eval statement. Use with caution. Not listed in the help because it only makes sense when mo is sourced. +* --fail-not-set - (`-u`) Fail upon expansion of an unset variable. Default behavior is to silently ignore and expand into empty string. +* --false - (`-e`) Treat "false" as an empty value. You may set the MO_FALSE_IS_EMPTY environment variable instead to a non-empty value to enable this behavior. +* --help - (`-h)` Display a help message. +* --source=FILE - (`-s=FILE`) Source a file into the environment before processing template files. +* --path=PATH - (`-p=PATH`) Colon-separated list of paths to search for templates. They are relative to where `mo` was executed. +* -- - Used to indicate the end of options. You may use this when filenames start with hyphens. +* $@ - Filenames to parse. Mo uses the following environment variables: -* MO_FAIL_ON_UNSET - When set to a non-empty value, expansion of an unset env variable will be aborted with an error. -* MO_FALSE_IS_EMPTY - When set to a non-empty value, the string "false" will be treated as an empty value for the purposes of conditionals. +* MO_ALLOW_FUNCTION_ARGUMENTS - When set to a non-empty value, this allows functions referenced in templates to receive additional options and arguments. This puts the content from the template directly into an eval statement. Use with extreme care. + +* MO_FAIL_ON_UNSET - When set to a non-empty value, expansion of an unset env variable will be aborted with an error. + +* MO_FALSE_IS_EMPTY - When set to a non-empty value, the string "false" will be treated as an empty value for the purposes of conditionals. + * MO_ORIGINAL_COMMAND - Used to find the `mo` program in order to generate a help message. -Returns nothing. +* MO_SEARCH_PATH - Colon-separated list of folders to search for templates. They are relative to where `mo` was executed. + +Returns true (0) when there are no errors. Sometimes returns (1) when there are errors and sometimes those errors are consumed. It greatly depends on the error and your options. -files ------ +`files` +------- After we encounter two hyphens together, all the rest of the arguments are files. -MO_FAIL_ON_UNSET ----------------- +`MO_ALLOW_FUNCTION_ARGUMENTS` +----------------------------- shellcheck disable=SC2030 -MO_FALSE_IS_EMPTY ------------------ +`MO_FAIL_ON_UNSET` +------------------ shellcheck disable=SC2030 -doubleHyphens -------------- +`MO_FALSE_IS_EMPTY` +------------------- + +shellcheck disable=SC2030 + + +`doubleHyphens` +--------------- Set a flag indicating we've encountered double hyphens -files ------ +`files` +------- Every arg that is not a flag or a option should be a file -moFindEndTag() --------------- +`moProcessSearchPath()` +----------------------- + +Internal: Change relative paths into absolute paths + + +`moCallFunction()` +------------------ + +Internal: Call a function. + +* $1 - Function to call +* $2 - Content to pass +* $3 - Additional arguments as a single string + +This can be dangerous, especially if you are using tags like {{someFunction ; rm -rf / }} + +Returns nothing. + + +`moFindEndTag()` +---------------- Internal: Scan content until the right end tag is found. Creates an array with the following members: @@ -75,8 +109,8 @@ Everything using this function uses the "standalone tags" logic. Returns nothing. -moFindString() --------------- +`moFindString()` +---------------- Internal: Find the first index of a substring. If not found, sets the index to -1. @@ -87,8 +121,8 @@ Internal: Find the first index of a substring. If not found, sets the index to Returns nothing. -moFullTagName() ---------------- +`moFullTagName()` +----------------- Internal: Generate a dotted name based on current context and target name. @@ -99,8 +133,8 @@ Internal: Generate a dotted name based on current context and target name. Returns nothing. -moGetContent() --------------- +`moGetContent()` +---------------- Internal: Fetches the content to parse into a variable. Can be a list of partials for files or the content from stdin. @@ -110,8 +144,8 @@ Internal: Fetches the content to parse into a variable. Can be a list of partia Returns nothing. -moIndentLines() ---------------- +`moIndentLines()` +----------------- Internal: Indent a string, placing the indent at the beginning of every line that has any content. @@ -122,8 +156,8 @@ Internal: Indent a string, placing the indent at the beginning of every line tha Returns nothing. -moIndirect() ------------- +`moIndirect()` +-------------- Internal: Send a variable up to the parent of the caller of this function. @@ -141,8 +175,8 @@ Examples Returns nothing. -moIndirectArray() ------------------ +`moIndirectArray()` +------------------- Internal: Send an array as a variable up to caller of a function @@ -161,8 +195,8 @@ Examples Returns nothing. -moIsArray() ------------ +`moIsArray()` +------------- Internal: Determine if a given environment variable exists and if it is an array. @@ -173,16 +207,16 @@ Be extremely careful. Even if strict mode is enabled, it is not honored in newe Examples var=(abc) - if moIsArray var; the + if moIsArray var; then echo "This is an array" - echo "Make sure you don't accidentally use $var" + echo "Make sure you don't accidentally use \$var" fi Returns 0 if the name is not empty, 1 otherwise. -moIsFunction() --------------- +`moIsFunction()` +---------------- Internal: Determine if the given name is a defined function. @@ -202,8 +236,8 @@ Examples Returns 0 if the name is a function, 1 otherwise. -moIsStandalone() ----------------- +`moIsStandalone()` +------------------ Internal: Determine if the tag is a standalone tag based on whitespace before and after the tag. @@ -223,8 +257,8 @@ Examples Returns nothing. -moJoin() --------- +`moJoin()` +---------- Internal: Join / implode an array @@ -235,8 +269,8 @@ Internal: Join / implode an array Returns nothing. -moLoadFile() ------------- +`moLoadFile()` +-------------- Internal: Read a file into a variable. @@ -246,8 +280,8 @@ Internal: Read a file into a variable. Returns nothing. -moLoop() --------- +`moLoop()` +---------- Internal: Process a chunk of content some number of times. Writes output to stdout. @@ -258,8 +292,8 @@ Internal: Process a chunk of content some number of times. Writes output to std Returns nothing. -moParse() ---------- +`moParse()` +----------- Internal: Parse a block of text, writing the result to stdout. @@ -270,8 +304,14 @@ Internal: Parse a block of text, writing the result to stdout. Returns nothing. -moPartial() ------------ +`moArgs` +-------- + +Split arguments from the tag name. Arguments are passed to functions. + + +`moPartial()` +------------- Internal: Process a partial. @@ -291,8 +331,14 @@ Prefix all variables. Returns nothing. -moShow() --------- +`IFS` +----- + +Search the path for the file + + +`moShow()` +---------- Internal: Show an environment variable or the output of a function to stdout. @@ -300,12 +346,13 @@ Limit/prefix any variables used. * $1 - Name of environment variable or function * $2 - Current context +* $3 - Arguments string if $1 is a function Returns nothing. -moSplit() ---------- +`moSplit()` +----------- Internal: Split a larger string into an array. @@ -317,8 +364,8 @@ Internal: Split a larger string into an array. Returns nothing. -moStandaloneAllowed() ---------------------- +`moStandaloneAllowed()` +----------------------- Internal: Handle the content for a standalone tag. This means removing whitespace (not newlines) before a tag and whitespace and a newline after a tag. That is, assuming, that the line is otherwise empty. @@ -331,8 +378,8 @@ Internal: Handle the content for a standalone tag. This means removing whitespa Returns nothing. -moStandaloneDenied() --------------------- +`moStandaloneDenied()` +---------------------- Internal: Handle the content for a tag that is never "standalone". No adjustments are made for newlines and whitespace. @@ -344,8 +391,8 @@ Internal: Handle the content for a tag that is never "standalone". No adjustmen Returns nothing. -moTest() --------- +`moTest()` +---------- Internal: Determines if the named thing is a function or if it is a non-empty environment variable. When MO_FALSE_IS_EMPTY is set to a non-empty value, then "false" is also treated is an empty value. @@ -358,8 +405,8 @@ Do not use variables without prefixes here if possible as this needs to check if Returns 0 if the name is not empty, 1 otherwise. When MO_FALSE_IS_EMPTY is set, this returns 1 if the name is "false". -moTestVarSet() --------------- +`moTestVarSet()` +---------------- Internal: Determine if a variable is assigned, even if it is assigned an empty value. @@ -368,8 +415,8 @@ Internal: Determine if a variable is assigned, even if it is assigned an empty v Returns true (0) if the variable is set, 1 if the variable is unset. -moTrimChars() -------------- +`moTrimChars()` +--------------- Internal: Trim the leading whitespace only. @@ -382,8 +429,8 @@ Internal: Trim the leading whitespace only. Returns nothing. -moTrimWhitespace() ------------------- +`moTrimWhitespace()` +-------------------- Internal: Trim leading and trailing whitespace from a string. @@ -393,8 +440,8 @@ Internal: Trim leading and trailing whitespace from a string. Returns nothing. -moUsage() ---------- +`moUsage()` +----------- Internal: Displays the usage for mo. Pulls this from the file that contained the `mo` function. Can only work when the right filename comes is the one argument, and that only happens when `mo` is called with `$0` set to this file. @@ -403,8 +450,8 @@ Internal: Displays the usage for mo. Pulls this from the file that contained th Returns nothing. -MO_ORIGINAL_COMMAND -------------------- +`MO_ORIGINAL_COMMAND` +--------------------- Save the original command's path for usage later diff --git a/README.md b/README.md index 0e4b72d..9ddad97 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Requirements * The "coreutils" package (`basename` and `cat`) * ... that's it. Why? Because bash **can**! -If you intend to develop this and run the official specs, you also need node.js. +If you intend to develop this and run the official specs, you also need Node.js. Installation diff --git a/demo/relative-templates/child1 b/demo/relative-templates/child1 new file mode 100644 index 0000000..00558ba --- /dev/null +++ b/demo/relative-templates/child1 @@ -0,0 +1,3 @@ +* Child1 +{{> deeper/child2 }} +{{> ../relative-templates/deeper/child2 }} diff --git a/demo/relative-templates/child3 b/demo/relative-templates/child3 new file mode 100644 index 0000000..13b8487 --- /dev/null +++ b/demo/relative-templates/child3 @@ -0,0 +1 @@ + * Child3 diff --git a/demo/relative-templates/deeper/child2 b/demo/relative-templates/deeper/child2 new file mode 100644 index 0000000..7c1f610 --- /dev/null +++ b/demo/relative-templates/deeper/child2 @@ -0,0 +1,2 @@ + * Child2 +{{> ../child3 }} diff --git a/demo/relative-templates/file b/demo/relative-templates/file new file mode 100644 index 0000000..daad39f --- /dev/null +++ b/demo/relative-templates/file @@ -0,0 +1,7 @@ +This is "file" + +Child1 in different ways +{{> child1 }} +{{> ./child1 }} +{{> ../relative-templates/child1 }} +{{> deeper/../child1 }} diff --git a/mo b/mo index 5fb7ca2..67a816c 100755 --- a/mo +++ b/mo @@ -23,6 +23,8 @@ #/ - This message. #/ -s=FILE, --source=FILE #/ - Load FILE into the environment before processing templates. +#/ -p=PATH, --path=PATH +#/ - Set a colon-delimited list of folders to search for templates. # # Mo is under a MIT style licence with an additional non-advertising clause. # See LICENSE.md for the full text. @@ -34,47 +36,51 @@ # Public: Template parser function. Writes templates to stdout. # -# $0 - Name of the mo file, used for getting the help message. -# --allow-function-arguments -# - Permit functions in templates to be called with additional -# arguments. This puts template data directly in to the path -# of an eval statement. Use with caution. Not listed in the -# help because it only makes sense when mo is sourced. -# -u, --fail-not-set -# - Fail upon expansion of an unset variable. Default behavior -# is to silently ignore and expand into empty string. -# -e, --false - Treat "false" as an empty value. You may set the -# MO_FALSE_IS_EMPTY environment variable instead to a non-empty -# value to enable this behavior. -# -h, --help - Display a help message. -# -s=FILE, --source=FILE -# - Source a file into the environment before processint -# template files. -# -- - Used to indicate the end of options. You may optionally -# use this when filenames may start with two hyphens. -# $@ - Filenames to parse. +# $0 - Name of the mo file, used for getting the help message. +# --allow-function-arguments - Permit functions in templates to be called with +# additional arguments. This puts template data directly in to the path +# of an eval statement. Use with caution. Not listed in the help +# because it only makes sense when mo is sourced. +# --fail-not-set - (`-u`) Fail upon expansion of an unset variable. Default +# behavior is to silently ignore and expand into empty string. +# --false - (`-e`) Treat "false" as an empty value. You may set the +# MO_FALSE_IS_EMPTY environment variable instead to a non-empty value +# to enable this behavior. +# --help - (`-h)` Display a help message. +# --source=FILE - (`-s=FILE`) Source a file into the environment before processing +# template files. +# --path=PATH - (`-p=PATH`) Colon-separated list of paths to search for templates. +# They are relative to where `mo` was executed. +# -- - Used to indicate the end of options. You may use this when filenames +# start with hyphens. +# $@ - Filenames to parse. # # Mo uses the following environment variables: # -# MO_ALLOW_FUNCTION_ARGUMENTS -# - When set to a non-empty value, this allows functions -# referenced in templates to receive additional -# options and arguments. This puts the content from the -# template directly into an eval statement. Use with -# extreme care. -# MO_FAIL_ON_UNSET - When set to a non-empty value, expansion of an unset -# env variable will be aborted with an error. -# MO_FALSE_IS_EMPTY - When set to a non-empty value, the string "false" -# will be treated as an empty value for the purposes -# of conditionals. -# MO_ORIGINAL_COMMAND - Used to find the `mo` program in order to generate -# a help message. +# MO_ALLOW_FUNCTION_ARGUMENTS - When set to a non-empty value, this allows +# functions referenced in templates to receive additional options and +# arguments. This puts the content from the template directly into an +# eval statement. Use with extreme care. # -# Returns nothing. +# MO_FAIL_ON_UNSET - When set to a non-empty value, expansion of an unset env +# variable will be aborted with an error. +# +# MO_FALSE_IS_EMPTY - When set to a non-empty value, the string "false" will be +# treated as an empty value for the purposes of conditionals. +# +# MO_ORIGINAL_COMMAND - Used to find the `mo` program in order to generate a +# help message. +# +# MO_SEARCH_PATH - Colon-separated list of folders to search for templates. +# They are relative to where `mo` was executed. +# +# Returns true (0) when there are no errors. Sometimes returns (1) when there +# are errors and sometimes those errors are consumed. It greatly depends on the +# error and your options. mo() ( # This function executes in a subshell so IFS is reset. # Namespace this variable so we don't conflict with desired values. - local moContent f2source files doubleHyphens + local moContent f2source files doubleHyphens paths IFS=$' \n\t' files=() @@ -109,11 +115,7 @@ mo() ( ;; -s=* | --source=*) - if [[ "$arg" == --source=* ]]; then - f2source="${arg#--source=}" - else - f2source="${arg#-s=}" - fi + f2source="${arg#*=}" if [[ -f "$f2source" ]]; then # shellcheck disable=SC1090 @@ -124,6 +126,10 @@ mo() ( fi ;; + -p=* | --path=*) + MO_SEARCH_PATH="$(moProcessSearchPath "${arg#*=}")" + ;; + --) # Set a flag indicating we've encountered double hyphens doubleHyphens=true @@ -143,6 +149,21 @@ mo() ( ) +# Internal: Change relative paths into absolute paths +moProcessSearchPath() { + local in out path startingPwd IFS + + IFS=: + startingPwd=$PWD + + for path in $1; do + cd "$startingPwd" && cd "$path" 2>/dev/null && out="$out:$PWD" + done + + echo "${out:1}" +} + + # Internal: Call a function. # # $1 - Function to call @@ -803,7 +824,40 @@ moPartial() { ( # It would be nice to remove `dirname` and use a function instead, # but that's difficult when you're only given filenames. - cd "$(dirname -- "$moFilename")" || exit 1 + if ! cd "$(dirname -- "$moFilename")"; then + if [[ -n "${MO_FAIL_ON_UNSET-}" ]]; then + echo "Error changing to directory: $(dirname -- "$moFilename")" >&2 + exit 1 + fi + + # Mustache likes to be silent when there are errors. + exit 0 + fi + + if [[ "$moFilename" != */* ]] && [[ ! -f "$moFilename" ]] && [[ -n "$MO_SEARCH_PATH" ]]; then + echo "searching" + # Search the path for the file + IFS=: + + for moSearchPath in $MO_SEARCH_PATH; do + if [[ ! -f "$moFilename" ]]; then + cd "$moSearchPath" + fi + done + + IFS=$' \n\t' + fi + + if [[ ! -f "${moFilename##*/}" ]]; then + if [[ -n "${MO_FAIL_ON_UNSET-}" ]]; then + echo "File does not exist: $PWD/${moFilename##*/}" >&2 + exit 1 + fi + + # Mustache likes to be silent when there are errors. + exit 0 + fi + moUnindented="$( moLoadFile moPartial "${moFilename##*/}" || exit 1 moParse "${moPartial}" "$6" true diff --git a/tests/double-hyphen.expected b/tests/double-hyphen.expected index 84672c3..ec1b86b 100644 --- a/tests/double-hyphen.expected +++ b/tests/double-hyphen.expected @@ -1 +1 @@ -cat: --help: No such file or directory +File does not exist: /home/fidian/repo/mo/tests/--help diff --git a/tests/double-hyphen.sh b/tests/double-hyphen.sh index a6bd0dc..c69fb66 100755 --- a/tests/double-hyphen.sh +++ b/tests/double-hyphen.sh @@ -2,4 +2,4 @@ # This should display a message indicating that the file --help # could not be found. It should not display a help messsage. cd "${0%/*}" -../mo -- --help 2>&1 +../mo -u -- --help 2>&1 diff --git a/tests/help.expected b/tests/help.expected index 51a740a..cf16d2a 100644 --- a/tests/help.expected +++ b/tests/help.expected @@ -9,9 +9,19 @@ Learn more about mustache templates at https://mustache.github.io/ Simple usage: - mo [--false] [--help] [--source=FILE] filenames... + mo [OPTIONS] filenames... ---fail-not-set - Fail upon expansion of an unset variable. ---false - Treat the string "false" as empty for conditionals. ---help - This message. ---source=FILE - Load FILE into the environment before processing templates. +Options: + + -u, --fail-not-set + - Fail upon expansion of an unset variable. + -e, --false + - Treat the string "false" as empty for conditionals. + -h, --help + - This message. + -s=FILE, --source=FILE + - Load FILE into the environment before processing templates. + -p=PATH, --path=PATH + - Set a colon-delimited list of folders to search for templates. + +MO_VERSION=2.0.4 diff --git a/tests/help.sh b/tests/help.sh index 6e0a88c..8f546be 100755 --- a/tests/help.sh +++ b/tests/help.sh @@ -1,4 +1,4 @@ #!/usr/bin/env bash cd "${0%/*}" -../mo --help +../mo -u --help diff --git a/tests/invalid-option.expected b/tests/invalid-option.expected index 641b7ae..e69de29 100644 --- a/tests/invalid-option.expected +++ b/tests/invalid-option.expected @@ -1 +0,0 @@ -cat: --something: No such file or directory diff --git a/tests/partial-missing.expected b/tests/partial-missing.expected index 83597d5..e3a3876 100644 --- a/tests/partial-missing.expected +++ b/tests/partial-missing.expected @@ -1 +1 @@ -cat: partial-missing.partial: No such file or directory +File does not exist: /home/fidian/repo/mo/tests/partial-missing.partial diff --git a/tests/partial-missing.sh b/tests/partial-missing.sh index d06b174..51fecda 100755 --- a/tests/partial-missing.sh +++ b/tests/partial-missing.sh @@ -1,8 +1,9 @@ #!/usr/bin/env bash cd "${0%/*}" -../mo partial-missing.template 2>&1 +../mo -u partial-missing.template 2>&1 +returned=$? -if [[ $? -ne 1 ]]; then - echo "Did not return 1" +if [[ $returned -ne 1 ]]; then + echo "Did not return 1. Instead, returned $returned." fi diff --git a/tests/source.sh b/tests/source.sh index 1b0b1e9..b10e6e9 100755 --- a/tests/source.sh +++ b/tests/source.sh @@ -1,7 +1,8 @@ #!/usr/bin/env bash cd "${0%/*}" -cat <