fix: More specific error on bare key with '!' and similar characters

This also fixes some other stuff

Author: hyperupcall

pkg/lib/cmd/bash-toml.sh

@@ -1,12 +1,5 @@
 # shellcheck shell=bash
 
-if [ -n "${DEBUG+x}" ]; then
-trap 'bash_toml.trap_error' 'ERR'
-bash_toml.trap_error() {
-bash_toml.debug
-}
-fi
-
 for f in "$BASH_TOML_LIB_DIR"/util/?*.sh; do
 # shellcheck disable=SC1090
 source "$f"

pkg/lib/commands/parse.sh

@@ -6,7 +6,7 @@ bash_toml.do_parse() {
 
 declare char=
 declare mode='MODE_DEFAULT'
-declare -i PARSER_LINE_NUMBER=0
+declare -i PARSER_LINE_NUMBER=1
 declare -i PARSER_COLUMN_NUMBER=0
 
 while IFS= read -rn 1 char; do
@@ -78,7 +78,7 @@ bash_toml.do_parse() {
 bash_toml.parse_fail 'KEY_INVALID'
 return 1
 else
-bash_toml.parse_fail 'UNEXPECTED_BRANCH'
+bash_toml.parse_fail 'UNEXPECTED_CHARACTER' "Char '$char' is not valid in toml bare keys"
 return 1
 fi
 ;;

pkg/lib/util/util.sh

@@ -10,14 +10,14 @@ declare -gA BASH_TOML_ERRORS=(
 [VALUE_STRING_INVALID]='The value was not valid'
 )
 
-declare -a token_history=()
+declare -a BASH_TOKEN_HISTORY=()
 
 # @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"
+printf -v str '%s' "$mode ($char) at $PARSER_LINE_NUMBER:$PARSER_COLUMN_NUMBER"
 
-token_history+=("$str")
+BASH_TOKEN_HISTORY+=("$str")
 
 if [ -n "${DEBUG_BASH_TOML+x}" ]; then
 if [ -n "${BATS_RUN_TMPDIR+x}" ]; then
@@ -32,6 +32,10 @@ bash_toml.parse_fail() {
 local error_key="$1"
 local error_context="$2"
 
+if [ -z "$error_context" ]; then
+error_context="<empty>"
+fi
+
 local error_message="${BASH_TOML_ERRORS["$error_key"]}"
 
 local error_output=
@@ -41,8 +45,8 @@ bash_toml.parse_fail() {
  -> context: %s
  -> history:' "$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"
+for history_item in "${BASH_TOKEN_HISTORY[@]}"; do
+printf -v error_output '%s\n - %s' "$error_output" "$history_item"
 done
 
 if [ "$TOML_MANUAL_ERROR" = yes ]; then

tests/equals.bats

@@ -0,0 +1,12 @@
+#!/usr/bin/env bats
+
+load './util/init.sh'
+
+@test "fails on invalid key 4" {
+run bash_toml.do_parse <<-"EOF"
+fox=
+EOF
+
+assert_failure
+assert_output -p 'VALUE_STRING_INVALID'
+}

tests/fail.bats renamed to tests/key-bare.bats

@@ -2,7 +2,7 @@
 
 load './util/init.sh'
 
-@test "fails on incomplete key" {
+@test "fails on invalid bare key" {
 run bash_toml.do_parse <<-"EOF"
 fox
 EOF
@@ -11,7 +11,7 @@ load './util/init.sh'
 assert_output -p 'KEY_INVALID'
 }
 
-@test "fails on incomplete key 2" {
+@test "fails on invalid bare key 2" {
 run bash_toml.do_parse <<-"EOF"
 f ox
 EOF
@@ -20,11 +20,11 @@ load './util/init.sh'
 assert_output -p 'KEY_INVALID'
 }
 
-@test "fails on incomplete key 3" {
+@test "fails on invalid bare key 3" {
 run bash_toml.do_parse <<-"EOF"
-fox=
+f!ox
 EOF
 
 assert_failure
-assert_output -p 'VALUE_STRING_INVALID'
+assert_output -p 'UNEXPECTED_CHARACTER'
 }