123456789_123456789_123456789_123456789_123456789_

Class: Gem::Package::TarReader

Relationships & Source Files
Namespace Children
Classes:
Entry
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

Instance Method Summary

Constructor Details

.new(io) ⇒ TarReader

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

[ GitHub ] 

  


# File 'lib/rubygems/package/tar_reader.rb', line 19



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=


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader.rb', line 37



def initialize(io)
  @io = io
  @init_pos = io.pos
end


  







Instance Method Details



  

    #close  
  



  

    

Close the tar file


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader.rb', line 45



def close
end


  








  

    #each  
    Also known as: #each_entry
  



  

    

Iterates over files in the tarball yielding each entry


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader.rb', line 51



def each
  return enum_for __method__ unless block_given?

  until @io.eof? do
    begin
      header = Gem::Package::TarHeader.from @io
    rescue ArgumentError => e
      # Specialize only exceptions from Gem::Package::TarHeader.strict_oct
      raise e unless e.message.match?(/ is not an octal string$/)
      raise Gem::Package::TarInvalidError, e.message
    end

    return if header.empty?
    entry = Gem::Package::TarReader::Entry.new header, @io
    yield entry
    entry.close
  end
end


  








  

    #each_entry  
  



  

    

Alias for #each.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader.rb', line 70



alias_method :each_entry, :each


  








  

    #rewind  
  



  

    

NOTE: Do not call #rewind during #each


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader.rb', line 75



def rewind
  if @init_pos == 0
    @io.rewind
  else
    @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.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/package/tar_reader.rb', line 88



def seek(name) # :yields: entry
  found = find do |entry|
    entry.full_name == name
  end

  return unless found

  yield found
ensure
  rewind
end