Ruby

Unzip a Text File Entry into a StringBuilder Using ZipEntry.UnzipToSb

See more Zip Examples

This example demonstrates how to use the ZipEntry.UnzipToSb method to inflate a text file entry directly into a StringBuilder object.

The ZIP entry is uncompressed entirely in memory and appended to the StringBuilder without creating a temporary file on disk.

This is useful when:

• Processing text files directly in memory
• Avoiding temporary filesystem files
• Reading configuration files, JSON, XML, CSV, or source code from ZIP archives
• Automatically converting line endings while inflating the text

The srcCharset argument specifies how the uncompressed bytes should be interpreted, such as:

• utf-8
• utf-16
• windows-1252

The lineEndingBehavior argument controls line-ending conversion:

• 0 — Leave line endings unchanged
• 1 — Convert all line endings to bare LF
• 2 — Convert all line endings to CRLF

Suppose the ZIP archive contains:

config/settings.json

The example inflates the JSON file directly into a StringBuilder.

Ruby

require 'chilkat'

success = false

zip = Chilkat::CkZip.new()

# Open an existing ZIP archive.
success = zip.OpenZip("qa_data/zips/configFiles.zip")
if (success == false)
    print zip.lastErrorText() + "\n";
    exit
end

# Locate the JSON file entry within the ZIP archive.
entry = Chilkat::CkZipEntry.new()

success = zip.EntryOf("config/settings.json",entry)
if (success == false)
    print "ZIP entry not found." + "\n";
    zip.CloseZip()
    exit
end

# ------------------------------------------------------------
# Inflate the ZIP entry directly into a StringBuilder.
# 
# The uncompressed text is appended to the StringBuilder.
# 
sb = Chilkat::CkStringBuilder.new()

# Leave line endings unchanged.
lineEndingBehavior = 0

# Interpret the uncompressed bytes as UTF-8 text.
srcCharset = "utf-8"

success = entry.UnzipToSb(lineEndingBehavior,srcCharset,sb)
if (success == false)
    print entry.lastErrorText() + "\n";
    exit
end

print "Uncompressed text:" + "\n";
print "" + "\n";
print sb.getAsString() + "\n";

zip.CloseZip()

print "Done." + "\n";