Class Archive::Tar::Minitar::Writer
In: lib/more/facets/minitar.rb
Parent: Object

The class that writes a tar format archive to a data stream.

Methods

add_file   add_file_simple   close   flush   mkdir   new   open  

Public Class methods

Creates and returns a new Writer object.

[Source]

# File lib/more/facets/minitar.rb, line 388
    def initialize(anIO)
      @io     = anIO
      @closed = false
    end

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

[Source]

# File lib/more/facets/minitar.rb, line 373
    def self.open(anIO)
      writer = Writer.new(anIO)

      return writer unless block_given?

      begin
        res = yield writer
      ensure
        writer.close
      end

      res
    end

Public Instance methods

Adds a file to the archive as name. opts must contain the following value:

:mode:The Unix file permissions mode value.

opts may contain the following values:

:uid: The Unix file owner user ID number. :gid: The Unix file owner group ID number.

:mtime:The integer modification time value.

The file‘s size will be determined from the amount of data written to the stream.

For add_file to be used, the Archive::Tar::Minitar::Writer must be wrapping a stream object that is seekable (e.g., it responds to pos=). Otherwise, add_file_simple must be used.

opts may be modified during the writing to the stream.

[Source]

# File lib/more/facets/minitar.rb, line 448
    def add_file(name, opts = {}) # :yields RestrictedStream, +opts+:
      raise Archive::Tar::Minitar::BlockRequired unless block_given?
      raise Archive::Tar::Minitar::ClosedStream if @closed
      raise Archive::Tar::Minitar::NonSeekableStream unless @io.respond_to?(:pos=)

      name, prefix = split_name(name)
      init_pos = @io.pos
      @io.write("\0" * 512) # placeholder for the header

      yield RestrictedStream.new(@io), opts
        # FIXME: what if an exception is raised in the block?

      size      = @io.pos - (init_pos + 512)
      remainder = (512 - (size % 512)) % 512
      @io.write("\0" * remainder)

      final_pos = @io.pos
      @io.pos   = init_pos

      header = { :name => name, :mode => opts[:mode], :mtime => opts[:mtime],
                 :size => size, :gid => opts[:gid], :uid => opts[:uid],
                 :prefix => prefix }
      header = Archive::Tar::PosixHeader.new(header).to_s
      @io.write(header)
      @io.pos = final_pos
    end

Adds a file to the archive as name. opts must contain the following values:

:mode:The Unix file permissions mode value.
:size:The size, in bytes.

opts may contain the following values:

:uid: The Unix file owner user ID number. :gid: The Unix file owner group ID number.

:mtime:The integer modification time value.

It will not be possible to add more than opts[:size] bytes to the file.

[Source]

# File lib/more/facets/minitar.rb, line 407
    def add_file_simple(name, opts = {}) # :yields BoundedStream:
      raise Archive::Tar::Minitar::BlockRequired unless block_given?
      raise Archive::Tar::ClosedStream if @closed

      name, prefix = split_name(name)

      header = { :name => name, :mode => opts[:mode], :mtime => opts[:mtime],
        :size => opts[:size], :gid => opts[:gid], :uid => opts[:uid],
        :prefix => prefix }
      header = Archive::Tar::PosixHeader.new(header).to_s
      @io.write(header)

      os = BoundedStream.new(@io, opts[:size])
      yield os
        # FIXME: what if an exception is raised in the block?

      min_padding = opts[:size] - os.written
      @io.write("\0" * min_padding)
      remainder = (512 - (opts[:size] % 512)) % 512
      @io.write("\0" * remainder)
    end

Closes the Writer.

[Source]

# File lib/more/facets/minitar.rb, line 495
    def close
      return if @closed
      @io.write("\0" * 1024)
      @closed = true
    end

Passes the flush method to the wrapped stream, used for buffered streams.

[Source]

# File lib/more/facets/minitar.rb, line 489
    def flush
      raise ClosedStream if @closed
      @io.flush if @io.respond_to?(:flush)
    end

Creates a directory in the tar.

[Source]

# File lib/more/facets/minitar.rb, line 476
    def mkdir(name, opts = {})
      raise ClosedStream if @closed
      name, prefix = split_name(name)
      header = { :name => name, :mode => opts[:mode], :typeflag => "5",
                 :size => 0, :gid => opts[:gid], :uid => opts[:uid],
                 :mtime => opts[:mtime], :prefix => prefix }
      header = Archive::Tar::PosixHeader.new(header).to_s
      @io.write(header)
      nil
    end

[Validate]