Squashed 'vendor/git.knownelement.com/ExternalVendorCode/mo/' content from commit 7e86c1a
git-subtree-dir: vendor/git.knownelement.com/ExternalVendorCode/mo git-subtree-split: 7e86c1a5f525f352983077d743c2ce2f5d75f4fa
This commit is contained in:
commit
a0db8e8df0
168
.eslintrc.yaml
Normal file
168
.eslintrc.yaml
Normal file
@ -0,0 +1,168 @@
|
||||
parserOptions:
|
||||
ecmaVersion: latest
|
||||
sourceType: module
|
||||
env:
|
||||
es6: true
|
||||
jasmine: true
|
||||
node: true
|
||||
extends: eslint:recommended
|
||||
rules:
|
||||
accessor-pairs: error
|
||||
array-bracket-spacing:
|
||||
- error
|
||||
- never
|
||||
array-callback-return: error
|
||||
block-spacing:
|
||||
- error
|
||||
- never
|
||||
brace-style: error
|
||||
comma-dangle: error
|
||||
comma-spacing: error
|
||||
comma-style: error
|
||||
complexity:
|
||||
- error
|
||||
- 10
|
||||
computed-property-spacing: error
|
||||
consistent-return: error
|
||||
consistent-this: error
|
||||
constructor-super: error
|
||||
curly: error
|
||||
default-case: error
|
||||
dot-notation: error
|
||||
eol-last: error
|
||||
eqeqeq: error
|
||||
generator-star-spacing: error
|
||||
global-require: off
|
||||
guard-for-in: error
|
||||
jsx-quotes: error
|
||||
key-spacing: error
|
||||
keyword-spacing: error
|
||||
linebreak-style: error
|
||||
lines-around-comment:
|
||||
- error
|
||||
-
|
||||
allowBlockStart: true
|
||||
allowObjectStart: true
|
||||
allowArrayStart: true
|
||||
max-statements-per-line: error
|
||||
new-cap: error
|
||||
new-parens: error
|
||||
no-array-constructor: error
|
||||
no-bitwise: error
|
||||
no-caller: error
|
||||
no-case-declarations: error
|
||||
no-catch-shadow: error
|
||||
no-class-assign: error
|
||||
no-cond-assign: error
|
||||
no-confusing-arrow: error
|
||||
no-console: off
|
||||
no-const-assign: error
|
||||
no-constant-condition: error
|
||||
no-continue: error
|
||||
no-delete-var: error
|
||||
no-dupe-args: error
|
||||
no-dupe-class-members: error
|
||||
no-dupe-keys: error
|
||||
no-duplicate-case: error
|
||||
no-duplicate-imports: error
|
||||
no-empty: off
|
||||
no-empty-character-class: error
|
||||
no-empty-pattern: error
|
||||
no-eq-null: error
|
||||
no-eval: error
|
||||
no-extend-native: error
|
||||
no-extra-bind: error
|
||||
no-extra-boolean-cast: error
|
||||
no-extra-label: error
|
||||
no-extra-semi: error
|
||||
no-fallthrough: error
|
||||
no-func-assign: error
|
||||
no-implied-eval: error
|
||||
no-inner-declarations: error
|
||||
no-invalid-this: error
|
||||
no-invalid-regexp: error
|
||||
no-irregular-whitespace: error
|
||||
no-iterator: error
|
||||
no-label-var: error
|
||||
no-labels: error
|
||||
no-lone-blocks: error
|
||||
no-lonely-if: error
|
||||
no-loop-func: error
|
||||
no-mixed-spaces-and-tabs: error
|
||||
no-multi-spaces: error
|
||||
no-multi-str: error
|
||||
no-multiple-empty-lines:
|
||||
- error
|
||||
-
|
||||
max: 2
|
||||
no-native-reassign: error
|
||||
no-negated-condition: error
|
||||
no-nested-ternary: error
|
||||
no-new: error
|
||||
no-new-func: error
|
||||
no-new-object: error
|
||||
no-new-symbol: error
|
||||
no-new-wrappers: error
|
||||
no-obj-calls: error
|
||||
no-octal: error
|
||||
no-octal-escape: error
|
||||
no-path-concat: error
|
||||
no-plusplus: error
|
||||
no-proto: error
|
||||
no-redeclare: error
|
||||
no-regex-spaces: error
|
||||
no-restricted-globals: error
|
||||
no-return-assign: error
|
||||
no-script-url: error
|
||||
no-self-assign: error
|
||||
no-self-compare: error
|
||||
no-sequences: error
|
||||
no-shadow: error
|
||||
no-shadow-restricted-names: error
|
||||
no-spaced-func: error
|
||||
no-sparse-arrays: error
|
||||
no-this-before-super: error
|
||||
no-throw-literal: error
|
||||
no-trailing-spaces: error
|
||||
no-undef: error
|
||||
no-undef-init: error
|
||||
no-unexpected-multiline: error
|
||||
no-unmodified-loop-condition: error
|
||||
no-unneeded-ternary: error
|
||||
no-unreachable: error
|
||||
no-unsafe-finally: error
|
||||
no-unused-expressions: error
|
||||
no-unused-labels: error
|
||||
no-unused-vars: error
|
||||
no-useless-call: error
|
||||
no-useless-computed-key: error
|
||||
no-useless-concat: error
|
||||
no-useless-constructor: error
|
||||
no-useless-escape: error
|
||||
no-void: error
|
||||
no-warning-comments: warn
|
||||
no-whitespace-before-property: error
|
||||
no-with: error
|
||||
operator-assignment: error
|
||||
padded-blocks:
|
||||
- error
|
||||
- never
|
||||
prefer-const: error
|
||||
quote-props:
|
||||
- error
|
||||
- as-needed
|
||||
radix: error
|
||||
require-yield: error
|
||||
semi: error
|
||||
semi-spacing: error
|
||||
space-before-blocks: error
|
||||
space-in-parens: error
|
||||
space-infix-ops:
|
||||
- error
|
||||
-
|
||||
int32Hint: false
|
||||
space-unary-ops: error
|
||||
spaced-comment: error
|
||||
use-isnan: error
|
||||
valid-typeof: error
|
||||
yield-star-spacing: error
|
||||
13
.github/workflows/ci.yaml
vendored
Normal file
13
.github/workflows/ci.yaml
vendored
Normal file
@ -0,0 +1,13 @@
|
||||
name: CI
|
||||
on: [push]
|
||||
jobs:
|
||||
test:
|
||||
name: Test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v1
|
||||
- name: Run tests
|
||||
run: ./run-tests
|
||||
- name: Run against spec
|
||||
run: ./run-spec
|
||||
45
.github/workflows/release.yaml
vendored
Normal file
45
.github/workflows/release.yaml
vendored
Normal file
@ -0,0 +1,45 @@
|
||||
name: docker push
|
||||
on: [push]
|
||||
jobs:
|
||||
push_to_registry:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- name: Docker meta
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
id: docker_meta
|
||||
uses: crazy-max/ghaction-docker-meta@v1
|
||||
with:
|
||||
images: ghcr.io/${{ github.repository }}
|
||||
tag-match: v(.*)
|
||||
- name: Set up QEMU
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
uses: docker/setup-qemu-action@v1
|
||||
- name: Set up Docker Buildx
|
||||
id: buildx
|
||||
uses: docker/setup-buildx-action@v1
|
||||
- name: Cache Docker layers
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: /tmp/.buildx-cache
|
||||
key: ${{ runner.os }}-buildx-${{ github.sha }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-buildx-
|
||||
- name: Login to GitHub Container Registry
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
uses: docker/login-action@v1
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.repository_owner }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v2
|
||||
if: startsWith(github.ref, 'refs/tags/')
|
||||
with:
|
||||
builder: ${{ steps.buildx.outputs.name }}
|
||||
platforms: linux/amd64,linux/arm64
|
||||
tags: ${{ steps.docker_meta.outputs.tags }}
|
||||
cache-from: type=local,src=/tmp/.buildx-cache
|
||||
cache-to: type=local,dest=/tmp/.buildx-cache
|
||||
push: true
|
||||
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
*.swp
|
||||
diagnostic.partial
|
||||
diagnostic.test
|
||||
tests/*.diff
|
||||
spec/
|
||||
spec-runner/
|
||||
node_modules/
|
||||
package.json
|
||||
package-lock.json
|
||||
616
API.md
Normal file
616
API.md
Normal file
@ -0,0 +1,616 @@
|
||||
API / Function Documentation
|
||||
============================
|
||||
|
||||
This documentation is generated automatically from the source of [mo] thanks to [tomdoc.sh].
|
||||
|
||||
|
||||
`mo()`
|
||||
------
|
||||
|
||||
Public: Template parser function. Writes templates to stdout.
|
||||
|
||||
* $0 - Name of the mo file, used for getting the help message.
|
||||
* $@ - Filenames to parse.
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::debug()`
|
||||
-------------
|
||||
|
||||
Internal: Show a debug message
|
||||
|
||||
* $1 - The debug message to show
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::debugShowState()`
|
||||
----------------------
|
||||
|
||||
Internal: Show a debug message and internal state information
|
||||
|
||||
No arguments
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::error()`
|
||||
-------------
|
||||
|
||||
Internal: Show an error message and exit
|
||||
|
||||
* $1 - The error message to show
|
||||
* $2 - Error code
|
||||
|
||||
Returns nothing. Exits the program.
|
||||
|
||||
|
||||
`mo::errorNear()`
|
||||
-----------------
|
||||
|
||||
Internal: Show an error message with a snippet of context and exit
|
||||
|
||||
* $1 - The error message to show
|
||||
* $2 - The starting point
|
||||
* $3 - Error code
|
||||
|
||||
Returns nothing. Exits the program.
|
||||
|
||||
|
||||
`mo::usage()`
|
||||
-------------
|
||||
|
||||
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.
|
||||
|
||||
* $1 - Filename that has the help message
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::content()`
|
||||
---------------
|
||||
|
||||
Internal: Fetches the content to parse into MO_UNPARSED. Can be a list of partials for files or the content from stdin.
|
||||
|
||||
* $1 - Destination variable name
|
||||
* $2-@ - File names (optional), read from stdin otherwise
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::contentFile()`
|
||||
-------------------
|
||||
|
||||
Internal: Read a file into MO_UNPARSED.
|
||||
|
||||
* $1 - Destination variable name.
|
||||
* $2 - Filename to load - if empty, defaults to /dev/stdin
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::indirect()`
|
||||
----------------
|
||||
|
||||
Internal: Send a variable up to the parent of the caller of this function.
|
||||
|
||||
* $1 - Variable name
|
||||
* $2 - Value
|
||||
|
||||
Examples
|
||||
|
||||
callFunc () {
|
||||
local "$1" && mo::indirect "$1" "the value"
|
||||
}
|
||||
callFunc dest
|
||||
echo "$dest" # writes "the value"
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::indirectArray()`
|
||||
---------------------
|
||||
|
||||
Internal: Send an array as a variable up to caller of a function
|
||||
|
||||
* $1 - Variable name
|
||||
* $2-@ - Array elements
|
||||
|
||||
Examples
|
||||
|
||||
callFunc () {
|
||||
local myArray=(one two three)
|
||||
local "$1" && mo::indirectArray "$1" "${myArray[@]}"
|
||||
}
|
||||
callFunc dest
|
||||
echo "${dest[@]}" # writes "one two three"
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::trimUnparsed()`
|
||||
--------------------
|
||||
|
||||
Internal: Trim leading characters from MO_UNPARSED
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::chomp()`
|
||||
-------------
|
||||
|
||||
Internal: Remove whitespace and content after whitespace
|
||||
|
||||
* $1 - Name of the destination variable
|
||||
* $2 - The string to chomp
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::parse()`
|
||||
-------------
|
||||
|
||||
Public: Parses text, interpolates mustache tags. Utilizes the current value of MO_OPEN_DELIMITER, MO_CLOSE_DELIMITER, and MO_STANDALONE_CONTENT. Those three variables shouldn't be changed by user-defined functions.
|
||||
|
||||
* $1 - Destination variable name - where to store the finished content
|
||||
* $2 - Content to parse
|
||||
* $3 - Preserve standalone status/content - truthy if not empty. When set to a value, that becomes the standalone content value
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::parseInternal()`
|
||||
---------------------
|
||||
|
||||
Internal: Parse MO_UNPARSED, writing content to MO_PARSED. Interpolates mustache tags.
|
||||
|
||||
No arguments
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::parseBlock()`
|
||||
------------------
|
||||
|
||||
Internal: Handle parsing a block
|
||||
|
||||
* $1 - Invert condition ("true" or "false")
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::parseBlockFunction()`
|
||||
--------------------------
|
||||
|
||||
Internal: Handle parsing a block whose first argument is a function
|
||||
|
||||
* $1 - Invert condition ("true" or "false")
|
||||
* $2-@ - The parsed tokens from inside the block tags
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::parseBlockArray()`
|
||||
-----------------------
|
||||
|
||||
Internal: Handle parsing a block whose first argument is an array
|
||||
|
||||
* $1 - Invert condition ("true" or "false")
|
||||
* $2-@ - The parsed tokens from inside the block tags
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::parseBlockValue()`
|
||||
-----------------------
|
||||
|
||||
Internal: Handle parsing a block whose first argument is a value
|
||||
|
||||
* $1 - Invert condition ("true" or "false")
|
||||
* $2-@ - The parsed tokens from inside the block tags
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::parsePartial()`
|
||||
--------------------
|
||||
|
||||
Internal: Handle parsing a partial
|
||||
|
||||
No arguments.
|
||||
|
||||
Indentation will be applied to the entire partial's contents before parsing. This indentation is based on the whitespace that ends the previously parsed content.
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::parseComment()`
|
||||
--------------------
|
||||
|
||||
Internal: Handle parsing a comment
|
||||
|
||||
No arguments.
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::parseDelimiter()`
|
||||
----------------------
|
||||
|
||||
Internal: Handle parsing the change of delimiters
|
||||
|
||||
No arguments.
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::parseValue()`
|
||||
------------------
|
||||
|
||||
Internal: Handle parsing value or function call
|
||||
|
||||
No arguments.
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::isFunction()`
|
||||
------------------
|
||||
|
||||
Internal: Determine if the given name is a defined function.
|
||||
|
||||
* $1 - Function name to check
|
||||
|
||||
Be extremely careful. Even if strict mode is enabled, it is not honored in newer versions of Bash. Any errors that crop up here will not be caught automatically.
|
||||
|
||||
Examples
|
||||
|
||||
moo () {
|
||||
echo "This is a function"
|
||||
}
|
||||
if mo::isFunction moo; then
|
||||
echo "moo is a defined function"
|
||||
fi
|
||||
|
||||
Returns 0 if the name is a function, 1 otherwise.
|
||||
|
||||
|
||||
`mo::isArray()`
|
||||
---------------
|
||||
|
||||
Internal: Determine if a given environment variable exists and if it is an array.
|
||||
|
||||
* $1 - Name of environment variable
|
||||
|
||||
Be extremely careful. Even if strict mode is enabled, it is not honored in newer versions of Bash. Any errors that crop up here will not be caught automatically.
|
||||
|
||||
Examples
|
||||
|
||||
var=(abc)
|
||||
if moIsArray var; then
|
||||
echo "This is an array"
|
||||
echo "Make sure you don't accidentally use \$var"
|
||||
fi
|
||||
|
||||
Returns 0 if the name is not empty, 1 otherwise.
|
||||
|
||||
|
||||
`mo::isArrayIndexValid()`
|
||||
-------------------------
|
||||
|
||||
Internal: Determine if an array index exists.
|
||||
|
||||
* $1 - Variable name to check
|
||||
* $2 - The index to check
|
||||
|
||||
Has to check if the variable is an array and if the index is valid for that type of array.
|
||||
|
||||
Returns true (0) if everything was ok, 1 if there's any condition that fails.
|
||||
|
||||
|
||||
`mo::isVarSet()`
|
||||
----------------
|
||||
|
||||
Internal: Determine if a variable is assigned, even if it is assigned an empty value.
|
||||
|
||||
* $1 - Variable name to check.
|
||||
|
||||
Can not use logic like this in case invalid variable names are passed. [[ "${!1-a}" == "${!1-b}" ]]
|
||||
|
||||
Returns true (0) if the variable is set, 1 if the variable is unset.
|
||||
|
||||
|
||||
`mo::isTruthy()`
|
||||
----------------
|
||||
|
||||
Internal: Determine if a value is considered truthy.
|
||||
|
||||
* $1 - The value to test
|
||||
* $2 - Invert the value, either "true" or "false"
|
||||
|
||||
Returns true (0) if truthy, 1 otherwise.
|
||||
|
||||
|
||||
`mo::evaluate()`
|
||||
----------------
|
||||
|
||||
Internal: Convert token list to values
|
||||
|
||||
* $1 - Destination variable name
|
||||
* $2-@ - Tokens to convert
|
||||
|
||||
Sample call:
|
||||
|
||||
mo::evaluate dest NAME username VALUE abc123 PAREN 2
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::evaluateListOfSingles()`
|
||||
-----------------------------
|
||||
|
||||
Internal: Convert an argument list to individual values.
|
||||
|
||||
* $1 - Destination variable name
|
||||
* $2-@ - A list of argument types and argument name/value.
|
||||
|
||||
This assumes each value is separate from the rest. In contrast, mo::evaluate will pass all arguments to a function if the first value is a function.
|
||||
|
||||
Sample call:
|
||||
|
||||
mo::evaluateListOfSingles dest NAME username VALUE abc123
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::evaluateSingle()`
|
||||
----------------------
|
||||
|
||||
Internal: Evaluate a single argument
|
||||
|
||||
* $1 - Name of variable for result
|
||||
* $2 - Type of argument, either NAME or VALUE
|
||||
* $3 - Argument
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::evaluateKey()`
|
||||
-------------------
|
||||
|
||||
Internal: Return the value for @key based on current's name
|
||||
|
||||
* $1 - Name of variable for result
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::evaluateVariable()`
|
||||
------------------------
|
||||
|
||||
Internal: Handle a variable name
|
||||
|
||||
* $1 - Destination variable name
|
||||
* $2 - Variable name
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::findVariableName()`
|
||||
------------------------
|
||||
|
||||
Internal: Find the name of a variable to use
|
||||
|
||||
* $1 - Destination variable name, receives an array
|
||||
* $2 - Variable name from the template
|
||||
|
||||
The array contains the following values
|
||||
* [0] - Variable name
|
||||
* [1] - Array index, or empty string
|
||||
|
||||
Example variables a="a"
|
||||
b="b"
|
||||
c=("c.0" "c.1")
|
||||
d=([b]="d.b" [d]="d.d")
|
||||
|
||||
Given these inputs (function input, current value), produce these outputs a c => a
|
||||
a c.0 => a
|
||||
b d => d.b
|
||||
b d.d => d.b
|
||||
a d => d.a
|
||||
a d.d => d.a
|
||||
c.0 d => c.0
|
||||
d.b d => d.b
|
||||
'' c => c
|
||||
'' c.0 => c.0
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::join()`
|
||||
------------
|
||||
|
||||
Internal: Join / implode an array
|
||||
|
||||
* $1 - Variable name to receive the joined content
|
||||
* $2 - Joiner
|
||||
* $3-@ - Elements to join
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::evaluateFunction()`
|
||||
------------------------
|
||||
|
||||
Internal: Call a function.
|
||||
|
||||
* $1 - Variable for output
|
||||
* $2 - Content to pass
|
||||
* $3 - Function to call
|
||||
* $4-@ - Additional arguments as list of type, value/name
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::standaloneCheck()`
|
||||
-----------------------
|
||||
|
||||
Internal: Check if a tag appears to have only whitespace before it and after it on a line. There must be a new line before and there must be a newline after or the end of a string
|
||||
|
||||
No arguments.
|
||||
|
||||
Returns 0 if this is a standalone tag, 1 otherwise.
|
||||
|
||||
|
||||
`mo::standaloneProcess()`
|
||||
-------------------------
|
||||
|
||||
Internal: Process content before and after a tag. Remove prior whitespace up to the previous newline. Remove following whitespace up to and including the next newline.
|
||||
|
||||
No arguments.
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::indentLines()`
|
||||
-------------------
|
||||
|
||||
Internal: Apply indentation before any line that has content in MO_UNPARSED.
|
||||
|
||||
* $1 - Destination variable name.
|
||||
* $2 - The indentation string.
|
||||
* $3 - The content that needs the indentation string prepended on each line.
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::escape()`
|
||||
--------------
|
||||
|
||||
Internal: Escape a value
|
||||
|
||||
* $1 - Destination variable name
|
||||
* $2 - Value to escape
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::getContentUntilClose()`
|
||||
----------------------------
|
||||
|
||||
Internal: Get the content up to the end of the block by minimally parsing and balancing blocks. Returns the content before the end tag to the caller and removes the content + the end tag from MO_UNPARSED. This can change the delimiters, adjusting MO_OPEN_DELIMITER and MO_CLOSE_DELIMITER.
|
||||
|
||||
* $1 - Destination variable name
|
||||
* $2 - Token string to match for a closing tag
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::tokensToString()`
|
||||
----------------------
|
||||
|
||||
Internal: Convert a list of tokens to a string
|
||||
|
||||
* $1 - Destination variable for the string
|
||||
* $2-$@ - Token list
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::getContentTrim()`
|
||||
----------------------
|
||||
|
||||
Internal: Trims content from MO_UNPARSED, returns trimmed content.
|
||||
|
||||
* $1 - Destination variable
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::getContentComment()`
|
||||
-------------------------
|
||||
|
||||
Get the content up to and including a close tag
|
||||
|
||||
* $1 - Destination variable
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::getContentDelimiter()`
|
||||
---------------------------
|
||||
|
||||
Get the content up to and including a close tag. First two non-whitespace tokens become the new open and close tag.
|
||||
|
||||
* $1 - Destination variable
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::getContentWithinTag()`
|
||||
---------------------------
|
||||
|
||||
Get the content up to and including a close tag. First two non-whitespace tokens become the new open and close tag.
|
||||
|
||||
* $1 - Destination variable, an array
|
||||
* $2 - Terminator string
|
||||
|
||||
The array contents: [0] The raw content within the tag
|
||||
[1] The parsed tokens as a single string
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::tokenizeTagContents()`
|
||||
---------------------------
|
||||
|
||||
Internal: Parse MO_UNPARSED and retrieve the content within the tag delimiters. Converts everything into an array of string values.
|
||||
|
||||
* $1 - Destination variable for the array of contents.
|
||||
* $2 - Stop processing when this content is found.
|
||||
|
||||
The list of tokens are in RPN form. The first item in the resulting array is the number of actual tokens (after combining command tokens) in the list.
|
||||
|
||||
Given: a 'bc' "de\"\n" (f {g 'h'}) Result: ([0]=4 [1]=NAME [2]=a [3]=VALUE [4]=bc [5]=VALUE [6]=$'de\"\n' [7]=NAME [8]=f [9]=NAME [10]=g [11]=VALUE [12]=h [13]=BRACE [14]=2 [15]=PAREN [16]=2
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::tokenizeTagContentsName()`
|
||||
-------------------------------
|
||||
|
||||
Internal: Get the contents of a variable name.
|
||||
|
||||
* $1 - Destination variable name for the token list (array of strings)
|
||||
|
||||
Returns nothing
|
||||
|
||||
|
||||
`mo::tokenizeTagContentsDoubleQuote()`
|
||||
--------------------------------------
|
||||
|
||||
Internal: Get the contents of a tag in double quotes. Parses the backslash sequences.
|
||||
|
||||
* $1 - Destination variable name for the token list (array of strings)
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`mo::tokenizeTagContentsSingleQuote()`
|
||||
--------------------------------------
|
||||
|
||||
Internal: Get the contents of a tag in single quotes. Only gets the raw value.
|
||||
|
||||
* $1 - Destination variable name for the token list (array of strings)
|
||||
|
||||
Returns nothing.
|
||||
|
||||
|
||||
`MO_ORIGINAL_COMMAND`
|
||||
---------------------
|
||||
|
||||
Save the original command's path for usage later
|
||||
|
||||
|
||||
[mo]: ./mo
|
||||
[tomdoc.sh]: https://github.com/tests-always-included/tomdoc.sh
|
||||
7
Dockerfile
Normal file
7
Dockerfile
Normal file
@ -0,0 +1,7 @@
|
||||
FROM alpine
|
||||
|
||||
RUN apk add --no-cache bash
|
||||
ADD mo /usr/local/bin/mo
|
||||
RUN chmod +x /usr/local/bin/mo
|
||||
|
||||
ENTRYPOINT /usr/local/bin/mo
|
||||
7
LICENSE.md
Normal file
7
LICENSE.md
Normal file
@ -0,0 +1,7 @@
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
Except as contained in this notice, the name(s) of the above copyright holders shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization.
|
||||
|
||||
The end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by contributors", in the same place and form as other third-party acknowledgments. Alternately, this acknowledgment may appear in the software itself, in the same form and location as other such third-party acknowledgments.
|
||||
340
README.md
Normal file
340
README.md
Normal file
@ -0,0 +1,340 @@
|
||||
Mo - Mustache Templates in Bash
|
||||
===============================
|
||||
|
||||
[Mustache] templates are simple, logic-less templates. Because of their simplicity, they are able to be ported to many languages. The syntax is quite simple.
|
||||
|
||||
Hello, {{NAME}}.
|
||||
|
||||
I hope your {{TIME_PERIOD}} was fun.
|
||||
|
||||
The above file is [`demo/fun-trip.mo`](demo/fun-trip.mo). Let's try using this template some data from bash's environment. Go to your checked out copy of the project and run a command like this:
|
||||
|
||||
NAME=Tyler TIME_PERIOD=weekend ./mo demo/fun-trip.mo
|
||||
|
||||
Your result?
|
||||
|
||||
Hello, Tyler.
|
||||
|
||||
I hope your weekend was fun.
|
||||
|
||||
This bash version supports conditionals, functions (both as filters and as values), as well as indexed arrays (for iteration). You are able to leverage these additional features by adding more information into the environment. It is easiest to do this when you source `mo`. See the [demo scripts](demo/) for further examples.
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
* Bash 3.x (the aim is to make it work on Macs)
|
||||
* 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.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
There are a few ways you can install this tool. How you install it depends on how you want to use it.
|
||||
|
||||
|
||||
### Globally; For Everyone
|
||||
|
||||
You can install this file in `/usr/local/bin/` or `/usr/bin/` by simply downloading it, changing the permissions, then moving it to the right location. Double check that your system's PATH includes the destination folder, otherwise users may have a hard time starting the command.
|
||||
|
||||
# Download
|
||||
curl -sSL https://raw.githubusercontent.com/tests-always-included/mo/master/mo -o mo
|
||||
|
||||
# Make executable
|
||||
chmod +x mo
|
||||
|
||||
# Move to the right folder
|
||||
sudo mv mo /usr/local/bin/
|
||||
|
||||
# Test
|
||||
echo "works" | mo
|
||||
|
||||
|
||||
### Locally; For Yourself
|
||||
|
||||
This is very similar to installing it globally but it does not require root privileges. It is very important that your PATH includes the destination folder otherwise it won't work. Some local folders that are typically used are `~/bin/` and `~/.local/bin/`.
|
||||
|
||||
# Download
|
||||
curl -sSL https://raw.githubusercontent.com/tests-always-included/mo/master/mo -o mo
|
||||
|
||||
# Make executable
|
||||
chmod +x mo
|
||||
|
||||
# Ensure destination folder exists
|
||||
mkdir -p ~/.local/bin/
|
||||
|
||||
# Move to the right folder
|
||||
mv mo ~/.local/bin/
|
||||
|
||||
# Test
|
||||
echo "works" | mo
|
||||
|
||||
|
||||
### As A Library; For A Tool
|
||||
|
||||
Bash scripts can source `mo` to include the functionality in their own routines. This usage typically would have `mo` saved to a `lib/` folder in an application and your other scripts would use `. lib/mo` to bring it into your project.
|
||||
|
||||
# Download
|
||||
curl -sSL https://raw.githubusercontent.com/tests-always-included/mo/master/mo -o mo
|
||||
|
||||
# Move into your project folder
|
||||
mv mo ~/projects/amazing-things/lib/
|
||||
|
||||
To allow it to work this way, you either should source the file (`. "lib/mo"`) or make it executable (`chmod +x lib/mo`) and run it from your scripts.
|
||||
|
||||
|
||||
How to Use
|
||||
----------
|
||||
|
||||
If you only plan using strings and numbers, nothing could be simpler. In your shell script you can choose to export the variables. The below script is [`demo/using-strings`](demo/using-strings).
|
||||
|
||||
#!/usr/bin/env bash
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
export TEST="This is a test"
|
||||
echo "Your message: {{TEST}}" | ../mo
|
||||
|
||||
The result? "Your message: This is a test".
|
||||
|
||||
Using arrays adds a slight level of complexity. *You must source `mo`.* Look at [`demo/using-arrays`](demo/using-arrays).
|
||||
|
||||
#!/usr/bin/env bash
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
export ARRAY=( one two "three three three" four five )
|
||||
. ../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. 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.
|
||||
|
||||
There are additional features that the program supports. Try using `mo --help` to see what is available.
|
||||
|
||||
Please note that this command is written in Bash and pulls data from either the environment or (when using `--source`) from a text file that will be sourced and loaded into the environment, which means you will need to have Bash-style variables defined. Please see the examples in `demo/` for different ways you can use `mo`.
|
||||
|
||||
|
||||
Enhancements
|
||||
------------
|
||||
|
||||
In addition to many of the features built-in to Mustache, `mo` includes a number of unique features that make it a bit more powerful.
|
||||
|
||||
### Loop @key
|
||||
|
||||
`mo` implements Handlebar's `@key` references for outputting the key inside of a loop:
|
||||
|
||||
Env:
|
||||
```bash
|
||||
myarr=( foo bar )
|
||||
|
||||
# Bash v4+
|
||||
declare -A myassoc
|
||||
myassoc[hello]="mo"
|
||||
myassoc[world]="is great"
|
||||
```
|
||||
|
||||
Template:
|
||||
```handlebars
|
||||
{{#myarr}}
|
||||
- {{@key}} {{.}}
|
||||
{{/myarr}}
|
||||
|
||||
{{#myassoc}}
|
||||
* {{@key}} {{.}}
|
||||
{{/myassoc}}
|
||||
```
|
||||
|
||||
Output:
|
||||
```markdown
|
||||
- 0 foo
|
||||
- 1 bar
|
||||
|
||||
* hello mo
|
||||
* world is great
|
||||
```
|
||||
|
||||
|
||||
### Helpers / Function Arguments
|
||||
|
||||
Function Arguments are not a part of the official Mustache implementation, and are more often associated with Handlebar's Helper functionality.
|
||||
|
||||
`mo` allows for passing strings to functions.
|
||||
|
||||
```handlebars
|
||||
{{myfunc foo bar}}
|
||||
```
|
||||
|
||||
For security reasons, these arguments are not immediately available to function calls without a flag.
|
||||
|
||||
#### with `--allow-function-arguments`
|
||||
|
||||
```bash
|
||||
myfunc() {
|
||||
# Outputs "foo, bar"
|
||||
echo "$1, $2";
|
||||
}
|
||||
```
|
||||
|
||||
#### Using `$MO_FUNCTION_ARGS`
|
||||
|
||||
```bash
|
||||
myfunc() {
|
||||
# Outputs "foo, bar"
|
||||
echo "${MO_FUNCTION_ARGS[0]}, ${MO_FUNCTION_ARGS[1]}";
|
||||
}
|
||||
```
|
||||
|
||||
### Triple Mustache, Parenthesis, and Quotes
|
||||
|
||||
Normally, triple mustache syntax, such as `{{{var}}}` will avoid HTML escaping of the variable. Because HTML escaping is not supported in `mo`, this is now used differently. Anything within braces will be looked up and the values will be concatenated together and the result will be treated as a value. Anything in parenthesis will be looked up, concatenated, and treated as a name. Also, anything in single quotes is passed as a value; double quoted things first are unescaped and then passed as a value.
|
||||
|
||||
```
|
||||
# Example input
|
||||
var=abc
|
||||
user=admin
|
||||
admin=Administrator
|
||||
u=user
|
||||
abc=([0]=zero [1]=one [2]=two)
|
||||
```
|
||||
|
||||
| Mustache syntax | Resulting output | Notes |
|
||||
|-----------------|------------------|-------|
|
||||
| `{{var}}` | `abc` | Normal behavior |
|
||||
| `{{var us}}` | `abcus` | Concatenation |
|
||||
| `{{'var'}}` | `var` | Passing as a value |
|
||||
| `{{"a\tb"}}` | `a b` | There was an escaped tab in the value |
|
||||
| `{{u}}` | `user` | Normal behavior |
|
||||
| `{{{u}}}` | `user` | Look up "$u", treat as the value `{{'user'}}` |
|
||||
| `{{(u)}}` | `admin` | Look up "$u", treat as the name `{{user}}` |
|
||||
| `{{var user}}` | `abcuser` | Concatenation |
|
||||
| `{{(var '.1')}}` | `one` | Look up "$var", treat as "abc", then concatenate ".1" and look up `{{abc.1}}` |
|
||||
|
||||
In double-quoted strings, the following escape sequences are defined.
|
||||
|
||||
* `\"` - Quote
|
||||
* `\b` - Bell
|
||||
* `\e` - Escape (note that Bash typically uses $'\E' for the same thing)
|
||||
* `\f` - Form feed
|
||||
* `\n` - Newline
|
||||
* `\r` - Carriage return
|
||||
* `\t` - Tab
|
||||
* `\v` - Vertical tab
|
||||
* Anything else will skip the `\` and place the next character. However, this implementation is allowed to change in the future if a different escape character mapping becomes commonplace.
|
||||
|
||||
|
||||
Environment Variables and Functions
|
||||
-----------------------------------
|
||||
|
||||
There are several functions and variables used to process templates. `mo` reserves variables that start with `MO_` for variables exposing data or configuration, functions starting with `mo::`, and local variables starting with `mo[A-Z]`. You are welcome to use internal functions, though only ones that are marked as "Public" should not change their interface. Scripts may also read any of the variables.
|
||||
|
||||
Functions are all executed in a subshell, with another subshell for lambdas. Thus, your lambda can't affect the parsing of a template. There's more information about lambdas when talking about tests that fail.
|
||||
|
||||
* `MO_ALLOW_FUNCTION_ARGUMENTS` - When set to a non-empty value, this allows functions referenced in templates to receive additional options and arguments.
|
||||
* `MO_CLOSE_DELIMITER` - The string used when closing a tag. Defaults to "}}". Used internally.
|
||||
* `MO_CLOSE_DELIMITER_DEFAULT` - The default value of `MO_CLOSE_DELIMITER`. Used when resetting the close delimiter, such as when parsing a partial.
|
||||
* `MO_CURRENT` - Variable name to use for ".".
|
||||
* `MO_DEBUG` - When set to a non-empty value, additional debug information is written to stderr.
|
||||
* `MO_FUNCTION_ARGS` - Arguments passed to the function.
|
||||
* `MO_FAIL_ON_FILE` - If a filename from the command-line is missing or a partial does not exist, abort with an error.
|
||||
* `MO_FAIL_ON_FUNCTION` - If a function returns a non-zero status code, abort with an error.
|
||||
* `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_OPEN_DELIMITER` - The string used when opening a tag. Defaults to "{{". Used internally.
|
||||
* `MO_OPEN_DELIMITER_DEFAULT` - The default value of MO_OPEN_DELIMITER. Used when resetting the open delimiter, such as when parsing a partial.
|
||||
* `MO_ORIGINAL_COMMAND` - Used to find the `mo` program in order to generate a help message.
|
||||
* `MO_PARSED` - Content that has made it through the template engine.
|
||||
* `MO_STANDALONE_CONTENT` - The unparsed content that preceeded the current tag. When a standalone tag is encountered, this is checked to see if it only contains whitespace. If this and the whitespace condition after a tag is met, then this will be reset to $'\n'.
|
||||
* `MO_UNPARSED` - Template content yet to make it through the parser.
|
||||
|
||||
|
||||
Concessions
|
||||
-----------
|
||||
|
||||
I admit that implementing everything in bash just doesn't make a lot of sense. For example, the following things just don't work because they don't really mesh with the "bash way".
|
||||
|
||||
Pull requests to solve the following issues would be helpful.
|
||||
|
||||
|
||||
### Mustache Syntax
|
||||
|
||||
* Dotted names are supported but only for associative arrays (Bash 4). See [`demo/associative-arrays`](demo/associative-arrays) for an example.
|
||||
* There's no "top level" object, so `echo '{{.}}' | ./mo` does not do anything useful. In other languages you can say the data for the template is a string and in `mo` the data is always the environment. Luckily this type of usage is rare and `{{.}}` works great when iterating over an array.
|
||||
* [Parents](https://mustache.github.io/mustache.5.html#Parents), where a template can override chunks of a partial, are not supported.
|
||||
* HTML encoding is not built into `mo`. `{{{var}}}`, `{{&var}}` and `{{var}}` all do the same thing. `echo '{{TEST}}' | TEST='<b>' mo` will give you "`<b>`" instead of "`>b<`".
|
||||
|
||||
|
||||
### General Scripting Issues
|
||||
|
||||
* Using binary files as templates is simply not allowed.
|
||||
* Bash does not support anything more complex than strings/numbers inside of associative arrays. I'm not able to add objects nor nested arrays to bash - it's just a shell after all!
|
||||
* You must make sure the data is in the environment when `mo` runs. The easiest way to do that is to source `mo` in your shell script after setting up lots of other environment variables / functions.
|
||||
|
||||
|
||||
Developing
|
||||
----------
|
||||
|
||||
Check out the code and hack away. Please add tests to show off bugs before fixing them. New functionality should also be covered by a test.
|
||||
|
||||
First, make sure you install Node.js. After that, run `npm run install-tests` to get the dependencies and the repository of YAML tests. Run `npm run test` to run the JavaScript tests. There's over 100 of them, which is great. Not all of them will pass, but that's discussed later.
|
||||
|
||||
When submitting patches, make sure to run them past [ShellCheck] and ensure no problems are found. Also please use Bash 3 syntax if you are manipulating arrays.
|
||||
|
||||
|
||||
### Porting and Backporting
|
||||
|
||||
In case of problems, setting MO_DEBUG to a non-empty value will give you LOTS of output.
|
||||
|
||||
MO_DEBUG=1 ./mo my-template
|
||||
|
||||
|
||||
### Failed Specs
|
||||
|
||||
It is acceptable for some of the official spec tests to fail. The spec runner has specific exclusions and overrides to test similar functionality that avoid the following issues.
|
||||
|
||||
* Using `{{.}}` outside of a loop - In order to access any variable, you must use its name. In a loop, `{{.}}` will refer to the current value, but outside the loop you are unable to use this dot notation because there is no current value.
|
||||
* Deeply nested data - Bash doesn't support complex data structure. Basically, just strings and arrays of strings.
|
||||
* Interpolation; Multiple Calls: This fails because lambdas execute in a subshell so their output can be captured. If you want state to be preserved, you will need to write it outside of the current environment and load it again later.
|
||||
* HTML Escaping - Since bash is not often executed in a web server context, it makes no sense to have the output escaped as HTML. Performing shell escaping of variables may be an option in the future if there's a demand.
|
||||
* Lambdas - Function results are *not* automatically interpreted again. If you want to parse the results as Mustache content, use `mo::parse`. When they use `mo::parse`, it will use the current delimiters.
|
||||
|
||||
For lambdas, these examples may help.
|
||||
|
||||
```bash
|
||||
# Retrieve content into a variable.
|
||||
content=$(cat)
|
||||
|
||||
# Retrieve all content and do not trim newlines at the end.
|
||||
content=$(cat; echo -n '.')
|
||||
content=${content%.}
|
||||
|
||||
# Parse content using the current delimiters
|
||||
mo::parse results "This is my content. Hello, {{username}}"
|
||||
echo -n "$results"
|
||||
|
||||
# Parse content using the default delimiters
|
||||
MO_OPEN_DELIMITER=$MO_OPEN_DELIMITER_DEFAULT
|
||||
MO_CLOSE_DELIMITER=$MO_CLOSE_DELIMITER_DEFAULT
|
||||
mo::parse results "This is my content. Hello, {{username}}"
|
||||
echo -n "$results"
|
||||
```
|
||||
|
||||
|
||||
### Future Enhancements
|
||||
|
||||
There's a few places in the code marked with `TODO` to signify areas that could use improvement. Care to help? Keep in mind that this uses bash exclusively, so it might not look the prettiest.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
This program is licensed under an MIT license with an additional non-advertising clause. See [LICENSE.md](LICENSE.md) for the full text.
|
||||
|
||||
|
||||
[Mustache]: https://mustache.github.io/
|
||||
[ShellCheck]: https://github.com/koalaman/shellcheck
|
||||
19
demo/associative-arrays
Executable file
19
demo/associative-arrays
Executable file
@ -0,0 +1,19 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
|
||||
declare -A DATA
|
||||
export DATA=([one]=111 [two]=222)
|
||||
. ../mo
|
||||
|
||||
cat <<EOF | mo
|
||||
Accessing data directly:
|
||||
DATA: {{DATA}}
|
||||
One: {{DATA.one}}
|
||||
Two: {{DATA.two}}
|
||||
|
||||
Things in DATA:
|
||||
{{#DATA}}
|
||||
Item: {{.}}
|
||||
{{/DATA}}
|
||||
EOF
|
||||
28
demo/embedded-template
Executable file
28
demo/embedded-template
Executable file
@ -0,0 +1,28 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# This embeds a template in the script without using strange `cat` syntax.
|
||||
# shellcheck disable=SC1083 disable=SC1010 disable=SC1054 disable=SC1073 disable=SC1072 disable=SC1056 disable=SC1009
|
||||
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
|
||||
export NAME="Tyler"
|
||||
export VEHICLE="Ford Explorer"
|
||||
export OVERDUE_LENGTH="2 months"
|
||||
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"
|
||||
)
|
||||
. ../mo
|
||||
sed '0,/^# END/ d' "$(basename "$0")" | mo
|
||||
exit
|
||||
|
||||
# END
|
||||
Attention {{NAME}},
|
||||
|
||||
You need to pay for the {{VEHICLE}} you are leasing from us.
|
||||
It has been {{OVERDUE_LENGTH}} since your last payment.
|
||||
At this point you must do one of the following:
|
||||
|
||||
{{#OPTIONS}}
|
||||
* {{.}}
|
||||
{{/OPTIONS}}
|
||||
3
demo/fun-trip.mo
Normal file
3
demo/fun-trip.mo
Normal file
@ -0,0 +1,3 @@
|
||||
Hello, {{NAME}}
|
||||
|
||||
I hope your {{TIME_PERIOD}} was fun.
|
||||
31
demo/function-args
Executable file
31
demo/function-args
Executable file
@ -0,0 +1,31 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# This sources a simple script with the env. variables needed for the template.
|
||||
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
source ../mo
|
||||
|
||||
export NAME="Alex"
|
||||
export ARRAY=( AAA BBB CCC )
|
||||
|
||||
# Include an external template
|
||||
INCLUDE() {
|
||||
# shellcheck disable=SC2031
|
||||
cat "${MO_FUNCTION_ARGS[0]}"
|
||||
}
|
||||
|
||||
# Print section title
|
||||
TITLE() {
|
||||
echo "+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"
|
||||
# shellcheck disable=SC2031
|
||||
echo "${MO_FUNCTION_ARGS[0]}"
|
||||
echo "+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+"
|
||||
}
|
||||
|
||||
cat <<EOF | mo -u
|
||||
{{TITLE 'Part 1'}}
|
||||
{{INCLUDE 'function-args-part1'}}
|
||||
|
||||
{{TITLE 'Part 2'}}
|
||||
{{INCLUDE 'function-args-part2'}}
|
||||
EOF
|
||||
1
demo/function-args-part1
Normal file
1
demo/function-args-part1
Normal file
@ -0,0 +1 @@
|
||||
Hello, my name is {{NAME}}.
|
||||
3
demo/function-args-part2
Normal file
3
demo/function-args-part2
Normal file
@ -0,0 +1,3 @@
|
||||
{{#ARRAY}}
|
||||
* {{.}}
|
||||
{{/ARRAY}}
|
||||
42
demo/function-for-advanced-looping
Executable file
42
demo/function-for-advanced-looping
Executable file
@ -0,0 +1,42 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
|
||||
EVERY_REPO() {
|
||||
# The block contents come in through standard input. Capture it here.
|
||||
content=$(cat)
|
||||
|
||||
echo "# Starting EVERY_REPO"
|
||||
|
||||
# Get list of repos
|
||||
for REPO in "${REPOS[@]}"; do
|
||||
echo "## Looping one time for repo: $REPO"
|
||||
|
||||
# String replace REPO_ with the name
|
||||
# This changes everything in the content block of the template.
|
||||
# It rewrites {{__REPO__.name}} into {{resque.name}}, for instance.
|
||||
# You can prefix your environment variables and do other things as well.
|
||||
|
||||
echo "$content" | sed "s/__REPO__/${REPO}/"
|
||||
|
||||
echo "## Looped one time for repo: $REPO"
|
||||
done
|
||||
|
||||
echo "# Finished EVERY_REPO"
|
||||
}
|
||||
|
||||
REPOS=(resque hub rip)
|
||||
|
||||
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)
|
||||
. ../mo
|
||||
cat <<EOF | mo
|
||||
{{#EVERY_REPO}}
|
||||
The repo is __REPO__
|
||||
Name: {{__REPO__.name}}
|
||||
URL: {{__REPO__.url}}
|
||||
{{/EVERY_REPO}}
|
||||
|
||||
EOF
|
||||
39
demo/function-for-building-json
Executable file
39
demo/function-for-building-json
Executable file
@ -0,0 +1,39 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
|
||||
# Detect if this is the first item and write a comma if it is.
|
||||
# Normally, I would track this using a variable, like so:
|
||||
#
|
||||
# COMMA_IF_NOT_FIRST_FLAG=false
|
||||
# COMMA_IF_NOT_FIRST() {
|
||||
# $COMMA_IF_NOT_FIRST || echo ","
|
||||
# COMMA_IF_NOT_FIRST_FLAG=true
|
||||
# }
|
||||
#
|
||||
# Since this function executes in a subshell, that approach will not work.
|
||||
# Instead, we peek inside mo and see what is being processed. If the variable
|
||||
# name in moParse() changes, this will need to get updated as well. An
|
||||
# alternate variable that is usable is context, but that is in moLoop() and is
|
||||
# two levels levels deep instead of just one.
|
||||
COMMA_IF_NOT_FIRST() {
|
||||
[[ "${moCurrent#*.}" != "0" ]] && echo ","
|
||||
}
|
||||
|
||||
# Create an array that will be embedded into the JSON. If you are manipulating
|
||||
# JSON, might I suggest you look at using jq? It's really good at processing
|
||||
# JSON.
|
||||
items=(
|
||||
'{"position":"one","url":"1"}'
|
||||
'{"position":"two","url":"2"}'
|
||||
'{"position":"three","url":"3"}'
|
||||
)
|
||||
. ../mo
|
||||
cat <<EOF | mo
|
||||
{
|
||||
{{#items}}
|
||||
{{COMMA_IF_NOT_FIRST}}
|
||||
{{.}}
|
||||
{{/items}}
|
||||
}
|
||||
EOF
|
||||
50
demo/function-for-foreach
Executable file
50
demo/function-for-foreach
Executable file
@ -0,0 +1,50 @@
|
||||
#!/usr/bin/env bash
|
||||
# Example for how #29 can get implemented.
|
||||
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
|
||||
foreach() {
|
||||
# Trying to use unique names
|
||||
local foreachSourceName foreachIterator foreachEvalString foreachContent
|
||||
|
||||
foreachContent=$(cat)
|
||||
|
||||
local x
|
||||
x=("${@}")
|
||||
if [[ "$2" != "as" && "$2" != "in" ]]; then
|
||||
echo "Invalid foreach - bad format."
|
||||
elif [[ "$(declare -p "$1")" != "declare -"[aA]* ]]; then
|
||||
echo "$1 is not an array"
|
||||
else
|
||||
foreachSourceName="${1}[@]"
|
||||
|
||||
for foreachIterator in "${!foreachSourceName}"; do
|
||||
foreachEvalString=$(declare -p "$foreachIterator")
|
||||
foreachEvalString="declare -A $3=${foreachEvalString#*=}"
|
||||
eval "$foreachEvalString"
|
||||
echo "$foreachContent" | mo
|
||||
done
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
# The links are associative arrays
|
||||
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)
|
||||
|
||||
# This is a list of the link arrays
|
||||
links=(resque hub rip)
|
||||
|
||||
# Source mo in order to work with arrays
|
||||
. ../mo
|
||||
|
||||
# Process the template
|
||||
cat <<EOF | mo --allow-function-arguments
|
||||
Here are your links:
|
||||
{{#foreach 'links' 'as' 'link'}}
|
||||
* [{{link.name}}]({{link.url}})
|
||||
{{/foreach 'links' 'as' 'link'}}
|
||||
|
||||
EOF
|
||||
28
demo/important-file
Executable file
28
demo/important-file
Executable file
@ -0,0 +1,28 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
cd "$(dirname "$0")"/..
|
||||
|
||||
date-string() {
|
||||
date
|
||||
}
|
||||
wrapper() {
|
||||
echo -n "*** $(cat) ***"
|
||||
}
|
||||
|
||||
export IP=127.0.0.1
|
||||
export ALLOWED_HOSTS=( 192.168.0.1 192.168.0.2 192.168.0.3 )
|
||||
|
||||
. ./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}}
|
||||
|
||||
# ALLOWED HOSTS
|
||||
{{#ALLOWED_HOSTS}}allowed_host={{.}}
|
||||
{{/ALLOWED_HOSTS}}{{^ALLOWED_HOSTS}}# No allowed hosts{{/ALLOWED_HOSTS}}
|
||||
|
||||
# DENIED HOSTS
|
||||
{{#DENIED_HOSTS}}denied_host={{.}}
|
||||
{{/DENIED_HOSTS}}{{^DENIED_HOSTS}}# No denied hosts{{/DENIED_HOSTS}}
|
||||
EOF
|
||||
15
demo/indented-partial
Executable file
15
demo/indented-partial
Executable file
@ -0,0 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
export data=$'line 1\nline 2'
|
||||
|
||||
cat <<EOF | ../mo
|
||||
Here is a partial without an indent:
|
||||
|
||||
{{> partial}}
|
||||
|
||||
And here's the same partial with a 4-space indent:
|
||||
|
||||
{{> partial}}
|
||||
|
||||
:-)
|
||||
EOF
|
||||
1
demo/partial
Normal file
1
demo/partial
Normal file
@ -0,0 +1 @@
|
||||
{{data}}
|
||||
13
demo/sourcing
Executable file
13
demo/sourcing
Executable file
@ -0,0 +1,13 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# This sources a simple script with the env. variables needed for the template.
|
||||
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
|
||||
cat <<EOF | ../mo --source=sourcing.vars
|
||||
Hello, my name is {{NAME}}.
|
||||
And this is ARRAY's conntents:
|
||||
{{#ARRAY}}
|
||||
* {{.}}
|
||||
{{/ARRAY}}
|
||||
EOF
|
||||
2
demo/sourcing.vars
Normal file
2
demo/sourcing.vars
Normal file
@ -0,0 +1,2 @@
|
||||
export NAME="Alex"
|
||||
export ARRAY=( AAA BBB CCC )
|
||||
10
demo/using-arrays
Executable file
10
demo/using-arrays
Executable file
@ -0,0 +1,10 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
export ARRAY=( one two "three three three" four five )
|
||||
. ../mo
|
||||
cat << EOF | mo
|
||||
Here are the items in the array:
|
||||
{{#ARRAY}}
|
||||
* {{.}}
|
||||
{{/ARRAY}}
|
||||
EOF
|
||||
7
demo/using-strings
Executable file
7
demo/using-strings
Executable file
@ -0,0 +1,7 @@
|
||||
#!/usr/bin/env 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
|
||||
12
demo/writing-out-braces
Executable file
12
demo/writing-out-braces
Executable file
@ -0,0 +1,12 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
cd "$(dirname "$0")" # Go to the script's directory
|
||||
|
||||
|
||||
export OPEN="{{"
|
||||
export CLOSE="}}"
|
||||
cat <<'EOF' | mo
|
||||
You can use environment variables to write output that has double braces.
|
||||
|
||||
{{OPEN}}sampleTag{{CLOSE}}
|
||||
EOF
|
||||
20
make-api-doc
Executable file
20
make-api-doc
Executable file
@ -0,0 +1,20 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# This requires tomdoc.sh to be in your PATH.
|
||||
# https://github.com/tests-always-included/tomdoc.sh
|
||||
|
||||
cd "${0%/*}" || exit 1
|
||||
|
||||
cat <<'EOF'
|
||||
API / Function Documentation
|
||||
============================
|
||||
|
||||
This documentation is generated automatically from the source of [mo] thanks to [tomdoc.sh].
|
||||
|
||||
|
||||
EOF
|
||||
sed 's/# shellcheck.*//' mo | tomdoc.sh -m
|
||||
cat <<'EOF'
|
||||
[mo]: ./mo
|
||||
[tomdoc.sh]: https://github.com/tests-always-included/tomdoc.sh
|
||||
EOF
|
||||
22
run-spec
Executable file
22
run-spec
Executable file
@ -0,0 +1,22 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Install or update the specs
|
||||
if [[ ! -d spec ]]; then
|
||||
git clone https://github.com/mustache/spec.git spec
|
||||
else
|
||||
(
|
||||
cd spec
|
||||
git pull
|
||||
)
|
||||
fi
|
||||
|
||||
if [[ "$BASH_VERSION" == 3.* ]]; then
|
||||
echo "WARNING! Specs assume you are using a version of Bash with associative arrays!"
|
||||
fi
|
||||
|
||||
# Actually run the specs
|
||||
node run-spec.js spec/specs/*.json
|
||||
|
||||
if [[ "$BASH_VERSION" == 3.* ]]; then
|
||||
echo "Some tests may have failed because they assume Bash supports associative arays"
|
||||
fi
|
||||
512
run-spec.js
Normal file
512
run-spec.js
Normal file
@ -0,0 +1,512 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
const exec = require("child_process").exec;
|
||||
const fsPromises = require("fs").promises;
|
||||
|
||||
// Skip or override portions of tests. The goal is to still have as much
|
||||
// coverage as possible, but skip things that Bash does not support.
|
||||
//
|
||||
// To skip a test, define a "skip" property and explain why the test is
|
||||
// skipped.
|
||||
//
|
||||
// To override any test property, just define that property. It replaces the
|
||||
// original property, not augmenting it.
|
||||
const testOverrides = {
|
||||
"Comments -> Variable Name Collision": {
|
||||
// Can't use variables with exclamation points easily
|
||||
data: {
|
||||
comment: 4
|
||||
}
|
||||
},
|
||||
"Interpolation -> Dotted Names - Arbitrary Depth": {
|
||||
skip: "Not able to use more than one level of depth"
|
||||
},
|
||||
"Interpolation -> Dotted Names - Broken Chain Resolution": {
|
||||
data: {
|
||||
a: {
|
||||
b: "wrong"
|
||||
},
|
||||
name: "Jim"
|
||||
},
|
||||
template: '"{{a.name}}" == ""'
|
||||
},
|
||||
"Interpolation -> Dotted Names - Initial Resolution": {
|
||||
data: {
|
||||
a: {
|
||||
name: "Phil"
|
||||
},
|
||||
name: "Wrong"
|
||||
},
|
||||
template: "\"{{#a}}{{name}}{{/a}}\" == \"Phil\""
|
||||
},
|
||||
"Interpolation -> Implicit Iterators - Ampersand": {
|
||||
skip: "HTML escaping is not supported"
|
||||
},
|
||||
"Interpolation -> Implicit Iterators - Basic Interpolation": {
|
||||
skip: "Can not use {{.}} outside of a loop. Need to use a variable name."
|
||||
},
|
||||
"Interpolation -> Implicit Iterators - Basic Integer Interpolation": {
|
||||
skip: "Can not use {{.}} outside of a loop. Need to use a variable name."
|
||||
},
|
||||
"Interpolation -> Implicit Iterators - Triple Mustache": {
|
||||
skip: "Can not use {{.}} outside of a loop. Need to use a variable name."
|
||||
},
|
||||
"Interpolation -> HTML Escaping": {
|
||||
skip: "HTML escaping is not supported"
|
||||
},
|
||||
"Interpolation -> Implicit Iterators - HTML Escaping": {
|
||||
skip: "HTML escaping is not supported"
|
||||
},
|
||||
"Inverted -> Dotted Names - Falsey": {
|
||||
data: {
|
||||
a: {
|
||||
b: ""
|
||||
}
|
||||
},
|
||||
template: '"{{^a.b}}Not Here{{/a.b}}" == "Not Here"'
|
||||
},
|
||||
"Inverted -> Dotted Names - Truthy": {
|
||||
data: {
|
||||
a: {
|
||||
b: "1"
|
||||
}
|
||||
},
|
||||
template: '"{{^a.b}}Not Here{{/a.b}}" == ""'
|
||||
},
|
||||
"Lambdas -> Escaping": {
|
||||
skip: "HTML escaping is not supported"
|
||||
},
|
||||
"Lambdas -> Interpolation - Alternate Delimiters": {
|
||||
skip: "There is no difference between a lamba used as a value and a lambda used as a block. Both will parse using the current delimiters."
|
||||
},
|
||||
"Lambdas -> Inverted Section": {
|
||||
// This one passed mostly by accident. Correcting so the test still
|
||||
// tests what is was designed to illustrate.
|
||||
data: {
|
||||
static: "static",
|
||||
lambda: {
|
||||
__tag__: 'code',
|
||||
bash: 'false'
|
||||
}
|
||||
}
|
||||
},
|
||||
"Lambdas -> Interpolation": {
|
||||
data: {
|
||||
lambda: {
|
||||
__tag__: 'code',
|
||||
bash: 'echo -n "world"'
|
||||
}
|
||||
}
|
||||
},
|
||||
"Lambdas -> Interpolation - Expansion": {
|
||||
data: {
|
||||
lambda: {
|
||||
__tag__: 'code',
|
||||
bash: 'mo::parse result "{{planet}}"; echo -n "$result"'
|
||||
},
|
||||
planet: 'world'
|
||||
}
|
||||
},
|
||||
"Lambdas -> Interpolation - Multiple Calls": {
|
||||
skip: "Calls are not cached, but they run in isolated environments, so saving a global variable does not work."
|
||||
},
|
||||
"Lambdas -> Section": {
|
||||
data: {
|
||||
lambda: {
|
||||
__tag__: 'code',
|
||||
bash: 'if [[ "$(cat)" == "{{x}}" ]]; then echo -n yes; else echo -n no; fi'
|
||||
},
|
||||
x: "Error!"
|
||||
}
|
||||
},
|
||||
"Lambdas -> Section - Alternate Delimiters": {
|
||||
data: {
|
||||
lambda: {
|
||||
__tag__: 'code',
|
||||
bash: 'local content=$(cat); mo::parse content "$content{{planet}} => |planet|$content"; echo -n "$content"'
|
||||
},
|
||||
planet: 'Earth'
|
||||
}
|
||||
},
|
||||
"Lambdas -> Section - Expansion": {
|
||||
data: {
|
||||
lambda: {
|
||||
__tag__: 'code',
|
||||
bash: 'local content=$(cat); mo::parse content "$content{{planet}}$content"; echo -n "$content"'
|
||||
},
|
||||
planet: "Earth"
|
||||
}
|
||||
},
|
||||
"Lambdas -> Section - Multiple Calls": {
|
||||
data: {
|
||||
lambda: {
|
||||
__tag__: 'code',
|
||||
bash: 'echo -n "__$(cat)__"'
|
||||
}
|
||||
}
|
||||
},
|
||||
"Partials -> Recursion": {
|
||||
skip: "Complex objects are not supported and context is reset to the global level, so the recursion will loop forever"
|
||||
},
|
||||
"Sections -> Deeply Nested Contexts": {
|
||||
skip: "Nested objects are not supported"
|
||||
},
|
||||
"Sections -> Dotted Names - Broken Chains": {
|
||||
// Complex objects are not supported
|
||||
template: `"{{#a.b}}Here{{/a.b}}" == ""`
|
||||
},
|
||||
"Sections -> Dotted Names - Falsey": {
|
||||
// Complex objects are not supported
|
||||
data: { a: { b: false } },
|
||||
template: `"{{#a.b}}Here{{/a.b}}" == ""`
|
||||
},
|
||||
"Sections -> Dotted Names - Truthy": {
|
||||
// Complex objects are not supported
|
||||
data: { a: { b: true } },
|
||||
template: `"{{#a.b}}Here{{/a.b}}" == "Here"`
|
||||
},
|
||||
"Sections -> Implicit Iterator - Array": {
|
||||
skip: "Nested arrays are not supported"
|
||||
},
|
||||
"Sections -> List": {
|
||||
// Arrays of objects are not supported
|
||||
data: { list: [1, 2, 3] },
|
||||
template: `"{{#list}}{{.}}{{/list}}"`
|
||||
},
|
||||
"Sections -> List Context": {
|
||||
skip: "Deeply nested objects are not supported"
|
||||
},
|
||||
"Sections -> List Contexts": {
|
||||
skip: "Deeply nested objects are not supported"
|
||||
}
|
||||
};
|
||||
|
||||
function specFileToName(file) {
|
||||
return file
|
||||
.replace(/.*\//, "")
|
||||
.replace(".json", "")
|
||||
.replace("~", "")
|
||||
.replace(/(^|-)[a-z]/g, function (match) {
|
||||
return match.toUpperCase();
|
||||
});
|
||||
}
|
||||
|
||||
function processArraySequentially(array, callback) {
|
||||
function processCopy() {
|
||||
if (arrayCopy.length) {
|
||||
const item = arrayCopy.shift();
|
||||
return Promise.resolve(item)
|
||||
.then(callback)
|
||||
.then((singleResult) => {
|
||||
result.push(singleResult);
|
||||
|
||||
return processCopy();
|
||||
});
|
||||
} else {
|
||||
return Promise.resolve(result);
|
||||
}
|
||||
}
|
||||
|
||||
const result = [];
|
||||
const arrayCopy = array.slice();
|
||||
|
||||
return processCopy();
|
||||
}
|
||||
|
||||
function debug(...args) {
|
||||
if (process.env.DEBUG) {
|
||||
console.debug(...args);
|
||||
}
|
||||
}
|
||||
|
||||
function makeShellString(value) {
|
||||
if (typeof value === "boolean") {
|
||||
return value ? '"true"' : '""';
|
||||
}
|
||||
|
||||
if (typeof value === "string") {
|
||||
// Newlines are tricky
|
||||
return value
|
||||
.split(/\n/)
|
||||
.map(function (chunk) {
|
||||
return JSON.stringify(chunk);
|
||||
})
|
||||
.join('"\n"');
|
||||
}
|
||||
|
||||
if (typeof value === "number") {
|
||||
return value;
|
||||
}
|
||||
|
||||
return "ERR_CONVERTING";
|
||||
}
|
||||
|
||||
function addToEnvironmentArray(name, value) {
|
||||
const result = ["("];
|
||||
value.forEach(function (subValue) {
|
||||
result.push(makeShellString(subValue));
|
||||
});
|
||||
result.push(")");
|
||||
|
||||
return name + "=" + result.join(" ");
|
||||
}
|
||||
|
||||
function addToEnvironmentObjectConvertedToAssociativeArray(name, value) {
|
||||
const values = [];
|
||||
|
||||
for (const [k, v] of Object.entries(value)) {
|
||||
if (typeof v === "object") {
|
||||
if (v) {
|
||||
// An object - abort
|
||||
return `# ${name}.${k} is an object that can not be converted to an associative array`;
|
||||
}
|
||||
|
||||
// null
|
||||
values.push(`[${k}]=`);
|
||||
} else {
|
||||
values.push(`[${k}]=${makeShellString(v)}`);
|
||||
}
|
||||
}
|
||||
|
||||
return `declare -A ${name}\n${name}=(${values.join(" ")})`;
|
||||
}
|
||||
|
||||
function addToEnvironmentObject(name, value) {
|
||||
if (!value) {
|
||||
// null
|
||||
return `#${name} is null`;
|
||||
}
|
||||
|
||||
if (value.__tag__ === "code") {
|
||||
return `${name}() { ${value.bash || 'echo "NO BASH VERSION OF CODE"'}; }`;
|
||||
}
|
||||
|
||||
return addToEnvironmentObjectConvertedToAssociativeArray(name, value);
|
||||
}
|
||||
|
||||
function addToEnvironment(name, value) {
|
||||
if (Array.isArray(value)) {
|
||||
return addToEnvironmentArray(name, value);
|
||||
}
|
||||
|
||||
if (typeof value === "object") {
|
||||
return addToEnvironmentObject(name, value);
|
||||
}
|
||||
|
||||
return `${name}=${makeShellString(value)}`;
|
||||
}
|
||||
|
||||
function buildScript(test) {
|
||||
const script = ["#!/usr/bin/env bash"];
|
||||
Object.keys(test.data).forEach(function (name) {
|
||||
script.push(addToEnvironment(name, test.data[name]));
|
||||
});
|
||||
script.push(". ./mo");
|
||||
script.push("mo spec-runner/spec-template");
|
||||
script.push("");
|
||||
|
||||
return script.join("\n");
|
||||
}
|
||||
|
||||
function writePartials(test) {
|
||||
return processArraySequentially(
|
||||
Object.keys(test.partials),
|
||||
(partialName) => {
|
||||
debug("Writing partial:", partialName);
|
||||
|
||||
return fsPromises.writeFile(
|
||||
"spec-runner/" + partialName,
|
||||
test.partials[partialName]
|
||||
);
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
function setupEnvironment(test) {
|
||||
return cleanup()
|
||||
.then(() => fsPromises.mkdir("spec-runner/"))
|
||||
.then(() =>
|
||||
fsPromises.writeFile("spec-runner/spec-script", test.script)
|
||||
)
|
||||
.then(() =>
|
||||
fsPromises.writeFile("spec-runner/spec-template", test.template)
|
||||
)
|
||||
.then(() => writePartials(test));
|
||||
}
|
||||
|
||||
function executeScript(test) {
|
||||
return new Promise((resolve) => {
|
||||
exec(
|
||||
"bash spec-runner/spec-script 2>&1",
|
||||
{
|
||||
timeout: 2000
|
||||
},
|
||||
(err, stdout) => {
|
||||
if (err) {
|
||||
test.scriptError = err.toString();
|
||||
}
|
||||
|
||||
test.output = stdout;
|
||||
resolve();
|
||||
}
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
function cleanup() {
|
||||
return fsPromises.rm("spec-runner/", { force: true, recursive: true });
|
||||
}
|
||||
|
||||
function detectFailure(test) {
|
||||
if (test.scriptError) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (test.output !== test.expected) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
function showFailureDetails(test) {
|
||||
console.log(`FAILURE: ${test.fullName}`);
|
||||
console.log("");
|
||||
console.log(test.desc);
|
||||
console.log("");
|
||||
console.log(JSON.stringify(test, null, 4));
|
||||
}
|
||||
|
||||
function applyTestOverrides(test) {
|
||||
const overrides = testOverrides[test.fullName];
|
||||
const originals = {};
|
||||
|
||||
if (!overrides) {
|
||||
return;
|
||||
}
|
||||
|
||||
for (const [key, value] of Object.entries(overrides)) {
|
||||
originals[key] = test[key];
|
||||
test[key] = value;
|
||||
}
|
||||
|
||||
test.overridesApplied = true;
|
||||
test.valuesBeforeOverride = originals;
|
||||
}
|
||||
|
||||
function runTest(testSet, test) {
|
||||
test.partials = test.partials || {};
|
||||
test.fullName = `${testSet.name} -> ${test.name}`;
|
||||
applyTestOverrides(test);
|
||||
test.script = buildScript(test);
|
||||
|
||||
if (test.skip) {
|
||||
debug("Skipping test:", test.fullName, `(${test.skip})`);
|
||||
|
||||
return Promise.resolve();
|
||||
}
|
||||
|
||||
debug("Running test:", test.fullName);
|
||||
|
||||
return setupEnvironment(test)
|
||||
.then(() => executeScript(test))
|
||||
.then(cleanup)
|
||||
.then(() => {
|
||||
test.isFailure = detectFailure(test);
|
||||
|
||||
if (test.isFailure) {
|
||||
showFailureDetails(test);
|
||||
} else {
|
||||
debug('Test pass:', test.fullName);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function processSpecFile(filename) {
|
||||
debug("Read spec file:", filename);
|
||||
|
||||
return fsPromises.readFile(filename, "utf8").then((fileContents) => {
|
||||
const testSet = JSON.parse(fileContents);
|
||||
testSet.name = specFileToName(filename);
|
||||
|
||||
return processArraySequentially(testSet.tests, (test) =>
|
||||
runTest(testSet, test)
|
||||
).then(() => {
|
||||
testSet.pass = 0;
|
||||
testSet.fail = 0;
|
||||
testSet.skip = 0;
|
||||
testSet.passOverride = 0;
|
||||
|
||||
for (const test of testSet.tests) {
|
||||
if (test.isFailure) {
|
||||
testSet.fail += 1;
|
||||
} else if (test.skip) {
|
||||
testSet.skip += 1;
|
||||
} else {
|
||||
testSet.pass += 1;
|
||||
|
||||
if (test.overridesApplied) {
|
||||
testSet.passOverride += 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
console.log(
|
||||
`### ${testSet.name} Results = ${testSet.pass} passed (with ${testSet.passOverride} overridden), ${testSet.fail} failed, ${testSet.skip} skipped`
|
||||
);
|
||||
|
||||
return testSet;
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// 0 = node, 1 = script, 2 = file
|
||||
if (process.argv.length < 3) {
|
||||
console.log("Specify one or more JSON spec files on the command line");
|
||||
process.exit();
|
||||
}
|
||||
|
||||
processArraySequentially(process.argv.slice(2), processSpecFile).then(
|
||||
(result) => {
|
||||
console.log("=========================================");
|
||||
console.log("");
|
||||
console.log("Failed Test Summary");
|
||||
console.log("");
|
||||
let pass = 0,
|
||||
fail = 0,
|
||||
skip = 0,
|
||||
total = 0,
|
||||
passOverride = 0;
|
||||
|
||||
for (const testSet of result) {
|
||||
pass += testSet.pass;
|
||||
fail += testSet.fail;
|
||||
skip += testSet.skip;
|
||||
total += testSet.tests.length;
|
||||
passOverride += testSet.passOverride;
|
||||
|
||||
console.log(
|
||||
`* ${testSet.name}: ${testSet.tests.length} total, ${testSet.pass} pass (with ${passOverride} overridden), ${testSet.fail} fail, ${testSet.skip} skip`
|
||||
);
|
||||
|
||||
for (const test of testSet.tests) {
|
||||
if (test.isFailure) {
|
||||
console.log(` * Failure: ${test.name}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
console.log("");
|
||||
console.log(
|
||||
`Final result: ${total} total, ${pass} pass (with ${passOverride} overridden), ${fail} fail, ${skip} skip`
|
||||
);
|
||||
|
||||
if (fail) {
|
||||
process.exit(1);
|
||||
}
|
||||
},
|
||||
(err) => {
|
||||
console.error(err);
|
||||
console.error("FAILURE RUNNING SCRIPT");
|
||||
console.error("Testing artifacts are left in script-runner/ folder");
|
||||
}
|
||||
);
|
||||
162
run-tests
Executable file
162
run-tests
Executable file
@ -0,0 +1,162 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Run one or more tests.
|
||||
#
|
||||
# Command-line usage to run all tests.
|
||||
#
|
||||
# ./run-tests
|
||||
#
|
||||
# To run only one test, run "tests/test-name".
|
||||
#
|
||||
# Usage within a test as a template. Source run-tests to get functions, export
|
||||
# any necessary variables, then call runTest.
|
||||
#
|
||||
# #!/usr/bin/env bash
|
||||
# cd "${0%/*}" || exit 1
|
||||
# . ../run-tests
|
||||
#
|
||||
# export template="This is a template"
|
||||
# export expected="This is a template"
|
||||
# runTest
|
||||
#
|
||||
# When used within the test, you control various aspects with environment
|
||||
# variables or functions.
|
||||
#
|
||||
# - The content passed into mo is either the variable "$template" or the output
|
||||
# of the function called template.
|
||||
# - The expected result is either "$expected" or the function called expected.
|
||||
# - The expected return code is "$returnCode" and defaults to 0.
|
||||
# - The arguments to pass to mo is the array "${arguments[@]}" and defaults to ().
|
||||
#
|
||||
# When $MO_DEBUG is set to a non-empty value, the test does not run, but mo is
|
||||
# simply executed directly. This allows for calling mo in the same manner as
|
||||
# the test but does not buffer output nor expect the output to match the
|
||||
# expected.
|
||||
#
|
||||
# When $MO_DEBUG_TEST is set to a non-empty value, the expected and actual
|
||||
# results are shown using "declare -p" to provide an easier time seeing the
|
||||
# differences, especially with whitespace.
|
||||
|
||||
testCase() {
|
||||
echo "Input: $1"
|
||||
echo "Expected: $2"
|
||||
}
|
||||
|
||||
indirect() {
|
||||
unset -v "$1"
|
||||
printf -v "$1" '%s' "$2"
|
||||
}
|
||||
|
||||
getValue() {
|
||||
local name temp len hardSpace
|
||||
|
||||
name=$2
|
||||
hardSpace=" "
|
||||
|
||||
if declare -f "$name" &> /dev/null; then
|
||||
temp=$("$name"; echo -n "$hardSpace")
|
||||
len=$((${#temp} - 1))
|
||||
|
||||
if [[ "${temp:$len}" == "$hardSpace" ]]; then
|
||||
temp=${temp:0:$len}
|
||||
fi
|
||||
else
|
||||
temp=${!name}
|
||||
fi
|
||||
|
||||
local "$1" && indirect "$1" "$temp"
|
||||
}
|
||||
|
||||
runTest() (
|
||||
local testTemplate testExpected testActual hardSpace len testReturnCode testFail
|
||||
|
||||
hardSpace=" "
|
||||
. ../mo
|
||||
|
||||
getValue testTemplate template
|
||||
getValue testExpected expected
|
||||
|
||||
if [[ -n "${MO_DEBUG:-}" ]]; then
|
||||
echo -n "$testTemplate" | mo ${arguments[@]+"${arguments[@]}"} 2>&1
|
||||
|
||||
return $?
|
||||
fi
|
||||
|
||||
testActual=$(echo -n "$testTemplate" | mo ${arguments[@]+"${arguments[@]}"} 2>&1; echo -n "$hardSpace$?")
|
||||
testReturnCode=${testActual##*$hardSpace}
|
||||
testActual=${testActual%$hardSpace*}
|
||||
testFail=false
|
||||
|
||||
if [[ "$testActual" != "$testExpected" ]]; then
|
||||
echo "Failure"
|
||||
echo "Expected:"
|
||||
echo "$testExpected"
|
||||
echo "Actual:"
|
||||
echo "$testActual"
|
||||
|
||||
if [[ -n "${MO_DEBUG_TEST-}" ]]; then
|
||||
declare -p testExpected
|
||||
# Align the two declare outputs
|
||||
echo -n " "
|
||||
declare -p testActual
|
||||
fi
|
||||
|
||||
testFail=true
|
||||
fi
|
||||
|
||||
if [[ "$testReturnCode" != "$returnCode" ]]; then
|
||||
echo "Expected return code $returnCode, but got $testReturnCode"
|
||||
testFail=true
|
||||
fi
|
||||
|
||||
if [[ "$testFail" == "true" ]]; then
|
||||
return 1
|
||||
fi
|
||||
|
||||
return 0
|
||||
)
|
||||
|
||||
runTestFile() (
|
||||
local file=$1
|
||||
|
||||
echo "Test: $file"
|
||||
"$file"
|
||||
)
|
||||
|
||||
runTests() (
|
||||
PASS=0
|
||||
FAIL=0
|
||||
|
||||
if [[ $# -gt 0 ]]; then
|
||||
for TEST in "$@"; do
|
||||
runTestFile "$TEST" && PASS=$((PASS + 1)) || FAIL=$((FAIL + 1))
|
||||
done
|
||||
else
|
||||
cd "${0%/*}"
|
||||
for TEST in tests/*; do
|
||||
if [[ -f "$TEST" ]]; then
|
||||
runTestFile "$TEST" && PASS=$((PASS + 1)) || FAIL=$((FAIL + 1))
|
||||
fi
|
||||
done
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "Pass: $PASS"
|
||||
echo "Fail: $FAIL"
|
||||
|
||||
if [[ $FAIL -gt 0 ]]; then
|
||||
exit 1
|
||||
fi
|
||||
)
|
||||
|
||||
# Clear test related variables
|
||||
template="Template not defined"
|
||||
expected="Expected not defined"
|
||||
returnCode=0
|
||||
arguments=()
|
||||
|
||||
# If sourced, load functions.
|
||||
# If executed, perform the actions as expected.
|
||||
if [[ "$0" == "${BASH_SOURCE[0]}" ]] || [[ -z "${BASH_SOURCE[0]}" ]]; then
|
||||
runTests ${@+"${@}"}
|
||||
fi
|
||||
9
tests/ampersand
Executable file
9
tests/ampersand
Executable file
@ -0,0 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export thing="Works"
|
||||
export template="{{&thing}}"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
21
tests/array
Executable file
21
tests/array
Executable file
@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export repo=( "resque" "hub" "rip" )
|
||||
template() {
|
||||
cat <<EOF
|
||||
{{#repo}}
|
||||
<b>{{@key}} - {{.}}</b>
|
||||
{{/repo}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
<b>0 - resque</b>
|
||||
<b>1 - hub</b>
|
||||
<b>2 - rip</b>
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
25
tests/assoc-array
Executable file
25
tests/assoc-array
Executable file
@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
declare -A repo
|
||||
# The order of the array elements can be shuffled depending on the version of
|
||||
# Bash. Keeping this to a minimal set and alphabetized seems to help.
|
||||
repo[hub]="Hub"
|
||||
repo[rip]="Rip"
|
||||
export repo
|
||||
template() {
|
||||
cat <<EOF
|
||||
{{#repo}}
|
||||
<b>{{@key}} - {{.}}</b>
|
||||
{{/repo}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
<b>hub - Hub</b>
|
||||
<b>rip - Rip</b>
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
8
tests/comment
Executable file
8
tests/comment
Executable file
@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export template="Wor{{!comment}}ks"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
15
tests/comment-newline
Executable file
15
tests/comment-newline
Executable file
@ -0,0 +1,15 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
template() {
|
||||
cat <<EOF
|
||||
<h1>Today{{! ignore me
|
||||
and this can
|
||||
run through multiple
|
||||
lines}}.</h1>
|
||||
EOF
|
||||
}
|
||||
export expected=$'<h1>Today.</h1>\n'
|
||||
|
||||
runTest
|
||||
8
tests/comment-with-spaces
Executable file
8
tests/comment-with-spaces
Executable file
@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export template="Wor{{! comment }}ks"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
10
tests/concatenated-variables
Executable file
10
tests/concatenated-variables
Executable file
@ -0,0 +1,10 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export thing="Wor"
|
||||
export thing2="ks"
|
||||
export template="{{thing thing2}}"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
9
tests/delimiters
Executable file
9
tests/delimiters
Executable file
@ -0,0 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export thing="Works"
|
||||
export template="{{=| |=}}|thing|"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
10
tests/double-hyphen
Executable file
10
tests/double-hyphen
Executable file
@ -0,0 +1,10 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export arguments=(--fail-on-file -- --help)
|
||||
export returnCode=1
|
||||
export template=""
|
||||
export expected=$'ERROR: No such file: --help\n'
|
||||
|
||||
runTest
|
||||
8
tests/double-quote
Executable file
8
tests/double-quote
Executable file
@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export template='{{"Works"}}'
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
20
tests/fail-not-set
Executable file
20
tests/fail-not-set
Executable file
@ -0,0 +1,20 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
unset __NO_SUCH_VAR
|
||||
export POPULATED="words"
|
||||
export EMPTY=""
|
||||
export arguments=(--fail-not-set)
|
||||
export returnCode=1
|
||||
|
||||
template() {
|
||||
cat <<EOF
|
||||
Populated: {{POPULATED}};
|
||||
Empty: {{EMPTY}};
|
||||
Unset: {{__NO_SUCH_VAR}};
|
||||
EOF
|
||||
}
|
||||
export expected=$'ERROR: Environment variable not set: __NO_SUCH_VAR\n'
|
||||
|
||||
runTest
|
||||
13
tests/fail-on-function
Executable file
13
tests/fail-on-function
Executable file
@ -0,0 +1,13 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
failFunction() {
|
||||
false
|
||||
}
|
||||
export arguments=(--fail-on-function)
|
||||
export returnCode=1
|
||||
export template="Fail on function? {{failFunction}}"
|
||||
export expected=$'ERROR: Function failed with status code 1: "failFunction"\n'
|
||||
|
||||
runTest
|
||||
18
tests/false-is-empty-arg
Executable file
18
tests/false-is-empty-arg
Executable file
@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export USER=j.doe
|
||||
export ADMIN=false
|
||||
export arguments=(--false)
|
||||
template() {
|
||||
cat <<EOF
|
||||
The user {{USER}} exists.
|
||||
{{#ADMIN}}
|
||||
WRONG - should not be an admin.
|
||||
{{/ADMIN}}
|
||||
EOF
|
||||
}
|
||||
export expected=$'The user j.doe exists.\n'
|
||||
|
||||
runTest
|
||||
18
tests/false-is-empty-env
Executable file
18
tests/false-is-empty-env
Executable file
@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export USER=j.doe
|
||||
export ADMIN=false
|
||||
MO_FALSE_IS_EMPTY=yeppers
|
||||
template() {
|
||||
cat <<EOF
|
||||
The user {{USER}} exists.
|
||||
{{#ADMIN}}
|
||||
WRONG - should not be an admin.
|
||||
{{/ADMIN}}
|
||||
EOF
|
||||
}
|
||||
export expected=$'The user j.doe exists.\n'
|
||||
|
||||
runTest
|
||||
16
tests/false-list
Executable file
16
tests/false-list
Executable file
@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export person=""
|
||||
template() {
|
||||
cat <<EOF
|
||||
Shown.
|
||||
{{#person}}
|
||||
Never shown!
|
||||
{{/person}}
|
||||
EOF
|
||||
}
|
||||
export expected=$'Shown.\n'
|
||||
|
||||
runTest
|
||||
2
tests/fixtures/indented-partials.partial
vendored
Normal file
2
tests/fixtures/indented-partials.partial
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
first line
|
||||
second line
|
||||
2
tests/fixtures/inline-indentation
vendored
Normal file
2
tests/fixtures/inline-indentation
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
>
|
||||
>
|
||||
1
tests/fixtures/multi-line-partial.partial
vendored
Normal file
1
tests/fixtures/multi-line-partial.partial
vendored
Normal file
@ -0,0 +1 @@
|
||||
{{multilineData}}
|
||||
1
tests/fixtures/partial.partial
vendored
Normal file
1
tests/fixtures/partial.partial
vendored
Normal file
@ -0,0 +1 @@
|
||||
<strong>{{.}}</strong>
|
||||
2
tests/fixtures/source-multiple-1.vars
vendored
Normal file
2
tests/fixtures/source-multiple-1.vars
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
export A=from1
|
||||
export B=from1
|
||||
2
tests/fixtures/source-multiple-2.vars
vendored
Normal file
2
tests/fixtures/source-multiple-2.vars
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
export B=from2
|
||||
export C=from2
|
||||
5
tests/fixtures/source.vars
vendored
Normal file
5
tests/fixtures/source.vars
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
export VAR=value
|
||||
export ARR=(1 2 3)
|
||||
declare -A ASSOC_ARR
|
||||
# Can not export associative arrays, otherwise they turn into indexed arrays
|
||||
ASSOC_ARR=([a]=AAA [b]=BBB)
|
||||
3
tests/fixtures/standalone-indentation.partial
vendored
Normal file
3
tests/fixtures/standalone-indentation.partial
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
|
|
||||
{{content}}
|
||||
|
|
||||
25
tests/function
Executable file
25
tests/function
Executable file
@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export name=Willy
|
||||
wrapped() {
|
||||
# Wrapping 'cat' in a subshell eats the trailing whitespace
|
||||
# The echo adds a newline, which is preserved.
|
||||
echo "<b>$(cat)</b>"
|
||||
}
|
||||
template() {
|
||||
cat <<EOF
|
||||
{{#wrapped}}
|
||||
{{name}} is awesome.
|
||||
{{/wrapped}}
|
||||
... this is the last line.
|
||||
EOF
|
||||
}
|
||||
|
||||
# We don't expect {{name}} to be changed. The function returns whatever content
|
||||
# that should be the result. There is a separate test where the function handles
|
||||
# parsing mustache tags.
|
||||
export expected=$'<b> {{name}} is awesome.</b>\n... this is the last line.\n'
|
||||
|
||||
runTest
|
||||
16
tests/function-alternate-delimiters
Executable file
16
tests/function-alternate-delimiters
Executable file
@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export planet=Earth
|
||||
lambda() {
|
||||
local content
|
||||
|
||||
content=$(cat)
|
||||
mo::parse content "$content{{planet}} => |planet|$content"
|
||||
echo -n "$content"
|
||||
}
|
||||
export template="{{= | | =}}<|#lambda|-|/lambda|>"
|
||||
export expected="<-{{planet}} => Earth->"
|
||||
|
||||
runTest
|
||||
35
tests/function-args
Executable file
35
tests/function-args
Executable file
@ -0,0 +1,35 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export name=Willy
|
||||
MO_ALLOW_FUNCTION_ARGUMENTS=true
|
||||
|
||||
pipeTo() {
|
||||
cat | "$1"
|
||||
}
|
||||
|
||||
testArgs() {
|
||||
printf "%d" "$#"
|
||||
|
||||
# Display all arguments
|
||||
printf " %q" ${@+"$@"}
|
||||
}
|
||||
template() {
|
||||
cat <<EOF
|
||||
No args: {{testArgs}} - done
|
||||
One arg: {{testArgs 'one'}} - done
|
||||
Getting name in a string: {{testArgs {"The name is " name}}} - done
|
||||
Reverse this: {{#pipeTo "rev"}}abcde{{/pipeTo "rev"}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
No args: 0 '' - done
|
||||
One arg: 1 one - done
|
||||
Getting name in a string: 1 The\ name\ is\ Willy - done
|
||||
Reverse this: edcba
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
42
tests/function-args-read
Executable file
42
tests/function-args-read
Executable file
@ -0,0 +1,42 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
testArgs() {
|
||||
local args
|
||||
# shellcheck disable=SC2031
|
||||
args=$(declare -p MO_FUNCTION_ARGS)
|
||||
|
||||
# The output from declare -p could look like these
|
||||
# declare -a MO_FUNCTION_ARGS=([0]="one")
|
||||
# declare -ax MO_FUNCTION_ARGS='([0]="one")'
|
||||
# Trim leading declare statement and variable name
|
||||
args="${args#*=}"
|
||||
|
||||
# If there are any quotes, remove them. The function arguments will always
|
||||
# be an array.
|
||||
if [[ "${args:0:1}" == "'" ]]; then
|
||||
args=${args#\'}
|
||||
args=${args%\'}
|
||||
fi
|
||||
|
||||
echo -n "$args"
|
||||
}
|
||||
template() {
|
||||
cat <<EOF
|
||||
No args: {{testArgs}} - done
|
||||
One arg: {{testArgs 'one'}} - done
|
||||
Multiple arguments: {{testArgs 'aa' 'bb' 'cc' 'x' "" '!' '{[_.|' }} - done
|
||||
Evil: {{testArgs bla; cat /etc/issue}} - done
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
No args: () - done
|
||||
One arg: ([0]="one") - done
|
||||
Multiple arguments: ([0]="aa" [1]="bb" [2]="cc" [3]="x" [4]="" [5]="!" [6]="{[_.|") - done
|
||||
Evil: ([0]="" [1]="" [2]="") - done
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
28
tests/function-with-more-parsing
Executable file
28
tests/function-with-more-parsing
Executable file
@ -0,0 +1,28 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export name=Willy
|
||||
wrapped() {
|
||||
local content
|
||||
|
||||
# Wrapping 'cat' in a subshell eats the trailing whitespace
|
||||
content="<b>$(cat)</b>"
|
||||
|
||||
# Parse the content using mustache
|
||||
mo::parse content "$content"
|
||||
|
||||
# The echo adds a newline, which is preserved.
|
||||
echo "$content"
|
||||
}
|
||||
template() {
|
||||
cat <<EOF
|
||||
{{#wrapped}}
|
||||
{{name}} is awesome.
|
||||
{{/wrapped}}
|
||||
... this is the last line.
|
||||
EOF
|
||||
}
|
||||
export expected=$'<b> Willy is awesome.</b>\n... this is the last line.\n'
|
||||
|
||||
runTest
|
||||
28
tests/globals-in-loop
Executable file
28
tests/globals-in-loop
Executable file
@ -0,0 +1,28 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export STR=abc
|
||||
export DATA=(111 222)
|
||||
template() {
|
||||
cat <<EOF
|
||||
Issue #7
|
||||
{{STR}}
|
||||
{{#DATA}}
|
||||
Item: {{.}}
|
||||
String: {{STR}}
|
||||
{{/DATA}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
Issue #7
|
||||
abc
|
||||
Item: 111
|
||||
String: abc
|
||||
Item: 222
|
||||
String: abc
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
101
tests/help
Executable file
101
tests/help
Executable file
@ -0,0 +1,101 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export arguments=(--help)
|
||||
expected() {
|
||||
cat <<'EOF'
|
||||
Mo is a mustache template rendering software written in bash. It inserts
|
||||
environment variables into templates.
|
||||
|
||||
Simply put, mo will change {{VARIABLE}} into the value of that
|
||||
environment variable. You can use {{#VARIABLE}}content{{/VARIABLE}} to
|
||||
conditionally display content or iterate over the values of an array.
|
||||
|
||||
Learn more about mustache templates at https://mustache.github.io/
|
||||
|
||||
Simple usage:
|
||||
|
||||
mo [OPTIONS] filenames...
|
||||
|
||||
Options:
|
||||
|
||||
--allow-function-arguments
|
||||
Permit functions to be called with additional arguments. Otherwise,
|
||||
the only way to get access to the arguments is to use the
|
||||
MO_FUNCTION_ARGS environment variable.
|
||||
-d, --debug
|
||||
Enable debug logging to stderr.
|
||||
-u, --fail-not-set
|
||||
Fail upon expansion of an unset variable. Will silently ignore by
|
||||
default. Alternately, set MO_FAIL_ON_UNSET to a non-empty value.
|
||||
-x, --fail-on-function
|
||||
Fail when a function returns a non-zero status code instead of
|
||||
silently ignoring it. Alternately, set MO_FAIL_ON_FUNCTION to a
|
||||
non-empty value.
|
||||
-f, --fail-on-file
|
||||
Fail when a file (from command-line or partial) does not exist.
|
||||
Alternately, set MO_FAIL_ON_FILE to a non-empty value.
|
||||
-e, --false
|
||||
Treat the string "false" as empty for conditionals. Alternately,
|
||||
set MO_FALSE_IS_EMPTY to a non-empty value.
|
||||
-h, --help
|
||||
This message.
|
||||
-s=FILE, --source=FILE
|
||||
Load FILE into the environment before processing templates.
|
||||
Can be used multiple times. The file must be a valid shell script
|
||||
and should only contain variable assignments.
|
||||
-o=DELIM, --open=DELIM
|
||||
Set the opening delimiter. Default is "{{".
|
||||
-c=DELIM, --close=DELIM
|
||||
Set the closing delimiter. Default is "}}".
|
||||
-- Indicate the end of options. All arguments after this will be
|
||||
treated as filenames only. Use when filenames may start with
|
||||
hyphens.
|
||||
|
||||
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.
|
||||
MO_CLOSE_DELIMITER - The string used when closing a tag. Defaults to "}}".
|
||||
Used internally.
|
||||
MO_CLOSE_DELIMITER_DEFAULT - The default value of MO_CLOSE_DELIMITER. Used
|
||||
when resetting the close delimiter, such as when parsing a partial.
|
||||
MO_CURRENT - Variable name to use for ".".
|
||||
MO_DEBUG - When set to a non-empty value, additional debug information is
|
||||
written to stderr.
|
||||
MO_FUNCTION_ARGS - Arguments passed to the function.
|
||||
MO_FAIL_ON_FILE - If a filename from the command-line is missing or a
|
||||
partial does not exist, abort with an error.
|
||||
MO_FAIL_ON_FUNCTION - If a function returns a non-zero status code, abort
|
||||
with an error.
|
||||
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_OPEN_DELIMITER - The string used when opening a tag. Defaults to "{{".
|
||||
Used internally.
|
||||
MO_OPEN_DELIMITER_DEFAULT - The default value of MO_OPEN_DELIMITER. Used
|
||||
when resetting the open delimiter, such as when parsing a partial.
|
||||
MO_ORIGINAL_COMMAND - Used to find the `mo` program in order to generate a
|
||||
help message.
|
||||
MO_PARSED - Content that has made it through the template engine.
|
||||
MO_STANDALONE_CONTENT - The unparsed content that preceeded the current tag.
|
||||
When a standalone tag is encountered, this is checked to see if it only
|
||||
contains whitespace. If this and the whitespace condition after a tag is
|
||||
met, then this will be reset to $'\n'.
|
||||
MO_UNPARSED - Template content yet to make it through the parser.
|
||||
|
||||
Mo is under a MIT style licence with an additional non-advertising clause.
|
||||
See LICENSE.md for the full text.
|
||||
|
||||
This is open source! Please feel free to contribute.
|
||||
|
||||
https://github.com/tests-always-included/mo
|
||||
|
||||
MO_VERSION=3.0.7
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
56
tests/indented-partials
Executable file
56
tests/indented-partials
Executable file
@ -0,0 +1,56 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export thisIsTrue=true
|
||||
template() {
|
||||
cat <<EOF
|
||||
With spacing
|
||||
{{> fixtures/indented-partials.partial}}
|
||||
|
||||
{{> fixtures/indented-partials.partial}}
|
||||
|
||||
Without spacing
|
||||
{{> fixtures/indented-partials.partial}}
|
||||
{{> fixtures/indented-partials.partial}}
|
||||
|
||||
With text
|
||||
{{> fixtures/indented-partials.partial}}
|
||||
text
|
||||
{{> fixtures/indented-partials.partial}}
|
||||
|
||||
In a conditional
|
||||
{{#thisIsTrue}}
|
||||
{{> fixtures/indented-partials.partial}}
|
||||
{{/thisIsTrue}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
With spacing
|
||||
first line
|
||||
second line
|
||||
|
||||
first line
|
||||
second line
|
||||
|
||||
Without spacing
|
||||
first line
|
||||
second line
|
||||
first line
|
||||
second line
|
||||
|
||||
With text
|
||||
first line
|
||||
second line
|
||||
text
|
||||
first line
|
||||
second line
|
||||
|
||||
In a conditional
|
||||
first line
|
||||
second line
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
19
tests/inline-indentation
Executable file
19
tests/inline-indentation
Executable file
@ -0,0 +1,19 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export data="|"
|
||||
template() {
|
||||
cat <<EOF
|
||||
{{data}} {{> fixtures/inline-indentation}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
| >
|
||||
>
|
||||
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
9
tests/internal-whitespace
Executable file
9
tests/internal-whitespace
Executable file
@ -0,0 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export boolean=true
|
||||
export template=$' | {{#boolean}} {{! Important Whitespace }}\n {{/boolean}} | \n'
|
||||
export expected=$' | \n | \n'
|
||||
|
||||
runTest
|
||||
11
tests/invalid-option
Executable file
11
tests/invalid-option
Executable file
@ -0,0 +1,11 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export person=""
|
||||
export template=""
|
||||
export returnCode=1
|
||||
export arguments=(--something)
|
||||
export expected=$'ERROR: Unknown option: --something (See --help for options)\n'
|
||||
|
||||
runTest
|
||||
18
tests/inverted
Executable file
18
tests/inverted
Executable file
@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export repo=()
|
||||
template() {
|
||||
cat <<EOF
|
||||
{{#repo}}
|
||||
<b>{{.}}</b>
|
||||
{{/repo}}
|
||||
{{^repo}}
|
||||
No repos :(
|
||||
{{/repo}}
|
||||
EOF
|
||||
}
|
||||
export expected=$' No repos :(\n'
|
||||
|
||||
runTest
|
||||
9
tests/issue-75
Executable file
9
tests/issue-75
Executable file
@ -0,0 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export uv
|
||||
export template='{{^uv}}OK{{/uv}}{{#uv}}FAIL{{/uv}}'
|
||||
export expected='OK'
|
||||
|
||||
runTest
|
||||
16
tests/list-contexts
Executable file
16
tests/list-contexts
Executable file
@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export a=foo
|
||||
export b=wrong
|
||||
declare -A sec
|
||||
sec=([b]="bar")
|
||||
export sec
|
||||
declare -A c
|
||||
c=([d]="baz")
|
||||
export c
|
||||
export template="{{#sec}}{{a}} {{b}} {{c.d}}{{/sec}}"
|
||||
export expected="foo bar baz"
|
||||
|
||||
runTest
|
||||
24
tests/miss
Executable file
24
tests/miss
Executable file
@ -0,0 +1,24 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export name="Chris"
|
||||
export company="<b>GitHub</b>"
|
||||
template() {
|
||||
cat <<EOF
|
||||
* .{{name}}.
|
||||
* .{{age}}.
|
||||
* .{{company}}.
|
||||
* .{{{company}}}.
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
* .Chris.
|
||||
* ..
|
||||
* .<b>GitHub</b>.
|
||||
* .<b>GitHub</b>.
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
35
tests/multi-line-partial
Executable file
35
tests/multi-line-partial
Executable file
@ -0,0 +1,35 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export multilineData=$'line 1\nline 2'
|
||||
template() {
|
||||
cat <<EOF
|
||||
Partial:
|
||||
|
||||
{{> fixtures/multi-line-partial.partial}}
|
||||
|
||||
Indented:
|
||||
|
||||
{{> fixtures/multi-line-partial.partial}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
Partial:
|
||||
|
||||
line 1
|
||||
line 2
|
||||
|
||||
Indented:
|
||||
|
||||
line 1
|
||||
line 2
|
||||
EOF
|
||||
# This one looks odd, but if you check the spec spec/specs/partials.yaml,
|
||||
# name "Standalone Indentation" (mirrors "standalone-indentation" in
|
||||
# tests/), then the spec clearly shows that the indentation is applied
|
||||
# before rendering.
|
||||
}
|
||||
|
||||
runTest
|
||||
33
tests/mush
Executable file
33
tests/mush
Executable file
@ -0,0 +1,33 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export USER=jwerle
|
||||
export GENDER=male
|
||||
export THING=apple
|
||||
export COLOR=red
|
||||
export PERSON=tobi
|
||||
export ADJECTIVE=cool
|
||||
template() {
|
||||
cat <<EOF
|
||||
{{! this is a comment }}
|
||||
|
||||
{{USER}} is {{GENDER}}
|
||||
{{THING}} is {{COLOR}}
|
||||
{{PERSON}} is {{ADJECTIVE}}
|
||||
{{USER}} is friends with {{PERSON}}
|
||||
{{var}} {{value}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
|
||||
jwerle is male
|
||||
apple is red
|
||||
tobi is cool
|
||||
jwerle is friends with tobi
|
||||
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
8
tests/no-content
Executable file
8
tests/no-content
Executable file
@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export template="Works"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
22
tests/partial
Executable file
22
tests/partial
Executable file
@ -0,0 +1,22 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export names=( "Tyler" "Abc" )
|
||||
template() {
|
||||
cat <<EOF
|
||||
<h2>Names</h2>
|
||||
{{#names}}
|
||||
{{> fixtures/partial.partial}}
|
||||
{{/names}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
<h2>Names</h2>
|
||||
<strong>Tyler</strong>
|
||||
<strong>Abc</strong>
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
9
tests/partial-bad-file
Executable file
9
tests/partial-bad-file
Executable file
@ -0,0 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
# This file intentionally does not exist
|
||||
export template="{{>fixtures/partial-bad-file.partial}}"
|
||||
export expected=""
|
||||
|
||||
runTest
|
||||
19
tests/partial-missing
Executable file
19
tests/partial-missing
Executable file
@ -0,0 +1,19 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export returnCode=1
|
||||
export arguments=(--fail-on-file)
|
||||
export person=""
|
||||
template() {
|
||||
cat <<EOF
|
||||
Won't be there: {{> fixtures/partial-missing.partial}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
ERROR: No such file: partial-missing.partial
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
8
tests/single-quote
Executable file
8
tests/single-quote
Executable file
@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export template="{{'Works'}}"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
9
tests/single-variable-replacement
Executable file
9
tests/single-variable-replacement
Executable file
@ -0,0 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export thing="Works"
|
||||
export template="{{thing}}"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
25
tests/source
Executable file
25
tests/source
Executable file
@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export arguments=(--source=fixtures/source.vars)
|
||||
template() {
|
||||
cat <<EOF
|
||||
{{VAR}}
|
||||
{{#ARR}}
|
||||
* {{.}}
|
||||
{{/ARR}}
|
||||
{{ASSOC_ARR.a}} {{ASSOC_ARR.b}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
value
|
||||
* 1
|
||||
* 2
|
||||
* 3
|
||||
AAA BBB
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
10
tests/source-bad-file
Executable file
10
tests/source-bad-file
Executable file
@ -0,0 +1,10 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export arguments=(--source=invalid)
|
||||
export returnCode=1
|
||||
export template="Do not display this"
|
||||
export expected=$'No such file: invalid\n'
|
||||
|
||||
runTest
|
||||
21
tests/source-multiple
Executable file
21
tests/source-multiple
Executable file
@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export arguments=(--source=fixtures/source-multiple-1.vars --source=fixtures/source-multiple-2.vars)
|
||||
template() {
|
||||
cat <<EOF
|
||||
A: {{A}}
|
||||
B: {{B}}
|
||||
C: {{C}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
A: from1
|
||||
B: from2
|
||||
C: from2
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
10
tests/source-no-file
Executable file
10
tests/source-no-file
Executable file
@ -0,0 +1,10 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export arguments=(--source=)
|
||||
export returnCode=1
|
||||
export template="Do not display this"
|
||||
export expected=$'No such file: \n'
|
||||
|
||||
runTest
|
||||
24
tests/standalone-indentation
Executable file
24
tests/standalone-indentation
Executable file
@ -0,0 +1,24 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export content=$'<\n->'
|
||||
template() {
|
||||
cat <<'EOF'
|
||||
\
|
||||
{{>fixtures/standalone-indentation.partial}}
|
||||
/
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<'EOF'
|
||||
\
|
||||
|
|
||||
<
|
||||
->
|
||||
|
|
||||
/
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
9
tests/triple-brace
Executable file
9
tests/triple-brace
Executable file
@ -0,0 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export thing="Works"
|
||||
export template="{{{thing}}}"
|
||||
export expected="Works"
|
||||
|
||||
runTest
|
||||
26
tests/typical
Executable file
26
tests/typical
Executable file
@ -0,0 +1,26 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export NAME="Chris"
|
||||
export VALUE=10000
|
||||
export TAXED_VALUE=6000
|
||||
export IN_CA=true
|
||||
template() {
|
||||
cat <<EOF
|
||||
Hello {{NAME}}
|
||||
You have just won {{VALUE}} dollars!
|
||||
{{#IN_CA}}
|
||||
Well, {{TAXED_VALUE}} dollars, after taxes.
|
||||
{{/IN_CA}}
|
||||
EOF
|
||||
}
|
||||
expected() {
|
||||
cat <<EOF
|
||||
Hello Chris
|
||||
You have just won 10000 dollars!
|
||||
Well, 6000 dollars, after taxes.
|
||||
EOF
|
||||
}
|
||||
|
||||
runTest
|
||||
10
tests/unbound-variable
Executable file
10
tests/unbound-variable
Executable file
@ -0,0 +1,10 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
declare -A a
|
||||
export a=()
|
||||
export template="o{{#a.b}}WRONG{{/a.b}}k"
|
||||
export expected="ok"
|
||||
|
||||
runTest
|
||||
9
tests/variable
Executable file
9
tests/variable
Executable file
@ -0,0 +1,9 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export foo=bar
|
||||
export template="{{#foo}}{{.}} is {{foo}}{{/foo}}"
|
||||
export expected="bar is bar"
|
||||
|
||||
runTest
|
||||
53
tests/variable-braces-and-parenthesis
Executable file
53
tests/variable-braces-and-parenthesis
Executable file
@ -0,0 +1,53 @@
|
||||
#!/usr/bin/env bash
|
||||
cd "${0%/*}" || exit 1
|
||||
. ../run-tests
|
||||
|
||||
export array=("wrong0" "item1" "wrong2")
|
||||
export index=1
|
||||
|
||||
# Example #8 is weird because of how the variable name is parsed. Considering
|
||||
# it's an edge case when a user probably has a bug in a template, I think we're
|
||||
# good leaving it as-is until a bug report is filed.
|
||||
|
||||
template() {
|
||||
cat <<'EOF'
|
||||
Starting point:
|
||||
1 "{{ array.1 }}" = "item1"
|
||||
|
||||
Whole expression:
|
||||
2 "{{ {'array.' index} }}" = "array.1"
|
||||
3 "{{ ('array.' index) }}" = "item1"
|
||||
|
||||
Partial expression:
|
||||
4 "{{ 'array.' {index} }}" = "array.1"
|
||||
5 "{{ 'array.' (index) }}" = "array."
|
||||
|
||||
Combined:
|
||||
6 "{{ {'array.' {index}} }}" = "array.1"
|
||||
7 "{{ {'array.' (index)} }}" = "array."
|
||||
8 "{{ ('array.' (index)) }}" = "wrong0,item1,wrong2"
|
||||
9 "{{ ('array.' {index}) }}" = "item1"
|
||||
EOF
|
||||
}
|
||||
|
||||
expected() {
|
||||
cat <<'EOF'
|
||||
Starting point:
|
||||
1 "item1" = "item1"
|
||||
|
||||
Whole expression:
|
||||
2 "array.1" = "array.1"
|
||||
3 "item1" = "item1"
|
||||
|
||||
Partial expression:
|
||||
4 "array.1" = "array.1"
|
||||
5 "array." = "array."
|
||||
|
||||
Combined:
|
||||
6 "array.1" = "array.1"
|
||||
7 "array." = "array."
|
||||
8 "wrong0,item1,wrong2" = "wrong0,item1,wrong2"
|
||||
9 "item1" = "item1"
|
||||
EOF
|
||||
}
|
||||
runTest
|
||||
Loading…
Reference in New Issue
Block a user