Class: Gem::Package::TarWriter

Inherits:
Object
  • Object
show all
Defined in:
lib/rubygems/package/tar_writer.rb

Overview

Allows writing of tar files

Defined Under Namespace

Classes: BoundedStream, FileOverflow, RestrictedStream

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (TarWriter) initialize(io)

Creates a new TarWriter that will write to io



97
98
99
100
 
# File 'lib/rubygems/package/tar_writer.rb', line 97

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

Class Method Details

+ (Object) new(io)

Creates a new TarWriter, yielding it if a block is given



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/rubygems/package/tar_writer.rb', line 80

def self.new(io)
  writer = super

  return writer unless block_given?

  begin
    yield writer
  ensure
    writer.close
  end

  nil
end

Instance Method Details

- (Object) add_file(name, mode) {|RestrictedStream.new(@io)| ... }

Adds file name with permissions mode, and yields an IO for writing the file to

Yields:

Raises:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/rubygems/package/tar_writer.rb', line 106

def add_file(name, mode) # :yields: io
  check_closed

  raise Gem::Package::NonSeekableIO 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) if block_given?

  size = @io.pos - init_pos - 512

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

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

  header = Gem::Package::TarHeader.new :name => name, :mode => mode,
                                       :size => size, :prefix => prefix

  @io.write header
  @io.pos = final_pos

  self
end

- (Object) add_file_simple(name, mode, size) {|os| ... }

Add file name with permissions mode size bytes long. Yields an IO to write the file to.

Yields:

  • (os) 


139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/rubygems/package/tar_writer.rb', line 139

def add_file_simple(name, mode, size) # :yields: io
  check_closed

  name, prefix = split_name name

  header = Gem::Package::TarHeader.new(:name => name, :mode => mode,
                                       :size => size, :prefix => prefix).to_s

  @io.write header
  os = BoundedStream.new @io, size

  yield os if block_given?

  min_padding = size - os.written
  @io.write("\0" * min_padding)

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

  self
end

- (Object) check_closed

Raises IOError if the TarWriter is closed

Raises:

  • (IOError) 


164
165
166
 
# File 'lib/rubygems/package/tar_writer.rb', line 164

def check_closed
  raise IOError, "closed #{self.class}" if closed?
end

- (Object) close

Closes the TarWriter



171
172
173
174
175
176
177
178
 
# File 'lib/rubygems/package/tar_writer.rb', line 171

def close
  check_closed

  @io.write "\0" * 1024
  flush

  @closed = true
end

- (Boolean) closed?

Is the TarWriter closed?

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/rubygems/package/tar_writer.rb', line 183

def closed?
  @closed
end

- (Object) flush

Flushes the TarWriter's IO



190
191
192
193
194
 
# File 'lib/rubygems/package/tar_writer.rb', line 190

def flush
  check_closed

  @io.flush if @io.respond_to? :flush
end

- (Object) mkdir(name, mode)

Creates a new directory in the tar file name with mode



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/rubygems/package/tar_writer.rb', line 199

def mkdir(name, mode)
  check_closed

  name, prefix = split_name(name)

  header = Gem::Package::TarHeader.new :name => name, :mode => mode,
                                       :typeflag => "5", :size => 0,
                                       :prefix => prefix

  @io.write header

  self
end

- (Object) split_name(name)

Splits name into a name and prefix that can fit in the TarHeader

Raises:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/rubygems/package/tar_writer.rb', line 216

def split_name(name) # :nodoc:
  raise Gem::Package::TooLongFileName if name.size > 256

  if name.size <= 100 then
    prefix = ""
  else
    parts = name.split(/\//)
    newname = parts.pop
    nxt = ""

    loop do
      nxt = parts.pop
      break if newname.size + 1 + nxt.size > 100
      newname = nxt + "/" + newname
    end

    prefix = (parts + [nxt]).join "/"
    name = newname

    if name.size > 100 or prefix.size > 155 then
      raise Gem::Package::TooLongFileName 
    end
  end

  return name, prefix
end