jekyll-eztags 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39cb3659d2375f563dd238431829c19c588cbc0b
+  data.tar.gz: 42f8a6a40f5c6822553a3921c97c8ce54cd6804b
+SHA512:
+  metadata.gz: a5ef5310789c9fdcda23396f8f15aa8f70bd545e06da9e8dfdca0d948920d19145b4e12aac15a6dea38a17e001055dcbb2595cb7ab6ed0189e08f39a57a2c207
+  data.tar.gz: f93e3df990dee6a135eca60d23bfa69432b5fab22fa133172163b14c52f7264259e90a3d84427d610728cdd46fb739c6978be1e32416ad3c33681ca67ebb9aaa

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jerzy J. Gangi
+
+MIT License
+
+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/README.md

@@ -0,0 +1,140 @@
+# Jekyll::Eztags
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jekyll-eztags'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-eztags
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/jekyll-eztags/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+
+= jekyll-eztagging
+
+By Jerzy J. Gangi <mailto:eilermann@lavabit.com>, based on the Jekyll-Tagging gem by Arne Eilermann and Jens Wille
+
+jekyll-eztagging is a Jekyll plugin, to add a tag cloud and per tag pages plus feeds to your Jekyll generated Website.
+
+== Usage
+
+Install it:
+
+  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. Furthermore, you got a <tt>tags</tt> filter which you can feed withe a <tt>post</tt> or a <tt>site</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.)
+
+
+=== 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>
+=== 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 }} | Tags: {{ post | tags }})</li>
+  {% endfor %}
+  </ul>
+
+  <div id="tag-cloud">
+    {{ site | tag_cloud }}
+  </div>
+
+
+=== Example layout of an Atom feed
+
+  ---
+  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,27 @@
+require "bundler/gem_tasks"
+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        => ['eilermann@lavabit.com', 'jens.wille@uni-koeln.de'],
+      :license      => %q{MIT},
+      :homepage     => :pattex,
+      :dependencies => %w[ruby-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/eztags/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Eztags
+    VERSION = "0.0.1"
+  end
+end

data/lib/jekyll/eztags.rb

@@ -0,0 +1,126 @@
+require 'nuggets/range/quantile'
+require 'erb'
+require "jekyll/eztags/version"
+
+module Jekyll
+  module Eztags
+    # Your code goes here...
+  end
+  class Tagger < Generator
+
+    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! }
+
+          name = yield data if block_given?
+
+          site.pages << TagPage.new(
+            site, site.source, site.config["tag_#{type}_dir"],
+            "#{name || tag}#{site.layouts[data['layout']].ext}", 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
+
+  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)
+
+      data['tag'] ||= basename
+    end
+
+    def read_yaml(*)
+      # Do nothing
+    end
+
+  end
+
+  module Filters
+
+    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["tag_#{type}_dir"], ERB::Util.u(tag))
+      site.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 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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-eztags
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jerzy J. Gangi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: ruby-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'
+description: A very simple Jekyll plugin to automatically generate tag pages. No fancy
+  features.
+email:
+- jerzygangi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jekyll/eztags.rb
+- lib/jekyll/eztags/version.rb
+homepage: http://github.com/jerzygangi/jekyll-eztags
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin to automatically generate tag pages
+test_files: []