jekyll-categories 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-categories.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/jekyll-categories.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jekyll-categories/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jekyll-categories"
+  s.version     = Jekyll::Categories::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Roger López"]
+  s.email       = ["roger@zroger.com"]
+  s.homepage    = "http://github.com/zroger/jekyll-categories"
+  s.summary     = %q{Category generators for Jekyll}
+  s.description = %q{Provides a category index page, category pages and category atom feeds for Jekyll.}
+
+  s.rubyforge_project = "jekyll-categories"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency('jekyll', [">= 0.10.0"])
+end

data/lib/jekyll-categories.rb

@@ -0,0 +1,121 @@
+module Jekyll
+  module Categories
+    class CategoryIndex < Page
+      def initialize(site, base, dir, category)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'index.html'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'category_index.html')
+        self.data['category'] = category
+
+        category_title_prefix = site.config['category_title_prefix'] || 'Category: '
+        self.data['title'] = "#{category_title_prefix}#{category}"
+      end
+    end
+
+    class CategoryFeed < Page
+      def initialize(site, base, dir, category)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'atom.xml'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'category_feed.xml')
+        self.data['category'] = category
+
+        category_title_prefix = site.config['category_title_prefix'] || 'Category: '
+        self.data['title'] = "#{category_title_prefix}#{category}"
+      end
+    end
+
+    class CategoryList < Page
+      def initialize(site,  base, dir, categories)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'index.html'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'category_list.html')
+        self.data['categories'] = categories
+      end
+    end
+
+    class CategoryGenerator < Generator
+      safe true
+
+      def generate(site)
+        if site.layouts.key? 'category_index'
+          dir = site.config['category_dir'] || 'categories'
+          site.categories.keys.each do |category|
+            write_category_index(site, File.join(dir, category.gsub(/\s/, "-").gsub(/[^\w-]/, '').downcase), category)
+          end
+        end
+
+        if site.layouts.key? 'category_feed'
+          dir = site.config['category_dir'] || 'categories'
+          site.categories.keys.each do |category|
+            write_category_feed(site, File.join(dir, category.gsub(/\s/, "-").gsub(/[^\w-]/, '').downcase), category)
+          end
+        end
+
+        if site.layouts.key? 'category_list'
+          dir = site.config['category_dir'] || 'categories'
+          write_category_list(site, dir, site.categories.keys.sort)
+        end
+      end
+
+      def write_category_index(site, dir, category)
+        index = CategoryIndex.new(site, site.source, dir, category)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+
+      def write_category_feed(site, dir, category)
+        index = CategoryFeed.new(site, site.source, dir, category)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+
+      def write_category_list(site, dir, categories)
+        index = CategoryList.new(site, site.source, dir, categories)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+    end
+
+    # Returns a correctly formatted category url based on site configuration.
+    #
+    # Use without arguments to return the url of the category list page.
+    #    {% category_url %}
+    #
+    # Use with argument to return the url of a specific catogory page.  The
+    # argument can be either a string or a variable in the current context.
+    #    {% category_url category_name %}
+    #    {% category_url category_var %}
+    #
+    class CategoryUrlTag < Liquid::Tag
+      def initialize(tag_name, text, tokens)
+        super
+        @category = text
+      end
+
+      def render(context)
+        base_url = context.registers[:site].config['base-url'] || '/'
+        category_dir = context.registers[:site].config['category_dir'] || 'categories'
+
+        category = context[@category] || @category.strip.tr(' ', '-').downcase
+        category.empty? ? "#{base_url}#{category_dir}" : "#{base_url}#{category_dir}/#{category}"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('category_url', Jekyll::Categories::CategoryUrlTag)

data/lib/jekyll-categories/version.rb

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

data/readme.md

@@ -0,0 +1,37 @@
+Jekyll Categories
+=================
+
+This gem provides a [Jekyll](http://github.com/mojombo/jekyll) generator for
+category pages, category feeds and a category index.
+
+Basic Setup
+-----------
+Install the gem:
+
+	[sudo] gem install jekyll-categories
+
+In a plugin file within your Jekyll project's _plugins directory:
+
+	# _plugins/my-plugin.rb
+	require "jekyll-categories"
+
+Create the following layouts:
+
+- category_index.html
+- category_list.html
+- category_feed.xml
+
+Bundler Setup
+-------------
+Already using bundler to manage gems for your Jekyll project?  Then just add
+
+	gem "jekyll-categories"
+
+to your gemfile and create the following plugin in your projects _plugins 
+directory.  I've called mine bundler.rb.  This will automatically require all 
+of the gems specified in your Gemfile.
+
+	# _plugins/bundler.rb
+	require "rubygems"
+	require "bundler/setup"
+	Bundler.require(:default)

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: jekyll-categories
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Roger L\xC3\xB3pez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jekyll
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :runtime
+  version_requirements: *id001
+description: Provides a category index page, category pages and category atom feeds for Jekyll.
+email: 
+- roger@zroger.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- jekyll-categories.gemspec
+- lib/jekyll-categories.rb
+- lib/jekyll-categories/version.rb
+- readme.md
+has_rdoc: true
+homepage: http://github.com/zroger/jekyll-categories
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: jekyll-categories
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Category generators for Jekyll
+test_files: []
+