feat: Implement 'unset' for Bash objects. Closes #2

Author: hyperupcall

examples/script.sh

@@ -1,11 +1,25 @@
 #!/usr/bin/env bash
 set -eo pipefail
 
+lsobj() {
+	local -i count=0
+	while IFS= read -r line || [ -n "$line" ]; do
+		((++count))
+		if [[ $line =~ ^__bash_object ]]; then
+			printf '%s\n' "$line"
+		fi
+
+	done < <(set -o posix; set); unset line
+
+	printf 'COUNT: %d\n' "$count"
+}
+
 # Necessary for Basalt to load dependencies
 eval "$(basalt-package-init)"
 basalt.package-init
 basalt.package-load
 
+lsobj
 
 declare -A root_object=()
 declare -A zulu_object=()
@@ -31,3 +45,7 @@ bobject get-string --value root_object '.["zulu"].["yankee"].["xray"].["foxtrot"
 printf '%s - %s\n' "$REPLY" rho
 
 bobject.print 'root_object'
+
+bobject.unset 'root_object'
+
+lsobj

pkg/src/parse.sh

@@ -9,6 +9,7 @@ bash_object.parse_querytree() {
 
 	local flag_parser_type=
 
+	local arg=
 	for arg; do case $arg in
 	--simple)
 		flag_parser_type='simple'

pkg/src/public/bobject-unset.sh

@@ -0,0 +1,17 @@
+# shellcheck shell=bash
+
+bobject.unset() {
+	local object_name="$1"
+
+	if [ -z "$object_name" ]; then
+		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' 'Positional parameter 1 is empty. Please check passed parameters'
+		return
+	fi
+
+	if declare -p "$object_name" &>/dev/null; then :; else
+		bash_object.util.die 'ERROR_NOT_FOUND' "The variable '$object_name' does not exist"
+		return
+	fi
+
+	bash_object.util.unset "$object_name"
+}

pkg/src/util/util.sh

@@ -112,6 +112,49 @@ bash_object.util.print_hierarchy() {
 	fi
 }
 
+# @description Prints the contents of a particular variable
+# or vobject
+bash_object.util.unset() {
+	local object_name="$1"
+
+	if object_type="$(declare -p "$object_name" 2>/dev/null)"; then :; else
+		bash_object.util.die 'ERROR_NOT_FOUND' "The variable '$object_name' does not exist"
+		return
+	fi
+	object_type="${object_type#declare -}"
+
+	local -n _object="$object_name"
+	if [ "${object_type::1}" = 'A' ]; then
+		for object_key in "${!_object[@]}"; do
+			local object_value="${_object[$object_key]}"
+			if [ "${object_value::2}" = $'\x1C\x1D' ]; then
+				# object_value is a vobject
+				bash_object.parse_virtual_object "$object_value"
+				local virtual_object_name="$REPLY1"
+				local vmd_dtype="$REPLY2"
+
+				bash_object.util.unset "$virtual_object_name"
+				unset "$virtual_object_name"
+			fi
+		done; unset object_key
+	elif [ "${object_type::1}" = 'a' ]; then
+		for object_value in "${_object[@]}"; do
+			# object_value is a vobject
+			if [ "${object_value::2}" = $'\x1C\x1D' ]; then
+				bash_object.parse_virtual_object "$object_value"
+				local virtual_object_name="$REPLY1"
+				local vmd_dtype="$REPLY2"
+
+				bash_object.util.unset "$virtual_object_name"
+				unset "$virtual_object_name"
+			fi
+		done
+	else
+		bash_object.util.die 'ERROR_ARGUMENTS_INVALID_TYPE' "The type of the named object ($object_name) is neither an array nor an object"
+		return
+	fi
+}
+
 # @description A stringified version of the querytree
 # stack. This is used when generating objects to prevent
 # conflicts