Skip to content

Getting Liquid to Work in Rails

whatcould edited this page Aug 12, 2010 · 10 revisions

Using .liquid as a template handler in your views

Liquid comes with a proper init.rb by default. To start using liquid just extract it into vendor/plugins or better yet use the ./script/plugin script to install liquid.

You can now start using templates with the .liquid file type.

Helpers become filters

A note about helpers. The liquid rails plugin tries to use your helpers as Filters. Your helpers will always receive the piped-in text as the first parameter, and then any Filter parameters (passed after the colon).

Helper:


   module ApplicationHelper
       def truncate(input, length)
           input[0..length] + '...' 
       end
   end
</pre>

Liquid:

 
  {{ 'This is a long section of text' | truncate: 3 }} #=>   Thi... 
</pre>

Using Rails model data and methods in liquid templates

When you pass variables to be available in a liquid template, Liquid accepts a limited number of object types — Strings, Arrays, Hashes, Numerics, and Booleans. If you’d like to pass your ActiveRecord (or other) objects to a liquid template, you have three basic approaches:

The easy way is to add a liquid_methods call:


class Post < ActiveRecord::Base
  liquid_methods :title, :body, :comments
...

Behind the scenes, liquid_methods actually constructs a Liquid Drop with the methods you include. This way you have lazy loading (say, of associated models, like “comments” in the example above) of methods.

An alternate route is to add a to_liquid call in your object, and return either one of the types listed above (string, array, hash, etc) or an object that in turn responds to to_liquid.


class Post < ActiveRecord::Base
...
 def to_liquid
    {'title' => title, 'body' => body}
  end

And finally, you can write and register a completely new Liquid Drop class, which enables you to pull from various models, and helps you consolidate (lazy-loaded) methods used just for passing data to templates.

Clone this wiki locally