Rack::RevisionInfo

About

When you deploy application to a demo server QA (or client) wants to know which revision is currently running. Of course you can handle it in a old-school way putting some helper into your layout(s) which will obtain revision number exec’ing “svnversion” or sth like this. It works but it’s not the most elegant solution. First, you are including code related only to demo/staging server in layouts/helpers (production server and your development box don’t need it at all). Second, you probably do this for every new project. But all ruby web frameworks now run on Rack so better solution would be to move revision-displaying code from the app itself to the middleware. So here comes RevisionInfo.

Installation

Add it to Gemfile:

gem "rack-revision-info"

Enable in Rails:

config/environment.rb:

config.middleware.use Rack::RevisionInfo, :path => Rails.root (RAILS_ROOT in Rails 2.x)

Enable in Merb:

config/rack.rb (before line with run Merb::Rack::Application.new):

use Rack::RevisionInfo, :path => Merb.root

Usage

Enabling this middleware for svn managed application you will get <!-- Revision 666 (2009-05-28 19:00:25 +00:00) --> appended to the end of resulting html. For git repository it will be <!-- Revision 31d0fa132584c7e9bf978443052b545c1aeca96b (2009-05-28 19:00:25 +00:00) -->. It’s commented out so in order to see it look into page source.

However if you prefer to see revision number somewhere on the page you can specify CSS selector of page element and method of injection like this:

use Rack::RevisionInfo, :path => Merb.root, :inner_html => ".footer li.revision"

Here are available injection methods:

• :append => "div.footer" inserts revision info at the end of footer div content

  <div class="footer"><img...> Revision 666 (2009-05-28 19:00:25 +00:00)</div>

• :prepend => "div.footer" inserts revision info at the begining of footer div

  <div class="footer">Revision 666 (2009-05-28 19:00:25 +00:00) <img...></div>

• :after => "div.footer" inserts revision info after footer div

  <div class="footer"><img...></div>Revision 666 (2009-05-28 19:00:25 +00:00)

• :before => "div.footer" inserts revision info before footer div

  Revision 666 (2009-05-28 19:00:25 +00:00)<div class="footer"><img...></div>

• :inner_html => "div.footer" replaces footer div content with revision info

  <div class="footer">Revision 666 (2009-05-28 19:00:25 +00:00)</div>

• :swap => "div.footer" replaces whole footer div with revision info

  Revision 666 (2009-05-28 19:00:25 +00:00)

• :header => "X-My-Header" puts revision into HTTP header of your choosing. Or use :header => true to use the default of X-Revision-Info. Good for XML/JSON API requests.

Specified CSS selector can be any selector supported by Nokogiri so you can freely use funky stuff like #main ul.footer li:last. You can also use XPath like //div/ul/li.

Contact & Information

Marcin Kulik – http://ku1ik.com/