123456789_123456789_123456789_123456789_123456789_

Module: Gem::Util

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Deprecate
Defined in: lib/rubygems/util.rb

Overview

This module contains various utility methods as module methods.

Class Method Summary

Deprecate - Extended

deprecate

Simple deprecation method that deprecates name by wrapping it up in a dummy method.

rubygems_deprecate

Simple deprecation method that deprecates name by wrapping it up in a dummy method.

rubygems_deprecate_command

Deprecation method to deprecate Rubygems commands.

skip_during

Temporarily turn off warnings.

Class Method Details

.correct_for_windows_path(path)

Corrects Gem.path (usually returned by URI.parse().path on Windows), that comes with a leading slash.

[ GitHub ]

  
# File 'lib/rubygems/util.rb', line 111

def self.correct_for_windows_path(path)
  if path[0].chr == '/' && path[1].chr =~ /[a-z]/i && path[2].chr == ':'
    path[1..-1]
  else
    path
  end
end

.glob_files_in_dir(glob, base_path)

Globs for files matching pattern inside of directory, returning absolute paths to the matching files.

[ GitHub ]

  
# File 'lib/rubygems/util.rb', line 99

def self.glob_files_in_dir(glob, base_path)
  if RUBY_VERSION >= "2.5"
    Dir.glob(glob, base: base_path).map! {|f| File.expand_path(f, base_path) }
  else
    Dir.glob(File.expand_path(glob, base_path))
  end
end

.gunzip(data)

Zlib::GzipReader wrapper that unzips data.

[ GitHub ]

  
# File 'lib/rubygems/util.rb', line 12

def self.gunzip(data)
  require 'zlib'
  require 'stringio'
  data = StringIO.new(data, 'r')

  gzip_reader = begin
                  Zlib::GzipReader.new(data)
                rescue Zlib::GzipFile::Error => e
                  raise e.class, e.inspect, e.backtrace
                end

  unzipped = gzip_reader.read
  unzipped.force_encoding Encoding::BINARY
  unzipped
end

.gzip(data)

Zlib::GzipWriter wrapper that zips data.

[ GitHub ]

  
# File 'lib/rubygems/util.rb', line 31

def self.gzip(data)
  require 'zlib'
  require 'stringio'
  zipped = StringIO.new(String.new, 'w')
  zipped.set_encoding Encoding::BINARY

  Zlib::GzipWriter.wrap zipped do |io|
    io.write data
  end

  zipped.string
end

.inflate(data)

A Zlib::Inflate#inflate wrapper

[ GitHub ]

  
# File 'lib/rubygems/util.rb', line 47

def self.inflate(data)
  require 'zlib'
  Zlib::Inflate.inflate data
end

.popen(*command)

This calls IO.popen and reads the result

[ GitHub ]

  
# File 'lib/rubygems/util.rb', line 55

def self.popen(*command)
  IO.popen command, &:read
end

.silent_system(*command)

Invokes system, but silences all output.

[ GitHub ]

  
# File 'lib/rubygems/util.rb', line 62

def self.silent_system(*command)
  opt = {:out => IO::NULL, :err => [:child, :out]}
  if Hash === command.last
    opt.update(command.last)
    cmds = command[0...-1]
  else
    cmds = command.dup
  end
  system(*(cmds << opt))
end

.traverse_parents(directory, &block)

Enumerates the parents of directory.

[ GitHub ]

  
# File 'lib/rubygems/util.rb', line 82

def self.traverse_parents(directory, &block)
  return enum_for __method__, directory unless block_given?

  here = File.expand_path directory
  loop do
    Dir.chdir here, &block rescue Errno::EACCES

    new_here = File.expand_path('..', here)
    return if new_here == here # toplevel
    here = new_here
  end
end