feat: Revamp do-list. Closes #50

Author: hyperupcall

pkg/lib/commands/do-add.sh

@@ -21,8 +21,7 @@ do-add() {
 
 	for repoSpec in "${pkgs[@]}"; do
 		if [[ -d "$repoSpec" && "${repoSpec::1}" == / ]]; then
-			log.warn "Identifier '$repoSpec' is a directory, not a package. Skipping"
-			continue
+			die "Identifier '$repoSpec' is a directory, not a package"
 		fi
 
 		util.extract_data_from_input "$repoSpec" "$with_ssh"
@@ -31,6 +30,10 @@ do-add() {
 		local package="$REPLY3"
 		local ref="$REPLY4"
 
+		if [ "${package%/*}" = 'local' ]; then
+			die "Cannot install packages owned by username 'local' because that conflicts with linked packages"
+		fi
+
 		log.info "Installing '$repoSpec'"
 		do-plumbing-clone "$uri" "$site/$package" $ref
 		do-plumbing-add-deps "$site/$package"

pkg/lib/commands/do-list.sh

@@ -1,44 +1,35 @@
 # shellcheck shell=bash
 
 do-list() {
-	local should_show_outdated='no'
+	local flag_outdated='no'
+	local flag_simple='no'
 
 	for arg; do
 		case "$arg" in
 		--outdated)
-			should_show_outdated='yes'
+			flag_outdated='yes'
+			;;
+		--simple)
+			flag_simple='yes'
 			;;
 		esac
 	done
 
 	local has_invalid_packages='no'
 
-	if [ "$should_show_outdated" = 'yes' ]; then
-		local packages
-		readarray -t packages < <(do-list)
-
-		for package in "${packages[@]}"; do
-			local package_path="$BPM_PACKAGES_PATH/$package"
-
-			if [ ! -L "$package_path" ]; then
-				ensure.cd "$package_path"
-				git remote update &>/dev/null
+	for namespace_path in "$BPM_PACKAGES_PATH"/*; do
+		local glob_suffix=
+		if [ "${namespace_path##*/}" = 'local' ]; then
+			glob_suffix="/*"
+		else
+			glob_suffix="/*/*"
+		fi
 
-				if git symbolic-ref --short -q HEAD >/dev/null; then
-					# shellcheck disable=SC1083
-					if [ "$(git rev-list --count HEAD...HEAD@{upstream})" -gt 0 ]; then
-						printf "%s\n" "$package"
-					fi
-				fi
-			fi
-		done
-	else
-		for package_path in "$BPM_PACKAGES_PATH"/*/*/*; do
-			util.extract_data_from_package_dir "$package_path"
+		for pkg_path in "$namespace_path"$glob_suffix; do
+			util.extract_data_from_package_dir "$pkg_path"
 			local site="$REPLY1"
 			local user="$REPLY2"
 			local repository="$REPLY3"
-			local package="$user/$repository"
 
 			# Users that have installed packages before the switch to namespacing by
 			# site domain name will print incorrectly. So, we check to make sure the site
@@ -48,15 +39,53 @@ do-list() {
 				continue
 			fi
 
+			# Relative path location of the current package
+			local id=
 			if [ "$site" = 'local' ]; then
-				printf "%s\n" "$site/$user"
+				id="$site/$repository"
 			else
-				printf "%s\n" "$site/$package"
+				id="$site/$user/$repository"
+			fi
+
+			# The information being outputed for a particular package
+			# Ex.
+			# github.com/tj/git-extras
+			#   Status: Up to Date
+			#   Branch: main\n
+			local pkg_output=
+
+			printf -v pkg_output "%s\n" "$id"
+
+			if [ "$flag_simple" = 'no' ]; then
+				ensure.git_repository "$pkg_path" "$id"
+
+				local repo_branch_str= repo_outdated_str=
+
+				repo_branch_str="Branch: $(git -C "$pkg_path" branch --show-current)"
+				printf -v pkg_output "%s  %s\n" "$pkg_output" "$repo_branch_str"
+
+				if git config remote.origin.url &>/dev/null; then
+					# shellcheck disable=SC1083
+					if [ "$(git -C "$pkg_path" rev-list --count HEAD...HEAD@{upstream})" -gt 0 ]; then
+						if [ -n "${NO_COLOR+x}" ] || [ "$TERM" = dumb ]; then
+							repo_outdated_str="State: Out of date"
+						else
+							printf -v repo_outdated_str "\033[1;33m%s\033[0m\n" "State: Out of date"
+						fi
+						repo_outdated_str="State: Out of date"
+					else
+						repo_outdated_str="State: Up to date"
+					fi
+
+					printf -v pkg_output "%s  %s\n" "$pkg_output" "$repo_outdated_str"
+				fi
 			fi
+
+			printf "%s" "$pkg_output"
 		done
-	fi
+	done
 
 	if [ "$has_invalid_packages" = 'yes' ]; then
-		log.error "You have invalid packages. To fix this optimally, remove the '${BPM_PACKAGES_PATH%/*}' directory and reinstall all that packages that were deleted in the process"
+		log.error "You have invalid packages. To fix this optimally, remove the '${BPM_PACKAGES_PATH%/*}' directory and reinstall all that packages that were deleted in the process. This procedure is required in response to a one-time breaking change in how packages are stored"
 	fi
 }

pkg/lib/util/ensure.sh

@@ -39,3 +39,12 @@ ensure.package_exists() {
 		die "Package '$package' does not exist"
 	fi
 }
+
+ensure.git_repository() {
+	local dir="$1"
+	local id="$2"
+
+	if [ ! -d "$dir/.git" ]; then
+		die "Package '$id' is not a Git repository. Unlink or otherwise remove it at '$dir'"
+	fi
+}

pkg/lib/util/util.sh

@@ -89,9 +89,15 @@ util.extract_data_from_package_dir() {
 	local user="${dir%/*}"; user="${user##*/}"
 	local repository="${dir##*/}"
 
-	REPLY1="$site"
-	REPLY2="$user"
-	REPLY3="$repository"
+	if [ "$user" = 'local' ]; then
+		REPLY1="$user"
+		REPLY2=''
+		REPLY3="$repository"
+	else
+		REPLY1="$site"
+		REPLY2="$user"
+		REPLY3="$repository"
+	fi
 	REPLY4=
 }
 

tests/do-add.bats

@@ -15,6 +15,36 @@ load 'util/init.sh'
 	assert_line -n 0 -p "At least one package must be supplied"
 }
 
+@test "fails when the remote repository is owned by a user with username 'local'" {
+	test_util.mock_command do-plumbing-clone
+	test_util.mock_command do-plumbing-add-deps
+	test_util.mock_command do-plumbing-link-bins
+	test_util.mock_command do-plumbing-link-completions
+	test_util.mock_command do-plumbing-link-man
+
+	run do-add 'local/pkg'
+
+	assert_failure
+	assert_line -n 0 -p  "Cannot install packages owned by username 'local' because that conflicts with linked packages"
+}
+
+@test "fails when input is an absolute path to a directory" {
+	local site='github.com'
+	local pkg='username/main'
+
+	test_util.mock_command do-plumbing-clone
+	test_util.mock_command do-plumbing-add-deps
+	test_util.mock_command do-plumbing-link-bins
+	test_util.mock_command do-plumbing-link-completions
+	test_util.mock_command do-plumbing-link-man
+
+	test_util.create_package "$pkg"
+	run do-add "$BPM_ORIGIN_DIR/$site/$pkg"
+
+	assert_failure
+	assert_line -p "Identifier '$BPM_ORIGIN_DIR/$site/$pkg' is a directory, not a package"
+}
+
 @test "executes install steps in right order" {
 	test_util.mock_command do-plumbing-clone
 	test_util.mock_command do-plumbing-add-deps

tests/do-list.bats

@@ -2,7 +2,16 @@
 
 load 'util/init.sh'
 
-@test "properly list for 2 installed packages" {
+@test "properly list for no installed packages" {
+	test_util.create_package 'username/p1'
+
+	run do-list
+
+	assert_success
+	assert_output ""
+}
+
+@test "properly list for 2 installed packages in mode simple list" {
 	local site='github.com'
 
 	test_util.create_package 'username/p1'
@@ -11,24 +20,54 @@ load 'util/init.sh'
 	test_util.fake_clone "$site/username/p1"
 	test_util.fake_clone "$site/username2/p2"
 
-	run do-list
+	run do-list --simple
 
 	assert_success
-	assert_line "$site/username/p1"
-	assert_line "$site/username2/p2"
+	assert_line -n 0 "$site/username2/p2"
+	assert_line -n 1 "$site/username/p1"
 	refute_line "$site/username2/p3"
 }
 
-@test "properly list for no installed packages" {
+@test "properly list for local packages in simple list" {
+	local site='github.com'
+	local pkg='somepath/project2'
+
+	test_util.mock_command do-plumbing-add-deps
+	test_util.mock_command do-plumbing-link-bins
+	test_util.mock_command do-plumbing-link-completions
+	test_util.mock_command do-plumbing-link-man
+
+	test_util.create_package "$pkg"
+	do-link "$BPM_ORIGIN_DIR/$site/$pkg"
+
+	run do-list --simple
+
+	assert_success
+	assert_output "local/project2"
+}
+
+@test "properly list for 2 installed packages in mode non-simple list" {
+	local site='github.com'
+
 	test_util.create_package 'username/p1'
+	test_util.create_package 'username2/p2'
+	test_util.create_package 'username2/p3'
+	test_util.fake_clone "$site/username/p1"
+	test_util.fake_clone "$site/username2/p2"
 
 	run do-list
 
+	# Note that all the tests for non-simple list do not include 'state' up to date since that is not emulated
+	# in the test
 	assert_success
-	assert_output ""
+	assert_output "$site/username2/p2
+  Branch: master
+$site/username/p1
+  Branch: master"
 }
 
-@test "properly list for local packages" {
+
+@test "properly list for local packages in mode non-simple list" {
 	local site='github.com'
 	local pkg='somepath/project2'
 
@@ -43,7 +82,8 @@ load 'util/init.sh'
 	run do-list
 
 	assert_success
-	assert_output "local/project2"
+	assert_output "local/project2
+  Branch: master"
 }
 
 @test "properly list outdated packages" {

tests/util-extract-data-from-package-dir.bats

@@ -0,0 +1,27 @@
+#!/usr/bin/env bats
+
+load 'util/init.sh'
+
+@test "directory with GitHub site" {
+	util.extract_data_from_package_dir "cellar/packages/github.com/eankeen/bash-args"
+
+	assert [ "$REPLY1" = 'github.com' ]
+	assert [ "$REPLY2" = 'eankeen' ]
+	assert [ "$REPLY3" = 'bash-args' ]
+}
+
+@test "directory with GitLab site" {
+	util.extract_data_from_package_dir "cellar/packages/gitlab.com/eankeen/bash-args"
+
+	assert [ "$REPLY1" = 'gitlab.com' ]
+	assert [ "$REPLY2" = 'eankeen' ]
+	assert [ "$REPLY3" = 'bash-args' ]
+}
+
+@test "directory installed locally" {
+	util.extract_data_from_package_dir "cellar/packages/local/bash-args"
+
+	assert [ "$REPLY1" = 'local' ]
+	assert [ "$REPLY2" = '' ]
+	assert [ "$REPLY3" = 'bash-args' ]
+}

tests/util/test_util.sh

@@ -58,6 +58,6 @@ test_util.create_package() {
 	ensure.non_zero 'pkg' "$pkg"
 
 	test_util.setup_pkg "$pkg"; {
-		:
+		git branch -M master
 	}; test_util.finish_pkg
 }