class Gem::StreamUI
Gem::StreamUI 实现了一个简单的基于流的用户界面。
属性
错误流
输入流
输出流
Public Class Methods
Source
# File lib/rubygems/user_interaction.rb, line 193 def initialize(in_stream, out_stream, err_stream = $stderr, usetty = true) @ins = in_stream @outs = out_stream @errs = err_stream @usetty = usetty end
创建一个新的 StreamUI,使用 in_stream 进行用户输入,out_stream 进行标准输出,err_stream 进行错误输出。如果 usetty 为 true,则特殊操作(如输入密码)将使用 TTY 命令禁用字符回显。
Public Instance Methods
Source
# File lib/rubygems/user_interaction.rb, line 317 def _gets_noecho require_io_console @ins.noecho { @ins.gets } end
Source
# File lib/rubygems/user_interaction.rb, line 332 def alert(statement, question = nil) @outs.puts "INFO: #{statement}" ask(question) if question end
显示一个信息性提示。如果 question 不为 nil,则会询问 question。
Source
# File lib/rubygems/user_interaction.rb, line 349 def alert_error(statement, question = nil) @errs.puts "ERROR: #{statement}" ask(question) if question end
在预期接收错误消息的位置显示一条错误消息。如果 question 不为 nil,则会询问 question。
Source
# File lib/rubygems/user_interaction.rb, line 340 def alert_warning(statement, question = nil) @errs.puts "WARNING: #{statement}" ask(question) if question end
在 stderr 上显示一个警告。如果 question 不为 nil,则会询问 question。
Source
# File lib/rubygems/user_interaction.rb, line 281 def ask(question) return nil unless tty? @outs.print(question + " ") @outs.flush result = @ins.gets result&.chomp! result end
询问一个问题。如果连接到 tty,则返回答案,否则返回 nil。
Source
# File lib/rubygems/user_interaction.rb, line 295 def ask_for_password(question) return nil unless tty? @outs.print(question, " ") @outs.flush password = _gets_noecho @outs.puts password&.chomp! password end
询问密码。不会将响应回显到终端。
Source
# File lib/rubygems/user_interaction.rb, line 246 def ask_yes_no(question, default = nil) unless tty? if default.nil? 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 end end result end
询问一个问题。返回 true 表示是,false 表示否。如果未连接到 tty,则如果 default 为 nil,则引发异常,否则返回 default。
Source
# File lib/rubygems/user_interaction.rb, line 211 def backtrace(exception) return unless Gem.configuration.backtrace @errs.puts "\t#{exception.backtrace.join "\n\t"}" end
如果启用了回溯,则将格式化的回溯打印到错误流。
Source
# File lib/rubygems/user_interaction.rb, line 222 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 nil, nil unless (0...list.size) === result [list[result], result] end
从选项列表中选择。question 是显示在列表上方的提示。list 是选项字符串的列表。返回 [选项名称, 选项索引] 对。
Source
# File lib/rubygems/user_interaction.rb, line 496 def download_reporter(*args) if [nil, false].include?(Gem.configuration.verbose) || !@outs.tty? SilentDownloadReporter.new(@outs, *args) else ThreadedDownloadReporter.new(@outs, *args) end end
根据当前的详细程度返回一个下载报告器对象。
Source
# File lib/rubygems/user_interaction.rb, line 369 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
根据当前的详细程度返回一个进度报告器对象。
Source
# File lib/rubygems/user_interaction.rb, line 307 def require_io_console @require_io_console ||= begin begin require "io/console" rescue LoadError end true end end
Source
# File lib/rubygems/user_interaction.rb, line 325 def say(statement = "") @outs.puts statement end
显示一个语句。
Source
# File lib/rubygems/user_interaction.rb, line 358 def terminate_interaction(status = 0) close raise Gem::SystemExitException, status end
以退出码 status 终止应用程序,并运行可能已定义的任何退出处理程序。