Module | Juicer::CacheBuster |
In: |
lib/juicer/cache_buster.rb
|
Assists in creating filenames that reflect the last change to the file. These kinds of filenames are useful when serving static content through a web server. If the filename changes everytime the file is modified, you can safely configure the web server to cache files indefinately, and know that the updated filename will cause the file to be downloaded again - only once - when it has changed.
Soft cache busters require no web server configuration. However, it is not guaranteed to work in all settings. For example, older default configurations for popular proxy server Squid does not consider a known URL with a new query string a new URL, and thus will not download the file over.
The soft cache busters transforms /images/logo.png to /images/logo.png?cb=1232923789
Hard cache busters change the file name itself, and thus requires either the web server to (internally) rewrite requests for these files to the original ones, or the file names to actually change. Hard cache busters transforms /images/logo.png to /images/logo-1232923789.png
Hard cache busters are guaranteed to work, and is the recommended variant. An example configuration for the Apache web server that does not require you to actually change the filenames can be seen below.
<VirtualHost *> # Application/website configuration # Cache static resources for a year <FilesMatch "\.(ico|pdf|flv|jpg|jpeg|png|gif|js|css|swf)$"> ExpiresActive On ExpiresDefault "access plus 1 year" </FilesMatch> # Rewrite URLs like /images/logo-cb1234567890.png to /images/logo.png RewriteEngine On RewriteRule (.*)-cb\d+\.(.*)$ $1.$2 [L] </VirtualHost>])
Consecutive calls to add a cache buster to a path will replace the existing cache buster *as long as the parameter name is the same*. Consider this:
file = Juicer::CacheBuster.hard("/home/file.png") #=> "/home/file-cb1234567890.png" Juicer::CacheBuster.hard(file) #=> "/home/file-cb1234567891.png" # Changing the parameter name breaks this Juicer::CacheBuster.hard(file, :juicer) #=> "/home/file-cb1234567891-juicer1234567892.png"
Avoid this type of trouble simply be cleaning the URL with the old name first:
Juicer::CacheBuster.clean(file) #=> "/home/file.png" file = Juicer::CacheBuster.hard(file, :juicer) #=> "/home/file-juicer1234567892.png" Juicer::CacheBuster.clean(file, :juicer) #=> "/home/file.png"
Author: | Christian Johansen (christian@cjohansen.no) |
Copyright: | Copyright (c) 2009 Christian Johansen |
License: | BSD |
DEFAULT_PARAMETER | = | "jcb" |
Add a hard cache buster to a filename. The parameter is an optional prefix that is added before the mtime timestamp. It results in filenames of the form: file-[parameter name][timestamp].suffix, ie images/logo-cb1234567890.png which is the case for the default parameter name "cb" (as in *c*ache *b*uster).
Add a md5 cache buster to a filename. The parameter is an optional prefix that is added before the md5 digest. It results in filenames of the form: file-[parameter name][md5].suffix, ie images/logo-cb4fdbd4c637ad377adf0fc0c88f6854b3.png which is the case for the default parameter name "cb" (as in *c*ache *b*uster).
Creates a unique file name for every revision to the files contents. Raises an ArgumentError if the file can not be found.
The type indicates which type of cache buster you want, :soft or :hard. Default is :soft. If an unsupported value is specified, :soft will be used.
See hard and soft for explanation of the parameter argument.
Add a Rails-style cache buster to a filename. Results in filenames of the form: file.suffix?[timestamp], ie images/logo.png?1234567890 which is the format used by Rails’ image_tag helper.
Add a soft cache buster to a filename. The parameter is an optional name for the mtime timestamp value. It results in filenames of the form: file.suffix?[parameter name]=[timestamp], ie images/logo.png?cb=1234567890 which is the case for the default parameter name "cb" (as in *c*ache *b*uster).