class Liquid::Drop
A drop in liquid is a class which allows you to export DOM like things to liquid. Methods of drops are callable. The main use for liquid drops is to implement lazy loaded objects. If you would like to make data available to the web designers which you don't want loaded unless needed then a drop is a great way to do that.
Example:
class ProductDrop < Liquid::Drop def top_sales Shop.current.products.find(:all, :order => 'sales', :limit => 10 ) end end tmpl = Liquid::Template.parse( ' {% for product in product.top_sales %} {{ product.name }} {%endfor%} ' ) tmpl.render('product' => ProductDrop.new ) # will invoke top_sales query.
Your drop can either implement the methods sans any parameters or implement the #liquid_method_missing(name) method which is a catch all.
Attributes
context[W]
Public Class Methods
invokable?(method_name)
click to toggle source
Check for method existence without invoking respond_to?, which creates symbols
# File lib/liquid/drop.rb, line 60 def self.invokable?(method_name) invokable_methods.include?(method_name.to_s) end
invokable_methods()
click to toggle source
# File lib/liquid/drop.rb, line 64 def self.invokable_methods @invokable_methods ||= begin blacklist = Liquid::Drop.public_instance_methods + [:each] if include?(Enumerable) blacklist += Enumerable.public_instance_methods blacklist -= [:sort, :count, :first, :min, :max, :include?] end whitelist = [:to_liquid] + (public_instance_methods - blacklist) Set.new(whitelist.map(&:to_s)) end end
Public Instance Methods
inspect()
click to toggle source
# File lib/liquid/drop.rb, line 45 def inspect self.class.to_s end
invoke_drop(method_or_key)
click to toggle source
called by liquid to invoke a drop
# File lib/liquid/drop.rb, line 33 def invoke_drop(method_or_key) if self.class.invokable?(method_or_key) send(method_or_key) else liquid_method_missing(method_or_key) end end
Also aliased as: []
key?(_name)
click to toggle source
# File lib/liquid/drop.rb, line 41 def key?(_name) true end
liquid_method_missing(method)
click to toggle source
Catch all for the method
# File lib/liquid/drop.rb, line 27 def liquid_method_missing(method) return nil unless @context && @context.strict_variables raise Liquid::UndefinedDropMethod, "undefined method #{method}" end
to_liquid()
click to toggle source
# File lib/liquid/drop.rb, line 49 def to_liquid self end
to_s()
click to toggle source
# File lib/liquid/drop.rb, line 53 def to_s self.class.name end