Class: Gem::Package::TarReader
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Exceptions:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Enumerable
|
|
Inherits: | Object |
Defined in: | lib/rubygems/package/tar_reader.rb |
Overview
TarReader
reads tar files and allows iteration over their items
Class Method Summary
-
.new(io) ⇒ TarReader
constructor
Creates a new
TarReader
onio
and yields it to the block, if given.
Instance Method Summary
-
#close
Close the tar file.
-
#each
(also: #each_entry)
Iterates over files in the tarball yielding each entry.
-
#each_entry
Alias for #each.
-
#initialize(io) ⇒ TarReader
constructor
Creates a new tar file reader on
io
which needs to respond to#pos
,#eof?
,#read
,#getc
and#pos=
- #rewind
-
#seek(name)
Seeks through the tar file until it finds the
entry
withname
and yields it.
Constructor Details
.new(io) ⇒ TarReader
Creates a new TarReader
on io
and yields it to the block, if given.
# File 'lib/rubygems/package/tar_reader.rb', line 23
def self.new(io) reader = super return reader unless block_given? begin yield reader ensure reader.close end nil end
#initialize(io) ⇒ TarReader
Creates a new tar file reader on io
which needs to respond to #pos
, #eof?
, #read
, #getc
and #pos=
# File 'lib/rubygems/package/tar_reader.rb', line 41
def initialize(io) @io = io @init_pos = io.pos end
Instance Method Details
#close
Close the tar file
# File 'lib/rubygems/package/tar_reader.rb', line 49
def close end
#each Also known as: #each_entry
Iterates over files in the tarball yielding each entry
# File 'lib/rubygems/package/tar_reader.rb', line 55
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.
# File 'lib/rubygems/package/tar_reader.rb', line 89
alias each_entry each
#rewind
NOTE: Do not call #rewind
during #each
# File 'lib/rubygems/package/tar_reader.rb', line 94
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.
# File 'lib/rubygems/package/tar_reader.rb', line 109
def seek name # :yields: entry found = find do |entry| entry.full_name == name end return unless found return yield found ensure rewind end