feat: Require '--as-<ref|value>' flag for get

This also fixes some things in other places

Author: hyperupcall

README.md

@@ -32,16 +32,16 @@ bobject set-object --by-ref root_object '.zulu.yankee' yankee_object
 bobject set-object --by-ref root_object '.zulu.yankee.xray' xray_object
 bobject set-array --by-ref root_object '.zulu.yankee.xray.foxtrot' foxtrot_array
 
-bobject get-object root_object '.zulu.yankee.xray'
+bobject get-object --as-value root_object '.zulu.yankee.xray'
 assert [ "${REPLY[whiskey]}" = victor ]
 
-bobject get-string root_object '.zulu.yankee.xray.whiskey'
+bobject get-string --as-value root_object '.zulu.yankee.xray.whiskey'
 assert [ "$REPLY" = victor ]
 
-bobject get-array root_object '.zulu.yankee.xray.foxtrot'
+bobject get-array --as-value root_object '.zulu.yankee.xray.foxtrot'
 assert [ ${#REPLY[@]} -eq 4 ]
 
-bobject get-string root_object '.["zulu"].["yankee"].["xray"].["foxtrot"].[2]'
+bobject get-string --as-value root_object '.["zulu"].["yankee"].["xray"].["foxtrot"].[2]'
 assert [ "$REPLY" = rho ]
 ```
 
@@ -58,4 +58,4 @@ bpm install
 - error on invalid references (`type=object` in virtual object metadata, when it is referencing an array)
 - ensure error (for set primarily) if the virtual object references a variable that does not exist
 - "queried for X, but found existing object": print object in error (same with indexed arrays)
---reply-with-value
+- use ${param@A} on newer bash instead of declare -p

docs/unmarshaling.md

@@ -66,7 +66,7 @@ declare -A OBJECT=([xray]=$'\x1C\x1Dtype=object;&unique_global_variable_xray')
 You can retrieve the data with
 
 ```sh
-bobject get-object 'OBJECT' 'xray'
+bobject get-object --as-value 'OBJECT' 'xray'
 assert [ "${REPLY[yankee]}" = zulu ]
 ```
 

pkg/lib/traverse-get.sh

@@ -8,30 +8,61 @@ bash_object.traverse-get() {
 		stdtrace.log 0 "CALL: bash_object.traverse-get: $*"
 	fi
 
-	local final_value_type="$1"
-	local root_object_name="$2"
-	local filter="$3"
+	local flag_as_what=''
+	local -a args=()
+
+	for arg; do case "$arg" in
+	--as-ref)
+		if [ -n "$flag_as_what" ]; then
+			bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Flags '--as-ref' and '--as-value' are mutually exclusive"
+			return
+		fi
+		flag_as_what='as-ref'
+		;;
+	--as-value)
+		if [ -n "$flag_as_what" ]; then
+			bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Flags '--as-ref' and '--as-value' are mutually exclusive"
+			return
+		fi
+		flag_as_what='as-value'
+		;;
+	--)
+		break
+		;;
+	*)
+		args+=("$arg")
+		;;
+	esac done
+
+	if [ -z "$flag_as_what" ]; then
+		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Must pass either the '--as-ref' or '--as-value' flag"
+		return
+	fi
 
 	# Ensure correct number of arguments have been passed
-	if (( $# != 3)); then
-		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Expected '3' arguments, but received '$#'"
+	if (( ${#args[@]} != 3)); then
+		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Expected '3' arguments, but received '${#args[@]}'"
 		return
 	fi
 
 	# Ensure parameters are not empty
-	if [ -z "$final_value_type" ]; then
+	if [ -z "${args[0]}" ]; then
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Positional parameter '1' is empty. Please check passed parameters"
 		return
 	fi
-	if [ -z "$root_object_name" ]; then
+	if [ -z "${args[1]}" ]; then
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Positional parameter '2' is empty. Please check passed parameters"
 		return
 	fi
-	if [ -z "$filter" ]; then
+	if [ -z "${args[2]}" ]; then
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Positional parameter '3' is empty. Please check passed parameters"
 		return
 	fi
 
+	local final_value_type="${args[0]}"
+	local root_object_name="${args[1]}"
+	local filter="${args[2]}"
+
 	# Start traversing at the root object
 	local current_object_name="$root_object_name"
 	local -n current_object="$root_object_name"

pkg/lib/traverse-set.sh

@@ -10,29 +10,55 @@ bash_object.traverse-set() {
 	local -a args=()
 
 	for arg; do case "$arg" in
-		--by-ref) flag_pass_by_what='by-ref'; shift ;;
-		--by-value) flag_pass_by_what='by-value'; shift ;;
-		--) shift; break ;;
-		*) args+=("$arg") ;;
+	--by-ref)
+		if [ -n "$flag_pass_by_what" ]; then
+			bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Flags '--by-ref' and '--by-value' are mutually exclusive"
+			return
+		fi
+		flag_pass_by_what='by-ref'
+		;;
+	--by-value)
+		if [ -n "$flag_pass_by_what" ]; then
+			bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Flags '--by-ref' and '--by-value' are mutually exclusive"
+			return
+		fi
+		flag_pass_by_what='by-value'
+		;;
+	--)
+		break
+		;;
+	*)
+		args+=("$arg")
+		;;
 	esac done
 
 	if [ -z "$flag_pass_by_what" ]; then
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Must pass either the '--by-ref' or '--by-value' flag"
 		return
 	fi
 
-	local final_value_type="${args[0]}"
-	local root_object_name="${args[1]}"
-	local filter="${args[2]}"
-	local final_value="${args[3]}"
+	local final_value_type root_object_name filter final_value
+	# `set -u` compat
+	if [ -n "${args[0]+x}" ]; then
+		final_value_type="${args[0]}"
+	fi
+	if [ -n "${args[1]+x}" ]; then
+		root_object_name="${args[1]}"
+	fi
+	if [ -n "${args[2]+x}" ]; then
+		filter="${args[2]}"
+	fi
+	if [ -n "${args[3]+x}" ]; then
+		final_value="${args[3]}"
+	fi
 
-	# Ensure correct number of arguments have been passed. Only do this
-	# for circumstances in which we know the correct argument amount
+	# Ensure correct number of arguments have been passed
+	# Only do this for circumstances in which we know the correct argument amount
 	if [ "$flag_pass_by_what" = 'by-ref' ] && (( ${#args[@]} != 4)); then
 		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Expected '4' arguments, but received '${#args[@]}'"
 		return
 	elif [[ "$flag_pass_by_what" == 'by-value' && "$final_value_type" == 'string' ]] && (( ${#args[@]} != 4 )); then
-		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Expected '4' arguments, but received '$#'"
+		bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Expected '4' arguments, but received '${#args[@]}'"
 		return
 	fi
 

tests/e2e.bats

@@ -8,7 +8,7 @@ load './util/init.sh'
 	for subcmd in "${subcmds[@]}"; do
 		declare -A OBJECT=()
 
-		run bobject "$subcmd" 'OBJECT' '.zulu.yankee' 'invalid'
+		run bobject "$subcmd" --as-value 'OBJECT' '.zulu.yankee' 'invalid'
 
 		assert_failure
 		assert_line -p "Expected '3' arguments, but received '4'"
@@ -21,7 +21,7 @@ load './util/init.sh'
 	for subcmd in "${subcmds[@]}"; do
 		declare -A OBJECT=()
 
-		run bobject "$subcmd" 'invalid'
+		run bobject "$subcmd" --as-value 'invalid'
 
 		assert_failure
 		assert_failure
@@ -62,7 +62,7 @@ load './util/init.sh'
 
 	bobject set-object --by-ref 'OBJECT' '.zulu' subobj
 	bobject set-string --by-ref 'OBJECT' '.zulu.yankee' str
-	bobject get-string 'OBJECT' '.zulu.yankee'
+	bobject get-string --as-value 'OBJECT' '.zulu.yankee'
 
 	assert [ "$REPLY" = 'MEOW' ]
 }
@@ -74,7 +74,7 @@ load './util/init.sh'
 
 	bobject set-object --by-ref 'OBJECT' '.zulu' subobj
 	bobject set-string --by-ref 'OBJECT' '.["zulu"].["yankee"]' str
-	bobject get-string 'OBJECT' '.["zulu"].["yankee"]'
+	bobject get-string --as-value 'OBJECT' '.["zulu"].["yankee"]'
 
 	assert [ "$REPLY" = 'MEOW' ]
 }
@@ -91,15 +91,15 @@ load './util/init.sh'
 	bobject set-object --by-ref root_object '.zulu.yankee.xray' xray_object
 	bobject set-array --by-ref root_object '.zulu.yankee.xray.foxtrot' foxtrot_array
 
-	bobject get-object root_object '.zulu.yankee.xray'
+	bobject get-object --as-value root_object '.zulu.yankee.xray'
 	assert [ "${REPLY[whiskey]}" = victor ]
 
-	bobject get-string root_object '.zulu.yankee.xray.whiskey'
+	bobject get-string --as-value root_object '.zulu.yankee.xray.whiskey'
 	assert [ "$REPLY" = victor ]
 
-	bobject get-array root_object '.zulu.yankee.xray.foxtrot'
+	bobject get-array --as-value root_object '.zulu.yankee.xray.foxtrot'
 	assert [ ${#REPLY[@]} -eq 4 ]
 
-	bobject get-string root_object '.["zulu"].["yankee"].["xray"].["foxtrot"].[2]'
+	bobject get-string --as-value root_object '.["zulu"].["yankee"].["xray"].["foxtrot"].[2]'
 	assert [ "$REPLY" = rho ]
 }

tests/error-circular-reference.bats renamed to tests/errors-circular-reference.bats

@@ -7,7 +7,7 @@ load './util/init.sh'
 	declare -A SUB_OBJECT=([nested]=$'\x1C\x1Dtype=object;&SUB_OBJECT')
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=object;&SUB_OBJECT')
 
-	run bobject get-object OBJECT '.my_key.nested'
+	run bobject get-object --as-value OBJECT '.my_key.nested'
 
 	assert_failure
 	assert_line -p "ERROR_SELF_REFERENCE"
@@ -18,7 +18,7 @@ load './util/init.sh'
 	declare -A SUB_OBJECT=([nested]=$'\x1C\x1Dtype=object;&SUB_OBJECT')
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=object;&SUB_OBJECT')
 
-	run bobject get-object OBJECT '.my_key.nested.nested'
+	run bobject get-object --as-value OBJECT '.my_key.nested.nested'
 
 	assert_failure
 	assert_line -p "ERROR_SELF_REFERENCE"
@@ -29,7 +29,7 @@ load './util/init.sh'
 	declare -a SUB_ARRAY=([nested]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
 
-	run bobject get-array OBJECT '.my_key.nested'
+	run bobject get-array --as-value OBJECT '.my_key.nested'
 
 	assert_failure
 	assert_line -p "ERROR_SELF_REFERENCE"
@@ -40,7 +40,7 @@ load './util/init.sh'
 	declare -a SUB_ARRAY=([nested]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
 
-	run bobject get-array OBJECT '.my_key.nested.nested'
+	run bobject get-array --as-value OBJECT '.my_key.nested.nested'
 
 	assert_failure
 	assert_line -p "ERROR_SELF_REFERENCE"

tests/errors-required-flags.bats

@@ -0,0 +1,37 @@
+#!/usr/bin/env bats
+
+load './util/init.sh'
+
+# get
+@test "get errors on missing flags" {
+	run bobject get-string
+
+	assert_failure
+	assert_line -p 'ERROR_ARGUMENTS_INVALID'
+	assert_line -p "Must pass either the '--as-ref' or '--as-value' flag"
+}
+
+@test "get errors on combining mutually exclusive flags" {
+	run bobject get-string --as-value --as-ref
+
+	assert_failure
+	assert_line -p 'ERROR_ARGUMENTS_INVALID'
+	assert_line -p "Flags '--as-ref' and '--as-value' are mutually exclusive"
+}
+
+# set
+@test "set errors on missing flags" {
+	run bobject set-string
+
+	assert_failure
+	assert_line -p 'ERROR_ARGUMENTS_INVALID'
+	assert_line -p "Must pass either the '--by-ref' or '--by-value' flag"
+}
+
+@test "set errors on combining mutually exclusive flags" {
+	run bobject set-string --by-value --by-ref
+
+	assert_failure
+	assert_line -p 'ERROR_ARGUMENTS_INVALID'
+	assert_line -p "Flags '--by-ref' and '--by-value' are mutually exclusive"
+}

tests/get-errors-invalid-dereferenced-vobj-type.bats

@@ -10,7 +10,7 @@ load './util/init.sh'
 	declare -a whatever=()
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=object;&whatever')
 
-	run bobject get-object OBJECT '.my_key'
+	run bobject get-object --as-value OBJECT '.my_key'
 
 	assert_failure
 	assert_line -p "ERROR_VOBJ_INCORRECT_TYPE"
@@ -23,7 +23,7 @@ load './util/init.sh'
 
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=object;&whatever')
 
-	run bobject get-object OBJECT '.my_key'
+	run bobject get-object --as-value OBJECT '.my_key'
 
 	assert_failure
 	assert_line -p "ERROR_VOBJ_INCORRECT_TYPE"