octopress 3.0.0.alpha1

data/lib/octopress/filters/post.rb

@@ -0,0 +1,175 @@
+module Jekyll
+
+  # Extended plugin type that allows the plugin
+  # to be called on varous callback methods.
+  #
+  # Examples:
+  # https://github.com/tedkulp/octopress/blob/master/plugins/post_metaweblog.rb
+  class PostFilter < Plugin
+
+    #Called before post is sent to the converter. Allows
+    #you to modify the post object before the converter
+    #does it's thing
+    def pre_render(post)
+    end
+
+    #Called after the post is rendered with the converter.
+    #Use the post object to modify it's contents before the
+    #post is inserted into the template.
+    def post_render(post)
+    end
+
+    #Called after the post is written to the disk.
+    #Use the post object to read it's contents to do something
+    #after the post is safely written.
+    def post_write(post)
+    end
+  end
+
+  # Monkey patch for the Jekyll Site class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/site.rb
+  class Site
+
+    # Instance variable to store the various post_filter
+    # plugins that are loaded.
+    attr_accessor :post_filters
+
+    # Instantiates all of the post_filter plugins. This is basically
+    # a duplication of the other loaders in Site#setup.
+    def load_post_filters
+      self.post_filters = instantiate_subclasses(Jekyll::PostFilter)
+    end
+  end
+
+  # Monkey patch for the Jekyll Post class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/post.rb
+  class Post
+
+    # Copy the #write method to #old_write, so we can redefine #write
+    # method.
+    alias_method :old_write, :write
+
+    # Write the generated post file to the destination directory. It
+    # then calls any post_write methods that may exist.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      old_write(dest)
+      post_write if respond_to?(:post_write)
+    end
+  end
+
+  # Monkey patch for the Jekyll Page class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/page.rb
+  class Page
+
+    # Copy the #write method to #old_write, so we can redefine #write
+    # method.
+    alias_method :old_write, :write
+
+    # Write the generated post file to the destination directory. It
+    # then calls any post_write methods that may exist.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      old_write(dest)
+      post_write if respond_to?(:post_write)
+    end
+  end
+
+  # Monkey patch for the Jekyll Convertible module. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/convertible.rb
+  module Convertible
+
+    def is_post?
+      self.class.to_s == 'Jekyll::Post'
+    end
+
+    def is_page?
+      self.class.to_s == 'Jekyll::Page'
+    end
+
+    def is_convertible_page?
+      self.class.to_s == 'Jekyll::ConvertiblePage'
+    end
+
+    def is_filterable?
+      is_post? or is_page? or is_convertible_page?
+    end
+
+    # Call the #pre_render methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def pre_render
+      self.site.load_post_filters unless self.site.post_filters
+
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.pre_render(self)
+        end
+      end
+    end
+
+    # Call the #post_render methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def post_render
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.post_render(self)
+        end
+      end
+    end
+
+    # Call the #post_write methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def post_write
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.post_write(self)
+        end
+      end
+    end
+
+    # Copy the #transform method to #old_transform, so we can
+    # redefine #transform method.
+    alias_method :old_transform, :transform
+
+    # Transform the contents based on the content type. Then calls the
+    # #post_render method if it exists
+    #
+    # Returns nothing.
+    def transform
+      old_transform
+      post_render if respond_to?(:post_render)
+    end
+
+    # Copy the #do_layout method to #old_do_layout, so we can
+    # redefine #do_layout method.
+    alias_method :old_do_layout, :do_layout
+
+    # Calls the pre_render method if it exists and then adds any necessary
+    # layouts to this convertible document.
+    #
+    # payload - The site payload Hash.
+    # layouts - A Hash of {"name" => "layout"}.
+    #
+    # Returns nothing.
+    def do_layout(payload, layouts)
+      pre_render if respond_to?(:pre_render)
+      old_do_layout(payload, layouts)
+    end
+
+    # Returns the full url of the post, including the
+    # configured url
+    def full_url
+      self.site.config['url'] + self.url
+    end
+  end
+end

data/lib/octopress/filters/url.rb

@@ -0,0 +1,34 @@
+# Liquid filters for Octopress
+
+module Octopress
+  module UrlFilters
+    include UrlHelpers
+    
+    # Replaces relative urls with full urls
+    
+    def expand_urls(input, url='')
+      url ||= '/'
+      input.gsub /(\s+(href|src)\s*=\s*["|']{1})(\/(?!\/)[^\"'>]*)/ do
+        $1+url+$3
+      end
+    end
+
+    # Removes trailing forward slash from a string for easily appending url segments
+
+    def strip_slash(input)
+      input.sub(/\/\s*$/, '')
+    end
+
+    # Returns a url without the protocol (http://)
+
+    def shorthand_url(input)
+      input.gsub /(https?:\/\/)(\S+)/ do
+        $2
+      end
+    end
+
+  end
+end
+
+Liquid::Template.register_filter Octopress::UrlFilters
+

data/lib/octopress/formatters.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__))
+
+module Octopress
+  module Formatters
+    autoload :BaseFormatter,    'formatters/base_formatter'
+    autoload :SimpleFormatter,  'formatters/simple_formatter'
+    autoload :VerboseFormatter, 'formatters/verbose_formatter'
+  end
+end

data/lib/octopress/formatters/base_formatter.rb

@@ -0,0 +1,17 @@
+module Octopress
+  module Formatters
+    class BaseFormatter < Logger::Formatter
+
+      COLORS = {
+        "ERROR" => "red",
+        "WARN"  => "yellow",
+        "INFO"  => "green",
+        "DEBUG" => "white"
+      }
+
+      def call(severity, timestamp, progname, msg)
+        (progname || msg).to_s.send(COLORS[severity]) + "\n"
+      end
+    end
+  end
+end

data/lib/octopress/formatters/simple_formatter.rb

@@ -0,0 +1,9 @@
+module Octopress
+  module Formatters
+    class SimpleFormatter < Logger::Formatter
+      def call(severity, timestamp, progname, msg)
+        "#{msg}\n"
+      end
+    end
+  end
+end

data/lib/octopress/formatters/verbose_formatter.rb

@@ -0,0 +1,9 @@
+module Octopress
+  module Formatters
+    class VerboseFormatter < Logger::Formatter
+      def call(severity, timestamp, progname, msg)
+        "[#{timestamp}] #{severity}: #{msg}\n"
+      end
+    end
+  end
+end

data/lib/octopress/generators/category_generator.rb

@@ -0,0 +1,196 @@
+# encoding: utf-8
+#
+# Jekyll category page generator.
+# http://recursive-design.com/projects/jekyll-plugins/
+#
+# Version: 0.1.4 (201101061053)
+#
+# Copyright (c) 2010 Dave Perrett, http://recursive-design.com/
+# Licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php)
+#
+# A generator that creates category pages for jekyll sites.
+#
+# Included filters :
+# - category_links:      Outputs the list of categories as comma-separated <a> links.
+# - date_to_html_string: Outputs the post.date as formatted html, with hooks for CSS styling.
+#
+# Available _config.yml settings :
+# - category_dir:          The subfolder to build category pages in (default is 'categories').
+# - category_title_prefix: The string used before the category name in the page title (default is
+#                          'Category: ').
+
+require 'stringex'
+
+module Jekyll
+
+  # The CategoryIndex class creates a single category page for the specified category.
+  class CategoryIndex < Page
+
+    # Initializes a new CategoryIndex.
+    #
+    #  +base+         is the String path to the <source>.
+    #  +category_dir+ is the String path between <source> and the category folder.
+    #  +category+     is the category currently being processed.
+    def initialize(site, base, category_dir, category, title)
+      @site = site
+      @base = base
+      @dir  = category_dir
+      @name = 'index.html'
+      self.process(@name)
+      # Read the YAML data from the layout page.
+      return unless self.read_yaml(File.join(base, '_layouts'), 'category-index.html')
+      self.data['category']    = category
+      # Set the title for this page.
+      title_prefix             = site.config['category_title_prefix'] || 'Category: '
+      self.data['title']       = "#{title_prefix}#{title}"
+      # Set the meta-description for this page.
+      meta_description_prefix  = site.config['category_meta_description_prefix'] || 'Category: '
+      self.data['description'] = "#{meta_description_prefix}#{title}"
+    end
+
+  end
+
+  # The CategoryFeed class creates an Atom feed for the specified category.
+  class CategoryFeed < Page
+
+    # Initializes a new CategoryFeed.
+    #
+    #  +base+         is the String path to the <source>.
+    #  +category_dir+ is the String path between <source> and the category folder.
+    #  +category+     is the category currently being processed.
+    def initialize(site, base, category_dir, category, title)
+      @site = site
+      @base = base
+      @dir  = category_dir
+      @name = 'atom.xml'
+      self.process(@name)
+      # Read the YAML data from the layout page.
+      self.read_yaml(File.join(base, '_includes/custom'), 'category-feed.xml')
+      self.data['category']    = category
+      # Set the title for this page.
+      title_prefix             = site.config['category_title_prefix'] || 'Category: '
+      self.data['title']       = "#{title_prefix}#{title}"
+      # Set the meta-description for this page.
+      meta_description_prefix  = site.config['category_meta_description_prefix'] || 'Category: '
+      self.data['description'] = "#{meta_description_prefix}#{title}"
+
+      # Set the correct feed URL.
+      self.data['feed_url'] = "#{category_dir}/#{name}"
+    end
+
+  end
+
+  # The Site class is a built-in Jekyll class with access to global site config information.
+  class Site
+
+    # Creates an instance of CategoryIndex for each category page, renders it, and
+    # writes the output to a file.
+    #
+    #  +category_dir+ is the String path to the category folder.
+    #  +category+     is the category currently being processed.
+    def write_category_index(category_dir, category, title)
+      index = CategoryIndex.new(self, self.source, category_dir, category, title)
+      index.render(self.layouts, site_payload)
+      index.write(self.dest)
+      # Record the fact that this page has been added, otherwise Site::cleanup will remove it.
+      self.pages << index
+
+      # Create an Atom-feed for each index.
+      if self.config['category_feeds']
+        feed = CategoryFeed.new(self, self.source, category_dir, category, title)
+        feed.render(self.layouts, site_payload)
+        feed.write(self.dest)
+        # Record the fact that this page has been added, otherwise Site::cleanup will remove it.
+        self.pages << feed
+      end
+    end
+
+
+    # Loops through the list of category pages and processes each one.
+    def write_category_indexes
+      return unless self.layouts.key? 'category_index'
+      dir = self.config['category_dir']
+      self.categories.keys.each do |category|
+        if category =~ /(.+)\[(.+)\]/
+          slug = $1.strip
+          title = $2.strip
+        else
+          slug = title = category
+        end
+        cat_dir = slug.to_url
+        cat_dir = File.join(dir, cat_dir) unless dir.nil? or dir.empty?
+        self.write_category_index(cat_dir, category, title)
+      end
+    end
+  end
+
+
+  # Jekyll hook - the generate method is called by jekyll, and generates all of the category pages.
+  class GenerateCategories < Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      site.write_category_indexes
+    end
+
+  end
+
+
+  # Adds some extra filters used during the category creation process.
+  module Filters
+
+    # Outputs a list of categories as comma-separated <a> links. This is used
+    # to output the category list for each post on a category page.
+    #
+    #  +categories+ is the list of categories to format.
+    #
+    # Returns string
+    #
+    def category_links(categories)
+      categories = categories.sort!.map { |c| category_link c }
+      case categories.length
+      when 0
+        ""
+      when 1
+        categories[0].to_s
+      else
+        "#{categories[0...-1].join(', ')}, #{categories[-1]}"
+      end
+    end
+
+    # Outputs a single category as an <a> link.
+    #
+    #  +category+ is a category string to format as an <a> link
+    #
+    # Returns string
+    #
+    def category_link(category)
+      if category =~ /(.+)\[(.+)\]/
+        slug = $1.strip
+        title = $2.strip
+      else
+        slug = title = category
+      end
+      dir = @context.registers[:site].config['category_dir']
+      url = slug.to_url
+      url = "#{dir}/#{url}" unless dir.nil? or dir.empty?
+      "<a class='category' href='/#{url}/'>#{title}</a>"
+    end
+
+    # Outputs the post.date as formatted html, with hooks for CSS styling.
+    #
+    #  +date+ is the date object to format as HTML.
+    #
+    # Returns string
+    def date_to_html_string(date)
+      string = <<HTML.strip
+<span class='month'>#{date.strftime('%b').upcase}</span>
+#{date.strftime('<span class="day">%d</span>')}
+#{date.strftime('<span class="year">%Y</span>')}
+HTML
+    end
+
+  end
+
+end