(Ruby) Transition from BeginCompressStringENC to FirstChunk/LastChunk

Provides instructions for replacing deprecated BeginCompressStringENC method calls with using FirstChunk/LastChunk properties.

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

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

sbCompressedBase64 = Chilkat::CkStringBuilder.new()

compress = Chilkat::CkCompression.new()
compress.put_Algorithm("deflate")
compress.put_Charset("utf-8")
compress.put_EncodingMode("base64")

sbIndex = Chilkat::CkStringBuilder.new()

# ----------------------------------------------------------------------------------
# This is the deprecated way of compressing in chunks using Begin/More/End methods..
# ----------------------------------------------------------------------------------

for i in 0 .. 24
    # Note: It is possible (and normal) for a BeginCompress* or MoreCompress* method to return
    # an empty string (or 0 bytes).  When this happens, the input data is not lost.  It will be flushed
    # in a subsequent call.
    sbIndex.Clear()
    sbIndex.AppendInt(i)
    if (i == 0)
        sbCompressedBase64.Append(compress.beginCompressStringENC(sbIndex.getAsString()))
    else
        sbCompressedBase64.Append(compress.moreCompressStringENC(sbIndex.getAsString()))
    end

    sbCompressedBase64.Append(compress.moreCompressStringENC(": This is a line of data to be compressed...\r\n"))
end

# Flush any remaining output.
sbCompressedBase64.Append(compress.endCompressStringENC())

print "The base64 encoded compressed text:" + "\n";
print sbCompressedBase64.getAsString() + "\n";

# Decompress in one call:
originalText = compress.decompressStringENC(sbCompressedBase64.getAsString())
print originalText + "\n";

# ----------------------------------------------------------------------------------
# This is new way of compressing in chunks using FirstChunk and LastChunk properties
# ----------------------------------------------------------------------------------

sbCompressedBase64.Clear()

compress.put_FirstChunk(true)
compress.put_LastChunk(false)

bdCompressed = Chilkat::CkBinData.new()
sbUncompressedChunk = Chilkat::CkStringBuilder.new()

for i in 0 .. 24
    if (i == 24)
        compress.put_LastChunk(true)
    end

    sbUncompressedChunk.Clear()
    sbUncompressedChunk.AppendInt(i)
    sbUncompressedChunk.Append(": This is a line of data to be compressed...\r\n")

    compress.CompressSb(sbUncompressedChunk,bdCompressed)

    compress.put_FirstChunk(false)
end

print "The base64 encoded compressed text:" + "\n";
print bdCompressed.getEncoded("base64") + "\n";

# Decompress in one call:
originalText = compress.decompressStringENC(bdCompressed.getEncoded("base64"))
print originalText + "\n";