ask, choose, confirm: implement #99, #213, #188

.github/workflows/dorothy-workflow.yml

@@ -16,7 +16,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
         run: |
           # ensure dorothy is cloned, and run command
-          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/install?slug=${{ github.repository }}&commit=${{ github.sha }}')"
+          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/install?slug=${{ github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')"
       - name: 'Dorothy Configure'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
@@ -123,7 +123,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
         run: |
           # ensure dorothy is cloned, and run command
-          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.repository }}&commit=${{ github.sha }}')" -- dorothy test
+          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')" -- dorothy test
   fresh-macos-test:
     strategy:
       fail-fast: false
@@ -140,7 +140,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
         run: |
           # ensure dorothy is cloned, and run command
-          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.repository }}&commit=${{ github.sha }}')" -- dorothy test
+          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')" -- dorothy test
   container-test:
     runs-on: ubuntu-latest
     strategy:
@@ -211,4 +211,4 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # prevent rate limiting
         run: |
           # ensure dorothy is cloned, and run command
-          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.repository }}&commit=${{ github.sha }}')" -- dorothy test
+          bash -c "$(curl -fsSL 'https://dorothy.bevry.me/run?slug=${{ github.repository }}&commit=${{ github.event.pull_request.head.sha || github.sha }}')" -- dorothy test

README.md

@@ -354,7 +354,7 @@ Stable commands:
 
     -   [`bash.bash`](https://github.com/bevry/dorothy/tree/master/sourcces/bash.bash) for a Bash strict mode that actually works, and various shims/polyfills
     -   [`ask`](https://github.com/bevry/dorothy/tree/master/commands/ask), [`confirm`](https://github.com/bevry/dorothy/tree/master/commands/confirm), and [`choose`](https://github.com/bevry/dorothy/tree/master/commands/choose) for prompting the user for input
-    -   [`echo-style`](https://github.com/bevry/dorothy/tree/master/commands/echo-style), [`echo-segment`](https://github.com/bevry/dorothy/tree/master/commands/echo-segment), [`echo-element`](https://github.com/bevry/dorothy/tree/master/commands/echo-element), [`echo-error`](https://github.com/bevry/dorothy/tree/master/commands/echo-error), [`echo-verbose`](https://github.com/bevry/dorothy/tree/master/commands/echo-verbose), and [`eval-helper`](https://github.com/bevry/dorothy/tree/master/commands/eval-helper) for output styling
+    -   [`echo-style`](https://github.com/bevry/dorothy/tree/master/commands/echo-style), [`echo-error`](https://github.com/bevry/dorothy/tree/master/commands/echo-error), [`echo-verbose`](https://github.com/bevry/dorothy/tree/master/commands/echo-verbose), and [`eval-helper`](https://github.com/bevry/dorothy/tree/master/commands/eval-helper) for output styling
     -   Dozens of `echo-*`, `fs-*`, `get-*`, and `is-*` helpers
 
 Beta commands:

commands.beta/choose-menu

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+function choose_menu() (
+	# b/c alias for choose
+	choose --index "$@"
+)
+
+# fire if invoked standalone
+if test "$0" = "${BASH_SOURCE[0]}"; then
+	choose_menu "$@"
+fi

commands.beta/choose-option

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+function choose_option() (
+	# b/c alias for choose
+	choose "$@"
+)
+
+# fire if invoked standalone
+if test "$0" = "${BASH_SOURCE[0]}"; then
+	choose_option "$@"
+fi

commands/echo-element → commands.beta/echo-element

@@ -9,7 +9,7 @@ function echo_element() (
 	function help {
 		cat <<-EOF >/dev/stderr
 			ABOUT:
-			Forward <input> to [echo-style], with expansions for --open, --close, --openclose, and --status.
+			[echo-style] now natively supports elements, change [--open=] to [--element=], [--close=] to [--/element=], and [--openclose=] to [--element/=], and [--status=] remains the same.
 
 			USAGE:
 			echo-element [--] ...<input>
@@ -25,23 +25,20 @@ function echo_element() (
 		case "$item" in
 		'--help' | '-h') help ;;
 		'--open='*)
-			option_args+=('--element_open' "--bold=${item#*=}" '--element_close')
+			item="${item#*=}"
+			option_args+=("--element=$item")
 			;;
 		'--close='*)
-			option_args+=('--element_slash_open' "--bold=${item#*=}" '--element_close')
+			item="${item#*=}"
+			option_args+=("--/element=$item")
 			;;
 		'--openclose='*)
-			option_args+=('--element_open' "--bold=${item#*=}" '--element_slash_close')
+			item="${item#*=}"
+			option_args+=("--element/=$item")
 			;;
 		'--status='*)
 			item="${item#*=}"
-			if test "$item" -eq 0; then
-				# success
-				option_args+=("--g3=[$item]")
-			else
-				# failure
-				option_args+=("--e3=[$item]")
-			fi
+			option_args+=("--status=$item")
 			;;
 		*) option_args+=("$item") ;;
 		esac

commands.beta/echo-exit-status

@@ -48,7 +48,7 @@ function echo_exit_status() (
 
 	local cmd_status
 	eval_capture --statusvar=cmd_status -- "${cmd[@]}"
-	print_line "$cmd_status"
+	__print_line "$cmd_status"
 )
 
 # fire if invoked standalone

commands.beta/echo-if-directory

@@ -36,7 +36,7 @@ function echo_if_directory() (
 
 	function on_input {
 		if test -n "$1" -a -d "$1"; then
-			print_line "$1"
+			__print_line "$1"
 		fi
 	}
 

commands.beta/echo-if-empty

@@ -85,9 +85,9 @@ function echo_if_empty() (
 	}
 	function on_finish {
 		if is-empty-string -- "$inputs"; then
-			print_string "$fallback"
+			__print_string "$fallback"
 		else
-			print_string "$inputs"
+			__print_string "$inputs"
 		fi
 	}
 	stdinargs "${option_args[@]}"

commands.beta/echo-if-executable

@@ -40,7 +40,7 @@ function echo_if_executable() (
 
 	function on_input {
 		if test -n "$1" -a -x "$1"; then
-			print_line "$1"
+			__print_line "$1"
 		fi
 	}
 

commands.beta/echo-if-path

@@ -36,7 +36,7 @@ function echo_if_path() (
 
 	function on_input {
 		if is-present -- "$1"; then
-			print_line "$1"
+			__print_line "$1"
 		fi
 	}
 

commands.beta/echo-nonflags

@@ -46,7 +46,7 @@ function echo_nonflags() (
 
 	function on_input {
 		if [[ $1 != -* ]]; then
-			print_line "$1"
+			__print_line "$1"
 		fi
 	}
 

commands.beta/echo-numeric

@@ -47,7 +47,7 @@ function echo_numeric() (
 	local had_an_invalid_input=no
 	function on_input {
 		if is-number -- "$1"; then
-			print_line "$1"
+			__print_line "$1"
 		else
 			echo-style --error="[$1] is not a number" >/dev/stderr
 			had_an_invalid_input=yes

commands.beta/echo-segment

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+function echo_segment() (
+	source "$DOROTHY/sources/bash.bash"
+
+	# =====================================
+	# Arguments
+
+	function help {
+		cat <<-EOF >/dev/stderr
+			ABOUT:
+			[echo-style] now supports _open and _close segments natively, as such there is no need for [echo-segment] anymore
+
+			USAGE:
+			echo-segment [--] ...<input>
+		EOF
+		return 22 # EINVAL 22 Invalid argument
+	}
+
+	# =====================================
+	# Action
+
+	echo-style "$@"
+)
+
+# fire if invoked standalone
+if test "$0" = "${BASH_SOURCE[0]}"; then
+	echo_segment "$@"
+fi

commands.beta/echo-values

@@ -47,7 +47,7 @@ function echo_values() (
 
 	function on_input {
 		if is-value -- "$1"; then
-			print_line "$1"
+			__print_line "$1"
 		fi
 	}
 

commands.beta/edit-dns

@@ -41,12 +41,12 @@ function edit_dns() (
 	# edit /etc/resolv.conf
 
 	if get-app --quiet -- 'ProtonVPN'; then
-		print_line 'ProtonVPN enforces its own DNS'
+		__print_line 'ProtonVPN enforces its own DNS'
 	elif command-exists dnscrypt-proxy; then
-		print_line 'Editing DNS configuration of dnscrypt-proxy'
+		__print_line 'Editing DNS configuration of dnscrypt-proxy'
 		edit --wait -- "${HOMEBREW_PREFIX:-"/usr/local"}/etc/dnscrypt-proxy.toml"
 	else
-		print_line 'DNS editing only supported for dnscrypt-proxy'
+		__print_line 'DNS editing only supported for dnscrypt-proxy'
 	fi
 )
 

commands.beta/eject-all

@@ -35,23 +35,23 @@ function eject_all() (
 	# =====================================
 	# Action
 
-	echo-segment --h1='eject-all'
+	echo-style --h1='eject-all'
 
-	echo-segment --h2='before'
+	echo-style --h2='before'
 	ls /Volumes
-	echo-segment --g2='before'
+	echo-style --g2='before'
 
 	eval-helper --quiet \
 		--pending="$(echo-style --bold='Ejecting...')" \
 		--success="$(echo-style --success='Ejected.')" \
 		--failure="$(echo-style --error='Failed to eject.')" \
 		-- osascript -e 'tell application "Finder" to eject (every disk whose ejectable is true)'
 
-	echo-segment --h2='after'
+	echo-style --h2='after'
 	ls /Volumes
-	echo-segment --g2='after'
+	echo-style --g2='after'
 
-	echo-segment --h1='eject-all'
+	echo-style --h1='eject-all'
 )
 
 # fire if invoked standalone

commands.beta/ensure-trailing-slash

@@ -50,16 +50,16 @@ function ensure_trailing_slash() (
 	for path in "${option_paths[@]}"; do
 		if test -d "$path"; then
 			if [[ $path != */ ]]; then
-				print_line "$path/"
+				__print_line "$path/"
 			else
-				print_line "$path"
+				__print_line "$path"
 			fi
 		elif test -f "$path"; then
 			if [[ $path == */ ]]; then
 				length="${#path}"
-				print_line "${path:0:length-1}"
+				__print_line "${path:0:length-1}"
 			else
-				print_line "$path"
+				__print_line "$path"
 			fi
 		else
 			echo-style --error='Not a file nor directory:' ' ' --code="$path" >/dev/stderr

commands.beta/get-git-default-branch

@@ -47,13 +47,13 @@ function get_git_default_branch() (
 	default_global="$(git config --global init.defaultBranch 2>/dev/null || :)"
 
 	if test -n "$default_local" && __branch_exists "$default_local"; then
-		print_line "$default_local"
+		__print_line "$default_local"
 	elif test -n "$default_global" && __branch_exists "$default_global"; then
-		print_line "$default_global"
+		__print_line "$default_global"
 	elif __branch_exists 'main'; then
-		print_line 'main'
+		__print_line 'main'
 	elif __branch_exists 'master'; then
-		print_line 'master'
+		__print_line 'master'
 	else
 		echo-error 'Unable to determine the default branch.'
 		return 1

commands.beta/icloud-helper

@@ -79,12 +79,12 @@ function icloud_helper() (
 			# .screenflow does not play niceley with iCloud Drive, as it is a secret directory
 			if test ! -d "$path" && [[ $path != *".DS_Store" && $path != *".icloud" ]]; then
 				if [[ $path == *".screenflow"* || $path == *".sketch"* ]]; then
-					print_line "skipped $path, as it is a directory in disguise as a file, and can only evict files"
+					__print_line "skipped $path, as it is a directory in disguise as a file, and can only evict files"
 				else
 					brctl evict "$path"
 				fi
 			else
-				print_line "skipped $path, as it is a directory or excluded path"
+				__print_line "skipped $path, as it is a directory or excluded path"
 			fi
 		done
 	}
@@ -103,7 +103,7 @@ function icloud_helper() (
 	if test "$(type -t "$action")" = 'function'; then
 		"$action" "${option_args[@]}"
 	else
-		print_line "Action [$action] not yet implemented." >/dev/stderr
+		__print_line "Action [$action] not yet implemented." >/dev/stderr
 		return 78 # ENOSYS 78 Function not implemented
 	fi
 )

commands.beta/itunes-owners

@@ -47,29 +47,29 @@ function itunes_owners() (
 	owner_list="$(fs-temp --directory='itunes-owners' --file='owner.txt' --touch)"
 	missing_list="$(fs-temp --directory='itunes-owners' --file='missing.txt' --touch)"
 	database="$HOME/Music/iTunes/iTunes Music Library.xml"
-	echo-style --h2="Reading $database"
+	echo-style --header2="Reading $database"
 
 	# fetch songs
 	local song_count=0
 	function fetch_songs {
-		echo-style --h2="Fetching songs to $song_list"
+		echo-style --header2="Fetching songs to $song_list"
 		rg --only-matching --regexp='<string>file://(.+)</string>' --replace='$1' <"$database" |
 			echo-url-decode --stdin |
 			echo-html-decode --stdin >"$song_list"
 		song_count="$(wc -l <"$song_list" | xargs)"
-		echo-style --g2="...found $song_count media files."
+		echo-style --good2="...found $song_count media files."
 	}
 	fetch_songs # @todo use eval-helper
 
 	# fetch owners
 	function fetch_owners {
 		local song owner
-		echo-style --h2="Fetching owners to $owner_list"
+		echo-style --header2="Fetching owners to $owner_list"
 		while read -r song; do
 			# check
 			if test ! -f "$song"; then
 				echo-style "$song" ' ' --notice='is missing'
-				print_line "$song" >>"$missing_list"
+				__print_line "$song" >>"$missing_list"
 				continue
 			fi
 
@@ -90,18 +90,18 @@ function itunes_owners() (
 	# extract
 	local owners owner_count owned_count
 	owners="$(cut -f1 -s <"$owner_list" | sort | uniq)"
-	owner_count="$(print_line "$owners" | wc -l | xargs)"
+	owner_count="$(__print_line "$owners" | wc -l | xargs)"
 	owned_count="$(wc -l <"$owner_list" | xargs)"
 
-	echo-style --h2="$owner_count UNIQUE OWNERS:"
-	print_line "$owners"
+	echo-style --header2="$owner_count UNIQUE OWNERS:"
+	__print_line "$owners"
 	echo
 
-	echo-style --h2="$owned_count OWNED MEDIA:"
+	echo-style --header2="$owned_count OWNED MEDIA:"
 	sort <"$owner_list" | column -t -s $'\t'
 	echo
 
-	echo-style --h2="$(wc -l <"$missing_list" | xargs) MISSING MEDIA:"
+	echo-style --header2="$(wc -l <"$missing_list" | xargs) MISSING MEDIA:"
 	sort <"$missing_list"
 	echo
 )