123456789_123456789_123456789_123456789_123456789_

Module: Gem::Text

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In:
Licenses, Request
Included In:
Command, CommandManager, Commands::BuildCommand, Commands::CertCommand, Commands::CheckCommand, Commands::CleanupCommand, Commands::ContentsCommand, Commands::DependencyCommand, Commands::EnvironmentCommand, Commands::ExecCommand, Commands::FetchCommand, Commands::GenerateIndexCommand, Commands::HelpCommand, Commands::InfoCommand, Commands::InstallCommand, Commands::ListCommand, Commands::LockCommand, Commands::MirrorCommand, Commands::OpenCommand, Commands::OutdatedCommand, Commands::OwnerCommand, Commands::PristineCommand, Commands::PushCommand, Commands::QueryCommand, Commands::RdocCommand, Commands::RebuildCommand, Commands::SearchCommand, Commands::ServerCommand, Commands::SetupCommand, Commands::SigninCommand, Commands::SignoutCommand, Commands::SourcesCommand, Commands::SpecificationCommand, Commands::StaleCommand, Commands::UninstallCommand, Commands::UnpackCommand, Commands::UpdateCommand, Commands::WhichCommand, Commands::YankCommand, ConfigFile, DefaultUserInteraction, DependencyInstaller, Doctor, Ext::Builder, Ext::CargoBuilder, Ext::CmakeBuilder, Ext::ConfigureBuilder, Ext::ExtConfBuilder, Ext::RakeBuilder, GemcutterUtilities, GemcutterUtilities::WebauthnPoller, Installer, Package, Package::Old, QueryUtils, RemoteFetcher, Request, Security::Policy, Security::Signer, Source, Source::Git, Source::Installed, Source::Local, Source::Lock, Source::SpecificFile, Source::Vendor, SpecFetcher, SpecificationPolicy, StreamUI::SimpleProgressReporter, StreamUI::VerboseProgressReporter, Uninstaller, UserInteraction, Validator
Defined in: lib/rubygems/text.rb

Overview

A collection of text-wrangling methods

Instance Method Summary

Instance Method Details

#clean_text(text)

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

[ GitHub ] 

  


# File 'lib/rubygems/text.rb', line 10



def clean_text(text)
  text.gsub(/[\000-\b\v-\f\016-\037\177]/, ".")
end


  








  

    #format_text(text, wrap, indent = 0)  
  



  

    

Wraps text to wrap characters and optionally indents by indent characters


  



  [ GitHub ]


  

  


# File 'lib/rubygems/text.rb', line 24



def format_text(text, wrap, indent=0)
  result = []
  work = clean_text(text)

  while work.length > wrap do
    if work =~ /^(.{0,#{wrap}})[ \n]/
      result << $1.rstrip
      work.slice!(0, $&.length)
    else
      result << work.slice!(0, wrap)
    end
  end

  result << work if work.length.nonzero?
  result.join("\n").gsub(/^/, " " * indent)
end


  








  

    #levenshtein_distance(str1, str2)  
  



  

    

Returns a value representing the “cost” of transforming str1 into str2 Vendored version of DidYouMean::Levenshtein.distance from the ruby/did_you_mean gem @ 1.4.0 github.com/ruby/did_you_mean/blob/2ddf39b874808685965dbc47d344cf6c7651807c/lib/did_you_mean/levenshtein.rb#L7-L37


  



  [ GitHub ]


  

  


# File 'lib/rubygems/text.rb', line 54



def levenshtein_distance(str1, str2)
  n = str1.length
  m = str2.length
  return m if n.zero?
  return n if m.zero?

  d = (0..m).to_a
  x = nil

  # to avoid duplicating an enumerable object, create it outside of the loop
  str2_codepoints = str2.codepoints

  str1.each_codepoint.with_index(1) do |char1, i|
    j = 0
    while j < m
      cost = char1 == str2_codepoints[j] ? 0 : 1
      x = min3(
        d[j + 1] + 1, # insertion
        i + 1,      # deletion
        d[j] + cost # substitution
      )
      d[j] = i
      i = x

      j += 1
    end
    d[m] = x
  end

  x
end


  








  

    #min3(a, b, c)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def min3(a, b, c) # :nodoc:
  if a < b && a < c
    a
  elsif b < c
    b
  else
    c
  end
end


  








  

    #truncate_text(text, description, max_length = 100_000)  
  



  

    
  





  
Raises:


    
  
  • 
    (ArgumentError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/text.rb', line 14



def truncate_text(text, description, max_length = 100_000)
  raise ArgumentError, "max_length must be positive" unless max_length > 0
  return text if text.size <= max_length
  "Truncating #{description} to #{max_length.to_s.reverse.gsub(/...(?=.)/,'\&,').reverse} characters:\n" + text[0, max_length]
end