Class: Middleman::Extensions::Gzip

Inherits:
Middleman::Extension show all
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.

Instance Attribute Summary

Attributes inherited from Middleman::Extension

#app, #options

Instance Method Summary collapse

Methods inherited from Middleman::Extension

activate, activated_extension, after_extension_activated, clear_after_extension_callbacks, config, extension_name, helpers, option, register

Constructor Details

#initialize(app, options_hash = {}) ⇒ Gzip

Returns a new instance of Gzip.



15
16
17
18
19
20
21
 
# File 'lib/middleman-more/extensions/gzip.rb', line 15

def initialize(app, options_hash={})
  super

  require 'zlib'
  require 'stringio'
  require 'find'
end

Instance Method Details

#after_build(builder) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/middleman-more/extensions/gzip.rb', line 23

def after_build(builder)
  paths = ::Middleman::Util.all_files_under(app.build_dir)
  total_savings = 0

  paths.each do |path|
    next unless options.exts.include? path.extname

    output_filename, old_size, new_size = gzip_file(path.to_s)

    if output_filename
      total_savings += (old_size - new_size)
      size_change_word = (old_size - new_size) > 0 ? 'smaller' : 'larger'
      old_locale = I18n.locale
      I18n.locale = :en # use the english localizations for printing out file sizes to make sure the localizations exist
      builder.say_status :gzip, "#{output_filename} (#{app.number_to_human_size((old_size - new_size).abs)} #{size_change_word})"
      I18n.locale = old_locale
    end
  end

  builder.say_status :gzip, "Total gzip savings: #{app.number_to_human_size(total_savings)}", :blue
end

#gzip_file(path) ⇒ Object 



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
70
71
72
 
# File 'lib/middleman-more/extensions/gzip.rb', line 45

def gzip_file(path)
  input_file = File.open(path, 'rb').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, 'wb') 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