Migrated from getting-liquid-to-work-in-rails v4

RichMorin
2010-08-12 13:45:48 -07:00
parent cb7fe934f4
commit ebc9c1fa1f
+18 -9
@@ -1,12 +1,16 @@
h2. 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.
Liquid comes with a proper @init.rb@ file, by default.
To start using Liquid, just extract it into @vendor/plugins@.
Better yet, use the @./script/plugin@ script to install Liquid.
You can now start using templates with the .liquid file type.
You can now start using templates with the @.liquid@ file type (ie, extension).
h3. 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).
A note about helpers.
Liquid's 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:
<pre><code>
@@ -23,11 +27,13 @@ Liquid:
</pre></code>
h2. Using Rails model data and methods in liquid templates
h2. 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:
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:
The easy way is to add a @liquid_methods@ call:
<pre><code>
class Post < ActiveRecord::Base
@@ -35,9 +41,11 @@ class Post < ActiveRecord::Base
...
</pre></code>
"Behind the scenes":http://github.com/tobi/liquid/tree/master/lib/liquid/module_ex.rb, *liquid_methods* actually constructs a "Liquid Drop":http://liquid.rubyforge.org/classes/Liquid/Drop.html with the methods you include. This way you have lazy loading (say, of associated models, like "comments" in the example above) of methods.
"Behind the scenes":http://github.com/tobi/liquid/tree/master/lib/liquid/module_ex.rb,
@liquid_methods@ actually constructs a "Liquid Drop":http://liquid.rubyforge.org/classes/Liquid/Drop.html with the methods you include. This way, you have lazy loading (say, of associated models such as "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.
An alternate route is to add a @to_liquid@ call in your object,
returning either one of the types listed above (string, array, hash, etc) or an object that in turn responds to @to_liquid@.
<pre><code>
class Post < ActiveRecord::Base
@@ -47,4 +55,5 @@ class Post < ActiveRecord::Base
end
</pre></code>
And finally, you can write and register a completely new "Liquid Drop":http://liquid.rubyforge.org/classes/Liquid/Drop.html class, which enables you to pull from various models, and helps you consolidate (lazy-loaded) methods used just for passing data to templates.
Finally, you can write and register a completely new "Liquid Drop":http://liquid.rubyforge.org/classes/Liquid/Drop.html class.
This enables you to pull from various models and helps you consolidate (lazy-loaded) methods used just for passing data to templates.