feat(#17): Add range input (#18)

* feat(#17): Add first version of range

- Tested on MacOS, GNU bash 3.2.57

* docs(#17): Extend documentation

docs/modules/Prompts.md

@@ -15,6 +15,7 @@ Prompt for text
 * [password](#password)
 * [editor](#editor)
 * [with_validate](#with_validate)
+* [range](#range)
 * [validate_present](#validate_present)
 
 ### input
@@ -120,7 +121,7 @@ pass=$(password "Enter password to use")
 
 #### Arguments
 
-* **$1** (string): Phrase for promptint to text
+* **$1** (string): Phrase for prompting to text
 
 #### Output on stdout
 
@@ -164,12 +165,34 @@ pass=$(with_validate 'password "Enter random password"' validate_password)
 #### Arguments
 
 * **$1** (string): Prompt command to evaluate until validation is successful
-* #2 function validation callback (this is called once for exit code and once for status code)
+* **$2** (function): validation callback (this is called once for exit code and once for status code)
 
 #### Output on stdout
 
 * Value collected by evaluating prompt
 
+### range
+
+Display a range dialog that can incremented and decremented using the arrow keys
+
+#### Example
+
+```bash
+# Range with negative min value
+value=$(range -5 0 5)
+```
+
+#### Arguments
+
+* **$1** (string): Phrase for prompting to text
+* **$2** (int): Minimum selectable value
+* **$3** (int): Default selected value
+* **$4** (int): Maximum value of the select
+
+#### Output on stdout
+
+* Selected value using arrow keys
+
 ### validate_present
 
 Validate a prompt returned any value

src/prompts.sh

@@ -95,23 +95,32 @@ input() {
 #   confirmed=$(confirm "Should it be?")
 #   if [ "$confirmed" = "0" ]; then echo "No?"; else echo "Yes!"; fi
 confirm() {
+    # ensure cursor and input echoing back on upon a ctrl+c during read -s
+    trap "_cursor_blink_on; stty echo; exit" 2
+    _cursor_blink_off
+
     _prompt_text "$1 (y/N)"
     echo -en "\033[36m\c " >&2
+
+    local start_row; start_row=$(_get_cursor_row)
+    local current_row; current_row=$((start_row - 1))
+
     local result=""
     echo -n " " >&2
-    until [[ "$result" == "y" ]] || [[ "$result" == "n" ]] || [[ "$result" == "Y" ]] || [[ "$result" == "N" ]]
+    while true;
     do
         echo -e "\033[1D\c " >&2
         # shellcheck disable=SC2162
         read -n1 result
-    done
-    echo -en "\033[0m" >&2
 
         case "$result" in
-        y|Y) echo -n 1 ;;
+          y|Y) echo -n 1; break; ;;
-        n|N) echo -n 0 ;;
+          n|N) echo -n 0; break; ;;
+          *) _cursor_to "${current_row}";;
         esac
+    done
 
+    echo -en "\033[0m" >&2
     echo "" >&2
 }
 
@@ -252,7 +261,7 @@ checkbox() {
 
 # @description Show password prompt displaying stars for each password character letter typed
 # it also allows deleting input
-# @arg $1 string Phrase for promptint to text
+# @arg $1 string Phrase for prompting to text
 # @stdout password as written by user
 # @stderr Instructions for user
 # @example
@@ -310,7 +319,7 @@ editor() {
 # @description Evaluate prompt command with validation, this prompts the user for input till the validation function
 # returns with 0
 # @arg $1 string Prompt command to evaluate until validation is successful
-# @arg #2 function validation callback (this is called once for exit code and once for status code)
+# @arg $2 function validation callback (this is called once for exit code and once for status code)
 # @stdout Value collected by evaluating prompt
 # @stderr Instructions for user
 # @example
@@ -332,6 +341,68 @@ with_validate() {
     done
 }
 
+# @description Display a range dialog that can incremented and decremented using the arrow keys
+# @arg $1 string Phrase for prompting to text
+# @arg $2 int Minimum selectable value
+# @arg $3 int Default selected value
+# @arg $4 int Maximum value of the select
+# @stdout Selected value using arrow keys
+# @stderr Instructions for user
+# @example
+#   # Range with negative min value
+#   value=$(range -5 0 5)
+range() {
+  local min="$2"
+  local current="$3"
+  local max="$4"
+  local selected="${current}"
+
+  local max_len_current; max_len_current=0
+  if [[ "${#min}" -gt "${#max}" ]]; then
+    max_len_current="${#min}"
+  else
+    max_len_current="${#max}"
+  fi
+  local padding; padding="$(printf "%-${max_len_current}s" "")"
+  local start_row; start_row=$(_get_cursor_row)
+  local current_row; current_row=$((start_row - 1))
+
+  # ensure cursor and input echoing back on upon a ctrl+c during read -s
+  trap "_cursor_blink_on; stty echo; exit" 2
+  _cursor_blink_off
+
+  _check_range() {
+    val=$1
+
+    if [[ "$val" -gt "$max" ]]; then
+      val=$min
+    elif [[ "$val" -lt "$min" ]]; then
+      val=$max
+    fi
+
+    echo "$val"
+  }
+
+  while true; do
+    _prompt_text "$1"
+    printf "\033[37m%s\033[0m \033[1;90m❮\033[0m \033[36m%s%s\033[0m \033[1;90m❯\033[0m \033[37m%s\033[0m\n" "$min" "${padding:${#selected}}" "$selected" "$max" >&2
+    case $(_key_input) in
+      enter)
+        break;
+        ;;
+      left)
+         selected="$(_check_range $((selected - 1)))";
+        ;;
+      right)
+        selected="$(_check_range $((selected + 1)))";
+        ;;
+    esac;
+    _cursor_to "$current_row"
+  done;
+
+  echo "$selected"
+}
+
 # @description Validate a prompt returned any value
 # @arg $1 value to validate
 # @stdout error message for user

test.sh

@@ -32,6 +32,8 @@ log "$LOG_ERROR" "Error message"
 # PROMPTS
 #
 
+ranged="$(range "foo bar" "-5" 0 5)"
+
 options=("one" "two" "three" "four" "a" "b" "c" "d" "e")
 
 validate_password() {
@@ -71,6 +73,8 @@ checkbox:
 $checked
 confirm:
 $confirmed
+range:
+$ranged
 editor:
 $editor
 "