tonydamage/nux-env
1
1
Fork 0
mirror of https://github.com/tonydamage/nux-env.git synced 2025-12-11 13:24:28 +01:00
Code Issues 19 Releases Wiki Activity

Added skeleton of new library functions.

Browse source 
Signed-off-by: Tony Tkacik <tonydamage@gmail.com>
This commit is contained in:
Tony Tkáčik 2017-06-19 16:02:26 +02:00
parent e7bb96f730
commit ff4e509d1c
4 changed files with 249 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

107
inc/nux.json.inc.sh Normal file
View file

@ -0,0 +1,107 @@
## #nux.json NUX Script JSON Helper library
##
## #Public functions
## nux.json.start
## Starts operation on new JSON. Resets write operations stack and JSON
## source file to empty (useful for creating JSON from scratch.)
function nux.json.start {
nux_json_opstack=".";
nux_json_source="-n";
}
## nux.json.open <file>
## Opens JSON File for reading and writing using *nux.json.open* and
## *nux.json.write* commands.
##
## In order to work with empty JSON use *-n* as *file*. This allows
## for creating new JSON from scratch.
##
## NOTE: Open does not reset operation stack. To reset operation stack
## and opened file use *nux.json.start*
function nux.json.open {
local file="$1"
if [ -f $file ]; then
nux_json_source="$file"
fi
}
## nux.json.read <path>
## Reads *path* from currently opened JSON file.
## NOTE: Read does not see changes performed by *nux.json.write* unless
## these changes were flushed using *nux.json.flush*.
function nux.json.read {
local path=".$1";
jq -r "$path" "$nux_json_source";
}
## nux.json.write <path> <value>
## Adds write operation to action stack. Writes are not performed
## immediately, but rather when *nux.json.flush* is invoked.
## This allows for batching of operations or opting out of actually
## modifying file.
function nux.json.write {
local path=".$1";
local value="$2";
nux_json_opstack="${nux_json_opstack} | $path |= \"$value\""
}
## nux.json.flush [<target>]
## Flushes any write operations to specified *target* file.
## If *target* is not specified JSON is outputted to *STDIN*.
##
## NOTE: Flush does not reset operation stack. To reset
## operation stack and opened file use *nux.json.start*
##
function nux.json.flush {
local target="$1"
if [ -n "$target" ]; then
local write_target="$target";
if [ "$nux_json_source" == "$target" ]; then
write_target=$(mktemp $(dirname "$target")/tempXXXXXX.json)
fi
jq -r "$nux_json_opstack" "$nux_json_source" > "$write_target"
if [ "$nux_json_source" == "$target" ]; then
mv -f "$write_target" "$target"
fi
else
jq -r "$nux_json_opstack" "$nux_json_source"
fi
}
## nux.json.shorthands
## Exposes shorthands for writing and reading from JSON file.
## *njw* - nux.json.write
## *njr* - nux.json.read
##
function nux.json.shorthands {
function njw {
nux.json.write "$@"
}
function njr {
nux.json.read "$@"
}
}
## # Usage Notes
##
## ## Operation stack and flush
##
## As mentioned in documentation for *nux.json.flush* write stack
## is not removed, but rather kept alone, separatly from reference
## to open file. This allows for having modification template
## which could be executed on multiple files.
##
## The following example adds meta.author and meta.email
## to every JSON in directory.
##
## *nux.json.start*
## *nux.json.write* meta.author "Tony Tkacik"
## *nux.json.write* meta.email "example@example.com"
## *for* f *in* "*.json";
## *do*
## *nux.json.open* "$f"
## *nux.json.flush* "$f"
## *done*;
##
##