fix: Improve error handling in parse and rename fn to 'die'

Author: hyperupcall

README.md

@@ -50,13 +50,12 @@ assert [ "$REPLY" = rho ]
 STATUS: IN DEVELOPMENT!
 
 ```sh
-# With bpm (highly recommended)
-bpm add hyperupcall/bash-object
+echo "dependencies [ 'hyperupcall/bash-object' ]" > 'bpm.toml'
+bpm install
 ```
 
 ## TODO
 - do not auto create tree with set (or add -p flag that does so)
-- test errors on parser fail
 - workshop set-* functions
 - add support for set-object and set-array
 - error on invalid references (`type=object` in virtual object metadata, when it is referencing an array)

pkg/lib/parse.sh

@@ -1,13 +1,12 @@
 # shellcheck shell=bash
 
-# TODO: Error handling
-# TODO: print column and 'mode' in error
-
 # @description Convert a user string into an array representing successive
 # object / array access
 # @exitcode 1 Miscellaneous error
 # @exitcode 2 Parsing error
 bash_object.parse_filter() {
+	declare -ga REPLIES=()
+
 	local flag_parser_type=
 
 	for arg; do
@@ -25,12 +24,10 @@ bash_object.parse_filter() {
 
 	local filter="$1"
 
-	declare -ga REPLIES=()
-
 	if [ "$flag_parser_type" = 'simple' ]; then
 		if [ "${filter::1}" != . ]; then
-			printf '%s\n' "Error: bash-object: Filter must begin with a dot"
-			return 2
+			bash_object.util.die 'ERROR_INVALID_FILTER' 'Filter must begin with a dot'
+			return
 		fi
 
 		local old_ifs="$IFS"; IFS=.
@@ -66,16 +63,16 @@ bash_object.parse_filter() {
 				if [ "$char" = . ]; then
 					mode='MODE_EXPECTING_BRACKET'
 				else
-					printf '%s\n' "Error: bash-object: Filter must begin with a dot"
-					return 2
+					bash_object.util.die 'ERROR_INVALID_FILTER' 'Filter must begin with a dot'
+					return
 				fi
 				;;
 			MODE_BEFORE_DOT)
 				if [ "$char" = . ]; then
 					mode='MODE_EXPECTING_BRACKET'
 				else
-					printf '%s\n' "Error: bash-object: Each part in a filter must be deliminated by a dot"
-					return 2
+					bash_object.util.die 'ERROR_INVALID_FILTER' 'Each part in a filter must be deliminated by a dot'
+					return
 				fi
 				;;
 			MODE_EXPECTING_BRACKET)
@@ -84,8 +81,8 @@ bash_object.parse_filter() {
 				elif [ "$char" = $'\n' ]; then
 					return
 				else
-					printf '%s\n' "Error: bash-object: A dot MUST be followed by an opening bracket in this mode"
-					return 2
+					bash_object.util.die 'ERROR_INVALID_FILTER' 'A dot MUST be followed by an opening bracket in this mode'
+					return
 				fi
 				;;
 			MODE_EXPECTING_OPENING_STRING_OR_NUMBER)
@@ -94,17 +91,17 @@ bash_object.parse_filter() {
 				if [ "$char" = \" ]; then
 					mode='MODE_EXPECTING_STRING'
 				elif [ "$char" = ']' ]; then
-					printf '%s\n' "Error: bash-object: Key cannot be empty"
-					return 2
+					bash_object.util.die 'ERROR_INVALID_FILTER' 'Key cannot be empty'
+					return
 				else
 					case "$char" in
 					0|1|2|3|4|5|6|7|8|9)
 						reply=$'\x1C'"$char"
 						mode='MODE_EXPECTING_READ_NUMBER'
 						;;
 					*)
-						printf '%s\n' "Error: bash-object: A number or opening quote must follow an open bracket"
-						return 2
+						bash_object.util.die 'ERROR_INVALID_FILTER' 'A number or opening quote must follow an open bracket'
+						return
 						;;
 					esac
 				fi
@@ -114,15 +111,15 @@ bash_object.parse_filter() {
 					mode='MODE_STRING_ESCAPE_SEQUENCE'
 				elif [ "$char" = \" ]; then
 					if [ -z "$reply" ]; then
-						printf '%s\n' "Error: bash-object: Key cannot be empty"
-						return 2
+						bash_object.util.die 'ERROR_INVALID_FILTER' 'Key cannot be empty'
+						return
 					fi
 
 					REPLIES+=("$reply")
 					mode='MODE_EXPECTING_CLOSING_BRACKET'
 				elif [ "$char" = $'\n' ]; then
-					printf '%s\n' 'Filter is not complete'
-					return 2
+					bash_object.util.die 'ERROR_INVALID_FILTER' 'Filter is not complete'
+					return
 				else
 					reply+="$char"
 				fi
@@ -133,8 +130,8 @@ bash_object.parse_filter() {
 					\") reply+=\" ;;
 					']') reply+=']' ;;
 					*)
-						printf '%s\n' "Error: bash-object: Escape sequence of '$char' not valid"
-						return 2
+						bash_object.util.die 'ERROR_INVALID_FILTER' "Escape sequence of '$char' not valid"
+						return
 						;;
 				esac
 				mode='MODE_EXPECTING_STRING'
@@ -149,8 +146,8 @@ bash_object.parse_filter() {
 						reply+="$char"
 						;;
 					*)
-						printf '%s\n' "Error: bash-object: Expecting number, found '$char'"
-						return 2
+						bash_object.util.die 'ERROR_INVALID_FILTER' "Expecting number, found '$char'"
+						return
 						;;
 					esac
 				fi
@@ -159,15 +156,15 @@ bash_object.parse_filter() {
 				if [ "$char" = ']' ]; then
 					mode='MODE_BEFORE_DOT'
 				else
-					printf '%s\n' "Error: bash-object: Expected a closing bracket after the closing quotation mark"
-					return 2
+					bash_object.util.die 'ERROR_INVALID_FILTER' 'Expected a closing bracket after the closing quotation mark'
+					return
 				fi
 				;;
 			esac
 		done <<< "$filter"
 	else
-		printf '%s\n' "bash-object: Must choose simple or advanced; no current default established"
-		return 2
+		bash_object.util.die 'ERROR_INVALID_ARGS' "Must pass either '--simple' or '--advanced'"
+		return
 	fi
 }
 

pkg/lib/traverse-get.sh

@@ -65,18 +65,18 @@ bash_object.traverse-get() {
 					# case "$vmd_dtype" in
 					# object)
 					# 	if [ "$is_index_of_array" = yes ]; then
-					# 		bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "Expected object, but reference to array was found"
+					# 		bash_object.util.die 'ERROR_INTERNAL_INVALID_VOBJ' "Expected object, but reference to array was found"
 					# 		return
 					# 	fi
 					# 	;;
 					# array)
 					# 	if [ "$is_index_of_array" = no ]; then
-					# 		bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "Expected array, but reference to object was found"
+					# 		bash_object.util.die 'ERROR_INTERNAL_INVALID_VOBJ' "Expected array, but reference to object was found"
 					# 		return
 					# 	fi
 					# 	;;
 					# *)
-					# 	bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
+					# 	bash_object.util.die 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
 					# 	return
 					# 	;;
 					# esac
@@ -92,18 +92,18 @@ bash_object.traverse-get() {
 							done
 							;;
 						array)
-							bash_object.util.traverse_fail 'ERROR_VALUE_INCORRECT_TYPE' 'Queried for object, but found existing array'
+							bash_object.util.die 'ERROR_VALUE_INCORRECT_TYPE' 'Queried for object, but found existing array'
 							return
 							;;
 						*)
-							bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
+							bash_object.util.die 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
 							return
 							;;
 						esac
 					elif [ "$final_value_type" = array ]; then
 						case "$vmd_dtype" in
 						object)
-							bash_object.util.traverse_fail 'ERROR_VALUE_INCORRECT_TYPE' 'Queried for array, but found existing object'
+							bash_object.util.die 'ERROR_VALUE_INCORRECT_TYPE' 'Queried for array, but found existing object'
 							return
 							;;
 						array)
@@ -112,26 +112,26 @@ bash_object.traverse-get() {
 							REPLY=("${current_object[@]}")
 							;;
 						*)
-							bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
+							bash_object.util.die 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
 							return
 							;;
 						esac
 					elif [ "$final_value_type" = string ]; then
 						case "$vmd_dtype" in
 						object)
-							bash_object.util.traverse_fail 'ERROR_VALUE_INCORRECT_TYPE' 'Queried for string, but found existing object'
+							bash_object.util.die 'ERROR_VALUE_INCORRECT_TYPE' 'Queried for string, but found existing object'
 							return
 							;;
 						array)
-							bash_object.util.traverse_fail 'ERROR_VALUE_INCORRECT_TYPE' 'Queried for string, but found existing array'
+							bash_object.util.die 'ERROR_VALUE_INCORRECT_TYPE' 'Queried for string, but found existing array'
 							return
 							;;
 						*)
-							bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
+							bash_object.util.die 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
 							return
 						esac
 					else
-						bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_PARAM' "final_value_type: $final_value_type"
+						bash_object.util.die 'ERROR_INTERNAL_INVALID_PARAM' "final_value_type: $final_value_type"
 						return
 					fi
 				fi
@@ -150,10 +150,10 @@ bash_object.traverse-get() {
 				elif ((i+1 == ${#REPLIES[@]})); then
 					local value="${current_object["$key"]}"
 					if [ "$final_value_type" = object ]; then
-						bash_object.util.traverse_fail 'ERROR_VALUE_INCORRECT_TYPE' "Queried for object, but found existing string '$value'"
+						bash_object.util.die 'ERROR_VALUE_INCORRECT_TYPE' "Queried for object, but found existing string '$value'"
 						return
 					elif [ "$final_value_type" = array ]; then
-						bash_object.util.traverse_fail 'ERROR_VALUE_INCORRECT_TYPE' "Queried for array, but found existing string '$value'"
+						bash_object.util.die 'ERROR_VALUE_INCORRECT_TYPE' "Queried for array, but found existing string '$value'"
 						return
 					elif [ "$final_value_type" = string ]; then
 						# shellcheck disable=SC2178

pkg/lib/traverse-set.sh

@@ -88,7 +88,7 @@ bash_object.traverse-set() {
 				elif [ "$final_value_type" = string ]; then
 					current_object["$key"]="$final_value"
 				else
-					bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_PARAM' "final_value_type: $final_value_type"
+					bash_object.util.die 'ERROR_INTERNAL_INVALID_PARAM' "final_value_type: $final_value_type"
 					return
 				fi
 			fi
@@ -114,15 +114,15 @@ bash_object.traverse-set() {
 				elif ((i+1 == ${#REPLIES[@]})); then
 					case "$vmd_dtype" in
 						object)
-							bash_object.util.traverse_fail 'ERROR_VALUE_INCORRECT_TYPE' 'Was going to set-string, but found existing object'
+							bash_object.util.die 'ERROR_VALUE_INCORRECT_TYPE' 'Was going to set-string, but found existing object'
 							return
 							;;
 						array)
-							bash_object.util.traverse_fail 'ERROR_VALUE_INCORRECT_TYPE' 'Was going to set-string, but found existing array'
+							bash_object.util.die 'ERROR_VALUE_INCORRECT_TYPE' 'Was going to set-string, but found existing array'
 							return
 							;;
 						*)
-							bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
+							bash_object.util.die 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
 							return
 							;;
 					esac

pkg/lib/util/util.sh

@@ -3,29 +3,40 @@
 declare -gA ERRORS_BASH_OBJECT=(
 	[ERROR_VALUE_NOT_FOUND]='Attempted to access either a member of an object or an index of an array, but the member or index does not exist'
 	[ERROR_VALUE_INCORRECT_TYPE]='Attempted to get or set a value, but somewhere a value with a different type was expected'
+	[ERROR_INVALID_FILTER]='The supplied filter is invalid'
+	[ERROR_INVALID_ARGS]='Invalid arguments'
 	[ERROR_INTERNAL_INVALID_VOBJ]='Internal virtual object has incorrect metadata'
 	[ERROR_INTERNAL_INVALID_PARAM]='Internal parameter has an incorrect value'
+
 )
 
-bash_object.util.traverse_fail() {
+bash_object.util.die() {
 	local error_key="$1"
-	local error_context="$2"
-
-	if [ -z "$error_context" ]; then
-		error_context='<empty>'
-	fi
+	local error_context="${2:-<empty>}"
 
 	local error_message="${ERRORS_BASH_OBJECT["$error_key"]}"
 
 	local error_output=
-	printf -v error_output 'Failed to perform object operation:
+	case "$error_key" in
+	ERROR_INVALID_FILTER)
+		printf -v error_output 'Failed to perform operation:
+  -> code: %s
+  -> message: %s
+  -> context: %s
+  -> PARSER_COLUMN_NUMBER: %s' "$error_key" "$error_message" "$error_context" "$PARSER_COLUMN_NUMBER"
+		;;
+	*)
+		printf -v error_output 'Failed to parse filter:
   -> code: %s
   -> message: %s
   -> context: %s' "$error_key" "$error_message" "$error_context"
+		;;
+	esac
 
 	printf '%s' "$error_output"
 	return 2
 }
+
 # TODO
 stdtrace.log() {
     local level="$1"

tests/parse-filter-advanced.bats

@@ -55,7 +55,7 @@ load './util/init.sh'
 	run bash_object.parse_filter -a '.[""'
 
 	assert_failure
-	assert_line -p "Error: bash-object: Key cannot be empty"
+	assert_line -p "Key cannot be empty"
 }
 
 @test "advanced errors on incomplete 4" {