class Minitar::Output

Wraps a Minitar::Writer with convenience methods and wrapped stream management. If the stream provided to Output does not support random access, only Writer#add_file_simple and Writer#mkdir are guaranteed to work.

=== Security Notice

Constructing a Minitar::Output will use Kernel.open if the provided output is not a readable stream object. Using an untrusted value for output may allow a malicious user to execute arbitrary system commands. It is the caller’s responsibility to ensure that the output value is safe.

This notice applies to Minitar::Output.open, Minitar::Output.tar, and Minitar::Output.new.

Attributes

tar [R]

Returns the Writer object for direct access.

Public Class Methods

Minitar::Output.new(io) → output

Minitar::Output.new(path) → output

Source

# File lib/minitar/output.rb, line 68
def initialize(output)
  @io = if output.respond_to?(:write)
    output
  else
    ::Kernel.open(output, "wb")
  end
  @tar = Minitar::Writer.new(@io)
end

Creates a new Output object. If output is a stream object that responds to write, then it will simply be wrapped. Otherwise, one will be created and opened using Kernel#open. When Output#close is called, the stream object wrapped will be closed.

Minitar::Output.open(io) → output

Minitar::Output.open(io) { |output| block } → obj

Source

# File lib/minitar/output.rb, line 33
def self.open(output)
  stream = new(output)
  return stream unless block_given?

  # This exception context must remain, otherwise the stream closes on open
  # even if a block is not given.
  begin
    yield stream
  ensure
    stream.close
  end
end

With no associated block, Output.open is a synonym for Output.new.

If a block is given, the new Output will be yielded to the block as an argument and the Output object will automatically be closed when the block terminates (this also closes the wrapped stream object). The return value will be the value of the block.

Minitar::Output.tar(io) → enumerator

Minitar::Output.tar(io) { |tar| block } → obj

Source

# File lib/minitar/output.rb, line 53
def self.tar(output)
  return to_enum(__method__, output) unless block_given?

  Output.open(output) do |stream|
    yield stream.tar
  end
end

Output.tar is a wrapper for Output.open that yields the owned tar object instead of the Output object. If a block is not provided, an enumerator will be created with the same behaviour.

Public Instance Methods

close ()

Source

# File lib/minitar/output.rb, line 84
def close
  @tar.close
  @io.close
end

Closes the Writer object and the wrapped data stream.

closed? (= @io.closed?)

Source

# File lib/minitar/output.rb, line 81
  def closed? = @io.closed?

  # Closes the Writer object and the wrapped data stream.
  def close
    @tar.close
    @io.close
  end
end

Returns false if the wrapped data stream is open.