Module: Gem::Util (Ruby 2.2.3)
Description: Module : Gem::Util - Ruby 2.2.3

- Home
- Core 2.2.3
- Std-lib 2.2.3
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rubygems/util.rb

### Methods

- ::gunzip
- ::gzip
- ::inflate
- ::popen
- ::silent_system
- ::traverse_parents

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- 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::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::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::ConfigFile::Psych
- 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::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- 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::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::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- 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::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::VerboseDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StringSink
- Gem::StringSource
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::Util

This module contains various utility methods as module methods.

### Constants

NULL_DEVICE

### Public Class Methods

gunzip(data) click to toggle source

Zlib::GzipReader wrapper that unzips `data`.

                   # File rubygems/util.rb, line 11
    def self.gunzip(data)
      require 'zlib'
      require 'rubygems/util/stringio'
      data = Gem::StringSource.new data

      unzipped = Zlib::GzipReader.new(data).read
      unzipped.force_encoding Encoding::BINARY if Object.const_defined? :Encoding
      unzipped
    end

gzip(data) click to toggle source

Zlib::GzipWriter wrapper that zips `data`.

                   # File rubygems/util.rb, line 24
    def self.gzip(data)
      require 'zlib'
      require 'rubygems/util/stringio'
      zipped = Gem::StringSink.new
      zipped.set_encoding Encoding::BINARY if Object.const_defined? :Encoding

      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 rubygems/util.rb, line 38
    def self.inflate(data)
      require 'zlib'
      Zlib::Inflate.inflate data
    end

popen(*command) click to toggle source

This calls IO.popen where it accepts an array for a `command` (Ruby 1.9+) and implements an IO.popen-like behavior where it does not accept an array for a command.

                   # File rubygems/util.rb, line 48
    def self.popen *command
      IO.popen command, &:read
    rescue TypeError # ruby 1.8 only supports string command
      r, w = IO.pipe

      pid = fork do
        STDIN.close
        STDOUT.reopen w

        exec(*command)
      end

      w.close

      begin
        return r.read
      ensure
        Process.wait pid
      end
    end

silent_system(*command) click to toggle source

Invokes system, but silences all output.

                   # File rubygems/util.rb, line 74
    def self.silent_system *command
      opt = {:out => NULL_DEVICE, :err => [:child, :out]}
      if Hash === command.last
        opt.update(command.last)
        cmds = command[0...-1]
      else
        cmds = command.dup
      end
      return system(*(cmds << opt))
    rescue TypeError
      require 'thread'

      @silent_mutex ||= Mutex.new

      null_device = NULL_DEVICE

      @silent_mutex.synchronize do
        begin
          stdout = STDOUT.dup
          stderr = STDERR.dup

          STDOUT.reopen null_device, 'w'
          STDERR.reopen null_device, 'w'

          return system(*command)
        ensure
          STDOUT.reopen stdout
          STDERR.reopen stderr
          stdout.close
          stderr.close
        end
      end
    end

traverse_parents(directory) click to toggle source

Enumerates the parents of `directory`.

                   # File rubygems/util.rb, line 111
    def self.traverse_parents directory
      return enum_for __method__, directory unless block_given?

      here = File.expand_path directory
      start = here

      Dir.chdir start

      begin
        loop do
          yield here

          Dir.chdir '..'

          return if Dir.pwd == here # toplevel

          here = Dir.pwd
        end
      ensure
        Dir.chdir start
      end
    end