Module: Liquid::StandardFilters

Defined in:
lib/liquid/standardfilters.rb

Defined Under Namespace

Classes: InputIterator

Constant Summary collapse

HTML_ESCAPE =
{
  '&'.freeze => '&'.freeze,
  '>'.freeze => '>'.freeze,
  '<'.freeze => '&lt;'.freeze,
  '"'.freeze => '&quot;'.freeze,
  "'".freeze => '&#39;'.freeze
}
HTML_ESCAPE_ONCE_REGEXP =
/["><']|&(?!([a-zA-Z]+|(#\d+));)/

Instance Method Summary collapse

Instance Method Details

#abs(input) ⇒ Object

absolute value



302
303
304
305
# File 'lib/liquid/standardfilters.rb', line 302

def abs(input)
  result = Utils.to_number(input).abs
  result.is_a?(BigDecimal) ? result.to_f : result
end

#append(input, string) ⇒ Object

add one string to another



223
224
225
# File 'lib/liquid/standardfilters.rb', line 223

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

#capitalize(input) ⇒ Object

capitalize words in the input centence



31
32
33
# File 'lib/liquid/standardfilters.rb', line 31

def capitalize(input)
  input.to_s.capitalize
end

#ceil(input) ⇒ Object



344
345
346
347
348
# File 'lib/liquid/standardfilters.rb', line 344

def ceil(input)
  Utils.to_number(input).ceil.to_i
rescue ::FloatDomainError => e
  raise Liquid::FloatDomainError, e.message
end

#compact(input, property = nil) ⇒ Object

Remove nils within an array provide optional property with which to check for nil



190
191
192
193
194
195
196
197
198
199
200
# File 'lib/liquid/standardfilters.rb', line 190

def compact(input, property = nil)
  ary = InputIterator.new(input)

  if property.nil?
    ary.compact
  elsif ary.empty? # The next two cases assume a non-empty array.
    []
  elsif ary.first.respond_to?(:[])
    ary.reject{ |a| a[property].nil? }
  end
end

#concat(input, array) ⇒ Object



227
228
229
230
231
232
# File 'lib/liquid/standardfilters.rb', line 227

def concat(input, array)
  unless array.respond_to?(:to_ary)
    raise ArgumentError.new("concat filter requires an array argument")
  end
  InputIterator.new(input).concat(array)
end

#date(input, format) ⇒ Object

Reformat a date using Ruby's core Time#strftime( string ) -> string

%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 - Number of seconds since 1970-01-01 00:00:00 UTC.
%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

See also: http://www.ruby-doc.org/core/Time.html#method-i-strftime


275
276
277
278
279
280
281
# File 'lib/liquid/standardfilters.rb', line 275

def date(input, format)
  return input if format.to_s.empty?

  return input unless date = Utils.to_date(input)

  date.strftime(format.to_s)
end

#default(input, default_value = ''.freeze) ⇒ Object



356
357
358
359
360
361
362
# File 'lib/liquid/standardfilters.rb', line 356

def default(input, default_value = ''.freeze)
  if !input || input.respond_to?(:empty?) && input.empty?
    default_value
  else
    input
  end
end

#divided_by(input, operand) ⇒ Object

division



323
324
325
326
327
# File 'lib/liquid/standardfilters.rb', line 323

def divided_by(input, operand)
  apply_operation(input, operand, :/)
rescue ::ZeroDivisionError => e
  raise Liquid::ZeroDivisionError, e.message
end

#downcase(input) ⇒ Object

convert an input string to DOWNCASE



21
22
23
# File 'lib/liquid/standardfilters.rb', line 21

def downcase(input)
  input.to_s.downcase
end

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



35
36
37
# File 'lib/liquid/standardfilters.rb', line 35

def escape(input)
  CGI.escapeHTML(input).untaint unless input.nil?
end

#escape_once(input) ⇒ Object



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

def escape_once(input)
  input.to_s.gsub(HTML_ESCAPE_ONCE_REGEXP, HTML_ESCAPE)
end

#first(array) ⇒ Object

Get the first element of the passed in array

Example:

{{ product.images | first | to_img }}


288
289
290
# File 'lib/liquid/standardfilters.rb', line 288

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

#floor(input) ⇒ Object



350
351
352
353
354
# File 'lib/liquid/standardfilters.rb', line 350

def floor(input)
  Utils.to_number(input).floor.to_i
rescue ::FloatDomainError => e
  raise Liquid::FloatDomainError, e.message
end

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

Join elements of the array with certain character between them



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

def join(input, glue = ' '.freeze)
  InputIterator.new(input).join(glue)
end

#last(array) ⇒ Object

Get the last element of the passed in array

Example:

{{ product.images | last | to_img }}


297
298
299
# File 'lib/liquid/standardfilters.rb', line 297

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

#lstrip(input) ⇒ Object



96
97
98
# File 'lib/liquid/standardfilters.rb', line 96

def lstrip(input)
  input.to_s.lstrip
end

#map(input, property) ⇒ Object

map/collect on a given property



175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/liquid/standardfilters.rb', line 175

def map(input, property)
  InputIterator.new(input).map do |e|
    e = e.call if e.is_a?(Proc)

    if property == "to_liquid".freeze
      e
    elsif e.respond_to?(:[])
      r = e[property]
      r.is_a?(Proc) ? r.call : r
    end
  end
end

#minus(input, operand) ⇒ Object

subtraction



313
314
315
# File 'lib/liquid/standardfilters.rb', line 313

def minus(input, operand)
  apply_operation(input, operand, :-)
end

#modulo(input, operand) ⇒ Object



329
330
331
332
333
# File 'lib/liquid/standardfilters.rb', line 329

def modulo(input, operand)
  apply_operation(input, operand, :%)
rescue ::ZeroDivisionError => e
  raise Liquid::ZeroDivisionError, e.message
end

#newline_to_br(input) ⇒ Object

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



240
241
242
# File 'lib/liquid/standardfilters.rb', line 240

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

#plus(input, operand) ⇒ Object

addition



308
309
310
# File 'lib/liquid/standardfilters.rb', line 308

def plus(input, operand)
  apply_operation(input, operand, :+)
end

#prepend(input, string) ⇒ Object

prepend a string to another



235
236
237
# File 'lib/liquid/standardfilters.rb', line 235

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

#remove(input, string) ⇒ Object

remove a substring



213
214
215
# File 'lib/liquid/standardfilters.rb', line 213

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

#remove_first(input, string) ⇒ Object

remove the first occurrences of a substring



218
219
220
# File 'lib/liquid/standardfilters.rb', line 218

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

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

Replace occurrences of a string with another



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

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

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

Replace the first occurrences of a string with another



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

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

#reverse(input) ⇒ Object

Reverse the elements of an array



169
170
171
172
# File 'lib/liquid/standardfilters.rb', line 169

def reverse(input)
  ary = InputIterator.new(input)
  ary.reverse
end

#round(input, n = 0) ⇒ Object



335
336
337
338
339
340
341
342
# File 'lib/liquid/standardfilters.rb', line 335

def round(input, n = 0)
  result = Utils.to_number(input).round(Utils.to_number(n))
  result = result.to_f if result.is_a?(BigDecimal)
  result = result.to_i if n == 0
  result
rescue ::FloatDomainError => e
  raise Liquid::FloatDomainError, e.message
end

#rstrip(input) ⇒ Object



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

def rstrip(input)
  input.to_s.rstrip
end

#size(input) ⇒ Object

Return the size of an array or of an string



16
17
18
# File 'lib/liquid/standardfilters.rb', line 16

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

#slice(input, offset, length = nil) ⇒ Object



52
53
54
55
56
57
58
59
60
61
# File 'lib/liquid/standardfilters.rb', line 52

def slice(input, offset, length = nil)
  offset = Utils.to_integer(offset)
  length = length ? Utils.to_integer(length) : 1

  if input.is_a?(Array)
    input.slice(offset, length) || []
  else
    input.to_s.slice(offset, length) || ''
  end
end

#sort(input, property = nil) ⇒ Object

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/liquid/standardfilters.rb', line 121

def sort(input, property = nil)
  ary = InputIterator.new(input)
  if property.nil?
    ary.sort
  elsif ary.empty? # The next two cases assume a non-empty array.
    []
  elsif ary.first.respond_to?(:[]) && !ary.first[property].nil?
    ary.sort do |a, b|
      a = a[property]
      b = b[property]
      if a && b
        a <=> b
      else
        a ? -1 : 1
      end
    end
  end
end

#sort_natural(input, property = nil) ⇒ Object

Sort elements of an array ignoring case if strings provide optional property with which to sort an array of hashes or drops



142
143
144
145
146
147
148
149
150
151
152
# File 'lib/liquid/standardfilters.rb', line 142

def sort_natural(input, property = nil)
  ary = InputIterator.new(input)

  if property.nil?
    ary.sort { |a, b| a.casecmp(b) }
  elsif ary.empty? # The next two cases assume a non-empty array.
    []
  elsif ary.first.respond_to?(:[]) && !ary.first[property].nil?
    ary.sort { |a, b| a[property].casecmp(b[property]) }
  end
end

#split(input, pattern) ⇒ Object

Split input string into an array of substrings separated by given pattern.

Example:

<div class="summary">{{ post | split '//' | first }}</div>


88
89
90
# File 'lib/liquid/standardfilters.rb', line 88

def split(input, pattern)
  input.to_s.split(pattern.to_s)
end

#strip(input) ⇒ Object



92
93
94
# File 'lib/liquid/standardfilters.rb', line 92

def strip(input)
  input.to_s.strip
end

#strip_html(input) ⇒ Object



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

def strip_html(input)
  empty = ''.freeze
  input.to_s.gsub(/<script.*?<\/script>/m, empty).gsub(/<!--.*?-->/m, empty).gsub(/<style.*?<\/style>/m, empty).gsub(/<.*?>/m, empty)
end

#strip_newlines(input) ⇒ Object

Remove all newlines from the string



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

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

#times(input, operand) ⇒ Object

multiplication



318
319
320
# File 'lib/liquid/standardfilters.rb', line 318

def times(input, operand)
  apply_operation(input, operand, :*)
end

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

Truncate a string down to x characters



64
65
66
67
68
69
70
71
72
# File 'lib/liquid/standardfilters.rb', line 64

def truncate(input, length = 50, truncate_string = "...".freeze)
  return if input.nil?
  input_str = input.to_s
  length = Utils.to_integer(length)
  truncate_string_str = truncate_string.to_s
  l = length - truncate_string_str.length
  l = 0 if l < 0
  input_str.length > length ? input_str[0...l] + truncate_string_str : input_str
end

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



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

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

#uniq(input, property = nil) ⇒ Object

Remove duplicate elements from an array provide optional property with which to determine uniqueness



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

def uniq(input, property = nil)
  ary = InputIterator.new(input)

  if property.nil?
    ary.uniq
  elsif ary.empty? # The next two cases assume a non-empty array.
    []
  elsif ary.first.respond_to?(:[])
    ary.uniq{ |a| a[property] }
  end
end

#upcase(input) ⇒ Object

convert an input string to UPCASE



26
27
28
# File 'lib/liquid/standardfilters.rb', line 26

def upcase(input)
  input.to_s.upcase
end

#url_decode(input) ⇒ Object



48
49
50
# File 'lib/liquid/standardfilters.rb', line 48

def url_decode(input)
  CGI.unescape(input) unless input.nil?
end

#url_encode(input) ⇒ Object



44
45
46
# File 'lib/liquid/standardfilters.rb', line 44

def url_encode(input)
  CGI.escape(input) unless input.nil?
end