module Bunto::Filters
Public Instance Methods
Join an array of things into a string by separating with commas and the word “and” for the last one.
array - The Array of Strings to join. connector - Word used to connect the last 2 items in the array
Examples
array_to_sentence_string(["apples", "oranges", "grapes"]) # => "apples, oranges, and grapes"
Returns the formatted String.
# File lib/bunto/filters.rb, line 188 def array_to_sentence_string(array, connector = "and") case array.length when 0 "" when 1 array[0].to_s when 2 "#{array[0]} #{connector} #{array[1]}" else "#{array[0...-1].join(", ")}, #{connector} #{array[-1]}" end end
CGI escape a string for use in a URL
. Replaces any special characters with appropriate %XX replacements.
input - The String to escape.
Examples
cgi_escape('foo,bar;baz?') # => "foo%2Cbar%3Bbaz%3F"
Returns the escaped String.
# File lib/bunto/filters.rb, line 140 def cgi_escape(input) CGI.escape(input) end
Format a date in long format e.g. “27 January 2011”.
date - The Time to format.
Returns the formatted String.
# File lib/bunto/filters.rb, line 82 def date_to_long_string(date) time(date).strftime("%d %B %Y") end
Format a date according to RFC-822
date - The Time to format.
Examples
date_to_rfc822(Time.now) # => "Sun, 24 Apr 2011 12:34:46 +0000"
Returns the formatted String.
# File lib/bunto/filters.rb, line 110 def date_to_rfc822(date) time(date).rfc822 end
Format a date in short format e.g. “27 Jan 2011”.
date - the Time to format.
Returns the formatting String.
# File lib/bunto/filters.rb, line 73 def date_to_string(date) time(date).strftime("%d %b %Y") end
Format a date for use in XML.
date - The Time to format.
Examples
date_to_xmlschema(Time.now) # => "2011-04-24T20:34:46+08:00"
Returns the formatted String.
# File lib/bunto/filters.rb, line 96 def date_to_xmlschema(date) time(date).xmlschema end
Convert an object into its String representation for debugging
input - The Object
to be converted
Returns a String representation of the object.
# File lib/bunto/filters.rb, line 326 def inspect(input) xml_escape(input.inspect) end
Convert the input into json string
input - The Array or Hash to be converted
Returns the converted json string
# File lib/bunto/filters.rb, line 206 def jsonify(input) as_liquid(input).to_json end
Convert a Markdown string into HTML output.
input - The Markdown String to convert.
Returns the HTML formatted String.
# File lib/bunto/filters.rb, line 18 def markdownify(input) site = @context.registers[:site] converter = site.find_converter_instance(Bunto::Converters::Markdown) converter.convert(input.to_s) end
Replace any whitespace in the input string with a single space
input - The String on which to operate.
Returns the formatted String
# File lib/bunto/filters.rb, line 163 def normalize_whitespace(input) input.to_s.gsub(%r!\s+!, " ").strip end
Count the number of words in the input string.
input - The String on which to operate.
Returns the Integer word count.
# File lib/bunto/filters.rb, line 172 def number_of_words(input) input.split.length end
# File lib/bunto/filters.rb, line 283 def pop(array, input = 1) return array unless array.is_a?(Array) new_ary = array.dup new_ary.pop(input.to_i || 1) new_ary end
# File lib/bunto/filters.rb, line 290 def push(array, input) return array unless array.is_a?(Array) new_ary = array.dup new_ary.push(input) new_ary end
# File lib/bunto/filters.rb, line 311 def sample(input, num = 1) return input unless input.respond_to?(:sample) n = num.to_i rescue 1 if n == 1 input.sample else input.sample(n) end end
Convert a Sass string into CSS output.
input - The Sass String to convert.
Returns the CSS formatted String.
# File lib/bunto/filters.rb, line 40 def sassify(input) site = @context.registers[:site] converter = site.find_converter_instance(Bunto::Converters::Sass) converter.convert(input) end
Convert a Scss string into CSS output.
input - The Scss String to convert.
Returns the CSS formatted String.
# File lib/bunto/filters.rb, line 51 def scssify(input) site = @context.registers[:site] converter = site.find_converter_instance(Bunto::Converters::Scss) converter.convert(input) end
# File lib/bunto/filters.rb, line 297 def shift(array, input = 1) return array unless array.is_a?(Array) new_ary = array.dup new_ary.shift(input.to_i || 1) new_ary end
Slugify a filename or title.
input - The filename or title to slugify. mode - how string is slugified
Returns the given filename or title as a lowercase URL
String. See Utils.slugify
for more detail.
# File lib/bunto/filters.rb, line 64 def slugify(input, mode = nil) Utils.slugify(input, :mode => mode) end
Convert quotes into smart quotes.
input - The String to convert.
Returns the smart-quotified String.
# File lib/bunto/filters.rb, line 29 def smartify(input) site = @context.registers[:site] converter = site.find_converter_instance(Bunto::Converters::SmartyPants) converter.convert(input.to_s) end
Sort an array of objects
input - the object array property - property within each object to filter by nils ('first' | 'last') - nils appear before or after non-nil values
Returns the filtered array of objects
# File lib/bunto/filters.rb, line 263 def sort(input, property = nil, nils = "first") if input.nil? raise ArgumentError, "Cannot sort a null object." end if property.nil? input.sort else if nils == "first" order = - 1 elsif nils == "last" order = + 1 else raise ArgumentError, "Invalid nils order: " \ "'#{nils}' is not a valid nils order. It must be 'first' or 'last'." end sort_input(input, property, order) end end
Convert the input into integer
input - the object string
Returns the integer value
# File lib/bunto/filters.rb, line 250 def to_integer(input) return 1 if input == true return 0 if input == false input.to_i end
# File lib/bunto/filters.rb, line 304 def unshift(array, input) return array unless array.is_a?(Array) new_ary = array.dup new_ary.unshift(input) new_ary end
URI escape a string.
input - The String to escape.
Examples
uri_escape('foo, bar \\baz?') # => "foo,%20bar%20%5Cbaz?"
Returns the escaped String.
# File lib/bunto/filters.rb, line 154 def uri_escape(input) Addressable::URI.normalize_component(input) end
Filter an array of objects
input - the object array property - property within each object to filter by value - desired value
Returns the filtered array of objects
# File lib/bunto/filters.rb, line 217 def where(input, property, value) return input unless input.respond_to?(:select) input = input.values if input.is_a?(Hash) input.select do |object| Array(item_property(object, property)).map(&:to_s).include?(value.to_s) end || [] end
Filters
an array of objects against an expression
input - the object array variable - the variable to assign each item to in the expression expression - a Liquid comparison expression passed in as a string
Returns the filtered array of objects
# File lib/bunto/filters.rb, line 232 def where_exp(input, variable, expression) return input unless input.respond_to?(:select) input = input.values if input.is_a?(Hash) # FIXME condition = parse_condition(expression) @context.stack do input.select do |object| @context[variable] = object condition.evaluate(@context) end end || [] end
XML escape a string for use. Replaces any special characters with appropriate HTML entity replacements.
input - The String to escape.
Examples
xml_escape('foo "bar" <baz>') # => "foo "bar" <baz>"
Returns the escaped String.
# File lib/bunto/filters.rb, line 125 def xml_escape(input) input.to_s.encode(:xml => :attr).gsub(%r!\A"|"\Z!, "") end
Private Instance Methods
# File lib/bunto/filters.rb, line 375 def as_liquid(item) case item when Hash pairs = item.map { |k, v| as_liquid([k, v]) } Hash[pairs] when Array item.map { |i| as_liquid(i) } else if item.respond_to?(:to_liquid) liquidated = item.to_liquid # prevent infinite recursion for simple types (which return `self`) if liquidated == item item else as_liquid(liquidated) end else item end end end
# File lib/bunto/filters.rb, line 364 def item_property(item, property) if item.respond_to?(:to_liquid) item.to_liquid[property.to_s] elsif item.respond_to?(:data) item.data[property.to_s] else item[property.to_s] end end
Parse a string to a Liquid Condition
# File lib/bunto/filters.rb, line 399 def parse_condition(exp) parser = Liquid::Parser.new(exp) left_expr = parser.expression operator = parser.consume?(:comparison) condition = if operator Liquid::Condition.new(left_expr, operator, parser.expression) else Liquid::Condition.new(left_expr) end parser.consume(:end_of_string) condition end
# File lib/bunto/filters.rb, line 331 def sort_input(input, property, order) input.sort do |apple, orange| apple_property = item_property(apple, property) orange_property = item_property(orange, property) if !apple_property.nil? && orange_property.nil? - order elsif apple_property.nil? && !orange_property.nil? + order else apple_property <=> orange_property end end end
# File lib/bunto/filters.rb, line 347 def time(input) case input when Time input.clone when Date input.to_time when String Time.parse(input) rescue Time.at(input.to_i) when Numeric Time.at(input) else raise Errors::InvalidDateError, "Invalid Date: '#{input.inspect}' is not a valid datetime." end.localtime end