Module: Middleman::Extensions::Gzip

Defined in:
lib/middleman-more/extensions/gzip.rb

Overview

This extension Gzips assets and pages when building. Gzipped assets and pages can be served directly by Apache or Nginx with the proper configuration, and pre-zipping means that we can use a more agressive compression level at no CPU cost per request.

Use Nginx’s gzip_static directive, or AddEncoding and mod_rewrite in Apache to serve your Gzipped files whenever the normal (non-.gz) filename is requested.

Pass the :exts options to customize which file extensions get zipped (defaults to .html, .htm, .js and .css.

Class Method Summary collapse

Class Method Details

.gzip_file(path) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/middleman-more/extensions/gzip.rb', line 42

def self.gzip_file(path)
  input_file = File.open(path, 'r').read
  output_filename = path + '.gz'
  input_file_time = File.mtime(path)

  # Check if the right file's already there
  if File.exist?(output_filename) && File.mtime(output_filename) == input_file_time
    return
  end

  File.open(output_filename, 'w') do |f|
    gz = Zlib::GzipWriter.new(f, Zlib::BEST_COMPRESSION)
    gz.mtime = input_file_time.to_i
    gz.write input_file
    gz.close
  end

  # Make the file times match, both for Nginx's gzip_static extension
  # and so we can ID existing files. Also, so even if the GZ files are
  # wiped out by build --clean and recreated, we won't rsync them over
  # again because they'll end up with the same mtime.
  File.utime(File.atime(output_filename), input_file_time, output_filename)

  old_size = File.size(path)
  new_size = File.size(output_filename)

  [output_filename, old_size, new_size]
end

.registered(app, options = {}) ⇒ Object Also known as: included 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/middleman-more/extensions/gzip.rb', line 20

def registered(app, options={})
  exts = options[:exts] || %w(.js .css .html .htm)

  app.after_build do |builder|

    paths = ::Middleman::Util.all_files_under(self.class.inst.build_dir)
    paths.each do |path|
      next unless exts.include? path.extname

      output_filename, old_size, new_size = Middleman::Extensions::Gzip.gzip_file(path.to_s)

      if output_filename
        size_change_word = (old_size - new_size) > 0 ? 'smaller' : 'larger'
        builder.say_status :gzip, "#{output_filename} (#{number_to_human_size((old_size - new_size).abs)} #{size_change_word})"
      end
    end
  end
end