Class: Liquid::Drop

Inherits:
Object
  • Object
show all
Defined in:
lib/liquid/drop.rb

Overview

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 before_method(name) method which is a catch all.

Constant Summary collapse

EMPTY_STRING = 
''.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#context=(value) ⇒ Object (writeonly)

Sets the attribute context

Parameters:

  • value —

    the value to set the attribute context to.



25
26
27
 
# File 'lib/liquid/drop.rb', line 25

def context=(value)
  @context = value
end

Instance Method Details

#before_method(method) ⇒ Object

Catch all for the method



30
31
32
 
# File 'lib/liquid/drop.rb', line 30

def before_method(method)
  nil
end

#has_key?(name) ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/liquid/drop.rb', line 43

def has_key?(name)
  true
end

#inspect ⇒ Object 



47
48
49
 
# File 'lib/liquid/drop.rb', line 47

def inspect
  self.class.to_s
end

#invoke_drop(method_or_key) ⇒ Object Also known as: []

called by liquid to invoke a drop



35
36
37
38
39
40
41
 
# File 'lib/liquid/drop.rb', line 35

def invoke_drop(method_or_key)
  if method_or_key && method_or_key != EMPTY_STRING && self.class.invokable?(method_or_key)
    send(method_or_key)
  else
    before_method(method_or_key)
  end
end

#to_liquid ⇒ Object 



51
52
53
 
# File 'lib/liquid/drop.rb', line 51

def to_liquid
  self
end

#to_s ⇒ Object 



55
56
57
 
# File 'lib/liquid/drop.rb', line 55

def to_s
  self.class.name
end