Module: Liquid::StandardFilters

Defined in:
lib/liquid/standardfilters.rb

Instance Method Summary collapse

Instance Method Details

#append(input, string) ⇒ Object

add one string to another



114
115
116
 
# File 'lib/liquid/standardfilters.rb', line 114

def append(input, string)
  input.to_s + string.to_s
end

#capitalize(input) ⇒ Object

capitalize words in the input centence



29
30
31
 
# File 'lib/liquid/standardfilters.rb', line 29

def capitalize(input)
  input.to_s.capitalize
end

#date(input, format) ⇒ Object

Reformat a date

a - The abbreviated weekday name (``Sun'')
A - The  full  weekday  name (``Sunday'')
b - The abbreviated month name (``Jan'')
B - The  full  month  name (``January'')
c - The preferred local date and time representation
d - Day of the month (01..31)
H - Hour of the day, 24-hour clock (00..23)
I - Hour of the day, 12-hour clock (01..12)
j - Day of the year (001..366)
m - Month of the year (01..12)
M - Minute of the hour (00..59)
p - Meridian indicator (``AM''  or  ``PM'')
S - Second of the minute (00..60)
U - Week  number  of the current year,
        starting with the first Sunday as the first
        day of the first week (00..53)
%W - Week  number  of the current year,
        starting with the first Monday as the first
        day of the first week (00..53)
%w - Day of the week (Sunday is 0, 0..6)
%x - Preferred representation for the date alone, no time
X - Preferred representation for the time alone, no date
y - Year without a century (00..99)
Y - Year with century
Z - Time zone name
%% - Literal ``%'' character



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/liquid/standardfilters.rb', line 156

def date(input, format)
  
  if format.to_s.empty?
    return input.to_s
  end
  
  date = input.is_a?(String) ? Time.parse(input) : input
  
  if date.respond_to?(:strftime)
    date.strftime(format.to_s)
  else
    input
  end
rescue => e 
  input
end

#divided_by(input, operand) ⇒ Object

division



207
208
209
 
# File 'lib/liquid/standardfilters.rb', line 207

def divided_by(input, operand)
  input / operand if input.respond_to?('/')
end

#downcase(input) ⇒ Object

convert a input string to DOWNCASE



19
20
21
 
# File 'lib/liquid/standardfilters.rb', line 19

def downcase(input)
  input.to_s.downcase
end

#escape(input) ⇒ Object Also known as: h 



33
34
35
 
# File 'lib/liquid/standardfilters.rb', line 33

def escape(input)
  CGI.escapeHTML(input) rescue input
end

#first(array) ⇒ Object

Get the first element of the passed in array

Example:

{{ product.images | first | to_img }}



178
179
180
 
# File 'lib/liquid/standardfilters.rb', line 178

def first(array)
  array.first if array.respond_to?(:first)
end

#join(input, glue = ' ') ⇒ Object

Join elements of the array with certain character between them



66
67
68
 
# File 'lib/liquid/standardfilters.rb', line 66

def join(input, glue = ' ')
  [input].flatten.join(glue)
end

#last(array) ⇒ Object

Get the last element of the passed in array

Example:

{{ product.images | last | to_img }}



187
188
189
 
# File 'lib/liquid/standardfilters.rb', line 187

def last(array)
  array.last if array.respond_to?(:last)
end

#map(input, property) ⇒ Object

map/collect on a given property



84
85
86
87
88
89
90
91
 
# File 'lib/liquid/standardfilters.rb', line 84

def map(input, property)
  ary = [input].flatten
  if ary.first.respond_to?('[]') and !ary.first[property].nil?
    ary.map {|e| e[property] }
  elsif ary.first.respond_to?(property)
    ary.map {|e| e.send(property) }
  end
end

#minus(input, operand) ⇒ Object

subtraction



197
198
199
 
# File 'lib/liquid/standardfilters.rb', line 197

def minus(input, operand)
  input - operand if input.respond_to?('-')
end

#newline_to_br(input) ⇒ Object

Add <br /> tags in front of all newlines in input string



124
125
126
 
# File 'lib/liquid/standardfilters.rb', line 124

def newline_to_br(input)        
  input.to_s.gsub(/\n/, "<br />\n")      
end

#plus(input, operand) ⇒ Object

addition



192
193
194
 
# File 'lib/liquid/standardfilters.rb', line 192

def plus(input, operand)
  input + operand if input.respond_to?('+')
end

#prepend(input, string) ⇒ Object

prepend a string to another



119
120
121
 
# File 'lib/liquid/standardfilters.rb', line 119

def prepend(input, string)
  string.to_s + input.to_s
end

#raw(input) ⇒ Object

does nothing itself but prevent autoescaping: See Liquid::Variable



8
9
10
 
# File 'lib/liquid/standardfilters.rb', line 8

def raw(input)
  input 
end

#remove(input, string) ⇒ Object

remove a substring



104
105
106
 
# File 'lib/liquid/standardfilters.rb', line 104

def remove(input, string)
  input.to_s.gsub(string, '')      
end

#remove_first(input, string) ⇒ Object

remove the first occurrences of a substring



109
110
111
 
# File 'lib/liquid/standardfilters.rb', line 109

def remove_first(input, string)
  input.to_s.sub(string, '')      
end

#replace(input, string, replacement = '') ⇒ Object

Replace occurrences of a string with another



94
95
96
 
# File 'lib/liquid/standardfilters.rb', line 94

def replace(input, string, replacement = '')
  input.to_s.gsub(string, replacement)
end

#replace_first(input, string, replacement = '') ⇒ Object

Replace the first occurrences of a string with another



99
100
101
 
# File 'lib/liquid/standardfilters.rb', line 99

def replace_first(input, string, replacement = '')
  input.to_s.sub(string, replacement)
end

#size(input) ⇒ Object

Return the size of an array or of an string



13
14
15
16
 
# File 'lib/liquid/standardfilters.rb', line 13

def size(input)
  
  input.respond_to?(:size) ? input.size : 0
end

#sort(input, property = nil) ⇒ Object

Sort elements of the array provide optional property with which to sort an array of hashes or drops



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/liquid/standardfilters.rb', line 72

def sort(input, property = nil)
  ary = [input].flatten
  if property.nil?
    ary.sort
  elsif ary.first.respond_to?('[]') and !ary.first[property].nil?
    ary.sort {|a,b| a[property] <=> b[property] }
  elsif ary.first.respond_to?(property)
    ary.sort {|a,b| a.send(property) <=> b.send(property) }
  end
end

#strip_html(input) ⇒ Object 



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

def strip_html(input)
  input.to_s.gsub(/<.*?>/, '')
end

#strip_newlines(input) ⇒ Object

Remove all newlines from the string



60
61
62
 
# File 'lib/liquid/standardfilters.rb', line 60

def strip_newlines(input)        
  input.to_s.gsub(/\n/, '')      
end

#times(input, operand) ⇒ Object

multiplication



202
203
204
 
# File 'lib/liquid/standardfilters.rb', line 202

def times(input, operand)
  input * operand if input.respond_to?('*')
end

#truncate(input, length = 50, truncate_string = "...") ⇒ Object

Truncate a string down to x characters



40
41
42
43
44
45
 
# File 'lib/liquid/standardfilters.rb', line 40

def truncate(input, length = 50, truncate_string = "...")
  if input.nil? then return end
  l = length.to_i - truncate_string.length
  l = 0 if l < 0
  input.length > length.to_i ? input[0...l] + truncate_string : input
end

#truncatewords(input, words = 15, truncate_string = "...") ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/liquid/standardfilters.rb', line 47

def truncatewords(input, words = 15, truncate_string = "...")
  if input.nil? then return end
  wordlist = input.to_s.split
  l = words.to_i - 1
  l = 0 if l < 0
  wordlist.length > l ? wordlist[0..l].join(" ") + truncate_string : input 
end

#upcase(input) ⇒ Object

convert a input string to UPCASE



24
25
26
 
# File 'lib/liquid/standardfilters.rb', line 24

def upcase(input)
  input.to_s.upcase
end