fix: Do not automatically append --pass-by-ref when using bobject

Author: hyperupcall

README.md

@@ -27,9 +27,9 @@ declare -A yankee_object=([xray]=)
 declare -A xray_object=([whiskey]=victor [foxtrot]=)
 declare -a foxtrot_array=(omicron pi rho sigma)
 
-bobject set-object root_object '.zulu' zulu_object
-bobject set-object root_object '.zulu.yankee' yankee_object
-bobject set-object root_object '.zulu.yankee.xray' xray_object
+bobject set-object --pass-by-ref root_object '.zulu' zulu_object
+bobject set-object --pass-by-ref root_object '.zulu.yankee' yankee_object
+bobject set-object --pass-by-ref root_object '.zulu.yankee.xray' xray_object
 bobject set-array root_object '.zulu.yankee.xray.foxtrot' foxtrot_array
 
 bobject get-object root_object '.zulu.yankee.xray'

docs/errors.md

@@ -1,24 +1,8 @@
 # Errors
 
-Depending on your operation, your object transaction may fail. This details the reasons
-
-In this context, value means either "member of object" or "index of array"
-
-## Get
-
-- `ERROR_NOT_FOUND`
-  - Attempted to access a value that does not exist
-- `ERROR_VALUE_INCORRECT_TYPE`
-  - Attempted to access a value that has the wrong type. This can happen if the query uses `.[30]` to get an array index, but an object exists instead. It can also happen if the user writes `get-string`, and it found a non-string value after evaluating the query. It can also happen if the user writes `set-string`, and the place to write the new value already has a value of a different type
-- `ERROR_VOBJ_INVALID_TYPE`
-  - The virtual object (a string that contains a reference to the real global object) had keys with unexpected values. You shouldn't get this error unless something has seriously gone wrong
-
-# Handling
-
-Because Bash often does the wrong thing silently, it's important to fail early when any inputs are unexpected. `bash-object` does this at every level
-
-Below, if any of the assurances do not pass, `bash-object` will fail with a non-zero exit code. For some of these, `VERIFY_BASH_OBJECT` must be a variable
+Because Bash often does the wrong thing silently, it's important to fail early when any inputs are unexpected. Extra checks that require spawning subshells require setting the `VERIFY_BASH_OBJECT` variable. We recommend exporting it so any child Bash processes keep the verification behavior
 
+The following checks are performed
 
 1. Argument parsing
 

pkg/lib/cmd/bobject.sh

@@ -19,13 +19,13 @@ bobject() {
 			bash_object.traverse-get object "$@"
 			;;
 		set-string)
-			bash_object.traverse-set --pass-by-ref string "$@"
+			bash_object.traverse-set string "$@"
 			;;
 		set-array)
-			bash_object.traverse-set --pass-by-ref array "$@"
+			bash_object.traverse-set array "$@"
 			;;
 		set-object)
-			bash_object.traverse-set --pass-by-ref object "$@"
+			bash_object.traverse-set object "$@"
 			;;
 		*)
 			bash_object.util.die 'ERROR_ARGUMENTS_INVALID' "Subcommand '$subcmd' not recognized"

tests/e2e.bats

@@ -35,7 +35,7 @@ load './util/init.sh'
 	for subcmd in "${subcmds[@]}"; do
 		declare -A OBJECT=()
 
-		run bobject "$subcmd" 'OBJECT' '.zulu.yankee' 'xray' 'invalid'
+		run bobject "$subcmd" --pass-by-ref 'OBJECT' '.zulu.yankee' 'xray' 'invalid'
 
 		assert_failure
 		assert_line -p "Expected '4' arguments, but received '5'"
@@ -48,7 +48,7 @@ load './util/init.sh'
 	for subcmd in "${subcmds[@]}"; do
 		declare -A OBJECT=()
 
-		run bobject "$subcmd" 'OBJECT' '.zulu'
+		run bobject "$subcmd" --pass-by-ref 'OBJECT' '.zulu'
 
 		assert_failure
 		assert_line -p "Expected '4' arguments, but received '3'"
@@ -60,8 +60,8 @@ load './util/init.sh'
 	declare -A subobj=()
 	str='MEOW'
 
-	bobject set-object 'OBJECT' '.zulu' subobj
-	bobject set-string 'OBJECT' '.zulu.yankee' str
+	bobject set-object --pass-by-ref 'OBJECT' '.zulu' subobj
+	bobject set-string --pass-by-ref 'OBJECT' '.zulu.yankee' str
 	bobject get-string 'OBJECT' '.zulu.yankee'
 
 	assert [ "$REPLY" = 'MEOW' ]
@@ -72,8 +72,8 @@ load './util/init.sh'
 	declare -A subobj=()
 	str='MEOW'
 
-	bobject set-object 'OBJECT' '.zulu' subobj
-	bobject set-string 'OBJECT' '.["zulu"].["yankee"]' str
+	bobject set-object --pass-by-ref 'OBJECT' '.zulu' subobj
+	bobject set-string --pass-by-ref 'OBJECT' '.["zulu"].["yankee"]' str
 	bobject get-string 'OBJECT' '.["zulu"].["yankee"]'
 
 	assert [ "$REPLY" = 'MEOW' ]
@@ -86,10 +86,10 @@ load './util/init.sh'
 	declare -A xray_object=([whiskey]=victor [foxtrot]=)
 	declare -a foxtrot_array=(omicron pi rho sigma)
 
-	bobject set-object root_object '.zulu' zulu_object
-	bobject set-object root_object '.zulu.yankee' yankee_object
-	bobject set-object root_object '.zulu.yankee.xray' xray_object
-	bobject set-array root_object '.zulu.yankee.xray.foxtrot' foxtrot_array
+	bobject set-object --pass-by-ref root_object '.zulu' zulu_object
+	bobject set-object --pass-by-ref root_object '.zulu.yankee' yankee_object
+	bobject set-object --pass-by-ref root_object '.zulu.yankee.xray' xray_object
+	bobject set-array --pass-by-ref root_object '.zulu.yankee.xray.foxtrot' foxtrot_array
 
 	bobject get-object root_object '.zulu.yankee.xray'
 	assert [ "${REPLY[whiskey]}" = victor ]