Skip to Content Skip to Search

module ActiveSupport::Gzip

Active Support Gzip

A convenient wrapper for the zlib standard library that allows compression/decompression of strings with gzip.

gzip = ActiveSupport::Gzip.compress('compress me!')
# => "\x1F\x8B\b\x00o\x8D\xCDO\x00\x03K\xCE\xCF-(J-.V\xC8MU\x04\x00R>n\x83\f\x00\x00\x00"

ActiveSupport::Gzip.decompress(gzip)
# => "compress me!"

Public class methods

compress(source, level = Zlib::DEFAULT_COMPRESSION, strategy = Zlib::DEFAULT_STRATEGY)

Compresses a string using gzip.

Source code GitHub 
# File activesupport/lib/active_support/gzip.rb, line 32
def self.compress(source, level = Zlib::DEFAULT_COMPRESSION, strategy = Zlib::DEFAULT_STRATEGY)
  output = Stream.new
  gz = Zlib::GzipWriter.new(output, level, strategy)
  gz.write(source)
  gz.close
  output.string
end

decompress(source)

Decompresses a gzipped string.

Source code GitHub 
# File activesupport/lib/active_support/gzip.rb, line 27
def self.decompress(source)
  Zlib::GzipReader.wrap(StringIO.new(source), &:read)
end

Namespace

Definition files