ExternalVendorCode/mo
1
0
Fork 0
mirror of https://github.com/tests-always-included/mo.git synced 2024-12-18 16:27:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Implementing a search path

Browse Source 
Closes #30
This commit is contained in:
Tyler Akins 2019-07-19 21:10:42 -05:00
parent 9f6d3bcdab
commit 7a8d1d260e
No known key found for this signature in database
GPG Key ID: 8F3B8C432F4393BD
16 changed files with 255 additions and 130 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

187
API.md
View File

@ -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.
* --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.
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

2
README.md
View File

@ -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

3
demo/relative-templates/child1 Normal file
View File

@ -0,0 +1,3 @@
* Child1
{{> deeper/child2 }}
{{> ../relative-templates/deeper/child2 }}

1
demo/relative-templates/child3 Normal file
View File

@ -0,0 +1 @@
* Child3

2
demo/relative-templates/deeper/child2 Normal file
View File

@ -0,0 +1,2 @@
* Child2
{{> ../child3 }}

7
demo/relative-templates/file Normal file
View File

@ -0,0 +1,7 @@
This is "file"
Child1 in different ways
{{> child1 }}
{{> ./child1 }}
{{> ../relative-templates/child1 }}
{{> deeper/../child1 }}

128
mo
View File

@ -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.
@ -35,46 +37,50 @@
# 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
# --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.
# -- - Used to indicate the end of options. You may optionally
# use this when filenames may start with two hyphens.
# --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

2
tests/double-hyphen.expected
View File

@ -1 +1 @@
cat: --help: No such file or directory
File does not exist: /home/fidian/repo/mo/tests/--help

2
tests/double-hyphen.sh
View File

@ -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

20
tests/help.expected
View File

@ -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

2
tests/help.sh
View File

@ -1,4 +1,4 @@
#!/usr/bin/env bash
cd "${0%/*}"
../mo --help
../mo -u --help

1
tests/invalid-option.expected
View File

@ -1 +0,0 @@
cat: --something: No such file or directory

2
tests/partial-missing.expected
View File

@ -1 +1 @@
cat: partial-missing.partial: No such file or directory
File does not exist: /home/fidian/repo/mo/tests/partial-missing.partial

7
tests/partial-missing.sh
View File

@ -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

3
tests/source.sh
View File

@ -1,7 +1,8 @@
#!/usr/bin/env bash
cd "${0%/*}"
cat <<EOF | ../mo --source=source.vars
. ../mo
cat <<EOF | mo --source=source.vars
{{VAR}}
{{#ARR}}
* {{.}}

2
tests/source.vars
View File

@ -1,4 +1,4 @@
export VAR=value
export ARR=(1 2 3)
declare -A ASSOC_ARR
export ASSOC_ARR=([a]=AAA [b]=BBB)
ASSOC_ARR=([a]=AAA [b]=BBB)