feat: Add 'prune' subcommand

Author: hyperupcall

completions/bpm.bash

@@ -1,6 +1,6 @@
 _bpm() {
 	local -ra listPreSubcommandOptions=(--help --version --global)
-	local -ra listSubcommands=(add echo init link list package-path remove upgrade)
+	local -ra listSubcommands=(add echo init link list package-path prune remove upgrade)
 
 	local -r currentWord="${COMP_WORDS[COMP_CWORD]}"
 

completions/bpm.fish

@@ -1,5 +1,5 @@
 set cmd bpm
-set -l listSubcommands add echo init link list package-path remove upgrade
+set -l listSubcommands add echo init link list package-path prune remove upgrade
 
 # Not only does this prevent appending completion properties to $cmd (we
 # want to start from a completely new definition), it also removes incorrect

pkg/lib/cmd/bpm.sh

@@ -68,6 +68,10 @@ main() {
 		shift
 		bpm-package-path "$@"
 		;;
+	prune)
+		shift
+		do-prune "$@"
+		;;
 	remove)
 		shift
 		do-remove "$@"

pkg/lib/commands/do-prune.sh

@@ -0,0 +1,21 @@
+# shellcheck shell=bash
+
+do-prune() {
+	util.setup_mode
+
+	log.info "Pruning packages"
+
+	for file in "$BPM_INSTALL_BIN"/* "$BPM_INSTALL_MAN"/*/* "$BPM_INSTALL_COMPLETIONS"/{bash,zsh/{compsys,compctl},fish}/*; do
+		local real_file=
+		real_file="$(readlink "$file")"
+
+		if [[ "${real_file:0:1}" == / && -e "$real_file" ]]; then
+			# The only valid symlinks 'bpm' creates are absolute paths
+			# to an existing file
+			continue
+		fi
+
+		printf '  -> %s\n' "Unsymlinking broken symlink '$file'"
+		unlink "$file"
+	done
+}

pkg/lib/util/util.sh

@@ -310,6 +310,11 @@ Subcommands:
     Installs a package from a local directory. These have a
     namespace of 'local'
 
+  prune
+    Removes broken symlinks in the bins, completions, and man
+    directories. This is usually only required if a package is
+    force-removed
+
   list [--simple] [--fetch] [package...]
     List installed packages
 

tests/do-prune.bats

@@ -0,0 +1,68 @@
+#!/usr/bin/env bats
+
+load 'util/init.sh'
+
+@test "prune works for bin files" {
+	local file="$BPM_INSTALL_BIN/file"
+
+	mkdir -p "$BPM_INSTALL_BIN"
+	ln -s "/invalid" "$file"
+
+	assert [ -L "$file" ]
+
+	run do-prune
+
+	assert_success
+	assert [ ! -L "$file" ]
+	assert [ ! -e "$file" ]
+}
+
+@test "prune works for man files" {
+	local file="$BPM_INSTALL_MAN/man1/something.1"
+
+	mkdir -p "$BPM_INSTALL_MAN/man1"
+	ln -s "/invalid" "$file"
+
+	assert [ -L "$file"  ]
+
+	run do-prune
+
+	assert_success
+	assert [ ! -L "$file"  ]
+	assert [ ! -e "$file"  ]
+}
+
+@test "prune works for completion files" {
+	local file1="$BPM_INSTALL_COMPLETIONS/bash/something.bash"
+	local file2="$BPM_INSTALL_COMPLETIONS/zsh/compsys/_something.zsh"
+
+	mkdir -p "$BPM_INSTALL_COMPLETIONS"/{bash,zsh/compsys}
+	ln -s "/invalid" "$file1"
+	ln -s "/invalid" "$file2"
+
+	assert [ -L "$file1"  ]
+	assert [ -L "$file2"  ]
+
+	run do-prune
+
+	assert_success
+	assert [ ! -L "$file1"  ]
+	assert [ ! -e "$file1"  ]
+	assert [ ! -L "$file2"  ]
+	assert [ ! -e "$file2"  ]
+}
+
+@test "prune works for relative files" {
+	local file="$BPM_INSTALL_BIN/file"
+
+	mkdir -p "$BPM_INSTALL_BIN"
+	ln -s "invalid" "$file"
+
+	assert [ -L "$file" ]
+
+	run do-prune
+
+	assert_success
+	assert [ ! -L "$file" ]
+	assert [ ! -e "$file" ]
+}