Class: Archive::Tar::Minitar::Writer

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

Overview

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

Defined Under Namespace

Classes: BoundedStream, RestrictedStream

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(anIO) ⇒ Writer

Creates and returns a new Writer object.



65
66
67
68
 
# File 'lib/minitar/writer.rb', line 65

def initialize(anIO)
  @io     = anIO
  @closed = false
end

Class Method Details

.open(anIO) ⇒ Object

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.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/minitar/writer.rb', line 50

def self.open(anIO)
  writer = Writer.new(anIO)

  return writer unless block_given?

  begin
    res = yield writer
  ensure
    writer.close
  end

  res
end

Instance Method Details

#add_file(name, opts = {}) {|RestrictedStream.new(@io), opts| ... } ⇒ Object

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.

Yields:

Raises:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/minitar/writer.rb', line 125

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

#add_file_simple(name, opts = {}) {|os| ... } ⇒ Object

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.

Yields:

  • (os)

Raises:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/minitar/writer.rb', line 84

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

#close ⇒ Object

Closes the Writer.



172
173
174
175
176
 
# File 'lib/minitar/writer.rb', line 172

def close
  return if @closed
  @io.write("\0" * 1024)
  @closed = true
end

#flush ⇒ Object

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

Raises:



166
167
168
169
 
# File 'lib/minitar/writer.rb', line 166

def flush
  raise ClosedStream if @closed
  @io.flush if @io.respond_to?(:flush)
end

#mkdir(name, opts = {}) ⇒ Object

Creates a directory in the tar.

Raises:



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/minitar/writer.rb', line 153

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