123456789_123456789_123456789_123456789_123456789_

Module: Gem::DefaultUserInteraction

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In:
Gem::RDoc, Request
Included In:
Command, CommandManager, Commands::BuildCommand, Commands::CertCommand, Commands::CheckCommand, Commands::CleanupCommand, Commands::ContentsCommand, Commands::DependencyCommand, Commands::EnvironmentCommand, Commands::FetchCommand, Commands::GenerateIndexCommand, Commands::HelpCommand, Commands::InstallCommand, Commands::ListCommand, Commands::LockCommand, Commands::MirrorCommand, Commands::OpenCommand, Commands::OutdatedCommand, Commands::OwnerCommand, Commands::PristineCommand, Commands::PushCommand, Commands::QueryCommand, Commands::RdocCommand, Commands::SearchCommand, Commands::ServerCommand, Commands::SetupCommand, Commands::SourcesCommand, Commands::SpecificationCommand, Commands::StaleCommand, Commands::UninstallCommand, Commands::UnpackCommand, Commands::UpdateCommand, Commands::WhichCommand, Commands::YankCommand, ConfigFile, DependencyInstaller, Doctor, Ext::Builder, Ext::CmakeBuilder, Ext::ConfigureBuilder, Ext::ExtConfBuilder, Ext::RakeBuilder, Indexer, Installer, InstallerTestCase, Package, Package::Old, Package::TarTestCase, Gem::RDoc, RemoteFetcher, Request, Security::Policy, Server, SpecFetcher, StreamUI::SimpleProgressReporter, StreamUI::VerboseProgressReporter, TestCase, Uninstaller, UserInteraction, Validator
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, Text
Defined in: lib/rubygems/test_case.rb,
lib/rubygems/user_interaction.rb

Overview

When rubygems/test_case is required the default user interaction is a MockGemUi.

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Text - Included

#clean_text

Remove any non-printable characters and make the text suitable for printing.
#format_text

Wraps text to wrap characters and optionally indents by indent characters.
#levenshtein_distance

This code is based directly on the Text gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text

Class Attribute Details

.ui (rw)

Return the default UI.

[ GitHub ] 

  


# File 'lib/rubygems/user_interaction.rb', line 33



def self.ui
  @ui ||= Gem::ConsoleUI.new
end


  








  

    .ui=(new_ui)   (rw)
  



  

    

Set the default UI.  If the default UI is never explicitly set, a simple console based UserInteraction will be used automatically.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/user_interaction.rb', line 41



def self.ui=(new_ui)
  @ui = new_ui
end


  







Class Method Details



  

    .use_ui(new_ui)  
  



  

    

Use new_ui for the duration of block.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/user_interaction.rb', line 48



def self.use_ui(new_ui)
  old_ui = @ui
  @ui = new_ui
  yield
ensure
  @ui = old_ui
end


  







Instance Attribute Details



  

    #ui   (rw)
  



  

    

See .ui


  



  [ GitHub ]


  

  


# File 'lib/rubygems/user_interaction.rb', line 59



def ui
  Gem::DefaultUserInteraction.ui
end


  








  

    #ui=(new_ui)   (rw)
  



  

    

See .ui=


  



  [ GitHub ]


  

  


# File 'lib/rubygems/user_interaction.rb', line 66



def ui=(new_ui)
  Gem::DefaultUserInteraction.ui = new_ui
end


  







Instance Method Details



  

    #use_ui(new_ui, &block)  
  



  

    

See .use_ui


  



  [ GitHub ]


  

  


# File 'lib/rubygems/user_interaction.rb', line 73



def use_ui(new_ui, &block)
  Gem::DefaultUserInteraction.use_ui(new_ui, &block)
end