From 6239902b3147f1f1825c33d5b8b41c78115bea88 Mon Sep 17 00:00:00 2001 From: Luca Beltrame Date: Sat, 9 May 2015 22:23:38 +0200 Subject: [PATCH] Category archive plugin --- _plugins/category_archive_plugin.rb | 150 ++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 _plugins/category_archive_plugin.rb diff --git a/_plugins/category_archive_plugin.rb b/_plugins/category_archive_plugin.rb new file mode 100644 index 0000000..53bd3c2 --- /dev/null +++ b/_plugins/category_archive_plugin.rb @@ -0,0 +1,150 @@ +# Jekyll Module to create category archive pages +# +# Shigeya Suzuki, November 2013 +# Copyright notice (MIT License) attached at the end of this file +# + +# +# This code is based on the following works: +# https://gist.github.com/ilkka/707909 +# https://gist.github.com/ilkka/707020 +# https://gist.github.com/nlindley/6409459 +# + +# +# Archive will be written as #{archive_path}/#{category_name}/index.html +# archive_path can be configured in 'path' key in 'category_archive' of +# site configuration file. 'path' is default null. +# + +module Jekyll + + module CategoryArchiveUtil + def self.archive_base(site) + site.config['category_archive'] && site.config['category_archive']['path'] || '' + end + end + + # Generator class invoked from Jekyll + class CategoryArchiveGenerator < Generator + def generate(site) + posts_group_by_category(site).each do |category, list| + site.pages << CategoryArchivePage.new(site, CategoryArchiveUtil.archive_base(site), category, list) + end + end + + def posts_group_by_category(site) + category_map = {} + site.posts.each {|p| p.categories.each {|c| (category_map[c] ||= []) << p } } + category_map + end + end + + # Tag for generating a link to a category archive page + class CategoryArchiveLinkTag < Liquid::Block + + def initialize(tag_name, category, tokens) + super + @category = category.split(' ').first || category + end + + def render(context) + # If the category is a variable in the current context, expand it + if context.has_key?(@category) + category = context[@category] + else + category = @category + end + + + if context.registers[:site].config['category_archive'] && context.registers[:site].config['category_archive']['slugify'] + category = Utils.slugify(category) + end + + href = File.join('/', context.registers[:site].baseurl, context.environments.first['site']['category_archive']['path'], + category, 'index.html') + "#{super}" + end + end + + # Actual page instances + class CategoryArchivePage < Page + ATTRIBUTES_FOR_LIQUID = %w[ + category, + content + ] + + def initialize(site, dir, category, posts) + @site = site + @dir = dir + @category = category + + if site.config['category_archive'] && site.config['category_archive']['slugify'] + @category_dir_name = Utils.slugify(@category) # require sanitize here + else + @category_dir_name = @category + end + + @layout = site.config['category_archive'] && site.config['category_archive']['layout'] || 'category_archive' + self.ext = '.html' + self.basename = 'index' + self.content = <<-EOS +{% for post in page.posts %}
  • {{ post.title }}
  • +{% endfor %} + EOS + self.data = { + 'layout' => @layout, + 'type' => 'archive', + 'title' => "Category archive for #{@category}", + 'posts' => posts, + 'url' => File.join('/', + CategoryArchiveUtil.archive_base(site), + @category_dir_name, 'index.html') + } + end + + def render(layouts, site_payload) + payload = { + 'page' => self.to_liquid, + 'paginator' => pager.to_liquid + }.merge(site_payload) + do_layout(payload, layouts) + end + + def to_liquid(attr = nil) + self.data.merge({ + 'content' => self.content, + 'category' => @category + }) + end + + def destination(dest) + File.join('/', dest, @dir, @category_dir_name, 'index.html') + end + + end +end + +Liquid::Template.register_tag('categorylink', Jekyll::CategoryArchiveLinkTag) + +# The MIT License (MIT) +# +# Copyright (c) 2013 Shigeya Suzuki +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE.