UserInteraction allows RubyGems to
interact with the user through standard methods that can be replaced with
more-specific UI methods for different displays.
Since UserInteraction dispatches to a
concrete UI class you may need to reference other classes for specific
behavior such as Gem::ConsoleUI or Gem::SilentUI.
Example:
class X
include Gem::UserInteraction
def get_answer
n = ask("What is the meaning of life?")
end
end
Methods
- A
-
- C
-
- S
-
- T
-
- V
-
Included Modules
Instance Public methods
alert(statement, question = nil)
Link
Displays an alert statement. Asks a question if
given.
Source:
show
| on GitHub
def alert statement, question = nil
ui.alert statement, question
end
alert_error(statement, question = nil)
Link
Displays an error statement to the error output location.
Asks a question if given.
Source:
show
| on GitHub
def alert_error statement, question = nil
ui.alert_error statement, question
end
alert_warning(statement, question = nil)
Link
Displays a warning statement to the warning output location.
Asks a question if given.
Source:
show
| on GitHub
def alert_warning statement, question = nil
ui.alert_warning statement, question
end
Asks a question and returns the answer.
ask_for_password(prompt)
Link
Asks for a password with a prompt
Source:
show
| on GitHub
def ask_for_password prompt
ui.ask_for_password prompt
end
ask_yes_no(question, default = nil)
Link
Asks a yes or no question. Returns true for yes, false for
no.
Source:
show
| on GitHub
def ask_yes_no question, default = nil
ui.ask_yes_no question, default
end
choose_from_list(question, list)
Link
Asks the user to answer question with an answer from the given
list.
Source:
show
| on GitHub
def choose_from_list question, list
ui.choose_from_list question, list
end
Displays the given statement on the standard output (or
equivalent).
Source:
show
| on GitHub
def say statement = ''
ui.say statement
end
terminate_interaction(exit_code = 0)
Link
Terminates the RubyGems process with the given exit_code
Source:
show
| on GitHub
def terminate_interaction exit_code = 0
ui.terminate_interaction exit_code
end
Calls say with msg or the results of the block if
really_verbose is true.
Source:
show
| on GitHub
def verbose msg = nil
say(msg || yield) if Gem.configuration.really_verbose
end