Class: Gem::StreamUI
- Inherits:
-
Object
- Object
- Gem::StreamUI
- Defined in:
- lib/rubygems/user_interaction.rb
Overview
Gem::StreamUI implements a simple stream based user interface.
Defined Under Namespace
Classes: SilentDownloadReporter, SilentProgressReporter, SimpleProgressReporter, VerboseDownloadReporter, VerboseProgressReporter
Instance Attribute Summary collapse
-
#errs ⇒ Object
readonly
The error stream.
-
#ins ⇒ Object
readonly
The input stream.
-
#outs ⇒ Object
readonly
The output stream.
Instance Method Summary collapse
- #_gets_noecho ⇒ Object
-
#alert(statement, question = nil) ⇒ Object
Display an informational alert.
-
#alert_error(statement, question = nil) ⇒ Object
Display an error message in a location expected to get error messages.
-
#alert_warning(statement, question = nil) ⇒ Object
Display a warning on stderr.
-
#ask(question) ⇒ Object
Ask a question.
-
#ask_for_password(question) ⇒ Object
Ask for a password.
-
#ask_yes_no(question, default = nil) ⇒ Object
Ask a question.
-
#backtrace(exception) ⇒ Object
Prints a formatted backtrace to the errors stream if backtraces are enabled.
-
#choose_from_list(question, list) ⇒ Object
Choose from a list of options.
-
#debug(statement) ⇒ Object
Display a debug message on the same location as error messages.
-
#download_reporter(*args) ⇒ Object
Return a download reporter object chosen from the current verbosity.
-
#initialize(in_stream, out_stream, err_stream = STDERR, usetty = true) ⇒ StreamUI
constructor
Creates a new StreamUI wrapping
in_stream
for user input,out_stream
for standard output,err_stream
for error output. -
#progress_reporter(*args) ⇒ Object
Return a progress reporter object chosen from the current verbosity.
-
#say(statement = "") ⇒ Object
Display a statement.
-
#terminate_interaction(status = 0) ⇒ Object
Terminate the application with exit code
status
, running any exit handlers that might have been defined. -
#tty? ⇒ Boolean
Returns true if TTY methods should be used on this StreamUI.
Constructor Details
#initialize(in_stream, out_stream, err_stream = STDERR, usetty = true) ⇒ StreamUI
Creates a new StreamUI wrapping in_stream
for user input, out_stream
for standard output, err_stream
for error output. If usetty
is true then special operations (like asking for passwords) will use the TTY commands to disable character echo.
188 189 190 191 192 193 |
# File 'lib/rubygems/user_interaction.rb', line 188 def initialize(in_stream, out_stream, err_stream=STDERR, usetty=true) @ins = in_stream @outs = out_stream @errs = err_stream @usetty = usetty end |
Instance Attribute Details
#errs ⇒ Object (readonly)
The error stream
180 181 182 |
# File 'lib/rubygems/user_interaction.rb', line 180 def errs @errs end |
#ins ⇒ Object (readonly)
The input stream
170 171 172 |
# File 'lib/rubygems/user_interaction.rb', line 170 def ins @ins end |
#outs ⇒ Object (readonly)
The output stream
175 176 177 |
# File 'lib/rubygems/user_interaction.rb', line 175 def outs @outs end |
Instance Method Details
#_gets_noecho ⇒ Object
307 308 309 |
# File 'lib/rubygems/user_interaction.rb', line 307 def _gets_noecho @ins.noecho {@ins.gets} end |
#alert(statement, question = nil) ⇒ Object
Display an informational alert. Will ask question
if it is not nil.
347 348 349 350 |
# File 'lib/rubygems/user_interaction.rb', line 347 def alert(statement, question=nil) @outs.puts "INFO: #{statement}" ask(question) if question end |
#alert_error(statement, question = nil) ⇒ Object
Display an error message in a location expected to get error messages. Will ask question
if it is not nil.
364 365 366 367 |
# File 'lib/rubygems/user_interaction.rb', line 364 def alert_error(statement, question=nil) @errs.puts "ERROR: #{statement}" ask(question) if question end |
#alert_warning(statement, question = nil) ⇒ Object
Display a warning on stderr. Will ask question
if it is not nil.
355 356 357 358 |
# File 'lib/rubygems/user_interaction.rb', line 355 def alert_warning(statement, question=nil) @errs.puts "WARNING: #{statement}" ask(question) if question end |
#ask(question) ⇒ Object
Ask a question. Returns an answer if connected to a tty, nil otherwise.
280 281 282 283 284 285 286 287 288 289 |
# File 'lib/rubygems/user_interaction.rb', line 280 def ask(question) return nil if not tty? @outs.print(question + " ") @outs.flush result = @ins.gets result.chomp! if result result end |
#ask_for_password(question) ⇒ Object
Ask for a password. Does not echo response to terminal.
294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/rubygems/user_interaction.rb', line 294 def ask_for_password(question) return nil if not tty? @outs.print(question, " ") @outs.flush password = _gets_noecho @outs.puts password.chomp! if password password end |
#ask_yes_no(question, default = nil) ⇒ Object
Ask a question. Returns a true for yes, false for no. If not connected to a tty, raises an exception if default is nil, otherwise returns default.
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/rubygems/user_interaction.rb', line 244 def ask_yes_no(question, default=nil) unless tty? then if default.nil? then raise Gem::OperationNotSupportedError, "Not connected to a tty and no default specified" else return default end end default_answer = case default when nil 'yn' when true 'Yn' else 'yN' end result = nil while result.nil? do result = case ask "#{question} [#{default_answer}]" when /^y/i then true when /^n/i then false when /^$/ then default else nil end end return result end |
#backtrace(exception) ⇒ Object
Prints a formatted backtrace to the errors stream if backtraces are enabled.
210 211 212 213 214 |
# File 'lib/rubygems/user_interaction.rb', line 210 def backtrace exception return unless Gem.configuration.backtrace @errs.puts "\t#{exception.backtrace.join "\n\t"}" end |
#choose_from_list(question, list) ⇒ Object
Choose from a list of options. question
is a prompt displayed above the list. list
is a list of option strings. Returns the pair [option_name, option_index].
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/rubygems/user_interaction.rb', line 221 def choose_from_list(question, list) @outs.puts question list.each_with_index do |item, index| @outs.puts " #{index+1}. #{item}" end @outs.print "> " @outs.flush result = @ins.gets return nil, nil unless result result = result.strip.to_i - 1 return list[result], result end |
#debug(statement) ⇒ Object
Display a debug message on the same location as error messages.
372 373 374 |
# File 'lib/rubygems/user_interaction.rb', line 372 def debug(statement) @errs.puts statement end |
#download_reporter(*args) ⇒ Object
Return a download reporter object chosen from the current verbosity
524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'lib/rubygems/user_interaction.rb', line 524 def download_reporter(*args) if self.kind_of?(Gem::SilentUI) return SilentDownloadReporter.new(@outs, *args) end case Gem.configuration.verbose when nil, false SilentDownloadReporter.new(@outs, *args) else VerboseDownloadReporter.new(@outs, *args) end end |
#progress_reporter(*args) ⇒ Object
Return a progress reporter object chosen from the current verbosity.
387 388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'lib/rubygems/user_interaction.rb', line 387 def progress_reporter(*args) if self.kind_of?(Gem::SilentUI) return SilentProgressReporter.new(@outs, *args) end case Gem.configuration.verbose when nil, false SilentProgressReporter.new(@outs, *args) when true SimpleProgressReporter.new(@outs, *args) else VerboseProgressReporter.new(@outs, *args) end end |
#say(statement = "") ⇒ Object
Display a statement.
340 341 342 |
# File 'lib/rubygems/user_interaction.rb', line 340 def say(statement="") @outs.puts statement end |
#terminate_interaction(status = 0) ⇒ Object
Terminate the application with exit code status
, running any exit handlers that might have been defined.
380 381 382 |
# File 'lib/rubygems/user_interaction.rb', line 380 def terminate_interaction(status = 0) raise Gem::SystemExitException, status end |
#tty? ⇒ Boolean
Returns true if TTY methods should be used on this StreamUI.
198 199 200 201 202 203 204 |
# File 'lib/rubygems/user_interaction.rb', line 198 def tty? if RUBY_VERSION < '1.9.3' and RUBY_PLATFORM =~ /mingw|mswin/ then @usetty else @usetty && @ins.tty? end end |