module Gem::Util - Documentation for Ruby 3.2

# module Gem::Util

This module contains various utility methods as module methods.

### Public Class Methods

correct_for_windows_path(path) click to toggle source

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

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

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

    # File lib/rubygems/util.rb, line 100
    def self.glob_files_in_dir(glob, base_path)
      Dir.glob(glob, base: base_path).map! {|f| File.expand_path(f, base_path) }
    end

gunzip(data) click to toggle source

`Zlib::GzipReader` wrapper that unzips `data`.

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

`Zlib::GzipWriter` wrapper that zips `data`.

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

A `Zlib::Inflate#inflate` wrapper

    # File lib/rubygems/util.rb, line 48
    def self.inflate(data)
      require "zlib"
      Zlib::Inflate.inflate data
    end

popen(*command) click to toggle source

This calls `IO.popen` and reads the result

    # File lib/rubygems/util.rb, line 56
    def self.popen(*command)
      IO.popen command, &:read
    end

silent_system(*command) click to toggle source

Invokes system, but silences all output.

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

Enumerates the parents of `directory`.

    # File lib/rubygems/util.rb, line 83
    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