class ZipFolder

This is a simple example which uses rubyzip to recursively generate a zip file from the contents of a specified directory. The directory itself is not included in the archive, rather just its contents.

Usage:

directory_to_zip = "/tmp/input"
output_file = "/tmp/out.zip"
zf = ZipFolder.new(directory_to_zip, output_file)
zf.write()

Constants

VERSION

Public Class Methods

new(input_dir, output_file) click to toggle source

Initialize with the directory to zip and the location of the output archive.

# File lib/zip_folder.rb, line 25
def initialize(input_dir, output_file)
  @input_dir = input_dir
  @output_file = output_file
end

zip(input_dir, output_file) click to toggle source

# File lib/zip_folder.rb, line 20
def self.zip(input_dir, output_file)
  new(input_dir, output_file).write
end

Public Instance Methods

write() click to toggle source

Zip the input directory.

# File lib/zip_folder.rb, line 31
def write
  entries = Dir.entries(@input_dir) - %w[. ..]

  ::Zip::File.open(@output_file, ::Zip::File::CREATE) do |zipfile|
    write_entries entries, '', zipfile
  end
end

Private Instance Methods

put_into_archive(disk_file_path, zipfile, zipfile_path) click to toggle source

# File lib/zip_folder.rb, line 61
def put_into_archive(disk_file_path, zipfile, zipfile_path)
  zipfile.add(zipfile_path, disk_file_path)
end

recursively_deflate_directory(disk_file_path, zipfile, zipfile_path) click to toggle source

# File lib/zip_folder.rb, line 55
def recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
  zipfile.mkdir zipfile_path
  subdir = Dir.entries(disk_file_path) - %w[. ..]
  write_entries subdir, zipfile_path, zipfile
end

write_entries(entries, path, zipfile) click to toggle source

A helper method to make the recursion work.

# File lib/zip_folder.rb, line 42
def write_entries(entries, path, zipfile)
  entries.each do |e|
    zipfile_path = path == '' ? e : File.join(path, e)
    disk_file_path = File.join(@input_dir, zipfile_path)

    if File.directory? disk_file_path
      recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
    else
      put_into_archive(disk_file_path, zipfile, zipfile_path)
    end
  end
end