refactor: Rework variables again

Previously, a 'BPM_ROOT' variable would change all other variables,
including the ones appended with './source' and './cellar'. The
variables that represented the latter two values are the only
configurable ones; 'BPM_ROOT' is gone. This also renames some variables

Author: hyperupcall

README.md

@@ -38,7 +38,7 @@ See [Installation](./docs/installation.md) and [Getting Started](./docs/getting-
 - Local and user-wide package installation
 - Configure (optionally) exactly which directories are used for completions, binaries, or man pages
 - Works with essentially all popular Bash projects out of the box
-- 260+ Tests
+- 240+ Tests
 
 ## Alternatives Comparison
 

completions/_bpm.zsh

@@ -38,7 +38,7 @@ case $state in
 			_describe -t commands "gem subcommand" subcommandOptions
 			;;
 		(echo)
-			local -a subcommandOptions=(BPM_ROOT BPM_CELLAR)
+			local -a subcommandOptions=(BPM_LOCAL_PROJECT_DIR BPM_CELLAR)
 			_describe -t commands "gem subcommand" subcommandOptions
 			;;
 		(init)

completions/bpm.bash

@@ -60,7 +60,7 @@ _bpm() {
 				readarray -t COMPREPLY < <(IFS=' ' compgen -W "${subcommandOptions[*]}" -- "$currentWord")
 				;;
 			echo)
-				subcommandOptions=(BPM_ROOT BPM_CELLAR)
+				subcommandOptions=(BPM_LOCAL_PROJECT_DIR BPM_CELLAR)
 				readarray -t COMPREPLY < <(IFS=' ' compgen -W "${subcommandOptions[*]}" -- "$currentWord")
 				;;
 			init)

completions/bpm.fish

@@ -13,7 +13,7 @@ set -l subcommandOptions --shh
 complete -c $cmd -f -n "__fish_seen_subcommand_from $subcmd" -a "$subcommandOptions"
 
 set subcmd echo
-set -l subcommandOptions BPM_ROOT BPM_CELLAR
+set -l subcommandOptions BPM_LOCAL_PROJECT_DIR BPM_CELLAR
 complete -c $cmd -f -n "__fish_seen_subcommand_from $subcmd" -a "$subcommandOptions"
 
 set subcmd init

docs/reference.md

@@ -2,7 +2,7 @@
 
 ## Environment Variables
 
-### `BPM_ROOT`
+### `BPM_LOCAL_PROJECT_DIR`
 
 The location of the root `bpm` folder. Defaults to `"${XDG_DATA_HOME:-$HOME/.local/share}/bpm"`
 
@@ -12,7 +12,7 @@ Set to a non-null string to clone the full repository history instead of only th
 
 ### `BPM_CELLAR`
 
-Set the installation and package checkout prefix (default is `$BPM_ROOT/cellar`).  Setting this to `/usr/local`, for example, will install binaries to `/usr/local/bin`, manpages to `/usr/local/man`, completions to `/usr/local/completions`, and clone packages to `/usr/local/packages`
+Set the installation and package checkout prefix (default is `$BPM_LOCAL_PROJECT_DIR/cellar`).  Setting this to `/usr/local`, for example, will install binaries to `/usr/local/bin`, manpages to `/usr/local/man`, completions to `/usr/local/completions`, and clone packages to `/usr/local/packages`
 
 ## `bpm.toml`
 

pkg/lib/cmd/bpm-load.sh

@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+# TODO: print error if sourcing and passing arguments
+# TODO: print error if not being sourced and no arguments are passed
+
 # @description Source Bash packages to initialize any functions
 # that they may want to provide in the global scope
 # @exitcode 4 Unexpected internal error
@@ -63,11 +66,11 @@ bpm-load() {
 	unset REPLY REPLY1 REPLY2 REPLY3 REPLY4 REPLY5 # Be extra certain of no clobbering
 
 	# Get the bpm root dir (relative to this function's callsite)
-	local __bpm_root_dir=
+	local __bpm_cellar=
 	if [ "$__bpm_flag_global" = yes ]; then
-		__bpm_root_dir="${BPM_ROOT:-"${XDG_DATA_HOME:-$HOME/.local/share}/bpm"}/cellar"
+		__bpm_cellar="${BPM_CELLAR:-"${XDG_DATA_HOME:-$HOME/.local/share}/bpm/cellar"}"
 	else
-		if ! __bpm_root_dir="$(util.get_project_root_dir)/bpm_packages"; then
+		if ! __bpm_cellar="$(util.get_project_root_dir)/bpm_packages"; then
 			printf '%s\n' "bpm-load: Error: Unexpected error calling function 'util.get_project_root_dir' with PWD '$PWD'"
 			__bpm_bpm_load_restore_options
 			return 4
@@ -76,7 +79,7 @@ bpm-load() {
 
 	# Source file, behavior depending on whether it was specifed
 	if [ -n "$__bpm_file" ]; then
-		local __bpm_full_path="$__bpm_root_dir/packages/$__bpm_site/$__bpm_package/$__bpm_file"
+		local __bpm_full_path="$__bpm_cellar/packages/$__bpm_site/$__bpm_package/$__bpm_file"
 
 		if [ -d "$__bpm_full_path" ]; then
 			printf '%s\n' "bpm-load: Error: '$__bpm_full_path' is a directory"
@@ -97,7 +100,7 @@ bpm-load() {
 		local __bpm_file= __bpm_file_was_sourced='no'
 		# shellcheck disable=SC2041
 		for __bpm_file in 'load.bash'; do
-			local __bpm_full_path="$__bpm_root_dir/packages/$__bpm_site/$__bpm_package/$__bpm_file"
+			local __bpm_full_path="$__bpm_cellar/packages/$__bpm_site/$__bpm_package/$__bpm_file"
 
 			if [ -f "$__bpm_full_path" ]; then
 				__bpm_file_was_sourced='yes'

pkg/lib/cmd/bpm.sh

@@ -4,17 +4,26 @@ set -ETeo pipefail
 shopt -s nullglob extglob
 
 main() {
-	: "${BPM_ROOT:="${XDG_DATA_HOME:-$HOME/.local/share}/bpm"}"
-	: "${BPM_CELLAR:="$BPM_ROOT/cellar"}"
-	: "${BPM_PACKAGES_PATH:="$BPM_CELLAR/packages"}"
-	: "${BPM_INSTALL_BIN:="$BPM_CELLAR/bin"}"
-	: "${BPM_INSTALL_MAN:="$BPM_CELLAR/man"}"
-	: "${BPM_INSTALL_COMPLETIONS:="$BPM_CELLAR/completions"}"
-
 	for f in "$PROGRAM_LIB_DIR"/{commands,util}/?*.sh; do
 		source "$f"
 	done
 
+	if [ "$1" = init ] || [[ "$1" = - && "$2" = init ]]; then
+		shift
+		do-init "$@"
+		return
+	fi
+
+	if [[ -z "$BPM_REPO_SOURCE" || -z "$BPM_CELLAR" ]]; then
+		die "Either 'BPM_REPO_SOURCE' or 'BPM_CELLAR' is empty. Did you forget to run add \`bpm init <shell>\` in your shell configuration?"
+	fi
+
+	# 'BPM_LOCAL_PROJECT_DIR' is set in 'util.setup_mode'
+	BPM_PACKAGES_PATH="$BPM_CELLAR/packages"
+	BPM_INSTALL_BIN="$BPM_CELLAR/bin"
+	BPM_INSTALL_MAN="$BPM_CELLAR/man"
+	BPM_INSTALL_COMPLETIONS="$BPM_CELLAR/completions"
+
 	BPM_MODE='local'
 
 	for arg; do

pkg/lib/commands/do-add.sh

@@ -45,7 +45,7 @@ do-add() {
 	fi
 
 	if [ "$flag_all" = yes ]; then
-		local bpm_toml_file="$BPM_ROOT/bpm.toml"
+		local bpm_toml_file="$BPM_LOCAL_PROJECT_DIR/bpm.toml"
 
 		if util.get_toml_array "$bpm_toml_file" 'dependencies'; then
 			log.info "Adding all dependencies"

pkg/lib/commands/do-echo.sh

@@ -3,17 +3,17 @@
 echo_bpm_variables_posix() {
 	cat <<-EOF
 	# bpm variables
-	export BPM_REPO_ROOT="$BPM_REPO_ROOT"
-	export BPM_CELLAR="$BPM_CELLAR"
+	export BPM_REPO_SOURCE="${BPM_REPO_SOURCE:-"${XDG_DATA_HOME:-$HOME/.local/share}/bpm/source"}"
+	export BPM_CELLAR="${BPM_CELLAR:-"${XDG_DATA_HOME:-$HOME/.local/share}/bpm/cellar"}"
 
 	EOF
 }
 
 echo_bpm_include_posix() {
 	cat <<-"EOF"
 	# bpm include function
-	if [ -f "$BPM_REPO_ROOT/pkg/share/include.sh" ]; then
-	  . "$BPM_REPO_ROOT/pkg/share/include.sh"
+	if [ -f "$BPM_REPO_SOURCE/pkg/share/include.sh" ]; then
+	  . "$BPM_REPO_SOURCE/pkg/share/include.sh"
 	fi
 
 	EOF
@@ -51,15 +51,15 @@ do-init() {
 	fish)
 		cat <<-EOF
 		# bpm variables
-		set -gx BPM_REPO_ROOT $BPM_REPO_ROOT
-		set -gx BPM_CELLAR $BPM_CELLAR
+		set -gx BPM_REPO_SOURCE "${BPM_REPO_SOURCE:-"${XDG_DATA_HOME:-$HOME/.local/share}/bpm/source"}"
+		set -gx "${BPM_CELLAR:-"${XDG_DATA_HOME:-$HOME/.local/share}/bpm/cellar"}"
 
 		# bpm completion
-		source \$BPM_REPO_ROOT/completions/bpm.fish
+		source \$BPM_REPO_SOURCE/completions/bpm.fish
 
 		# bpm include function
-		if [ -f "$BPM_REPO_ROOT/pkg/share/include.fish" ]
-		  source "$BPM_REPO_ROOT/pkg/share/include.fish"
+		if [ -f "$BPM_REPO_SOURCE/pkg/share/include.fish" ]
+		  source "$BPM_REPO_SOURCE/pkg/share/include.fish"
 		end
 
 		# bpm packages PATH
@@ -80,8 +80,8 @@ do-init() {
 		echo_bpm_variables_posix
 		cat <<-EOF
 		# bpm completions
-		if [ -f "\$BPM_REPO_ROOT/completions/bpm.bash" ]; then
-		  . "\$BPM_REPO_ROOT/completions/bpm.bash"
+		if [ -f "\$BPM_REPO_SOURCE/completions/bpm.bash" ]; then
+		  . "\$BPM_REPO_SOURCE/completions/bpm.bash"
 		fi
 
 		EOF
@@ -103,7 +103,7 @@ do-init() {
 		echo_bpm_variables_posix
 		cat <<-EOF
 		# bpm completions
-		fpath=("\$BPM_REPO_ROOT/completions" \$fpath)
+		fpath=("\$BPM_REPO_SOURCE/completions" \$fpath)
 		EOF
 
 		echo_bpm_include_posix

pkg/lib/commands/do-init.sh

@@ -37,7 +37,7 @@ do-remove() {
 	fi
 
 	if [ "$flag_all" = yes ]; then
-		local bpm_toml_file="$BPM_ROOT/bpm.toml"
+		local bpm_toml_file="$BPM_LOCAL_PROJECT_DIR/bpm.toml"
 
 		if util.get_toml_array "$bpm_toml_file" 'dependencies'; then
 			log.info "Removing all dependencies"

pkg/lib/commands/do-remove.sh

@@ -62,7 +62,7 @@ do-upgrade() {
 
 	# TODO: test this
 	if [ "$flag_all" = yes ]; then
-		local bpm_toml_file="$BPM_ROOT/bpm.toml"
+		local bpm_toml_file="$BPM_LOCAL_PROJECT_DIR/bpm.toml"
 
 		if util.get_toml_array "$bpm_toml_file" 'dependencies'; then
 			log.info "Adding all dependencies"

pkg/lib/commands/do-upgrade.sh

@@ -277,7 +277,9 @@ util.setup_mode() {
 				printf "  -> %s\n" "'$project_root_dir'"
 			fi
 
-			BPM_ROOT="$project_root_dir"
+			# Set the variables as to make them orrect for 'local' mode
+			BPM_LOCAL_PROJECT_DIR="$project_root_dir"
+			BPM_REPO_SOURCE="$BPM_REPO_SOURCE"
 			BPM_CELLAR="$project_root_dir/bpm_packages"
 			BPM_PACKAGES_PATH="$BPM_CELLAR/packages"
 			BPM_INSTALL_BIN="$BPM_CELLAR/bin"

pkg/lib/util/util.sh

@@ -6,6 +6,9 @@ load 'util/init.sh'
 	local site='github.com'
 	local pkg="user/project2"
 
+	BPM_REPO_SOURCE="$BPM_TEST_REPO_ROOT/../source"
+	BPM_CELLAR="$BPM_TEST_DIR/cellar"
+
 	test_util.setup_pkg "$pkg"; {
 		echo "printf '%s\n' 'it works :)'" > 'load.bash'
 	}; test_util.finish_pkg