refactor: Revamp code checking and setting bpm variable values

Author: hyperupcall

pkg/lib/cmd/bpm.sh

@@ -15,7 +15,7 @@ main() {
 		source "$f"
 	done
 
-	local is_global='no'
+	BPM_IS_LOCAL='yes'
 
 	for arg; do
 		case "$arg" in
@@ -30,7 +30,7 @@ main() {
 			exit
 			;;
 		--global|-g)
-			is_global='yes'
+			BPM_IS_LOCAL='no'
 			shift
 			;;
 		*)
@@ -41,8 +41,6 @@ main() {
 
 	case "$1" in
 	add)
-		must_reset_bpm_vars "$is_global"
-
 		shift
 		do-add "$@"
 		;;
@@ -51,8 +49,6 @@ main() {
 		do-complete "$@"
 		;;
 	echo)
-		may_reset_bpm_vars "$is_global"
-
 		shift
 		do-echo "$@"
 		;;
@@ -61,38 +57,22 @@ main() {
 		do-init "$@"
 		;;
 	link)
-		must_reset_bpm_vars "$is_global"
-
 		shift
 		do-link "$@"
 		;;
 	list)
-		must_reset_bpm_vars "$is_global"
-
 		shift
 		do-list "$@"
 		;;
-	outdated)
-		must_reset_bpm_vars "$is_global"
-
-		shift
-		bpm-outdated "$@"
-		;;
 	package-path)
-		must_reset_bpm_vars "$is_global"
-
 		shift
 		bpm-package-path "$@"
 		;;
 	remove)
-		must_reset_bpm_vars "$is_global"
-
 		shift
 		do-remove "$@"
 		;;
 	upgrade)
-		must_reset_bpm_vars "$is_global"
-
 		shift
 		do-upgrade "$@"
 		;;
@@ -105,39 +85,4 @@ main() {
 	esac
 }
 
-must_reset_bpm_vars() {
-	local is_global="$1"
-
-	# TEST this
-	if [ "$is_global" = 'no' ]; then
-		local project_root_dir=
-		if ! project_root_dir="$(util.get_project_root_dir)"; then
-			die "No 'bpm.toml' file found. Please create one to install local packages or pass the '--global' option"
-		fi
-
-		do_set_bpm_vars "$project_root_dir"
-	fi
-}
-
-may_reset_bpm_vars() {
-	local is_global="$1"
-
-	local project_root_dir=
-	if project_root_dir="$(util.get_project_root_dir)"; then
-		do_set_bpm_vars "$project_root_dir"
-	fi
-}
-
-do_set_bpm_vars() {
-	local project_root_dir="$1"
-	ensure.non_zero 'project_root_dir' "$project_root_dir"
-
-	BPM_ROOT="$project_root_dir"
-	BPM_PREFIX="$project_root_dir/bpm_packages"
-	BPM_PACKAGES_PATH="$BPM_PREFIX/packages"
-	BPM_INSTALL_BIN="$BPM_PREFIX/bin"
-	BPM_INSTALL_MAN="$BPM_PREFIX/man"
-	BPM_INSTALL_COMPLETIONS="$BPM_PREFIX/completions"
-}
-
 main "$@"

pkg/lib/commands/do-add.sh

@@ -1,14 +1,16 @@
 # shellcheck shell=bash
 
 do-add() {
-	local with_ssh='no' # TODO: refactor flag_
+	local flag_ssh='no'
 	local flag_all='no'
 
+	util.setup_mode
+
 	local -a pkgs=()
 	for arg; do
 		case "$arg" in
 		--ssh)
-			with_ssh='yes'
+			flag_ssh='yes'
 			;;
 		--all)
 			flag_all='yes'
@@ -48,7 +50,7 @@ do-add() {
 			die "Identifier '$repoSpec' is a directory, not a package"
 		fi
 
-		util.extract_data_from_input "$repoSpec" "$with_ssh"
+		util.extract_data_from_input "$repoSpec" "$flag_ssh"
 		local uri="$REPLY1"
 		local site="$REPLY2"
 		local package="$REPLY3"

pkg/lib/commands/do-echo.sh

@@ -1,5 +1,7 @@
 # shellcheck shell=bash
 
 do-echo() {
+	util.setup_mode
+
 	eval "printf \"%s\" \$$1"
 }

pkg/lib/commands/do-link.sh

@@ -3,6 +3,8 @@
 do-link() {
 	local install_deps='yes'
 
+	util.setup_mode
+
 	local -a dirs=()
 	for arg; do
 		case "$arg" in

pkg/lib/commands/do-list.sh

@@ -5,6 +5,8 @@ do-list() {
 	local flag_simple='no'
 	local flag_fetch='no'
 
+	util.setup_mode
+
 	for arg; do
 		case "$arg" in
 		--simple)

pkg/lib/commands/do-package-path.sh

@@ -4,6 +4,8 @@ bpm-package-path() {
 	local id="$1"
 	ensure.non_zero 'id' "$id"
 
+	util.setup_mode
+
 	util.extract_data_from_input "$id"
 	local site="$REPLY2"
 	local package="$REPLY3"

pkg/lib/commands/do-remove.sh

@@ -3,6 +3,8 @@
 do-remove() {
 	local flag_all='no'
 
+	util.setup_mode
+
 	local -a pkgs=()
 	for arg; do
 		case "$arg" in

pkg/lib/commands/do-upgrade.sh

@@ -3,6 +3,8 @@
 do-upgrade() {
 	local upgrade_bpm='no'
 
+	util.setup_mode
+
 	local -a pkgs=()
 	for arg; do
 		case "$arg" in

pkg/lib/util/ensure.sh

@@ -30,7 +30,7 @@ ensure.non_zero() {
 # the integrity of the testing suite. Most of the callsites of this
 # function are in 'do-plumbing-link' since we expect a package to exist
 # before performing operations on it. This contrasts 'do-plumbing-unlink' -
-# that is not an expectation
+# in which the behavior is not expected
 # @arg $1 package
 ensure.package_exists() {
 	local id="$1"

pkg/lib/util/util.sh

@@ -249,6 +249,34 @@ util.get_project_root_dir() {
 	printf "%s" "$PWD"
 }
 
+util.set_bpm_variables() {
+	local project_root_dir="$1"
+	ensure.non_zero 'project_root_dir' "$project_root_dir"
+
+	BPM_ROOT="$project_root_dir"
+	BPM_PREFIX="$project_root_dir/bpm_packages"
+	BPM_PACKAGES_PATH="$BPM_PREFIX/packages"
+	BPM_INSTALL_BIN="$BPM_PREFIX/bin"
+	BPM_INSTALL_MAN="$BPM_PREFIX/man"
+	BPM_INSTALL_COMPLETIONS="$BPM_PREFIX/completions"
+}
+
+# @description Sets up the variables for the current mode
+util.setup_mode() {
+	if [ "$BPM_IS_LOCAL" = yes ]; then
+		local project_root_dir=
+		if ! project_root_dir="$(util.get_project_root_dir)"; then
+			die "No 'bpm.toml' file found"
+		fi
+
+		util.set_bpm_variables "$project_root_dir"
+	else
+		# If we do not set local mode, the default varaible
+		# values are already correct
+		:
+	fi
+}
+
 util.show_help() {
 	cat <<"EOF"
 Usage:

tests/mode-global.bats

@@ -4,7 +4,7 @@ load 'util/init.sh'
 
 # We only test two of all commands
 @test "error when not passing --global to add, list, and upgrade" {
-	local str="No 'bpm.toml' file found. Please create one to install local packages or pass the '--global' option"
+	local str="No 'bpm.toml' file found"
 
 	run bpm add foo
 	assert_failure