Module: CLI::UI::Prompt

Defined in:
lib/cli/ui/prompt.rb,
lib/cli/ui/prompt/interactive_options.rb

Class Method Summary collapse

Class Method Details

.ask(question, options: nil, default: nil, is_file: nil, allow_empty: true) ⇒ Object

Ask a user a question with either free form answer or a set of answers Do not use this method for yes/no questions. Use confirm Can use arrows, y/n, numbers, and vim bindings to control

  • Handles free form answers (options are nil)

  • Handles default answers for free form text

  • Handles file auto completion for file input

  • Handles interactively choosing answers using InteractiveOptions

Attributes

  • question - (required) The question to ask the user

Options

  • :options - Options to ask the user. Will use InteractiveOptions to do so

  • :default - The default answer to the question (e.g. they just press enter and don’t input anything)

  • :is_file - Tells the input to use file auto-completion (tab completion)

  • :allow_empty - Allows the answer to be empty

Note:

  • :options conflicts with :default and :is_file, you cannot set options with either of these keywords

  • :default conflicts with +:allow_empty:, you cannot set these together

Example Usage:

Free form question

CLI::UI::Prompt.ask('What color is the sky?')

Free form question with a file answer

CLI::UI::Prompt.ask('Where is your Gemfile located?', is_file: true)

Free form question with a default answer

CLI::UI::Prompt.ask('What color is the sky?', default: 'blue')

Free form question when the answer can be empty

CLI::UI::Prompt.ask('What is your opinion on this question?', allow_empty: true)

Question with answers

CLI::UI::Prompt.ask('What kind of project is this?', options: %w(rails go ruby python))



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/cli/ui/prompt.rb', line 55

def ask(question, options: nil, default: nil, is_file: nil, allow_empty: true)
  if (default && !allow_empty) || (options && (default || is_file))
    raise(ArgumentError, 'conflicting arguments')
  end

  if default
    puts_question("#{question} (empty = #{default})")
  elsif options
    puts_question("#{question} {{yellow:(choose with ↑ ↓ ⏎)}}")
  else
    puts_question(question)
  end

  # Present the user with options
  if options
    resp = InteractiveOptions.call(options)

    # Clear the line, and reset the question to include the answer
    print(ANSI.previous_line + ANSI.end_of_line + ' ')
    print(ANSI.cursor_save)
    print(' ' * CLI::UI::Terminal.width)
    print(ANSI.cursor_restore)
    puts_question("#{question} (You chose: {{italic:#{resp}}})")

    return resp
  end

  # Ask a free form question
  loop do
    line = readline(is_file: is_file)

    if line.empty? && default
      write_default_over_empty_input(default)
      return default
    end

    if !line.empty? || allow_empty
      return line
    end
  end
end

.confirm(question) ⇒ Object

Asks the user a yes/no question. Can use arrows, y/n, numbers (1/2), and vim bindings to control

Example Usage:

Confirmation question

CLI::UI::Prompt.confirm('Is the sky blue?')



105
106
107
 
# File 'lib/cli/ui/prompt.rb', line 105

def confirm(question)
  ask(question, options: %w(yes no)) == 'yes'
end