agoragames / ventilation

Ventilation

Ventilation makes developing with ESI a snap.

ESI helps scale your website by allowing you to break it down into fragments which can be cached independently and reconstructed on the fly. This allows your server to spend the majority of its time creating the truly dynamic sections of your site and the rest to be reused and mixed in at the edge.

Using ESI means you need to develop behind varnish or something capable of composing the response. Ventilation however, removes this dependecny which means you can develop with esi using nothing more the script/server. There is no need to run a local varnish server (you still can if you want to). Ventilation will automatically compose the page as if it was run through varnish while you are in development. When you move out of development or put your ventilation powered application behind varnish the composed content will be replaced with esi tags allowing varnish to work it's magic.

WARNING: Using Varnish without Ventilation may result in death!

Example

Include from a content delivery network.

<%= esi "http://cdn.megadomain.com/network_nav" %>

Include from somewhere else within your application.

<%= esi :header %>
<%= esi :header, :controller => :site %>

Copyright (c) 2010 Agora Games, released under the MIT license

Installation

gem install ventilation

Resources

• Ventilation GitHub Page
• Ventilation Documentation on RubyDoc.info
• Ventilation on GemCutter
• ESI Language Specification 1.0
• Edge Side Includes - Wikipedia

ventilation's Issues

Rails 3 Support Issues

The latest version of ventilation allows all tests to pass in rails3 but does not provide the end-to-end support I had hoped for. Specifically, the deepstack class which allow multiple requests to process in a simulated concurrent fashion is blowing-up. I am looking into this issue but wanted to make a note here incase anyone is wondering why certain functionality is not working as expected in Rails3 projects. I plan on having this issue addressed in the next release 0.2.1. Ventilation should still work as expected for rails 2.