Module: Gem::UserInteraction
- Includes:
- DefaultUserInteraction
- Included in:
- Command, CommandManager, ConfigFile, DependencyInstaller, Doctor, Ext::Builder, Indexer, Installer, Package, RDoc, RDoc, RemoteFetcher, Request, Security::Policy, Server, SpecFetcher, Uninstaller, Validator
- Defined in:
- lib/rubygems/user_interaction.rb
Overview
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
Instance Method Summary collapse
-
#alert(statement, question = nil) ⇒ Object
Displays an alert
statement
. -
#alert_error(statement, question = nil) ⇒ Object
Displays an error
statement
to the error output location. -
#alert_warning(statement, question = nil) ⇒ Object
Displays a warning
statement
to the warning output location. -
#ask(question) ⇒ Object
Asks a
question
and returns the answer. -
#ask_for_password(prompt) ⇒ Object
Asks for a password with a
prompt
. -
#ask_yes_no(question, default = nil) ⇒ Object
Asks a yes or no
question
. -
#choose_from_list(question, list) ⇒ Object
Asks the user to answer
question
with an answer from the givenlist
. -
#say(statement = '') ⇒ Object
Displays the given
statement
on the standard output (or equivalent). -
#terminate_interaction(exit_code = 0) ⇒ Object
Terminates the RubyGems process with the given
exit_code
. -
#verbose(msg = nil) ⇒ Object
Calls
say
withmsg
or the results of the block if really_verbose is true.
Methods included from DefaultUserInteraction
ui, #ui, ui=, #ui=, use_ui, #use_ui
Instance Method Details
#alert(statement, question = nil) ⇒ Object
Displays an alert statement
. Asks a question
if given.
99 100 101 |
# File 'lib/rubygems/user_interaction.rb', line 99 def alert statement, question = nil ui.alert statement, question end |
#alert_error(statement, question = nil) ⇒ Object
Displays an error statement
to the error output location. Asks a question
if given.
107 108 109 |
# File 'lib/rubygems/user_interaction.rb', line 107 def alert_error statement, question = nil ui.alert_error statement, question end |
#alert_warning(statement, question = nil) ⇒ Object
Displays a warning statement
to the warning output location. Asks a question
if given.
115 116 117 |
# File 'lib/rubygems/user_interaction.rb', line 115 def alert_warning statement, question = nil ui.alert_warning statement, question end |
#ask(question) ⇒ Object
Asks a question
and returns the answer.
122 123 124 |
# File 'lib/rubygems/user_interaction.rb', line 122 def ask question ui.ask question end |
#ask_for_password(prompt) ⇒ Object
Asks for a password with a prompt
129 130 131 |
# File 'lib/rubygems/user_interaction.rb', line 129 def ask_for_password prompt ui.ask_for_password prompt end |
#ask_yes_no(question, default = nil) ⇒ Object
Asks a yes or no question
. Returns true for yes, false for no.
136 137 138 |
# File 'lib/rubygems/user_interaction.rb', line 136 def ask_yes_no question, default = nil ui.ask_yes_no question, default end |
#choose_from_list(question, list) ⇒ Object
Asks the user to answer question
with an answer from the given list
.
143 144 145 |
# File 'lib/rubygems/user_interaction.rb', line 143 def choose_from_list question, list ui.choose_from_list question, list end |
#say(statement = '') ⇒ Object
Displays the given statement
on the standard output (or equivalent).
150 151 152 |
# File 'lib/rubygems/user_interaction.rb', line 150 def say statement = '' ui.say statement end |
#terminate_interaction(exit_code = 0) ⇒ Object
Terminates the RubyGems process with the given exit_code
157 158 159 |
# File 'lib/rubygems/user_interaction.rb', line 157 def terminate_interaction exit_code = 0 ui.terminate_interaction exit_code end |
#verbose(msg = nil) ⇒ Object
Calls say
with msg
or the results of the block if really_verbose is true.
165 166 167 |
# File 'lib/rubygems/user_interaction.rb', line 165 def verbose msg = nil say(msg || yield) if Gem.configuration.really_verbose end |