Class: Gem::StreamUI (Ruby 2.7.2)
Description: Class : Gem::StreamUI - Ruby 2.7.2

### Home Classes Methods

### In Files

- rubygems/user_interaction.rb

### Parent

Object

### Namespace

- CLASS Gem::StreamUI::SilentDownloadReporter
- CLASS Gem::StreamUI::SilentProgressReporter
- CLASS Gem::StreamUI::SimpleProgressReporter
- CLASS Gem::StreamUI::ThreadedDownloadReporter
- CLASS Gem::StreamUI::VerboseProgressReporter

### Methods

- ::new
- #_gets_noecho
- #alert
- #alert_error
- #alert_warning
- #ask
- #ask_for_password
- #ask_yes_no
- #backtrace
- #choose_from_list
- #close
- #debug
- #download_reporter
- #progress_reporter
- #require_io_console
- #say
- #terminate_interaction
- #tty?

### Class/Module Index

Quicksearch

- Bundler
- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::BundlerVersionFinder
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InfoCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SetupCommand::MakeDirs
- Gem::Commands::SigninCommand
- Gem::Commands::SignoutCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::Installer::FakePackage
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::Licenses
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MissingSpecError
- Gem::MissingSpecVersionError
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::Request::ConnectionPools
- Gem::Request::ConnectionPools::Net
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::RequestSet::Lockfile::Parser
- Gem::RequestSet::Lockfile::Tokenizer
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::Molinillo
- Gem::Resolver::Molinillo::CircularDependencyError
- Gem::Resolver::Molinillo::Delegates
- Gem::Resolver::Molinillo::Delegates::ResolutionState
- Gem::Resolver::Molinillo::Delegates::SpecificationProvider
- Gem::Resolver::Molinillo::DependencyGraph
- Gem::Resolver::Molinillo::DependencyGraph::Action
- Gem::Resolver::Molinillo::DependencyGraph::AddEdgeNoCircular
- Gem::Resolver::Molinillo::DependencyGraph::DeleteEdge
- Gem::Resolver::Molinillo::DependencyGraph::DetachVertexNamed
- Gem::Resolver::Molinillo::DependencyGraph::Log
- Gem::Resolver::Molinillo::DependencyGraph::Tag
- Gem::Resolver::Molinillo::DependencyGraph::Vertex
- Gem::Resolver::Molinillo::DependencyState
- Gem::Resolver::Molinillo::NoSuchDependencyError
- Gem::Resolver::Molinillo::PossibilityState
- Gem::Resolver::Molinillo::ResolutionState
- Gem::Resolver::Molinillo::Resolver
- Gem::Resolver::Molinillo::Resolver::Resolution
- Gem::Resolver::Molinillo::ResolverError
- Gem::Resolver::Molinillo::SpecificationProvider
- Gem::Resolver::Molinillo::UI
- Gem::Resolver::Molinillo::VersionConflict
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SourceSet
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::RuntimeRequirementNotMetError
- Gem::S3URISigner
- Gem::S3URISigner::ConfigurationError
- Gem::S3URISigner::InstanceProfileError
- Gem::SafeYAML
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::SecurityOption
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::SpecificationPolicy
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::ThreadedDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::UninstallError
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UriParser
- Gem::UriParsing
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::StreamUI

Gem::StreamUI implements a simple stream based user interface.

### Attributes

errs[R]

The error stream

ins[R]

The input stream

outs[R]

The output stream

### Public Class Methods

new(in_stream, out_stream, err_stream=STDERR, usetty=true) click to toggle source

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 rubygems/user_interaction.rb, line 200
    def initialize(in_stream, out_stream, err_stream=STDERR, usetty=true)
      @ins = in_stream
      @outs = out_stream
      @errs = err_stream
      @usetty = usetty
    end

### Public Instance Methods

_gets_noecho() click to toggle source

                   # File rubygems/user_interaction.rb, line 324
    def _gets_noecho
      require_io_console
      @ins.noecho {@ins.gets}
    end

alert(statement, question=nil) click to toggle source

Display an informational alert. Will ask `question` if it is not nil.

                   # File rubygems/user_interaction.rb, line 339
    def alert(statement, question=nil)
      @outs.puts "INFO:  #{statement}"
      ask(question) if question
    end

alert_error(statement, question=nil) click to toggle source

Display an error message in a location expected to get error messages. Will ask `question` if it is not nil.

                   # File rubygems/user_interaction.rb, line 356
    def alert_error(statement, question=nil)
      @errs.puts "ERROR:  #{statement}"
      ask(question) if question
    end

alert_warning(statement, question=nil) click to toggle source

Display a warning on stderr. Will ask `question` if it is not nil.

                   # File rubygems/user_interaction.rb, line 347
    def alert_warning(statement, question=nil)
      @errs.puts "WARNING:  #{statement}"
      ask(question) if question
    end

ask(question) click to toggle source

Ask a question. Returns an answer if connected to a tty, nil otherwise.

                   # File rubygems/user_interaction.rb, line 288
    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) click to toggle source

Ask for a password. Does not echo response to terminal.

                   # File rubygems/user_interaction.rb, line 302
    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) click to toggle source

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 rubygems/user_interaction.rb, line 252
    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
                 else            nil
                 end
      end

      return result
    end

backtrace(exception) click to toggle source

Prints a formatted backtrace to the errors stream if backtraces are enabled.

                   # File rubygems/user_interaction.rb, line 218
    def backtrace(exception)
      return unless Gem.configuration.backtrace

      @errs.puts "\t#{exception.backtrace.join "\n\t"}"
    end

choose_from_list(question, list) click to toggle source

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 rubygems/user_interaction.rb, line 229
    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() click to toggle source

                   # File rubygems/user_interaction.rb, line 378
    def close
    end

debug(statement) click to toggle source

Display a debug message on the same location as error messages.

                   # File rubygems/user_interaction.rb, line 364
    def debug(statement)
      @errs.puts statement
    end

download_reporter(*args) click to toggle source

Return a download reporter object chosen from the current verbosity

                   # File rubygems/user_interaction.rb, line 519
    def download_reporter(*args)
      if [nil, false].include?(Gem.configuration.verbose) || !@outs.tty?
        SilentDownloadReporter.new(@outs, *args)
      else
        ThreadedDownloadReporter.new(@outs, *args)
      end
    end

progress_reporter(*args) click to toggle source

Return a progress reporter object chosen from the current verbosity.

                   # File rubygems/user_interaction.rb, line 384
    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

require_io_console() click to toggle source

                   # File rubygems/user_interaction.rb, line 314
    def require_io_console
      @require_io_console ||= begin
        begin
          require 'io/console'
        rescue LoadError
        end
        true
      end
    end

say(statement="") click to toggle source

Display a statement.

                   # File rubygems/user_interaction.rb, line 332
    def say(statement="")
      @outs.puts statement
    end

terminate_interaction(status = 0) click to toggle source

Terminate the application with exit code `status`, running any exit handlers that might have been defined.

                   # File rubygems/user_interaction.rb, line 373
    def terminate_interaction(status = 0)
      close
      raise Gem::SystemExitException, status
    end

tty?() click to toggle source

Returns true if TTY methods should be used on this StreamUI.

                   # File rubygems/user_interaction.rb, line 210
    def tty?
      @usetty && @ins.tty?
    end