class Sprockets::Utils::Gzip

Constants

COMPRESSABLE_MIME_TYPES

What non-text mime types should we compress? This list comes from: www.fastly.com/blog/new-gzip-settings-and-deciding-what-compress

Attributes

archiver[R]
charset[R]
content_type[R]
source[R]

Public Class Methods

new(asset, archiver: ZlibArchiver) click to toggle source

Private: Generates a gzipped file based off of reference file.

# File lib/sprockets/utils/gzip.rb, line 43
def initialize(asset, archiver: ZlibArchiver)
  @content_type  = asset.content_type
  @source        = asset.source
  @charset       = asset.charset
  @archiver      = archiver
end

Public Instance Methods

can_compress?() click to toggle source

Private: Returns whether or not an asset can be compressed.

We want to compress any file that is text based. You do not want to compress binary files as they may already be compressed and running them through a compression algorithm would make them larger.

Return Boolean.

# File lib/sprockets/utils/gzip.rb, line 68
def can_compress?
  # The "charset" of a mime type is present if the value is
  # encoded text. We can check this value to see if the asset
  # can be compressed.
  #
  # We also check against our list of non-text compressible mime types
  @charset || COMPRESSABLE_MIME_TYPES.include?(@content_type)
end
cannot_compress?() click to toggle source

Private: Opposite of ‘can_compress?`.

Returns Boolean.

# File lib/sprockets/utils/gzip.rb, line 80
def cannot_compress?
  !can_compress?
end
compress(file, target) click to toggle source

Private: Generates a gzipped file based off of reference asset.

Compresses the target asset’s contents and puts it into a file with the same name plus a ‘.gz` extension in the same folder as the original. Does not modify the target asset.

Returns nothing.

# File lib/sprockets/utils/gzip.rb, line 91
def compress(file, target)
  mtime = Sprockets::PathUtils.stat(target).mtime
  archiver.call(file, source, mtime)

  nil
end