Class: IOStreams::Zip::Writer

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

Class Method Summary collapse

Class Method Details

.open(file_name_or_io, zip_file_name: nil, buffer_size: 65536, &block) ⇒ Object

Write a single file in Zip format to the supplied output file name

Parameters

file_name_or_io [String]
  Full path and filename for the output zip file

zip_file_name: [String]
  Name of the file within the Zip Stream

The stream supplied to the block only responds to #write

Example:

IOStreams::ZipWriter.open('myfile.zip', zip_file_name: 'myfile.txt') do |io_stream|
  io_stream.write("hello world\n")
  io_stream.write("and more\n")
end

Notes:

  • Since Zip cannot write to streams, if a stream is supplied, a temp file is automatically created under the covers



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/io_streams/zip/writer.rb', line 24

def self.open(file_name_or_io, zip_file_name: nil, buffer_size: 65536, &block)
  # Default the name of the file within the zip to the supplied file_name without the zip extension
  zip_file_name = file_name_or_io.to_s[0..-5] if zip_file_name.nil? && !IOStreams.writer_stream?(file_name_or_io) && (file_name_or_io =~ /\.(zip)\z/)
  zip_file_name ||= 'file'

  if !defined?(JRuby) && !defined?(::Zip)
    # MRI needs Ruby Zip, since it only has native support for GZip
    begin
      require 'zip'
    rescue LoadError => exc
      raise(LoadError, "Install gem 'rubyzip' to read and write Zip files: #{exc.message}")
    end
  end

  # File name supplied
  return write_file(file_name_or_io, zip_file_name, &block) unless IOStreams.writer_stream?(file_name_or_io)

  # ZIP can only work against a file, not a stream, so create temp file.
  IOStreams::File::Path.temp_file_name('iostreams_zip') do |temp_file_name|
    write_file(temp_file_name, zip_file_name, &block)
    IOStreams.copy(temp_file_name, file_name_or_io, source_options: {streams: []})
  end
end