Class: Archive::Tar::Minitar::Reader

Inherits:
Object
  • Object
show all
Defined in:
lib/shoes/minitar.rb

Overview

The class that reads a tar format archive from a data stream. The data stream may be sequential or random access, but certain features only work with random access data streams.

Defined Under Namespace

Modules: InvalidEntryStream Classes: EntryStream

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Reader) initialize(anIO)

Creates and returns a new Reader object.



584
585
586
587
# File 'lib/shoes/minitar.rb', line 584

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

Class Method Details

+ (Object) open(anIO)

With no associated block, Reader::open is a synonym for Reader::new. If the optional code block is given, it will be passed the new writer as an argument and the Reader object will automatically be closed when the block terminates. In this instance, Reader::open returns the value of the block.



569
570
571
572
573
574
575
576
577
578
579
580
581
# File 'lib/shoes/minitar.rb', line 569

def self.open(anIO)
  reader = Reader.new(anIO)

  return reader unless block_given?

  begin
    res = yield reader
  ensure
    reader.close
  end
  
  res
end

Instance Method Details

- (Object) close



639
640
# File 'lib/shoes/minitar.rb', line 639

def close
end

- (Object) each(&block)

Iterates through each entry in the data stream.



590
591
592
# File 'lib/shoes/minitar.rb', line 590

def each(&block)
  each_entry(&block)
end

- (Object) each_entry

Iterates through each entry in the data stream.



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
# File 'lib/shoes/minitar.rb', line 608

def each_entry
  loop do
    return if @io.eof?

    header = Archive::Tar::PosixHeader.new_from_stream(@io)
    return if header.empty?

    entry = EntryStream.new(header, @io)
    size  = entry.size

    yield entry

    skip = (512 - (size % 512)) % 512

    if @io.respond_to?(:seek)
        # avoid reading...
      @io.seek(size - entry.bytes_read, IO::SEEK_CUR)
    else
      pending = size - entry.bytes_read
      while pending > 0
        bread = @io.read([pending, 4096].min).size
        raise UnexpectedEOF if @io.eof?
        pending -= bread
      end
    end
    @io.read(skip) # discard trailing zeros
      # make sure nobody can use #read, #getc or #rewind anymore
    entry.close
  end
end

- (Object) rewind

Resets the read pointer to the beginning of data stream. Do not call this during a #each or #each_entry iteration. This only works with random access data streams that respond to #rewind and #pos.



597
598
599
600
601
602
603
604
605
# File 'lib/shoes/minitar.rb', line 597

def rewind
  if @init_pos == 0
    raise NonSeekableStream unless @io.respond_to?(:rewind)
    @io.rewind
  else
    raise NonSeekableStream unless @io.respond_to?(:pos=)
    @io.pos = @init_pos
  end
end