Skip to content

Adds 'required' option to 'prompt_for_input' #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Adds 'required' option to 'prompt_for_input' #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
004ca42
Adds option in prompt_for_input to reprompt the user until they enter…
nkakouros Jan 19, 2018
e6a45cd
Unsets existing value of variable to be read
nkakouros Jan 20, 2018
30d04a6
Adds test for "required" prompt argument
nkakouros Jan 20, 2018
78d77b3
Merge branch 'master' into prompt
nkakouros Feb 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions lib/prompt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,30 @@
# prompt Text prompt for user input
# default (Optional) Default value if response is empty
# fail_msg (Optional) Failure message if empty input isn't valid
# required (Optional) Flag to repeat prompt until user supplies value
@go.prompt_for_input() {
@go.validate_identifier_or_die 'Input prompt response variable name' "$1"

if [[ "$2" =~ [[:space:]]$ ]]; then
@go.printf '%s%s%s' "${2%?}" "${3:+ [default: $3]}" "${BASH_REMATCH[0]}" >&2
else
@go.printf '%s %s' "$2" "${3:+[default: $3] }" >&2
fi
@go.read_prompt_response "$1" "$3"
unset "$1"
while [[ -z "${!1-}" ]]; do
if [[ "$2" =~ [[:space:]]$ ]]; then
@go.printf '%s%s%s' "${2%?}" "${3:+ [default: $3]}" "${BASH_REMATCH[0]}" >&2
else
@go.printf '%s %s' "$2" "${3:+[default: $3] }" >&2
fi

if [[ -z "${!1}" && -n "$4" ]]; then
@go.printf '%s\n' "$4" >&2
return 1
fi
@go.read_prompt_response "$1" "${3-}"
if [[ "${5-}" != "required" ]]; then
if [[ -z "${!1}" && -n "${4-}" ]]; then
@go.printf '%s\n' "$4" >&2
return 1
else
break
fi
fi
done

return
}

# Prompts the user for a line of input, then validates it isn't dangerous
Expand Down
10 changes: 9 additions & 1 deletion tests/prompt/prompt-for-input.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ setup() {
'declare prompt="$1"' \
'declare default="$2"' \
'declare fail_msg="$3"' \
'declare required="$4"' \
'declare response="initial value"' \
'declare result' \
'@go.prompt_for_input "response" "$prompt" "$default" "$fail_msg"' \
'@go.prompt_for_input "response" "$prompt" "$default" "$fail_msg" "$required"' \
'result="$?"' \
'printf -- "%s\n" "$response"' \
'exit "$result"'
Expand Down Expand Up @@ -62,3 +63,10 @@ teardown() {
assert_failure 'What is your quest?' \
'Auuuuuuuugh!'
}

@test "$SUITE: re-prompts if input is required" {
run "$TEST_GO_SCRIPT" $'What is your quest?\n' '' '' 'required' <<< $'\n''None'
assert_success 'What is your quest?' \
'What is your quest?' \
'None'
}