Class: Gem::StreamUI
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Inherits: | Object |
Defined in: | lib/rubygems/user_interaction.rb |
Overview
StreamUI
implements a simple stream based user interface.
Class Method Summary
-
.new(in_stream, out_stream, err_stream = STDERR, usetty = true) ⇒ StreamUI
constructor
Creates a new
StreamUI
wrappingin_stream
for user input,out_stream
for standard output,err_stream
for error output.
Instance Attribute Summary
-
#errs
readonly
The error stream.
-
#ins
readonly
The input stream.
-
#outs
readonly
The output stream.
-
#tty? ⇒ Boolean
readonly
Returns true if TTY methods should be used on this
StreamUI
.
Instance Method Summary
-
#_gets_noecho
See additional method definition at line 316.
-
#alert(statement, question = nil)
Display an informational alert.
-
#alert_error(statement, question = nil)
Display an error message in a location expected to get error messages.
-
#alert_warning(statement, question = nil)
Display a warning on stderr.
-
#ask(question)
Ask a question.
-
#ask_for_password(question)
Ask for a password.
-
#ask_yes_no(question, default = nil)
Ask a question.
-
#backtrace(exception)
Prints a formatted backtrace to the errors stream if backtraces are enabled.
-
#choose_from_list(question, list)
Choose from a list of options.
- #close
-
#debug(statement)
Display a debug message on the same location as error messages.
-
#download_reporter(*args)
Return a download reporter object chosen from the current verbosity.
-
#progress_reporter(*args)
Return a progress reporter object chosen from the current verbosity.
-
#say(statement = "")
Display a statement.
-
#terminate_interaction(status = 0)
Terminate the application with exit code
status
, running any exit handlers that might have been defined.
Constructor Details
.new(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.
# File 'lib/rubygems/user_interaction.rb', line 197
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 (readonly)
The error stream
# File 'lib/rubygems/user_interaction.rb', line 189
attr_reader :errs
#ins (readonly)
The input stream
# File 'lib/rubygems/user_interaction.rb', line 179
attr_reader :ins
#outs (readonly)
The output stream
# File 'lib/rubygems/user_interaction.rb', line 184
attr_reader :outs
#tty? ⇒ Boolean
(readonly)
Returns true if TTY methods should be used on this StreamUI
.
# File 'lib/rubygems/user_interaction.rb', line 207
def tty? if RUBY_VERSION < '1.9.3' and RUBY_PLATFORM =~ /mingw|mswin/ then @usetty else @usetty && @ins.tty? end end
Instance Method Details
#_gets_noecho
See additional method definition at line 316.
See additional method definition at line 320.
# File 'lib/rubygems/user_interaction.rb', line 335
def _gets_noecho @ins.noecho {@ins.gets} end
#alert(statement, question = nil)
Display an informational alert. Will ask question
if it is not nil.
# File 'lib/rubygems/user_interaction.rb', line 355
def alert(statement, question=nil) @outs.puts "INFO: #{statement}" ask(question) if question end
#alert_error(statement, question = nil)
Display an error message in a location expected to get error messages. Will ask question
if it is not nil.
# File 'lib/rubygems/user_interaction.rb', line 372
def alert_error(statement, question=nil) @errs.puts "ERROR: #{statement}" ask(question) if question end
#alert_warning(statement, question = nil)
Display a warning on stderr. Will ask question
if it is not nil.
# File 'lib/rubygems/user_interaction.rb', line 363
def alert_warning(statement, question=nil) @errs.puts "WARNING: #{statement}" ask(question) if question end
#ask(question)
Ask a question. Returns an answer if connected to a tty, nil otherwise.
# File 'lib/rubygems/user_interaction.rb', line 289
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)
Ask for a password. Does not echo response to terminal.
# File 'lib/rubygems/user_interaction.rb', line 303
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)
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.
# File 'lib/rubygems/user_interaction.rb', line 253
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)
Prints a formatted backtrace to the errors stream if backtraces are enabled.
# File 'lib/rubygems/user_interaction.rb', line 219
def backtrace exception return unless Gem.configuration.backtrace @errs.puts "\t#{exception.backtrace.join "\n\t"}" end
#choose_from_list(question, list)
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].
# File 'lib/rubygems/user_interaction.rb', line 230
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
#close
[ GitHub ]# File 'lib/rubygems/user_interaction.rb', line 393
def close end
#debug(statement)
Display a debug message on the same location as error messages.
# File 'lib/rubygems/user_interaction.rb', line 380
def debug(statement) @errs.puts statement end
#download_reporter(*args)
Return a download reporter object chosen from the current verbosity
# File 'lib/rubygems/user_interaction.rb', line 532
def download_reporter(*args) case Gem.configuration.verbose when nil, false SilentDownloadReporter.new(@outs, *args) else VerboseDownloadReporter.new(@outs, *args) end end
#progress_reporter(*args)
Return a progress reporter object chosen from the current verbosity.
# File 'lib/rubygems/user_interaction.rb', line 399
def progress_reporter(*args) 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 = "")
Display a statement.
# File 'lib/rubygems/user_interaction.rb', line 348
def say(statement="") @outs.puts statement end
#terminate_interaction(status = 0)
Terminate the application with exit code status
, running any exit handlers that might have been defined.
# File 'lib/rubygems/user_interaction.rb', line 388
def terminate_interaction(status = 0) close raise Gem::SystemExitException, status end