fix: Rework error handling

This includes renaming the identifiers of various errors, exclusively using 'bash_toml.parse_fail', and better output of the parser during tests

Author: hyperupcall

linter.sh

@@ -1,9 +1,7 @@
 # shellcheck shell=bash
 
-# TODO: expand to parse_fail
-
 file='./pkg/lib/cmd/bash-toml.sh'
-grep -n -B0 -A1 -e 'bash_toml.die' "$file" \
+grep -n -B0 -A1 -e 'bash_toml.parse_fail' "$file" \
 | grep -vP '(^[0-9]*:|^--$)' \
 | awk '
 BEGIN {

pkg/lib/commands/parse.sh

@@ -11,13 +11,13 @@ bash_toml.do_parse() {
 
 while IFS= read -rn 1 char; do
 if bash_toml.is.newline "$char"; then
-PARSER_LINE_NUMBER+=1
 PARSER_COLUMN_NUMBER=0
+PARSER_LINE_NUMBER+=1
 else
 PARSER_COLUMN_NUMBER+=1
 fi
 
-bash_toml.debug
+bash_toml.token_history_add
 
 case "$mode" in
 # State in which parser starts, and before any given TOML construct
@@ -27,10 +27,10 @@ bash_toml.do_parse() {
 elif bash_toml.is.newline "$char"; then
 :
 elif bash_toml.is.table "$char"; then
-bash_toml.die "Tables are not supported"
+bash_toml.parse_fail 'NOT_IMPLEMENTED' "Tables are not supported"
 return 1
 elif bash_toml.is.double_quote "$char"; then
-bash_toml.die "Quoted keys are not supported"
+bash_toml.parse_fail 'NOT_IMPLEMENTED' "Quoted keys are not supported"
 return 1
 elif bash_toml.is.valid_bare_key_char "$char"; then
 bash_toml.init_key_string "$char"
@@ -46,21 +46,21 @@ bash_toml.do_parse() {
 :
 elif bash_toml.is.newline "$char"; then
 # TODO: not being fired?
-bash_toml.die "Key name found without value 2"
+bash_toml.parse_fail 'KEY_ABSENT' "Key name found without value 2"
 return 1
 elif bash_toml.is.double_quote "$char"; then
-bash_toml.die "Double quote values are not supported"
+bash_toml.parse_fail 'NOT_IMPLEMENTED' "Double quote values are not supported"
 return 1
 mode='MODE_DOUBLEQUOTE_DURING_VALUE'
 bash_toml.init_value_string
 elif bash_toml.is.single_quote "$char"; then
 mode='MODE_SINGLEQUOTE_DURING_VALUE'
 bash_toml.init_value_string
 elif bash_toml.is.empty "$char"; then
-bash_toml.parse_fail 'INCOMPLETE_VALUE_ANY'
+bash_toml.parse_fail 'VALUE_STRING_INVALID'
 return 1
 else
-bash_toml.die "Datetime, Boolean, Float, Integer, Array, Inline Table, etc. etc. Are not supported"
+bash_toml.parse_fail 'NOT_IMPLEMENTED' "Datetime, Boolean, Float, Integer, Array, Inline Table, etc. etc. Are not supported"
 return 1
 fi
 ;;
@@ -70,12 +70,12 @@ bash_toml.do_parse() {
 elif bash_toml.is.equals_sign "$char"; then
 mode='MODE_ANY_BEFORE_VALUE'
 elif bash_toml.is.newline "$char"; then
-bash_toml.die "Key name found without value"
+bash_toml.parse_fail 'KEY_INVALID' "Key name found without value"
 return 1
 elif bash_toml.is.valid_bare_key_char "$char"; then
 bash_toml.append_key_string "$char"
 elif bash_toml.is.empty "$char"; then
-bash_toml.parse_fail 'INCOMPLETE_KEY'
+bash_toml.parse_fail 'KEY_INVALID'
 return 1
 else
 bash_toml.parse_fail 'UNEXPECTED_BRANCH'
@@ -86,10 +86,10 @@ bash_toml.do_parse() {
 if bash_toml.is.equals_sign "$char"; then
 mode="MODE_ANY_BEFORE_VALUE"
 elif bash_toml.is.empty "$char"; then
-bash_toml.die "No equals sign found. End of file reached"
+bash_toml.parse_fail 'UNEXPECTED_CHARACTER' "No equals sign found. End of file reached"
 return 1
 else
-bash_toml.parse_fail 'INVALID_KEY'
+bash_toml.parse_fail 'KEY_INVALID'
 return 1
 fi
 ;;
@@ -103,7 +103,7 @@ bash_toml.do_parse() {
 if bash_toml.is.single_quote "$char"; then
 mode='MODE_ANY_AFTER_VALUE'
 elif bash_toml.is.newline "$char"; then
-bash_toml.die "Newlines are not valid in single quote"
+bash_toml.parse_fail 'VALUE_STRING_INVALID' "Newlines are not valid in single quote"
 return 1
 else
 bash_toml.append_value_string "$char"
@@ -117,7 +117,7 @@ bash_toml.do_parse() {
 elif bash_toml.is.empty "$char"; then
 mode='MODE_DEFAULT'
 else
-bash_toml.die "Newline expected"
+bash_toml.parse_fail 'UNEXPECTED_CHARACTER' "Newline expected"
 return 1
 fi
 ;;
@@ -130,12 +130,12 @@ bash_toml.do_parse() {
 :
 ;;
 MODE_ANY_BEFORE_VALUE)
-bash_toml.die "Key name found without value theta"
+bash_toml.parse_fail 'UNEXPECTED_BRANCH' "Key name found without value theta"
 return 1
 ;;
 MODE_BAREKEY_DURING_KEY)
 # i.g. `keyName`
-bash_toml.die "Key name found without value"
+bash_toml.parse_fail 'UNEXPECTED_BRANCH' "Key name found without value"
 return 1
 ;;
 MODE_EQUALS_BEFORE)

pkg/lib/util/util.sh

@@ -1,70 +1,55 @@
 # shellcheck shell=bash
 
-declare -gA errors=(
-[NOT_IMPLEMENTED]='The feature has not been implemented'
-[UNEXPECTED_BRANCH]='Unaccounted value'
-[INCOMPLETE_KEY]='The key could not completely be parsed'
-[INVALID_KEY]='The key is not valid'
-[INCOMPLETE_VALUE_ANY]='The key did not have a proper value'
+declare -gA BASH_TOML_ERRORS=(
+[NOT_IMPLEMENTED]='TOML feature has not been implemented'
+[UNEXPECTED_BRANCH]='This branch was not supposed to be activated. Please submit an issue'
+[KEY_ABSENT]='Key does not have a value'
+[UNEXPECTED_CHARACTER]='An unexpected character was encountered' # Generalization of any of the following errors
+[KEY_INVALID]='The key is not valid'
+[VALUE_INVALID]='The value could not be parsed'
+[VALUE_STRING_INVALID]='The value was not valid'
 )
 
-bash_toml.debug() {
-if [ -n "${DEBUG+x}" ]; then
-printf '%s\n' "$mode ($char) at $PARSER_LINE_NUMBER:$PARSER_COLUMN_NUMBER"
-fi
-}
+declare -a token_history=()
 
-bash_toml.die() {
-bash_toml.debug >&3
-cat <<-EOF
+# @description Appends to token history for improved error insight
+bash_toml.token_history_add() {
+local str=
+printf -v str '%s\n' "$mode ($char) at $PARSER_LINE_NUMBER:$PARSER_COLUMN_NUMBER"
 
-char: $char
-mode: $mode
-EOF
+token_history+=("$str")
 
-if [ "$TOML_MANUAL_ERROR" = yes ]; then
-TOML_ERROR="$1"
-return 1
-else
-if [[ -n "${NO_COLOR+x}" || $TERM = dumb ]]; then
-printf '%s\n' "Fatal: $1"
+if [ -n "${DEBUG_BASH_TOML+x}" ]; then
+if [ -n "${BATS_RUN_TMPDIR+x}" ]; then
+printf '%s\n' "$str" >&3
 else
-printf '\033[0;31m%s\033[0m\n' "Fatal: $1"
+printf '%s\n' "$str"
 fi
-exit 1
 fi
 }
 
-
-
 bash_toml.parse_fail() {
-bash_toml.debug >&3
-cat <<-EOF
-
-char: $char
-mode: $mode
-EOF
-
 local error_key="$1"
 local error_context="$2"
 
-local error_message="${errors[$error_key]}"
+local error_message="${BASH_TOML_ERRORS["$error_key"]}"
+
+local error_output=
+printf -v error_output 'Failed to parse toml:
+ -> code: %s
+ -> message: %s
+ -> context: %s
+ -> history:' "$error_key" "$error_message" "$error_context"
 
-printf -v error_output 'Failed to parse toml:\n -> code: %s\n -> message: %s\n -> context: %s' "$error_key" "$error_message" "$error_context"
+for history_item in "${token_history[@]}"; do
+printf -v error_output '%s\n - %s\n' "$error_output" "$history_item"
+done
 
 if [ "$TOML_MANUAL_ERROR" = yes ]; then
 TOML_ERROR="$error_output"
 return 1
 else
 printf '%s' "$error_output"
-# if [[ -n "${NO_COLOR+x}" || $TERM = dumb ]]; then
-#	printf '%s\n' "Fatal: $1"
-# else
-#	printf '\033[0;31m%s\033[0m\n' "Fatal: $1"
-# fi
 exit 1
 fi
-
-
-
 }

tests/fail.bats

@@ -8,7 +8,7 @@ load './util/init.sh'
 EOF
 
 assert_failure
-assert_output -p 'INCOMPLETE_KEY'
+assert_output -p 'KEY_INVALID'
 }
 
 @test "fails on incomplete key 2" {
@@ -17,7 +17,7 @@ load './util/init.sh'
 EOF
 
 assert_failure
-assert_output -p 'INVALID_KEY'
+assert_output -p 'KEY_INVALID'
 }
 
 @test "fails on incomplete key 3" {
@@ -26,5 +26,5 @@ load './util/init.sh'
 EOF
 
 assert_failure
-assert_output -p 'INCOMPLETE_VALUE_ANY'
+assert_output -p 'VALUE_STRING_INVALID'
 }