Last active
January 29, 2023 15:38
-
-
Save delputnam/6580c5c8139f686f63cc to your computer and use it in GitHub Desktop.
This is a liquid filter for Jekyll that will sort collections based on arbitrary yaml front matter variables.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# collections_sort.rb | |
# | |
# Sort Jekyll collections items based on arbitrary yaml front matter variables. | |
# | |
# example usage: | |
# | |
# if you want to sort a collection based on a yaml variable of "order": | |
# | |
# {% assign filtered_events = site.my_collection | collection_sort: 'order' %} | |
# | |
# | |
# 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 collection items | |
module Jekyll | |
module CollectionSort | |
def collection_sort(input, property, nils = "first") | |
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 { |apple, orange| | |
apple_property = apple.data[property] #item_property(apple, property) | |
orange_property = orange.data[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 | |
Liquid::Template.register_filter(Jekyll::CollectionSort) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment