h32-jekyll-tagging 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04be951779b8a87b8e1d58e4d89b8ad98d07509fbf09e4a848be6d9ddb2ddfd3
+  data.tar.gz: 5ec37ca4d13379de6c598c6cc880cd485e374fb85c6bbad4c59b1d8d0dfff0b8
+SHA512:
+  metadata.gz: b990d2f5a27202214b54f2e37069e25fced40dadb63d92b1e090427fc11d1c7ddec666f3c918ca94cbe715b24ca01c5082b47cb96cdf5292b8b3edacd1382d6b
+  data.tar.gz: 4fecaf176ef06dee66d9e1020774891894732ccc432a8b151e7d2be3caf44af99120b78f1273eeef8f08d99b74f28af8a7366f3c24867a978fcd9169e0a2dd15

data/ChangeLog

@@ -0,0 +1,62 @@
+== 1.1.0 [2017-03-07]
+
+* Added ability to append extra data to all tag pages. (tfe)
+* Provides compatibility to the current jekyll (3.4.1).
+* A few fixes. (felipe)
+* Some documentation improvements. (wsmoak, jonathanpberger)
+* Prooves who is the worst open source maintainer. (pattex ^__^)
+
+== 1.0.1 [2015-06-11]
+
+* Substitution of non ASCII characters and whitespaces, also when 'tag_permalink_style: pretty'.
+
+== 1.0.0 [2015-06-10]
+
+* Generate prettier urls for tag with whitespaces or non ASCII characters. ATTENTION: Your urls may change!
+* Added support for site.config["baseurl"]. (Tsukasa ŌMOTO)
+* Added trailing slashes to permalinks. (Pyry Kontio)
+
+== 0.6.0 [2014-09-03]
+
+* Pretty permalinks for tag pages. (Steve Valaitis)
+* Added support for keywords (allenlsy)
+
+== 0.5.0 [2013-06-06]
+
+* Added rel="tag" to posts' tag links. (Brandon Hicks)
+* Added support for ignored tags. (Zee Spencer)
+
+== 0.4.0 [2012-10-22]
+
+* Heavy refactoring to better support monkey patching.
+* Fixed issue when a number is used as a tag. (Fabrice Rossi)
+
+== 0.3.1 [2012-05-24]
+
+* Added support for Jekyll::Site#add_payload (custom extension).
+
+== 0.3.0 [2012-02-03]
+
+* Feed per tag feature added.
+
+== 0.2.0 [2011-03-10]
+
+* Added support for pretty tag page URLs.
+* Some bugs fixed.
+
+== 0.1.2 [2011-01-31]
+
+* Nothing to do when there are no tags.
+
+== 0.1.1 [2010-11-26]
+
+* Posts on tag pages are now sorted.
+
+== 0.1.0 [2010-10-28]
+
+* Added a <tt>tags</tt> filter.
+* Ease customization by adding additional layers.
+
+== 0.0.1 [2010-10-25]
+
+* Here I am!

data/README.rdoc

@@ -0,0 +1,142 @@
+= jekyll-tagging
+
+By Arne Eilermann <mailto:arne@kleinerdrei.net> and Jens Wille <mailto:jens.wille@uni-koeln.de>
+
+jekyll-tagging is a Jekyll plugin, to add a tag cloud and per tag pages plus feeds to your Jekyll generated Website.
+
+== Tags
+This plugin does not reinvent Jekyll's tagging feature. It just makes it easy to use.
+<https://jekyllrb.com/docs/frontmatter/>
+
+Add space-delimited lowercase tags to FrontMatter, e.g.
+
+  ---
+  author: Willow Rosenberg
+  tags: feminism anti-capitalism witchcraft
+  ---
+
+== Usage
+
+Install it:
+
+  gem install jekyll-tagging
+
+Add this line to your Jekyll project's Gemfile:
+
+  gem 'jekyll-tagging'
+
+Add the following to your <tt>_plugins/ext.rb</tt> file:
+
+  require 'jekyll/tagging'
+
+And in your <tt>_config.yml</tt> you have to define your layout used to generate tag pages like:
+
+  tag_page_layout: tag_page
+  tag_page_dir: tag
+
+This will look for <tt>_layouts/tag_page.html</tt>, and use it to generate tag pages into the <tt>_site/tag</tt> directory.
+
+Now you have a new filter called <tt>tag_cloud</tt> which you can use with the <tt>site</tt> object as argument in your layout to get a cloud of all your site's tags. The tags are linked to their related tag page. Furthermore, you have a <tt>tags</tt> filter which you can feed with a <tt>post</tt> or a <tt>page</tt> object to get a link list of all its tags.
+
+You can optionally define a per tag Atom/RSS feed.  In your <tt>_config.yml</tt> define the following:
+
+  tag_feed_layout: tag_feed
+  tag_feed_dir: tag
+
+(<tt>tag_page_dir</tt> and <tt>tag_feed_dir</tt> can have the same value.)
+
+=== Pretty page links
+
+If your Jekyll <tt>permalink</tt> configuration is set to something other than <tt>:pretty</tt>, and you still want to have pretty tag links define the following in your <tt>_config.yml</tt>:
+
+  tag_permalink_style: pretty
+
+=== Ignoring tags
+
+Sometimes you don't want tag pages generated for certain pages. That's ok! Just add <tt>ignored_tags: [tags,to,ignore]</tt> to your <tt>_config.yml</tt>
+
+=== Extra data on tag pages
+
+You can attach extra data to generated tag pages by specifying <tt>tag_page_data</tt> in <tt>_config.yml</tt> (this also works for <tt>tag_feed_data</tt>). For example, you might want to exclude tag pages from being picked up by `jekyll-sitemap`:
+
+  tag_page_data:
+    sitemap: false
+
+=== Example tag page layout
+
+(Save this to <tt>_layouts/tag_page.html</tt> if using the <tt>_config.yml</tt> snippet above.)
+
+  ---
+  layout: default
+  ---
+  <h2>{{ page.tag }}</h2>
+  <ul>
+  {% for post in page.posts %}
+    <li><a href="{{ post.url }}">{{ post.title }}</a> ({{ post.date | date_to_string }} | Tags: {{ post | tags }})</li>
+  {% endfor %}
+  </ul>
+
+  <div id="tag-cloud">
+    {{ site | tag_cloud }}
+  </div>
+
+
+=== Example layout of an Atom feed
+
+(Save this to <tt>_layouts/tag_feed.xml</tt> if using the <tt>_config.yml</tt> snippet above.)
+
+  ---
+  layout: nil
+  ---
+  <?xml version="1.0" encoding="utf-8"?>
+  <feed xmlns="http://www.w3.org/2005/Atom">
+   <title>Your Title - {{ page.tag }}</title>
+   <link href="http://example.com{{ page.url }}" rel="self"/>
+   <link href="http://example.com/tag/{{ page.tag }}.html"/>
+   <updated>{{ site.time | date_to_xmlschema }}</updated>
+   <id>http://example.com/tag/{{ page.tag }}.html</id>
+   <author>
+     <name>Author Here</name>
+   </author>
+   {% for post in page.posts %}
+   <entry>
+     <title>{{ post.title }}</title>
+     <link href="http://example.com{{ post.url }}"/>
+     <updated>{{ post.date | date_to_xmlschema }}</updated>
+     <id>http://example.com{{ post.id }}</id>
+     <content type="html">{{ post.content | xml_escape }}</content>
+   </entry>
+   {% endfor %}
+  </feed>
+
+== Links
+
+<b></b>
+Documentation:: <http://rubydoc.info/gems/jekyll-tagging/frames>
+Source code:: <http://github.com/pattex/jekyll-tagging>
+RubyGem:: <http://rubygems.org/gems/jekyll-tagging>
+
+== License
+
+=== The MIT License
+
+Copyright (c) 2010-2012 University of Cologne,
+Albertus-Magnus-Platz, 50923 Cologne, Germany
+
+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.

data/Rakefile

@@ -0,0 +1,26 @@
+require File.expand_path(%q{../lib/jekyll/tagging/version}, __FILE__)
+
+begin
+  require 'hen'
+
+  Hen.lay! {{
+    :gem => {
+      :name         => %q{jekyll-tagging},
+      :version      => Jekyll::Tagging::VERSION,
+      :summary      => %q{Jekyll plugin to automatically generate a tag cloud and tag pages.},
+      :authors      => ['Arne Eilermann', 'Jens Wille'],
+      :email        => ['arne@kleinerdrei.net', 'jens.wille@uni-koeln.de'],
+      :license      => %q{MIT},
+      :homepage     => :pattex,
+      :dependencies => %w[nuggets]
+    }
+  }}
+rescue LoadError => err
+  warn "Please install the `hen' gem. (#{err})"
+end
+
+begin
+  require 'jekyll/testtasks/rake'
+rescue LoadError => err
+  warn "Please install the `jekyll-testtasks' gem. (#{err})"
+end

data/lib/jekyll/tagging/version.rb

@@ -0,0 +1,31 @@
+module Jekyll
+
+  module Tagging
+
+    module Version
+
+      MAJOR = 1
+      MINOR = 1
+      TINY  = 0
+
+      class << self
+
+        # Returns array representation.
+        def to_a
+          [MAJOR, MINOR, TINY]
+        end
+
+        # Short-cut for version string.
+        def to_s
+          to_a.join('.')
+        end
+
+      end
+
+    end
+
+    VERSION = Version.to_s
+
+  end
+
+end

data/lib/jekyll/tagging.rb

@@ -0,0 +1,161 @@
+require 'nuggets/range/quantile'
+require 'nuggets/i18n'
+require 'erb'
+require "jekyll"
+
+module Jekyll
+
+  module Helpers
+
+    # call-seq:
+    #   jekyll_tagging_slug(str) => new_str
+    #
+    # Substitutes any diacritics in _str_ with their ASCII equivalents,
+    # whitespaces with dashes and converts _str_ to downcase.
+    def jekyll_tagging_slug(str)
+      # str.to_s.replace_diacritics.downcase.gsub(/\s/, '-')
+      Jekyll::Utils.slugify(str, mode:"latin")
+    end
+
+  end
+
+  class Tagger < Generator
+
+    include Helpers
+
+    safe true
+
+    attr_accessor :site
+
+    @types = [:page, :feed]
+
+    class << self; attr_accessor :types, :site; end
+
+    def generate(site)
+      self.class.site = self.site = site
+
+      generate_tag_pages
+      add_tag_cloud
+    end
+
+    private
+
+    # Generates a page per tag and adds them to all the pages of +site+.
+    # A <tt>tag_page_layout</tt> have to be defined in your <tt>_config.yml</tt>
+    # to use this.
+    def generate_tag_pages
+      active_tags.each { |tag, posts| new_tag(tag, posts) }
+    end
+
+    def new_tag(tag, posts)
+      self.class.types.each { |type|
+        if layout = site.config["tag_#{type}_layout"]
+          data = { 'layout' => layout, 'posts' => posts.sort.reverse!, 'tag' => tag }
+          data.merge!(site.config["tag_#{type}_data"] || {})
+
+          name = yield data if block_given?
+          name ||= tag
+          name = jekyll_tagging_slug(name)
+
+          tag_dir = site.config["tag_#{type}_dir"]
+          tag_dir = File.join(tag_dir, (pretty? ? name : ''))
+
+          page_name = "#{pretty? ? 'index' : name}#{site.layouts[data['layout']].ext}"
+
+          site.pages << TagPage.new(
+            site, site.source, tag_dir, page_name, data
+          )
+        end
+      }
+    end
+
+    def add_tag_cloud(num = 5, name = 'tag_data')
+      s, t = site, { name => calculate_tag_cloud(num) }
+      s.respond_to?(:add_payload) ? s.add_payload(t) : s.config.update(t)
+    end
+
+    # Calculates the css class of every tag for a tag cloud. The possible
+    # classes are: set-1..set-5.
+    #
+    # [[<TAG>, <CLASS>], ...]
+    def calculate_tag_cloud(num = 5)
+      range = 0
+
+      tags = active_tags.map { |tag, posts|
+        [tag.to_s, range < (size = posts.size) ? range = size : size]
+      }
+
+
+      range = 1..range
+
+      tags.sort!.map! { |tag, size| [tag, range.quantile(size, num)] }
+    end
+
+    def active_tags
+      return site.tags unless site.config["ignored_tags"]
+      site.tags.reject { |t| site.config["ignored_tags"].include? t[0] }
+    end
+
+    def pretty?
+      @pretty ||= (site.permalink_style == :pretty || site.config['tag_permalink_style'] == 'pretty')
+    end
+
+  end
+
+  class TagPage < Page
+
+    def initialize(site, base, dir, name, data = {})
+      self.content = data.delete('content') || ''
+      self.data    = data
+
+      super(site, base, dir[-1, 1] == '/' ? dir : '/' + dir, name)
+    end
+
+    def read_yaml(*)
+      # Do nothing
+    end
+
+  end
+
+  module TaggingFilters
+
+    include Helpers
+
+    def tag_cloud(site)
+      active_tag_data.map { |tag, set|
+        tag_link(tag, tag_url(tag), :class => "set-#{set}")
+      }.join(' ')
+    end
+
+    def tag_link(tag, url = tag_url(tag), html_opts = nil)
+      html_opts &&= ' ' << html_opts.map { |k, v| %Q{#{k}="#{v}"} }.join(' ')
+      %Q{<a href="#{url}"#{html_opts}>#{tag}</a>}
+    end
+
+    def tag_url(tag, type = :page, site = Tagger.site)
+      url = File.join('', site.config["baseurl"].to_s, site.config["tag_#{type}_dir"], ERB::Util.u(jekyll_tagging_slug(tag)))
+      site.permalink_style == :pretty || site.config['tag_permalink_style'] == 'pretty' ? url << '/' : url << '.html'
+    end
+
+    def tags(obj)
+      tags = obj['tags'].dup
+      tags.map! { |t| t.first } if tags.first.is_a?(Array)
+      tags.map! { |t| tag_link(t, tag_url(t), :rel => 'tag') if t.is_a?(String) }.compact!
+      tags.join(', ')
+    end
+
+    def keywords(obj)
+      return '' if not obj['tags']
+      tags = obj['tags'].dup
+      tags.join(',')
+    end
+
+    def active_tag_data(site = Tagger.site)
+      return site.config['tag_data'] unless site.config["ignored_tags"]
+      site.config["tag_data"].reject { |tag, set| site.config["ignored_tags"].include? tag }
+    end
+  end
+
+end
+
+Liquid::Template.register_filter(Jekyll::TaggingFilters)

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: h32-jekyll-tagging
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Arne Eilermann
+- Jens Wille
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nuggets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Jekyll plugin to automatically generate a tag cloud and tag pages.
+email:
+- arne@kleinerdrei.net
+- jens.wille@uni-koeln.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog
+files:
+- ChangeLog
+- README.rdoc
+- Rakefile
+- lib/jekyll/tagging.rb
+- lib/jekyll/tagging/version.rb
+homepage: http://github.com/pattex/jekyll-tagging
+licenses:
+- MIT
+metadata: {}
+post_install_message: |2+
+
+  jekyll-tagging-1.1.0 [2017-03-07]:
+
+  * Added ability to append extra data to all tag pages. (tfe)
+  * Provides compatibility to the current jekyll (3.4.1).
+  * A few fixes. (felipe)
+  * Some documentation improvements. (wsmoak, jonathanpberger)
+  * Prooves who is the worst open source maintainer. (pattex ^__^)
+
+rdoc_options:
+- "--title"
+- jekyll-tagging Application documentation (v1.1.0)
+- "--charset"
+- UTF-8
+- "--line-numbers"
+- "--all"
+- "--main"
+- ChangeLog
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin to automatically generate a tag cloud and tag pages.
+test_files: []