TarReader reads tar files and allows iteration over their items

Namespace
Methods
C
E
N
R
S
Included Modules
Class Public methods
new(io)

Creates a new TarReader on io and yields it to the block, if given.

Source: show 

# File lib/rubygems/package/tar_reader.rb, line 21
def self.new(io)
  reader = super

  return reader unless block_given?

  begin
    yield reader
  ensure
    reader.close
  end

  nil
end
new(io)

Creates a new tar file reader on io which needs to respond to pos, eof?, read, getc and pos=

Source: show 

# File lib/rubygems/package/tar_reader.rb, line 39
def initialize(io)
  @io = io
  @init_pos = io.pos
end
Instance Public methods
close()

Close the tar file

Source: show 

# File lib/rubygems/package/tar_reader.rb, line 47
def close
end
each()

Iterates over files in the tarball yielding each entry

Also aliased as: each_entry

Source: show 

# File lib/rubygems/package/tar_reader.rb, line 53
def each
  return enum_for __method__ unless block_given?

  until @io.eof? do
    header = Gem::Package::TarHeader.from @io
    return if header.empty?

    entry = Gem::Package::TarReader::Entry.new header, @io
    size = entry.header.size

    yield entry

    skip = (512 - (size % 512)) % 512
    pending = size - entry.bytes_read

    begin
      # avoid reading...
      @io.seek pending, IO::SEEK_CUR
      pending = 0
    rescue Errno::EINVAL, NameError
      while pending > 0 do
        bytes_read = @io.read([pending, 4096].min).size
        raise UnexpectedEOF if @io.eof?
        pending -= bytes_read
      end
    end

    @io.read skip # discard trailing zeros

    # make sure nobody can use #read, #getc or #rewind anymore
    entry.close
  end
end
each_entry()
Alias for: each
rewind()

NOTE: Do not call rewind during each

Source: show 

# File lib/rubygems/package/tar_reader.rb, line 92
def rewind
  if @init_pos == 0 then
    raise Gem::Package::NonSeekableIO unless @io.respond_to? :rewind
    @io.rewind
  else
    raise Gem::Package::NonSeekableIO unless @io.respond_to? :pos=
    @io.pos = @init_pos
  end
end
seek(name)

Seeks through the tar file until it finds the entry with name and yields it. Rewinds the tar file to the beginning when the block terminates.

Source: show 

# File lib/rubygems/package/tar_reader.rb, line 107
def seek name # :yields: entry
  found = find do |entry|
    entry.full_name == name
  end

  return unless found

  return yield found
ensure
  rewind
end