jekyll-tagging 0.0.1

data/ChangeLog

@@ -0,0 +1,3 @@
+== 0.0.1 [2010-10-25]
+
+* Here I am!

data/README.rdoc

@@ -0,0 +1,69 @@
+= jekyll-tagging
+
+By Arne Eilermann <mailto:eilermann@lavabit.com> and Jens Wille <mailto:jens.wille@uni-koeln.de>
+
+jekyll-tagging is a Jekyll plugin, to add a tag cloud and per tag pages to your Jekyll generated Website.
+
+== Usage
+
+Install it:
+
+  sudo gem install 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
+
+Now you got 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.
+
+=== Example tag page layout
+
+  ---
+  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 }})</li>
+  {% endfor %}
+  </ul>
+
+  <div id="tag-cloud">
+    {{ site | tag_cloud }}
+  </div>
+
+== Links
+
+<b></b>
+Documentation:: <http://rdoc.info/github/pattex/jekyll-tagging>
+Source code:: <http://github.com/pattex/jekyll-tagging>
+RubyGem:: <http://rubygems.org/gems/jekyll-tagging>
+
+== License
+
+=== The MIT License
+
+Copyright (c) 2010 Arne Eilermann
+
+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,29 @@
+require %q{lib/jekyll/tagging/version}
+
+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.},
+      :files        => FileList['lib/**/*.rb'].to_a,
+      :extra_files  => FileList['[A-Z]*'].to_a,
+      :dependencies => %w[ruby-nuggets],
+      :authors      => ['Arne Eilermann', 'Jens Wille'],
+      :email        => ['eilermann@lavabit.com', 'jens.wille@uni-koeln.de'],
+      :homepage     => %q{http://github.com/pattex/jekyll-tagging}
+    }
+  }}
+rescue LoadError
+  warn "Please install the `hen' gem."
+end
+
+### Place your custom Rake tasks here.
+
+begin
+  require 'jekyll/testtasks/rake'
+rescue LoadError
+  warn "Please install the `jekyll-testtasks' gem."
+end

data/lib/jekyll/tagging.rb

@@ -0,0 +1,82 @@
+require 'nuggets/range/quantile_mixin'
+require 'erb'
+
+class Range
+  include Nuggets::Range::QuantileMixin
+end
+
+module Jekyll
+
+  class Tagger < Generator
+
+    safe true
+
+    def generate(site)
+      @tag_page_dir    = site.config['tag_page_dir'] || 'tag'
+      @tag_page_layout = site.config['tag_page_layout']
+
+      generate_tag_pages(site) if @tag_page_layout
+      site.config.update({ 'tag_data' => calculate_tag_cloud(site) })
+    end
+
+    # 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(site)
+      site.tags.each { |t|
+        site.pages << new_tag_page(site, site.source, @tag_page_dir, t[0], t[1])
+      }
+    end
+
+    def new_tag_page(site, base, dir, tag, posts)
+      TagPage.new(site, base, dir, "#{tag}.html", {
+        'layout' => @tag_page_layout,
+        'posts'  => posts,
+      })
+    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(site)
+      tag_data = []
+      max   = site.tags.map { |t| t[1].size }.max
+      site.tags.sort.each { |t|
+        quant = (1..max).quantile(t[1].size, 5)
+        tag_data << [t[0], "set-#{quant}"]
+      }
+      tag_data
+    end
+
+  end
+
+  class TagPage < Page
+    def initialize(site, base, dir, name, data = {})
+      self.content = data.delete('content') || ''
+      self.data    = data
+
+      dir = dir[-1, 1] == '/' ? dir : '/' + dir
+
+      super(site, base, dir, name)
+
+      self.data['tag'] = basename
+    end
+
+    def read_yaml(_, __)
+      # Do nothing
+    end
+
+  end
+
+  module Filters
+
+    def tag_cloud(site)
+      site['tag_data'].collect { |t|
+        "<a href=\"/#{site['tag_page_dir']}/#{ERB::Util.u(t[0])}.html\" class=\"#{t[1]}\">#{t[0]}</a>"
+      }.join(' ')
+    end
+
+  end
+
+end

data/lib/jekyll/tagging/version.rb

@@ -0,0 +1,31 @@
+module Jekyll
+
+  module Tagging
+
+    module Version
+
+      MAJOR = 0
+      MINOR = 0
+      TINY  = 1
+
+      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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: jekyll-tagging
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Arne Eilermann
+- Jens Wille
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-nuggets
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Jekyll plugin to automatically generate a tag cloud and tag pages.
+email: 
+- eilermann@lavabit.com
+- jens.wille@uni-koeln.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog
+- README.rdoc
+files: 
+- lib/jekyll/tagging/version.rb
+- lib/jekyll/tagging.rb
+- Rakefile
+- README.rdoc
+- ChangeLog
+has_rdoc: true
+homepage: http://github.com/pattex/jekyll-tagging
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --charset
+- UTF-8
+- --title
+- jekyll-tagging Application documentation
+- --all
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Jekyll plugin to automatically generate a tag cloud and tag pages.
+test_files: []
+