refactor: Revamp naming

Author: hyperupcall

basalt.toml

@@ -1,6 +1,8 @@
 [package]
+lang = 'bash'
+type = 'lib'
 name = 'bash-toml'
-slug = 'btoml'
+slug = 'bash_toml'
 version = '0.2.0'
 authors = ['Edwin Kofler" <edwin@kofler.dev>']
 description = 'A kickass Toml parser written in pure Bash'

pkg/src/public/bash-toml-quick.sh

@@ -1,12 +1,12 @@
 # shellcheck shell=bash
 
-btoml.quick_string_get() {
-unset REPLY; REPLY=
+bash_toml.quick_string_get() {
+unset -v REPLY; REPLY=
 local toml_file="$1"
 local key_name="$2"
 
 if [ ! -f "$toml_file" ]; then
-btoml.error "File '$toml_file' not found"
+bash_toml.error "File '$toml_file' not found"
 return 1
 fi
 
@@ -33,12 +33,12 @@ btoml.quick_string_get() {
 REPLY="${BASH_REMATCH[1]}"
 else
 # This should not happen due to the '[[ $line == *"$key_name"*=* ]]' check above
-btoml.error "Could not find key '$key_name' in file '$toml_file'"
+bash_toml.error "Could not find key '$key_name' in file '$toml_file'"
 return 1
 fi
 }
 
-btoml.quick_array_get() {
+bash_toml.quick_array_get() {
 unset REPLY; declare -ga REPLY=()
 local toml_file="$1"
 local key_name="$2"
@@ -47,7 +47,7 @@ btoml.quick_array_get() {
 # ensure.nonzero 'key_name'
 
 if [ ! -f "$toml_file" ]; then
-btoml.error "File '$toml_file' does not exist"
+bash_toml.error "File '$toml_file' does not exist"
 return 2
 fi
 
@@ -98,17 +98,21 @@ btoml.quick_array_get() {
 if [[ ${REPLY[$i]} =~ $regex ]]; then
 REPLY[$i]="${BASH_REMATCH[1]}"
 else
-btoml.error "Key '$key_name' in file '$toml_file' is not valid"
+bash_toml.error "Key '$key_name' in file '$toml_file' is not valid"
 return 2
 fi
 done
 else
-btoml.error "Key '$key_name' in file '$toml_file' must be set to an array that spans one line"
+bash_toml.error "Key '$key_name' in file '$toml_file' must be set to an array that spans one line"
 return 2
 fi
 }
 
-btoml.quick_array_append() {
+bash_toml.quick_string_set() {
+:
+}
+
+bash_toml.quick_array_append() {
 local toml_file="$1"
 local key_name="$2"
 local key_value="$3"
@@ -117,15 +121,15 @@ btoml.quick_array_append() {
 # ensure.nonzero 'key_value'
 
 if [ ! -f "$toml_file" ]; then
-btoml.error "File '$toml_file' does not exist"
+bash_toml.error "File '$toml_file' does not exist"
 return 2
 fi
 
 if util.get_toml_array "$toml_file" 'dependencies'; then
 local name=
 for name in "${REPLY[@]}"; do
 if [ "${name%@*}" = "${key_value%@*}" ]; then
-btoml.error "A version of '${name%@*}' is already installed. Skipping"
+bash_toml.error "A version of '${name%@*}' is already installed. Skipping"
 return 2
 fi
 done; unset name
@@ -140,20 +144,20 @@ btoml.quick_array_append() {
 rm "$toml_file.bak"
 fi
 else
-btoml.error "Key 'dependencies' not found in file '$toml_file'"
+bash_toml.error "Key 'dependencies' not found in file '$toml_file'"
 return 2
 fi
 }
 
-btoml.quick_array_remove() {
+bash_toml.quick_array_remove() {
 local toml_file="$1"
 local key_value="$2"
 
 # ensure.nonzero 'toml_file'
 # ensure.nonzero 'key_value'
 
 if [ ! -f "$toml_file" ]; then
-btoml.error "File '$toml_file' does not exist"
+bash_toml.error "File '$toml_file' does not exist"
 return 2
 fi
 
@@ -170,7 +174,7 @@ btoml.quick_array_remove() {
 done; unset -v name
 
 if [ "$does_exist" != 'yes' ]; then
-btoml.error "The package '$key_value' is not currently a dependency"
+bash_toml.error "The package '$key_value' is not currently a dependency"
 return 2
 fi
 
@@ -191,7 +195,11 @@ btoml.quick_array_remove() {
 done < "$toml_file.bak" > "$toml_file"
 rm "$toml_file.bak"
 else
-btoml.error "Key 'dependencies' not found in file '$toml_file'"
+bash_toml.error "Key 'dependencies' not found in file '$toml_file'"
 return 2
 fi
 }
+
+bash_toml.quick_array_replace() {
+:
+}

pkg/src/util/helper.sh

@@ -0,0 +1,5 @@
+# shellcheck shell=bash
+
+bash_toml.helper_parse() {
+unset -v REPLY; declare -ga REPLY=()
+}

pkg/src/util/init_append.sh

@@ -1,17 +1,17 @@
 # shellcheck shell=bash
 
-btoml.init_key_string() {
+bash_toml.init_key_string() {
 BASH_TOML_KEY_STRING="$1"
 }
 
-btoml.append_key_string() {
+bash_toml.append_key_string() {
 BASH_TOML_KEY_STRING+="$1"
 }
 
-btoml.init_value_string() {
+bash_toml.init_value_string() {
 BASH_TOML_KEY_VALUE_STRING=
 }
 
-btoml.append_value_string() {
+bash_toml.append_value_string() {
 BASH_TOML_KEY_VALUE_STRING+="$1"
 }

pkg/src/util/is.sh

@@ -1,46 +1,46 @@
 # shellcheck shell=bash
 
-btoml.is.whitespace() {
+bash_toml.is.whitespace() {
 if [[ "$1" == @($'\u0009'|$'\u0020') ]]; then
 return 0
 else
 return 1
 fi
 }
 
-btoml.is.newline() {
+bash_toml.is.newline() {
 if [[ "$1" == @($'\u000A'|$'\u0D0A') ]]; then
 return 0
 else
 return 1
 fi
 }
 
-btoml.is.table() {
+bash_toml.is.table() {
 if [[ "$1" == \[ ]]; then
 return 0
 else
 return 1
 fi
 }
 
-btoml.is.double_quote() {
+bash_toml.is.double_quote() {
 if [[ "$1" == \" ]]; then
 return 0
 else
 return 1
 fi
 }
 
-btoml.is.single_quote() {
+bash_toml.is.single_quote() {
 if [[ "$1" == \' ]]; then
 return 0
 else
 return 1
 fi
 }
 
-btoml.is.backslash() {
+bash_toml.is.backslash() {
 # shellcheck disable=SC1003
 if [[ "$1" == \\ ]]; then
 return 0
@@ -49,7 +49,7 @@ btoml.is.backslash() {
 fi
 }
 
-btoml.is.control_character() {
+bash_toml.is.control_character() {
 # shellcheck disable=SC1003
 if [[ "$1" == [[:cntrl:]] ]]; then
 return 0
@@ -58,7 +58,7 @@ btoml.is.control_character() {
 fi
 }
 
-btoml.is.hex_digit() {
+bash_toml.is.hex_digit() {
 # shellcheck disable=SC1003
 if [[ "$1" == [[:xdigit:]] ]]; then
 return 0
@@ -67,7 +67,7 @@ btoml.is.hex_digit() {
 fi
 }
 
-btoml.is.octothorp() {
+bash_toml.is.octothorp() {
 # shellcheck disable=SC1003
 if [[ "$1" == \# ]]; then
 return 0
@@ -76,15 +76,15 @@ btoml.is.octothorp() {
 fi
 }
 
-btoml.is.valid_bare_key_char() {
+bash_toml.is.valid_bare_key_char() {
 if [[ "$1" == [A-Za-z0-9_-] ]]; then
 return 0
 else
 return 1
 fi
 }
 
-btoml.is.equals_sign() {
+bash_toml.is.equals_sign() {
 if [[ "$1" == = ]]; then
 return 0
 else

pkg/src/util/util.sh

@@ -1,23 +1,26 @@
 # shellcheck shell=bash
 
-declare -gA BASH_TOML_ERRORS=(
-[INTERNAL_ERROR]='Internal error'
-[NOT_IMPLEMENTED]='TOML feature has not been implemented'
-[UNEXPECTED_BRANCH]='This branch was not supposed to be activated. Please submit an issue'
-[UNICODE_INVALID]='The resulting unicode code point was invalid'
-[KEY_ABSENT]='Key does not have a value'
-[UNEXPECTED_EOF]='Unexpected end of line'
-[UNEXPECTED_NEWLINE]='Unexpected newline'
-[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 string value could not be parsed'
-)
+# @description Initialize bash-toml
+bash_toml.util_init() {
+declare -gA BASH_TOML_ERRORS=(
+[INTERNAL_ERROR]='Internal error'
+[NOT_IMPLEMENTED]='TOML feature has not been implemented'
+[UNEXPECTED_BRANCH]='This branch was not supposed to be activated. Please submit an issue'
+[UNICODE_INVALID]='The resulting unicode code point was invalid'
+[KEY_ABSENT]='Key does not have a value'
+[UNEXPECTED_EOF]='Unexpected end of line'
+[UNEXPECTED_NEWLINE]='Unexpected newline'
+[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 string value could not be parsed'
+)
 
-declare -a BASH_TOKEN_HISTORY=()
+declare -a BASH_TOKEN_HISTORY=()
+}
 
 # @description Appends to token history for improved error insight
-btoml.token_history_add() {
+bash_toml.util_token_history_add() {
 local str=
 printf -v str '%s' "$mode ($char) at $PARSER_LINE_NUMBER:$PARSER_COLUMN_NUMBER"
 
@@ -32,7 +35,7 @@ btoml.token_history_add() {
 fi
 }
 
-btoml.parse_fail() {
+bash_toml.parse_fail() {
 local error_key="$1"
 local error_context="$2"
 
@@ -62,6 +65,6 @@ btoml.parse_fail() {
 fi
 }
 
-btoml.error() {
+bash_toml.error() {
 printf '%s\n' "Error: $1" >&2
 }

scripts/linter.sh

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

tests/quick-array.bats

@@ -3,15 +3,15 @@
 load './util/init.sh'
 
 @test "Quick array properly fails" {
-run btoml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file1.toml" \
+run bash_toml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file1.toml" \
 'badkey'
 
 assert_failure
 }
 
 @test "Quick array get" {
 for n in {1..7}; do
-btoml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file1.toml" \
+bash_toml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file1.toml" \
 "key0${n}"
 assert [ "${#REPLY[@]}" -eq 0 ]
 done
@@ -21,7 +21,7 @@ load './util/init.sh'
 @test "Quick array get 2" {
 for m in {1..2}; do
 for n in {1..7}; do
-btoml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file1.toml" \
+bash_toml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file1.toml" \
 "key${m}${n}"
 assert [ "${#REPLY[@]}" -eq 1 ]
 assert [ -z "${REPLY[0]}" ]
@@ -32,7 +32,7 @@ load './util/init.sh'
 @test "Quick array get 3" {
 for m in {3..10}; do
 for n in {1..7}; do
-btoml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file1.toml" \
+bash_toml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file1.toml" \
 "key${m}${n}"
 assert [ "${#REPLY[@]}" -eq 2 ]
 assert [ "${REPLY[0]}" = 'a' ]
@@ -43,7 +43,7 @@ load './util/init.sh'
 
 @test "Quick array get multiline" {
 for n in {0..1}; do
-btoml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file2.toml" \
+bash_toml.quick_array_get "$BASALT_PACKAGE_DIR/tests/testdata/array/file2.toml" \
 "key${n}"
 assert [ "${#REPLY[@]}" -eq 1 ]
 assert [ "${REPLY[0]}" = 'multiline' ]

tests/quick-string.bats

@@ -5,7 +5,7 @@ load './util/init.sh'
 @test "quick string get" {
 for tens in {0..1}; do
 for ones in {1..7}; do
-btoml.quick_string_get "$BASALT_PACKAGE_DIR/tests/testdata/string/file1.toml" \
+bash_toml.quick_string_get "$BASALT_PACKAGE_DIR/tests/testdata/string/file1.toml" \
 "key${tens}${ones}"
 assert [ "$REPLY" = "value${ones}" ]
 done