Project

radiant-lacquer-extension

0.0
No commit activity in last 3 years
No release in over 3 years
radiant-lacquer-extensionjomz/radiant-lacquer-extensionHomepageDocumentationSource CodeBug TrackerWiki
Makes Radiant play nice with Varnish through Lacquer!
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
10,016
Stars
1
Forks
0
Watchers
2
 Releases
Current version
1.0.2
Total releases
3
First release
2012-01-12
Latest release
2013-12-05
 Development
Primary Language
Ruby
Average date of last 50 commits
2012-05-23
Reverse Dependencies
0

 Dependencies

Runtime

lacquer
= 0.5.5
 Project Readme

Radiant Lacquer Extension

Lacquer support for Radiant CMS.

The Lacquer extension uses the Lacquer gem to send purge commands to Varnish. As Lacquer requires Ruby 1.9, so does this extension.

Please file bugs and feature requests on Github.

Installation

Add this gem via bundler:

gem 'radiant-lacquer-extension' && bundle install

Run rake radiant:extensions:lacquer:update. This will add the following files:

  • RAILS_ROOT/config/varnishd.yml
  • RAILS_ROOT/config/varnishd.vcl.erb
  • RAILS_ROOT/config/initializers/lacquer.rb

You will want to update lacquer.rb and varnishd.yml Installation of Varnish itself is not covered in this README.

Purge strategy

This extension hooks into Admin::ResourceController to send purge commands through Lacquer. For any model class except Page, a global purge is performed after every CUD (create update destroy) action.

For pages, a CUD action will purge the cache for that page, all it's descendants, all it's ancestors and their descendants, except for the home page's descendants.

Assuming these pages exist in the cache:

/ /about /about/team /about/team/freelancers /about/contact /blog /blog/2012/01/12/varnish-is-so-awesome /portfolio

An update to /about/team will purge the following pages;

/about/team /about/team/freelancers (because it's a descendant of /about/team) /about (because it's an ancestor of /about/team) /about/contact (because it's a descendant of /about) / (because it's the home page)

But leave the cache for /blog and /portfolio alone. The idea is to avoid unnecessary purging. This strategy may not be 100% fit for your site. For example if on /portfolio you render content from /about (e.g. via r:find), this page will be stale, but not purged. To overwrite this behavior, you will want to change clear_model_cache_with_lacquer in Admin::ResourceController.

Contributions

If you would like to contribute, please fork the project and submit a pull request.

Pull requests with working tests are preferred and have a greater chance of being merged.

TODO

  • Add tests!
  • Make purge strategy configurable

Authors

  • Benny Degezelle

Released under the same terms as Radiant.