module Jekyll::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.
Examples
array_to_sentence_string(["apples", "oranges", "grapes"]) # => "apples, oranges, and grapes"
Returns the formatted String.
# File lib/jekyll/filters.rb, line 172 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/jekyll/filters.rb, line 134 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/jekyll/filters.rb, line 76 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/jekyll/filters.rb, line 104 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/jekyll/filters.rb, line 67 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/jekyll/filters.rb, line 90 def date_to_xmlschema(date) time(date).xmlschema end
Group an array of items by a property
input - the inputted Enumerable property - the property
Returns an array of Hashes, each looking something like this:
{"name" => "larry" "items" => [...] } # all the items where `property` == "larry"
# File lib/jekyll/filters.rb, line 203 def group_by(input, property) if groupable?(input) input.group_by do |item| item_property(item, property).to_s end.inject([]) do |memo, i| memo << { "name" => i.first, "items" => i.last } end else input end 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/jekyll/filters.rb, line 310 def inspect(input) CGI.escapeHTML(input.inspect) end
Convert the input into json string
input - The Array or Hash to be converted
Returns the converted json string
# File lib/jekyll/filters.rb, line 191 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/jekyll/filters.rb, line 12 def markdownify(input) site = @context.registers[:site] converter = site.find_converter_instance(Jekyll::Converters::Markdown) converter.convert(input) end
Count the number of words in the input string.
input - The String on which to operate.
Returns the Integer word count.
# File lib/jekyll/filters.rb, line 157 def number_of_words(input) input.split.length end
# File lib/jekyll/filters.rb, line 267 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/jekyll/filters.rb, line 274 def push(array, input) return array unless array.is_a?(Array) new_ary = array.dup new_ary.push(input) new_ary end
# File lib/jekyll/filters.rb, line 295 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/jekyll/filters.rb, line 34 def sassify(input) site = @context.registers[:site] converter = site.find_converter_instance(Jekyll::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/jekyll/filters.rb, line 45 def scssify(input) site = @context.registers[:site] converter = site.find_converter_instance(Jekyll::Converters::Scss) converter.convert(input) end
# File lib/jekyll/filters.rb, line 281 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 Jekyll::Utils#slugify for more detail.
# File lib/jekyll/filters.rb, line 58 def slugify(input, mode=nil) Utils.slugify(input, :mode => mode) end
Convert a Markdown string into HTML output.
input - The Markdown String to convert.
Returns the HTML formatted String.
# File lib/jekyll/filters.rb, line 23 def smartify(input) site = @context.registers[:site] converter = site.find_converter_instance(Jekyll::Converters::SmartyPants) converter.convert(input) 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/jekyll/filters.rb, line 235 def sort(input, property = nil, nils = "first") if input.nil? raise ArgumentError.new("Cannot sort a null object.") end if property.nil? input.sort else case when nils == "first" order = - 1 when nils == "last" order = + 1 else raise ArgumentError.new("Invalid nils order: " "'#{nils}' is not a valid nils order. It must be 'first' or 'last'.") end 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 end
# File lib/jekyll/filters.rb, line 288 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/jekyll/filters.rb, line 148 def uri_escape(input) URI.escape(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/jekyll/filters.rb, line 222 def where(input, property, value) return input unless input.is_a?(Enumerable) input = input.values if input.is_a?(Hash) input.select { |object| item_property(object, property).to_s == value.to_s } 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/jekyll/filters.rb, line 119 def xml_escape(input) CGI.escapeHTML(input.to_s) end
Private Instance Methods
# File lib/jekyll/filters.rb, line 345 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/jekyll/filters.rb, line 331 def groupable?(element) element.respond_to?(:group_by) end
# File lib/jekyll/filters.rb, line 335 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
# File lib/jekyll/filters.rb, line 315 def time(input) case input when Time input when Date input.to_time when String Time.parse(input) rescue Time.at(input.to_i) when Numeric Time.at(input) else Jekyll.logger.error "Invalid Date:", "'#{input}' is not a valid datetime." exit(1) end.localtime end