(Ruby) Recursively Add Files to a ZIP Using AppendFilesEx

See more Zip Examples

This example demonstrates how to use the AppendFilesEx method to recursively add files from the local filesystem to a ZIP archive while controlling how directory paths and special filesystem attributes are handled.

The example:

• Recursively scans a directory tree for files
• Demonstrates how the saveExtraPath argument affects the paths stored within the ZIP archive
• Includes hidden files
• Excludes files having the Windows System attribute
• Shows how local filesystem paths are transformed into ZIP entry paths

The AppendFilesEx method adds references to files in the local filesystem. The files are not actually read or compressed until a Write* method is called.

This method is cross-platform and works on Windows, macOS, Linux, Android, iOS, and other supported operating systems.

Some arguments are Windows-specific:

• archiveOnly applies only to the Windows Archive attribute
• includeSystem applies only to the Windows System attribute

On non-Windows operating systems, these Windows-specific options are simply ignored.

Suppose the local filesystem contains the following directory tree:

c:/project/files/docs/readme.txt
c:/project/files/docs/manual.pdf
c:/project/files/images/logo.png

And suppose the following call is made:

zip.AppendFilesEx("c:/project/files",true,saveExtraPath,false,true,false);

If saveExtraPath = true, the following paths are stored in the ZIP archive:

project/files/docs/readme.txt
project/files/docs/manual.pdf
project/files/images/logo.png

In this case, the extra leading path information from the filePattern is preserved in the ZIP.

If saveExtraPath = false, the following paths are stored in the ZIP archive instead:

docs/readme.txt
docs/manual.pdf
images/logo.png

In this case, the leading project/files portion of the path is not stored in the ZIP archive.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

success = false

zip = Chilkat::CkZip.new()

success = zip.NewZip("appendFilesEx.zip")
if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

# Recursively include all files beneath c:/project/files.
recurse = true

# 
# The saveExtraPath argument controls whether the extra leading path
# information from the filePattern is included in the stored ZIP paths.
# 
# For example, suppose the local filesystem contains:
# 
#     c:/project/files/docs/readme.txt
#     c:/project/files/docs/manual.pdf
#     c:/project/files/images/logo.png
# 
# And suppose AppendFilesEx is called with:
# 
#     "c:/project/files"
# 
# If saveExtraPath = true, the ZIP stores:
# 
#     project/files/docs/readme.txt
#     project/files/docs/manual.pdf
#     project/files/images/logo.png
# 
# In this case, the extra path information from the filePattern is preserved.
# 
# ----------------------------------------------------------------
# 
# If saveExtraPath = false, the ZIP stores paths relative to the
# directory specified by the filePattern:
# 
#     docs/readme.txt
#     docs/manual.pdf
#     images/logo.png
# 
# In this case, the leading "project/files" path is not stored in the ZIP.

# ----------------------------------------------------------------
# Preserve extra path information within the ZIP archive.
saveExtraPath = true

# Do not require the Windows archive attribute.
archiveOnly = false

# Include hidden files.
includeHidden = true

# Exclude files having the Windows System attribute.
includeSystem = false

success = zip.AppendFilesEx("c:/project/files",recurse,saveExtraPath,archiveOnly,includeHidden,includeSystem)

if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

# Write the ZIP archive to disk.
success = zip.WriteZipAndClose()
if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

print "ZIP archive created successfully." + "\n";