module Liquid::StandardFilters

Constants

HTML_ESCAPE
HTML_ESCAPE_ONCE_REGEXP

Public Instance Methods

append(input, string) click to toggle source

add one string to another

# File lib/liquid/standardfilters.rb, line 176
def append(input, string)
  input.to_s + string.to_s
end
capitalize(input) click to toggle source

capitalize words in the input centence

# File lib/liquid/standardfilters.rb, line 32
def capitalize(input)
  input.to_s.capitalize
end
ceil(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 278
def ceil(input)
  to_number(input).ceil.to_i
end
date(input, format) click to toggle source

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
# File lib/liquid/standardfilters.rb, line 221
def date(input, format)
  return input if format.to_s.empty?

  return input unless date = to_date(input)

  date.strftime(format.to_s)
end
default(input, default_value = "".freeze) click to toggle source
# File lib/liquid/standardfilters.rb, line 286
def default(input, default_value = "".freeze)
  is_blank = input.respond_to?(:empty?) ? input.empty? : !input
  is_blank ? default_value : input
end
divided_by(input, operand) click to toggle source

division

# File lib/liquid/standardfilters.rb, line 263
def divided_by(input, operand)
  apply_operation(input, operand, :/)
end
downcase(input) click to toggle source

convert an input string to DOWNCASE

# File lib/liquid/standardfilters.rb, line 22
def downcase(input)
  input.to_s.downcase
end
escape(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 36
def escape(input)
  CGI.escapeHTML(input).untaint rescue input
end
Also aliased as: h
escape_once(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 41
def escape_once(input)
  input.to_s.gsub(HTML_ESCAPE_ONCE_REGEXP, HTML_ESCAPE)
end
first(array) click to toggle source

Get the first element of the passed in array

Example:

{{ product.images | first | to_img }}
# File lib/liquid/standardfilters.rb, line 234
def first(array)
  array.first if array.respond_to?(:first)
end
floor(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 282
def floor(input)
  to_number(input).floor.to_i
end
h(input)
Alias for: escape
join(input, glue = ' '.freeze) click to toggle source

Join elements of the array with certain character between them

# File lib/liquid/standardfilters.rb, line 108
def join(input, glue = ' '.freeze)
  InputIterator.new(input).join(glue)
end
last(array) click to toggle source

Get the last element of the passed in array

Example:

{{ product.images | last | to_img }}
# File lib/liquid/standardfilters.rb, line 243
def last(array)
  array.last if array.respond_to?(:last)
end
lstrip(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 89
def lstrip(input)
  input.to_s.lstrip
end
map(input, property) click to toggle source

map/collect on a given property

# File lib/liquid/standardfilters.rb, line 143
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?(:[])
      e[property]
    end
  end
end
minus(input, operand) click to toggle source

subtraction

# File lib/liquid/standardfilters.rb, line 253
def minus(input, operand)
  apply_operation(input, operand, :-)
end
modulo(input, operand) click to toggle source
# File lib/liquid/standardfilters.rb, line 267
def modulo(input, operand)
  apply_operation(input, operand, :%)
end
newline_to_br(input) click to toggle source

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

# File lib/liquid/standardfilters.rb, line 186
def newline_to_br(input)
  input.to_s.gsub(/\n/, "<br />\n".freeze)
end
plus(input, operand) click to toggle source

addition

# File lib/liquid/standardfilters.rb, line 248
def plus(input, operand)
  apply_operation(input, operand, :+)
end
prepend(input, string) click to toggle source

prepend a string to another

# File lib/liquid/standardfilters.rb, line 181
def prepend(input, string)
  string.to_s + input.to_s
end
remove(input, string) click to toggle source

remove a substring

# File lib/liquid/standardfilters.rb, line 166
def remove(input, string)
  input.to_s.gsub(string, ''.freeze)
end
remove_first(input, string) click to toggle source

remove the first occurrences of a substring

# File lib/liquid/standardfilters.rb, line 171
def remove_first(input, string)
  input.to_s.sub(string, ''.freeze)
end
replace(input, string, replacement = ''.freeze) click to toggle source

Replace occurrences of a string with another

# File lib/liquid/standardfilters.rb, line 156
def replace(input, string, replacement = ''.freeze)
  input.to_s.gsub(string, replacement.to_s)
end
replace_first(input, string, replacement = ''.freeze) click to toggle source

Replace the first occurrences of a string with another

# File lib/liquid/standardfilters.rb, line 161
def replace_first(input, string, replacement = ''.freeze)
  input.to_s.sub(string, replacement.to_s)
end
reverse(input) click to toggle source

Reverse the elements of an array

# File lib/liquid/standardfilters.rb, line 137
def reverse(input)
  ary = InputIterator.new(input)
  ary.reverse
end
round(input, n = 0) click to toggle source
# File lib/liquid/standardfilters.rb, line 271
def round(input, n = 0)
  result = to_number(input).round(to_number(n))
  result = result.to_f if result.is_a?(BigDecimal)
  result = result.to_i if n == 0
  result
end
rstrip(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 93
def rstrip(input)
  input.to_s.rstrip
end
size(input) click to toggle source

Return the size of an array or of an string

# File lib/liquid/standardfilters.rb, line 17
def size(input)
  input.respond_to?(:size) ? input.size : 0
end
slice(input, offset, length=nil) click to toggle source
# File lib/liquid/standardfilters.rb, line 49
def slice(input, offset, length=nil)
  offset = Integer(offset)
  length = length ? 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) click to toggle source

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

# File lib/liquid/standardfilters.rb, line 114
def sort(input, property = nil)
  ary = InputIterator.new(input)
  if property.nil?
    ary.sort
  elsif ary.first.respond_to?(:[]) && !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
split(input, pattern) click to toggle source

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

Example:

<div class="summary">{{ post | split '//' | first }}</div>
# File lib/liquid/standardfilters.rb, line 81
def split(input, pattern)
  input.to_s.split(pattern)
end
strip(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 85
def strip(input)
  input.to_s.strip
end
strip_html(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 97
def strip_html(input)
  empty = ''.freeze
  input.to_s.gsub(/<script.*?<\/script>/, empty).gsub(/<!--.*?-->/, empty).gsub(/<style.*?<\/style>/, empty).gsub(/<.*?>/, empty)
end
strip_newlines(input) click to toggle source

Remove all newlines from the string

# File lib/liquid/standardfilters.rb, line 103
def strip_newlines(input)
  input.to_s.gsub(/\r?\n/, ''.freeze)
end
times(input, operand) click to toggle source

multiplication

# File lib/liquid/standardfilters.rb, line 258
def times(input, operand)
  apply_operation(input, operand, :*)
end
truncate(input, length = 50, truncate_string = "...".freeze) click to toggle source

Truncate a string down to x characters

# File lib/liquid/standardfilters.rb, line 61
def truncate(input, length = 50, truncate_string = "...".freeze)
  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 = "...".freeze) click to toggle source
# File lib/liquid/standardfilters.rb, line 68
def truncatewords(input, words = 15, truncate_string = "...".freeze)
  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(" ".freeze) + truncate_string : input
end
uniq(input, property = nil) click to toggle source

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

# File lib/liquid/standardfilters.rb, line 127
def uniq(input, property = nil)
  ary = InputIterator.new(input)
  if property.nil?
    input.uniq
  elsif input.first.respond_to?(:[])
    input.uniq{ |a| a[property] }
  end
end
upcase(input) click to toggle source

convert an input string to UPCASE

# File lib/liquid/standardfilters.rb, line 27
def upcase(input)
  input.to_s.upcase
end
url_encode(input) click to toggle source
# File lib/liquid/standardfilters.rb, line 45
def url_encode(input)
  CGI.escape(input) rescue input
end

Private Instance Methods

apply_operation(input, operand, operation) click to toggle source
# File lib/liquid/standardfilters.rb, line 323
def apply_operation(input, operand, operation)
  result = to_number(input).send(operation, to_number(operand))
  result.is_a?(BigDecimal) ? result.to_f : result
end
to_date(obj) click to toggle source
# File lib/liquid/standardfilters.rb, line 306
def to_date(obj)
  return obj if obj.respond_to?(:strftime)

  case obj
  when 'now'.freeze, 'today'.freeze
    Time.now
  when /\A\d+\z/, Integer
    Time.at(obj.to_i)
  when String
    Time.parse(obj)
  else
    nil
  end
rescue ::ArgumentError
  nil
end
to_number(obj) click to toggle source
# File lib/liquid/standardfilters.rb, line 293
def to_number(obj)
  case obj
  when Float
    BigDecimal.new(obj.to_s)
  when Numeric
    obj
  when String
    (obj.strip =~ /\A\d+\.\d+\z/) ? BigDecimal.new(obj) : obj.to_i
  else
    0
  end
end