summaryrefslogtreecommitdiff
path: root/lib/coderay/helpers/gzip.rb
blob: 43f1000605c62cb1ce7f66e095138bd3687b5382 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
module CodeRay

# =GZip Simple
#
# A simplified interface to the gzip library +zlib+ (from the Ruby Standard Library.)
#
# Author: murphy (mail to murphy rubychan de)
#
# Version: 0.2 (2005.may.28)
#
# ==Documentation
#
# See +GZip+ module and the +String+ extensions.
#
module GZip

  require 'zlib'

  # The default zipping level. 7 zips good and fast.
  DEFAULT_GZIP_LEVEL = 7

  # Unzips the given string +s+.
  #
  # Example:
  #   require 'gzip_simple'
  #   print GZip.gunzip(File.read('adresses.gz'))
  def GZip.gunzip s
    Zlib::Inflate.inflate s
  end

  # Zips the given string +s+.
  #
  # Example:
  #   require 'gzip_simple'
  #   File.open('adresses.gz', 'w') do |file
  #     file.write GZip.gzip('Mum: 0123 456 789', 9)
  #   end
  #
  # If you provide a +level+, you can control how strong
  # the string is compressed:
  # - 0: no compression, only convert to gzip format
  # - 1: compress fast
  # - 7: compress more, but still fast (default)
  # - 8: compress more, slower
  # - 9: compress best, very slow
  def GZip.gzip s, level = DEFAULT_GZIP_LEVEL
    Zlib::Deflate.new(level).deflate s, Zlib::FINISH
  end
end

end