refactor: Rename BASALT_PACKAGE_PATH to BASALT_PACKAGE_DIR

This also changes the code behind generated/source_package.sh

Author: hyperupcall

docs/reference/environment.md

@@ -16,6 +16,6 @@ The directory Basalt stores nearly all data. This includes downloaded tarballs,
 
 Local environment variables are only valid within a Bash package (after `eval "$(basalt-package-init)"; basalt.package-init`)
 
-### `BASALT_PACKAGE_PATH`
+### `BASALT_PACKAGE_DIR`
 
-The full path to the current project. It is calculated by walking up the file tree from `$PWD`, only stopping after detecting a `./basalt.toml`. The directory that was stopped at is the new value of `BASALT_PACKAGE_PATH`
+The full path to the current project. It is calculated by walking up the file tree from `$PWD`, only stopping after detecting a `./basalt.toml`. The directory that was stopped at is the new value of `BASALT_PACKAGE_DIR`

pkg/bin/basalt-package-init

@@ -3,6 +3,7 @@
 # Do NOT edit!
 
 # https://github.com/bashup/realpaths
+# TODO: get rid of this, and for 'basalt'
 realpath.location() {
 	realpath.follow "$1"
 	realpath.absolute "$REPLY" ".."

pkg/lib/cmd/basalt-package-init.sh

@@ -28,8 +28,8 @@ basalt.package-init() {
    source "$BASALT_GLOBAL_REPO/pkg/lib/public/basalt-package.sh"
 
    # TODO: this needs to be redone
-   if [ -z "$BASALT_PACKAGE_PATH" ]; then
-   local __old_cd="$PWD"
+   if [ -z "${BASALT_PACKAGE_DIR:-}" ]; then
+      local __old_cd="$PWD"
       if [ -L "$0" ]; then
          local __file="$(readlink "$0")"
          if ! cd "${__file%/*}"; then
@@ -38,7 +38,7 @@ basalt.package-init() {
          fi
       fi
 
-      if ! BASALT_PACKAGE_PATH="$(
+      if ! BASALT_PACKAGE_DIR="$(
          while [ ! -f 'basalt.toml' ] && [ "$PWD" != / ]; do
             if ! cd ..; then
                return 1

pkg/lib/commands/do-init.sh

@@ -67,7 +67,7 @@ do-init() {
 		eval "$(basalt-package-init)"; basalt.package-init
 		basalt.package-load
 
-		source "$BASALT_PACKAGE_PATH/pkg/lib/cmd/file.sh"
+		source "$BASALT_PACKAGE_DIR/pkg/lib/cmd/file.sh"
 		file.main "$@"
 		EOF
 			bprint.die "Could not write to $file2"
@@ -78,6 +78,8 @@ do-init() {
 		mkdir -p 'pkg/lib/cmd'
 		local file3="./pkg/lib/cmd/file.sh"
 		if ! cat >| "$file3" <<"EOF"; then
+# shellcheck shell=bash
+
 file.main() {
 	printf '%s\n' "Woof!"
 }
@@ -86,6 +88,40 @@ EOF
 		fi
 		bprint.info "Created $file3"
 
+
+		mkdir -p 'tests/util'
+		local file4='./tests/util/init.sh'
+		if ! cat >| "$file4" <<"EOF"; then
+# shellcheck shell=bash
+
+eval "$(basalt-package-init)"; basalt.package-init
+basalt.package-load
+# basalt.load 'github.com/hyperupcall/bats-common-utils' 'load.bash'
+
+load './util/test_util.sh'
+
+export NO_COLOR=
+
+setup() {
+	ensure.cd "$BATS_TEST_TMPDIR"
+}
+
+teardown() {
+	ensure.cd "$BATS_SUITE_TMPDIR"
+}
+EOF
+			bprint.die "Could not write to $file4"
+		fi
+		bprint.info "Created $file4"
+
+		mkdir -p 'tests/util'
+		local file5='./tests/util/test_util.sh'
+		if ! cat >| "$file5" <<"EOF"; then
+# shellcheck shell=bash
+EOF
+			bprint.die "Could not write to $file5"
+		fi
+		bprint.info "Created $file5"
 		;;
 	full)
 		if ! git clone -q 'https://github.com/hyperupcall/template-bash' .; then

pkg/lib/public/basalt-load.sh

@@ -87,7 +87,7 @@ basalt.load() {
 				source "$__basalt_pkg_path/load.bash"
 
 				if declare -f basalt_load &>/dev/null; then
-					BASALT_PACKAGE_PATH="$__basalt_pkg_path" basalt_load
+					BASALT_PACKAGE_DIR="$__basalt_pkg_path" basalt_load
 					unset basalt_load
 				fi
 			fi
@@ -98,7 +98,7 @@ basalt.load() {
 		# Assume can only have one version of a particular package for direct dependencies
 		local __basalt_load_package_exists='no' __basalt_did_run_source='no'
 		local __basalt_actual_pkg_path=
-		for __basalt_actual_pkg_path in "$BASALT_PACKAGE_PATH/.basalt/packages/$__basalt_pkg_path"*; do
+		for __basalt_actual_pkg_path in "$BASALT_PACKAGE_DIR/.basalt/packages/$__basalt_pkg_path"*; do
 			if [ "$__basalt_load_package_exists" = yes ]; then
 				printf '%s\n' "Error: basalt.load There are multiple direct dependencies for package '$__basalt_pkg_path'. This should not happen"
 				return 1
@@ -108,7 +108,7 @@ basalt.load() {
 
 			if [ -n "$__basalt_file" ]; then
 				if [ -f "$__basalt_actual_pkg_path/$__basalt_file" ]; then
-					BASALT_PACKAGE_PATH="$__basalt_actual_pkg_path" source "$__basalt_actual_pkg_path/$__basalt_file"
+					BASALT_PACKAGE_DIR="$__basalt_actual_pkg_path" source "$__basalt_actual_pkg_path/$__basalt_file"
 					__basalt_did_run_source='yes'
 				else
 					printf '%s\n' "Error: basalt.load File '$__basalt_file' not found in package '$__basalt_pkg_path'"
@@ -120,7 +120,7 @@ basalt.load() {
 				source "$__basalt_actual_pkg_path/load.bash"
 
 				if declare -f basalt_load &>/dev/null; then
-					BASALT_PACKAGE_PATH="$__basalt_actual_pkg_path" basalt_load
+					BASALT_PACKAGE_DIR="$__basalt_actual_pkg_path" basalt_load
 					unset basalt_load
 				fi
 

pkg/lib/public/basalt-package.sh

@@ -5,8 +5,8 @@
 basalt.package-load() {
 	local __basalt_shopt_nullglob=
 
-	if [ -z "${BASALT_PACKAGE_PATH:-}" ]; then
-		printf '%s\n' "Error: basalt.package-load: Variable 'BASALT_PACKAGE_PATH' is empty"
+	if [ -z "${BASALT_PACKAGE_DIR:-}" ]; then
+		printf '%s\n' "Error: basalt.package-load: Variable 'BASALT_PACKAGE_DIR' is empty"
 		return 1
 	fi
 
@@ -17,9 +17,10 @@ basalt.package-load() {
 	fi
 	shopt -s nullglob
 
+	# TODO: Use array expand glob so no need to shopt -s nullglob at end to make this cleaner
 	local __basalt_site= __basalt_repository_owner=  __basalt_package=
-	if [ -d "$BASALT_PACKAGE_PATH"/.basalt/packages ]; then
-		for __basalt_site in "$BASALT_PACKAGE_PATH"/.basalt/packages/*/; do
+	if [ -d "$BASALT_PACKAGE_DIR"/.basalt/packages ]; then
+		for __basalt_site in "$BASALT_PACKAGE_DIR"/.basalt/packages/*/; do
 			for __basalt_repository_owner in "$__basalt_site"/*/; do
 				for __basalt_package in "$__basalt_repository_owner"/*/; do
 					if [ "$__basalt_shopt_nullglob" = 'yes' ]; then
@@ -38,8 +39,8 @@ basalt.package-load() {
 		done; unset __basalt_site
 	fi
 
-	if [ -f "$BASALT_PACKAGE_PATH/.basalt/generated/source_package.sh" ]; then
-		source "$BASALT_PACKAGE_PATH/.basalt/generated/source_package.sh"
+	if [ -f "$BASALT_PACKAGE_DIR/.basalt/generated/source_package.sh" ]; then
+		source "$BASALT_PACKAGE_DIR/.basalt/generated/source_package.sh"
 	fi
 
 	if [ "$__basalt_shopt_nullglob" = 'yes' ]; then

pkg/lib/util/pkg.sh

@@ -215,21 +215,43 @@ pkg.phase_local_integration_nonrecursive() {
 	if [ -f "$project_dir/basalt.toml" ]; then
 		if util.get_toml_array "$project_dir/basalt.toml" 'sourceDirs'; then
 			if ((${#REPLIES[@]} > 0)); then
-				# TODO output to file descriptor with exec
+				# Convert the full '$project_dir' path into something that uses the environment variables
+				local project_dir_short=
+				if [ "$BASALT_LOCAL_PROJECT_DIR" = "${project_dir::${#BASALT_LOCAL_PROJECT_DIR}}" ]; then
+					project_dir_short='$BASALT_PACKAGE_DIR'
+				elif [ "$BASALT_GLOBAL_DATA_DIR" = "${project_dir::${#BASALT_GLOBAL_DATA_DIR}}" ]; then
+					project_dir_short="\$BASALT_GLOBAL_DATA_DIR${project_dir:${#BASALT_GLOBAL_DATA_DIR}}"
+				else
+					bprint.fatal "Unexpected path to project directory '$project_dir'"
+				fi
+
+				# shellcheck disable=SC2016
+				printf -v content '%s%s\n' "$content" '# shellcheck shell=bash
+
+if [ -z "$BASALT_PACKAGE_DIR" ]; then
+	printf "%s\n" "Fatal: source_package.sh: $BASALT_PACKAGE_DIR is empty, but must exist"
+	exit 1
+fi
+
+if [ -z "$BASALT_GLOBAL_DATA_DIR" ]; then
+	printf "%s\n" "Fatal: source_package.sh: $BASALT_GLOBAL_DATA_DIR is empty, but must exist"
+	exit 1
+fi'
 
-				local source_dir=
 				for source_dir in "${REPLIES[@]}"; do
-					# TODO: use BASALT_GLOBAL_DATA_DIR
-					printf -v content '%s%s\n' "$content" "for __basalt_f in \"$project_dir/$source_dir\"/*; do
-  if [ -f \"\$__basalt_f\" ]; then
-    source \"\$__basalt_f\"
-  fi
-done
-"
+					printf -v content '%s%s\n' "$content" "
+# Silently skip if directory doesn't exist since a corresponding warning will print during package installation
+if [ -d \"$project_dir_short/$source_dir\" ]; then
+	# Works if nullglob is unset, given that there is no file called '*'
+	for __basalt_f in \"$project_dir_short/$source_dir\"/*; do
+		if [ -f \"\$__basalt_f\" ]; then
+			# shellcheck disable=SC1090
+			source \"\$__basalt_f\"
+		fi
+	done; unset __basalt_f
+fi"
 				done; unset source_dir
 
-				printf -v content '%s%s' "$content" 'unset __basalt_f'
-
 				if [ ! -d "$project_dir/.basalt/generated" ]; then
 					mkdir -p "$project_dir/.basalt/generated"
 				fi

pkg/lib/util/util.sh

@@ -220,6 +220,7 @@ util.get_latest_package_version() {
 }
 
 util.get_package_info() {
+	unset REPLY{1,2,3,4,5}
 	REPLY1=; REPLY2=; REPLY3=; REPLY4=; REPLY5=
 	local input="$1"
 	ensure.nonzero 'input'