refactor: Rename 'filter' to 'querytree'

Author: hyperupcall

README.md

@@ -59,4 +59,4 @@ bpm install
 - clean up argument parsing?
 - do something with 'is_index_of_array?' (do not allow for using index notation to get keys of objects)
 - set element of the same type that already exists (--overwrite?)
-- filter => query
+- querytree => query

docs/query.md

@@ -1,6 +1,6 @@
 # Query
 
-Queries are modeled from `jq`'s filter mechanism. The featureset compared to `jq` is significantly less
+Queries are modeled from `jq`'s querytree mechanism. The featureset compared to `jq` is significantly less
 
 Both quering modes listed below are are mutually exclusive. By default, the 'simple' method is used by defualt; only if your query contains a `[` will the 'advanced' method be used
 

pkg/lib/parse.sh

@@ -4,7 +4,7 @@
 # object / array access
 # @exitcode 1 Miscellaneous error
 # @exitcode 2 Parsing error
-bash_object.parse_filter() {
+bash_object.parse_querytree() {
 	declare -ga REPLIES=()
 
 	local flag_parser_type=
@@ -18,16 +18,16 @@ bash_object.parse_filter() {
 		shift ;;
 	esac done
 
-	local filter="$1"
+	local querytree="$1"
 
 	if [ "$flag_parser_type" = 'simple' ]; then
-		if [ "${filter::1}" != . ]; then
-			bash_object.util.die 'ERROR_FILTER_INVALID' 'Filter must begin with a dot'
+		if [ "${querytree::1}" != . ]; then
+			bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'Querytree must begin with a dot'
 			return
 		fi
 
 		local old_ifs="$IFS"; IFS=.
-		for key in $filter; do
+		for key in $querytree; do
 			if [ -z "$key" ]; then
 				continue
 			fi
@@ -42,7 +42,7 @@ bash_object.parse_filter() {
 
 		# Append dot so parsing does not fail at end
 		# This makes parsing a lot easier, since it always expects a dot after a ']'
-		filter="${filter}."
+		querytree="${querytree}."
 
 		# Reply represents an accessor (e.g. 'sub_key')
 		local reply=
@@ -59,15 +59,15 @@ bash_object.parse_filter() {
 				if [ "$char" = . ]; then
 					mode='MODE_EXPECTING_BRACKET'
 				else
-					bash_object.util.die 'ERROR_FILTER_INVALID' 'Filter must begin with a dot'
+					bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'Querytree must begin with a dot'
 					return
 				fi
 				;;
 			MODE_BEFORE_DOT)
 				if [ "$char" = . ]; then
 					mode='MODE_EXPECTING_BRACKET'
 				else
-					bash_object.util.die 'ERROR_FILTER_INVALID' 'Each part in a filter must be deliminated by a dot'
+					bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'Each part in a querytree must be deliminated by a dot'
 					return
 				fi
 				;;
@@ -77,7 +77,7 @@ bash_object.parse_filter() {
 				elif [ "$char" = $'\n' ]; then
 					return
 				else
-					bash_object.util.die 'ERROR_FILTER_INVALID' 'A dot MUST be followed by an opening bracket in this mode'
+					bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'A dot MUST be followed by an opening bracket in this mode'
 					return
 				fi
 				;;
@@ -87,7 +87,7 @@ bash_object.parse_filter() {
 				if [ "$char" = \" ]; then
 					mode='MODE_EXPECTING_STRING'
 				elif [ "$char" = ']' ]; then
-					bash_object.util.die 'ERROR_FILTER_INVALID' 'Key cannot be empty'
+					bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'Key cannot be empty'
 					return
 				else
 					case "$char" in
@@ -96,7 +96,7 @@ bash_object.parse_filter() {
 						mode='MODE_EXPECTING_READ_NUMBER'
 						;;
 					*)
-						bash_object.util.die 'ERROR_FILTER_INVALID' 'A number or opening quote must follow an open bracket'
+						bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'A number or opening quote must follow an open bracket'
 						return
 						;;
 					esac
@@ -107,14 +107,14 @@ bash_object.parse_filter() {
 					mode='MODE_STRING_ESCAPE_SEQUENCE'
 				elif [ "$char" = \" ]; then
 					if [ -z "$reply" ]; then
-						bash_object.util.die 'ERROR_FILTER_INVALID' 'Key cannot be empty'
+						bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'Key cannot be empty'
 						return
 					fi
 
 					REPLIES+=("$reply")
 					mode='MODE_EXPECTING_CLOSING_BRACKET'
 				elif [ "$char" = $'\n' ]; then
-					bash_object.util.die 'ERROR_FILTER_INVALID' 'Filter is not complete'
+					bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'Querytree is not complete'
 					return
 				else
 					reply+="$char"
@@ -126,7 +126,7 @@ bash_object.parse_filter() {
 					\") reply+=\" ;;
 					']') reply+=']' ;;
 					*)
-						bash_object.util.die 'ERROR_FILTER_INVALID' "Escape sequence of '$char' not valid"
+						bash_object.util.die 'ERROR_QUERYTREE_INVALID' "Escape sequence of '$char' not valid"
 						return
 						;;
 				esac
@@ -142,7 +142,7 @@ bash_object.parse_filter() {
 						reply+="$char"
 						;;
 					*)
-						bash_object.util.die 'ERROR_FILTER_INVALID' "Expecting number, found '$char'"
+						bash_object.util.die 'ERROR_QUERYTREE_INVALID' "Expecting number, found '$char'"
 						return
 						;;
 					esac
@@ -152,12 +152,12 @@ bash_object.parse_filter() {
 				if [ "$char" = ']' ]; then
 					mode='MODE_BEFORE_DOT'
 				else
-					bash_object.util.die 'ERROR_FILTER_INVALID' 'Expected a closing bracket after the closing quotation mark'
+					bash_object.util.die 'ERROR_QUERYTREE_INVALID' 'Expected a closing bracket after the closing quotation mark'
 					return
 				fi
 				;;
 			esac
-		done <<< "$filter"
+		done <<< "$querytree"
 	else
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Must pass either '--simple' or '--advanced'"
 		return

pkg/lib/traverse-get.sh

@@ -65,19 +65,19 @@ bash_object.traverse-get() {
 
 	local final_value_type="${args[0]}"
 	local root_object_name="${args[1]}"
-	local filter="${args[2]}"
+	local querytree="${args[2]}"
 
 	# Start traversing at the root object
 	local current_object_name="$root_object_name"
 	local -n current_object="$root_object_name"
 
-	# A stack of all the evaluated filter elements
-	local -a filter_stack=()
+	# A stack of all the evaluated querytree elements
+	local -a querytree_stack=()
 
-	# Parse the filter, and recurse over their elements
-	case "$filter" in
-		*']'*) bash_object.parse_filter --advanced "$filter" ;;
-		*) bash_object.parse_filter --simple "$filter" ;;
+	# Parse the querytree, and recurse over their elements
+	case "$querytree" in
+		*']'*) bash_object.parse_querytree --advanced "$querytree" ;;
+		*) bash_object.parse_querytree --simple "$querytree" ;;
 	esac
 	for ((i=0; i<${#REPLIES[@]}; i++)); do
 		local key="${REPLIES[$i]}"
@@ -88,15 +88,15 @@ bash_object.traverse-get() {
 			is_index_of_array='yes'
 		fi
 
-		filter_stack+=("$key")
-		# bash_object.util.generate_filter_stack_string
-		# local filter_stack_string="$REPLY"
+		querytree_stack+=("$key")
+		# bash_object.util.generate_querytree_stack_string
+		# local querytree_stack_string="$REPLY"
 
 		bash_object.trace_loop
 
 		# If 'key' is not a member of object or index of array, error
 		if [ -z "${current_object["$key"]+x}" ]; then
-			bash_object.util.die 'ERROR_NOT_FOUND' "Key or index '$key' (filter index '$i') does not exist"
+			bash_object.util.die 'ERROR_NOT_FOUND' "Key or index '$key' (querytree index '$i') does not exist"
 			return
 		# If 'key' is a member of an object or index of array
 		else
@@ -224,7 +224,7 @@ bash_object.traverse-get() {
 				fi
 
 				if ((i+1 < ${#REPLIES[@]})); then
-					bash_object.util.die 'ERROR_NOT_FOUND' "The passed filter implies that '$key' accesses an object or array, but a string with a value of '$key_value' was found instead"
+					bash_object.util.die 'ERROR_NOT_FOUND' "The passed querytree implies that '$key' accesses an object or array, but a string with a value of '$key_value' was found instead"
 					return
 				elif ((i+1 == ${#REPLIES[@]})); then
 					local value="${current_object["$key"]}"

pkg/lib/traverse-set.sh

@@ -41,7 +41,7 @@ bash_object.traverse-set() {
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "--value not implemented"
 	fi
 
-	local final_value_type root_object_name filter final_value
+	local final_value_type root_object_name querytree final_value
 	# for compat with 'set -u'
 	if [ -n "${args[0]+x}" ]; then
 		final_value_type="${args[0]}"
@@ -50,7 +50,7 @@ bash_object.traverse-set() {
 		root_object_name="${args[1]}"
 	fi
 	if [ -n "${args[2]+x}" ]; then
-		filter="${args[2]}"
+		querytree="${args[2]}"
 	fi
 	if [ -n "${args[3]+x}" ]; then
 		final_value="${args[3]}"
@@ -75,7 +75,7 @@ bash_object.traverse-set() {
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Positional parameter '2' is empty. Please check passed parameters"
 		return
 	fi
-	if [ -z "$filter" ]; then
+	if [ -z "$querytree" ]; then
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Positional parameter '3' is empty. Please check passed parameters"
 		return
 	fi
@@ -141,13 +141,13 @@ bash_object.traverse-set() {
 	local current_object_name="$root_object_name"
 	local -n current_object="$root_object_name"
 
-	# A stack of all the evaluated filter elements
-	local -a filter_stack=()
+	# A stack of all the evaluated querytree elements
+	local -a querytree_stack=()
 
-	# Parse the filter, and recurse over their elements
-	case "$filter" in
-		*']'*) bash_object.parse_filter --advanced "$filter" ;;
-		*) bash_object.parse_filter --simple "$filter" ;;
+	# Parse the querytree, and recurse over their elements
+	case "$querytree" in
+		*']'*) bash_object.parse_querytree --advanced "$querytree" ;;
+		*) bash_object.parse_querytree --simple "$querytree" ;;
 	esac
 	for ((i=0; i<${#REPLIES[@]}; i++)); do
 		local key="${REPLIES[$i]}"
@@ -158,22 +158,22 @@ bash_object.traverse-set() {
 			is_index_of_array='yes'
 		fi
 
-		filter_stack+=("$key")
-		bash_object.util.generate_filter_stack_string
-		local filter_stack_string="$REPLY"
+		querytree_stack+=("$key")
+		bash_object.util.generate_querytree_stack_string
+		local querytree_stack_string="$REPLY"
 
 		bash_object.trace_loop
 
 		# If 'key' is not a member of object or index of array, error
 		if [ -z "${current_object["$key"]+x}" ]; then
 			# If we are before the last element in the query, then error
 			if ((i+1 < ${#REPLIES[@]})); then
-				bash_object.util.die 'ERROR_NOT_FOUND' "Key or index '$key' (filter index '$i') does not exist"
+				bash_object.util.die 'ERROR_NOT_FOUND' "Key or index '$key' (querytree index '$i') does not exist"
 				return
 			# If we are at the last element in the query, and it doesn't exist, create it
 			elif ((i+1 == ${#REPLIES[@]})); then
 				if [ "$final_value_type" = object ]; then
-					bash_object.util.generate_vobject_name "$root_object_name" "$filter_stack_string"
+					bash_object.util.generate_vobject_name "$root_object_name" "$querytree_stack_string"
 					local global_object_name="$REPLY"
 
 					if bash_object.ensure.variable_does_not_exist "$global_object_name"; then :; else
@@ -195,7 +195,7 @@ bash_object.traverse-set() {
 						global_object["$key"]="${object_to_copy_from["$key"]}"
 					done
 				elif [ "$final_value_type" = array ]; then
-					bash_object.util.generate_vobject_name "$root_object_name" "$filter_stack_string"
+					bash_object.util.generate_vobject_name "$root_object_name" "$querytree_stack_string"
 					local global_array_name="$REPLY"
 
 					if bash_object.ensure.variable_does_not_exist "$global_array_name"; then :; else
@@ -337,7 +337,7 @@ bash_object.traverse-set() {
 				fi
 
 				if ((i+1 < ${#REPLIES[@]})); then
-					bash_object.util.die 'ERROR_NOT_FOUND' "The passed filter implies that '$key' accesses an object or array, but a string with a value of '$key_value' was found instead"
+					bash_object.util.die 'ERROR_NOT_FOUND' "The passed querytree implies that '$key' accesses an object or array, but a string with a value of '$key_value' was found instead"
 					return
 				elif ((i+1 == ${#REPLIES[@]})); then
 					if [ "$final_value_type" = object ]; then

pkg/lib/util/util.sh

@@ -10,8 +10,8 @@ declare -gA ERRORS_BASH_OBJECT=(
 	[ERROR_ARGUMENTS_INVALID_TYPE]="The type of the final value specified by the user is neither 'object', 'array', nor 'string'"
 	[ERROR_ARGUMENTS_INCORRECT_TYPE]="The type of the final value does not match that of the actual final value (at end of query string)"
 
-	[ERROR_FILTER_INVALID]="The filter could not be parsed"
-	[ERROR_FILTER_INCORRECT_TYPE]=
+	[ERROR_QUERYTREE_INVALID]="The querytree could not be parsed"
+	[ERROR_QUERYTREE_INCORRECT_TYPE]=
 
 	[ERROR_VOBJ_INVALID_TYPE]="The type of the virtual object is neither 'object' nor 'array'"
 	[ERROR_VOBJ_INCORRECT_TYPE]="The type of the virtual object does not match with the type of the variable it references"
@@ -23,8 +23,8 @@ bash_object.util.die() {
 
 	local error_output=
 	case "$error_key" in
-	ERROR_FILTER_INVALID)
-		printf -v error_output 'Failed to parse filter:
+	ERROR_QUERYTREE_INVALID)
+		printf -v error_output 'Failed to parse querytree:
   -> code: %s
   -> context: %s
   -> PARSER_COLUMN_NUMBER: %s
@@ -58,15 +58,15 @@ bash_object.util.generate_vobject_name() {
 	printf -v REPLY '%q' "__bash_object_${root_object_name}_${root_object_query}_${random_string}"
 }
 
-# @description A stringified version of the filter
+# @description A stringified version of the querytree
 # stack. This is used when generating objects to prevent
 # conflicts
-bash_object.util.generate_filter_stack_string() {
+bash_object.util.generate_querytree_stack_string() {
 	unset REPLY; REPLY=
 
 	local oldIFS="$IFS"
 	IFS='_'
-	REPLY="${filter_stack[*]}"
+	REPLY="${querytree_stack[*]}"
 	IFS="$oldIFS"
 }