codeslinger-jekyll 0.3.0

data/lib/jekyll/core_ext.rb

@@ -0,0 +1,22 @@
+class Hash
+  # Merges self with another hash, recursively.
+  # 
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  # 
+  # Thanks to whoever made it.
+  def deep_merge(hash)
+    target = dup
+    
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+      
+      target[key] = hash[key]
+    end
+    
+    target
+  end
+end

data/lib/jekyll/filters.rb

@@ -0,0 +1,39 @@
+module Jekyll
+  
+  module Filters
+    def date_to_string(date)
+      date.strftime("%d %b %Y")
+    end
+
+    def date_to_long_string(date)
+      date.strftime("%d %B %Y")
+    end
+    
+    def date_to_xmlschema(date)
+      date.xmlschema
+    end
+    
+    def xml_escape(input)
+      input.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
+    end
+    
+    def number_of_words(input)
+      input.split.length
+    end
+    
+    def array_to_sentence_string(array)
+      connector = "and"
+      case array.length
+      when 0
+        ""
+      when 1
+        array[0].to_s
+      when 2
+        "#{array[0]} #{connector} #{array[1]}"
+      else
+        "#{array[0...-1].join(', ')}, #{connector} #{array[-1]}"
+      end
+    end
+
+  end  
+end

data/lib/jekyll/layout.rb

@@ -0,0 +1,33 @@
+module Jekyll
+
+  class Layout
+    include Convertible
+    
+    attr_accessor :ext
+    attr_accessor :data, :content
+    
+    # Initialize a new Layout.
+    #   +base+ is the String path to the <source>
+    #   +name+ is the String filename of the post file
+    #
+    # Returns <Page>
+    def initialize(base, name)
+      @base = base
+      @name = name
+      
+      self.data = {}
+      
+      self.process(name)
+      self.read_yaml(base, name)
+    end
+    
+    # Extract information from the layout filename
+    #   +name+ is the String filename of the layout file
+    #
+    # Returns nothing
+    def process(name)
+      self.ext = File.extname(name)
+    end
+  end
+
+end

data/lib/jekyll/page.rb

@@ -0,0 +1,64 @@
+module Jekyll
+
+  class Page
+    include Convertible
+    
+    attr_accessor :ext
+    attr_accessor :data, :content, :output
+    
+    # Initialize a new Page.
+    #   +base+ is the String path to the <source>
+    #   +dir+ is the String path between <source> and the file
+    #   +name+ is the String filename of the file
+    #
+    # Returns <Page>
+    def initialize(base, dir, name)
+      @base = base
+      @dir = dir
+      @name = name
+      
+      self.data = {}
+      
+      self.process(name)
+      self.read_yaml(File.join(base, dir), name)
+      #self.transform
+    end
+    
+    # Extract information from the page filename
+    #   +name+ is the String filename of the page file
+    #
+    # Returns nothing
+    def process(name)
+      self.ext = File.extname(name)
+    end
+    
+    # Add any necessary layouts to this post
+    #   +layouts+ is a Hash of {"name" => "layout"}
+    #   +site_payload+ is the site payload hash
+    #
+    # Returns nothing
+    def render(layouts, site_payload)
+      payload = {"page" => self.data}.deep_merge(site_payload)
+      do_layout(payload, layouts)
+    end
+    
+    # Write the generated page file to the destination directory.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      FileUtils.mkdir_p(File.join(dest, @dir))
+      
+      name = @name
+      if self.ext != ""
+        name = @name.split(".")[0..-2].join('.') + self.ext
+      end
+      
+      path = File.join(dest, @dir, name)
+      File.open(path, 'w') do |f|
+        f.write(self.output)
+      end
+    end
+  end
+
+end

data/lib/jekyll/post.rb

@@ -0,0 +1,174 @@
+module Jekyll
+
+  class Post
+    include Comparable
+    include Convertible
+        
+    class << self
+      attr_accessor :lsi
+    end
+    
+    MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
+    
+    # Post name validator. Post filenames must be like:
+    #   2008-11-05-my-awesome-post.textile
+    #
+    # Returns <Bool>
+    def self.valid?(name)
+      name =~ MATCHER
+    end
+    
+    attr_accessor :date, :slug, :ext, :categories, :topics
+    attr_accessor :data, :content, :output
+    
+    # Initialize this Post instance.
+    #   +base+ is the String path to the dir containing the post file
+    #   +name+ is the String filename of the post file
+    #   +categories+ is an Array of Strings for the categories for this post
+    #
+    # Returns <Post>
+    def initialize(source, dir, name)
+      @base = File.join(source, dir, '_posts')
+      @name = name
+      
+      self.categories = dir.split('/').reject { |x| x.empty? }
+      
+      parts = name.split('/')
+      self.topics = parts.size > 1 ? parts[0..-2] : []
+      
+      self.process(name)
+      self.read_yaml(@base, name)
+    end
+    
+    # Spaceship is based on Post#date
+    #
+    # Returns -1, 0, 1
+    def <=>(other)
+      self.date <=> other.date
+    end
+    
+    # Extract information from the post filename
+    #   +name+ is the String filename of the post file
+    #
+    # Returns nothing
+    def process(name)
+      m, cats, date, slug, ext = *name.match(MATCHER)
+      self.date = Time.parse(date)
+      self.slug = slug
+      self.ext = ext
+    end
+    
+    # The generated directory into which the post will be placed
+    # upon generation. This is derived from the permalink or, if
+    # permalink is absent, set to the default date
+    # e.g. "/2008/11/05/" if the permalink style is :date, otherwise nothing
+    #
+    # Returns <String>
+    def dir
+      if permalink
+        permalink.to_s.split("/")[0..-2].join("/") + '/'
+      else
+        prefix = self.categories.empty? ? '' : '/' + self.categories.join('/')
+        if Jekyll.permalink_style == :date
+          prefix + date.strftime("/%Y/%m/%d/")
+        else
+          prefix + '/'
+        end
+      end
+    end
+    
+    # The full path and filename of the post.
+    # Defined in the YAML of the post body
+    # (Optional)
+    #
+    # Returns <String>
+    def permalink
+      self.data && self.data['permalink']
+    end
+    
+    # The generated relative url of this post
+    # e.g. /2008/11/05/my-awesome-post.html
+    #
+    # Returns <String>
+    def url
+      permalink || self.dir + self.slug + ".html"
+    end
+    
+    # The UID for this post (useful in feeds)
+    # e.g. /2008/11/05/my-awesome-post
+    #
+    # Returns <String>
+    def id
+      self.dir + self.slug
+    end
+        
+    # Calculate related posts.
+    #
+    # Returns [<Post>]
+    def related_posts(posts)
+      return [] unless posts.size > 1
+      
+      if Jekyll.lsi
+        self.class.lsi ||= begin
+          puts "Running the classifier... this could take a while."
+          lsi = Classifier::LSI.new
+          posts.each { |x| $stdout.print(".");$stdout.flush;lsi.add_item(x) }
+          puts ""
+          lsi
+        end
+
+        related = self.class.lsi.find_related(self.content, 11)
+        related - [self]
+      else
+        (posts - [self])[0..9]
+      end
+    end
+    
+    # Add any necessary layouts to this post
+    #   +layouts+ is a Hash of {"name" => "layout"}
+    #   +site_payload+ is the site payload hash
+    #
+    # Returns nothing
+    def render(layouts, site_payload)
+      # construct payload
+      payload =
+      {
+        "site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) },
+        "page" => self.to_liquid
+      }
+      payload = payload.deep_merge(site_payload)
+      
+      do_layout(payload, layouts)
+    end
+    
+    # Write the generated post file to the destination directory.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      FileUtils.mkdir_p(File.join(dest, dir))
+      
+      path = File.join(dest, self.url)
+      File.open(path, 'w') do |f|
+        f.write(self.output)
+      end
+    end
+    
+    # Convert this post into a Hash for use in Liquid templates.
+    #
+    # Returns <Hash>
+    def to_liquid
+      { "title" => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
+        "url" => self.url,
+        "date" => self.date,
+        "id" => self.id,
+        "topics" => self.topics,
+        "content" => self.content }.deep_merge(self.data)
+    end
+    
+    def inspect
+      "<Post: #{self.id}>"
+    end
+  end
+
+end

data/lib/jekyll/site.rb

@@ -0,0 +1,161 @@
+module Jekyll
+  
+  class Site
+    attr_accessor :source, :dest
+    attr_accessor :layouts, :posts
+    
+    # Initialize the site
+    #   +source+ is String path to the source directory containing
+    #            the proto-site
+    #   +dest+ is the String path to the directory where the generated
+    #          site should be written
+    #
+    # Returns <Site>
+    def initialize(source, dest)
+      self.source = source
+      self.dest = dest
+      self.layouts = {}
+      self.posts = []
+    end
+    
+    # Do the actual work of processing the site and generating the
+    # real deal.
+    #
+    # Returns nothing
+    def process
+      self.read_layouts
+      self.transform_pages
+      self.write_posts
+    end
+    
+    # Read all the files in <source>/_layouts except backup files
+    # (end with "~") into memory for later use.
+    #
+    # Returns nothing
+    def read_layouts
+      base = File.join(self.source, "_layouts")
+      entries = Dir.entries(base)
+      entries = entries.reject { |e| e[-1..-1] == '~' }
+      entries = entries.reject { |e| File.directory?(File.join(base, e)) }
+      
+      entries.each do |f|
+        name = f.split(".")[0..-2].join(".")
+        self.layouts[name] = Layout.new(base, f)
+      end
+    rescue Errno::ENOENT => e
+      # ignore missing layout dir
+    end
+    
+    # Read all the files in <base>/_posts except backup files (end with "~")
+    # and create a new Post object with each one.
+    #
+    # Returns nothing
+    def read_posts(dir)
+      base = File.join(self.source, dir, '_posts')
+      
+      entries = []
+      Dir.chdir(base) { entries = Dir['**/*'] }
+      entries = entries.reject { |e| e[-1..-1] == '~' }
+      entries = entries.reject { |e| File.directory?(File.join(base, e)) }
+
+      # first pass processes, but does not yet render post content
+      entries.each do |f|
+        if Post.valid?(f)
+          post = Post.new(self.source, dir, f)
+          self.posts << post
+        end
+      end
+      
+      # second pass renders each post now that full site payload is available
+      self.posts.each do |post|
+        post.render(self.layouts, site_payload)
+      end
+      
+      self.posts.sort!
+    rescue Errno::ENOENT => e
+      # ignore missing layout dir
+    end
+    
+    # Write each post to <dest>/<year>/<month>/<day>/<slug>
+    #
+    # Returns nothing
+    def write_posts
+      self.posts.each do |post|
+        post.write(self.dest)
+      end
+    end
+    
+    # Copy all regular files from <source> to <dest>/ ignoring
+    # any files/directories that are hidden or backup files (start
+    # with "." or end with "~") or contain site content (start with "_")
+    # unless they are "_posts" directories or web server files such as
+    # '.htaccess'
+    #   The +dir+ String is a relative path used to call this method
+    #            recursively as it descends through directories
+    #
+    # Returns nothing
+    def transform_pages(dir = '')
+      base = File.join(self.source, dir)
+      entries = Dir.entries(base)
+      entries = entries.reject { |e| e[-1..-1] == '~' }
+      entries = entries.reject do |e|
+        (e != '_posts') and ['.', '_'].include?(e[0..0]) unless ['.htaccess'].include?(e)
+      end
+
+      # we need to make sure to process _posts *first* otherwise they 
+      # might not be available yet to other templates as {{ site.posts }}
+      if entries.include?('_posts')
+        entries.delete('_posts')
+        read_posts(dir)
+      end
+
+      entries.each do |f|
+        if File.directory?(File.join(base, f))
+          next if self.dest.sub(/\/$/, '') == File.join(base, f)
+          transform_pages(File.join(dir, f))
+        else
+          first3 = File.open(File.join(self.source, dir, f)) { |fd| fd.read(3) }
+
+          if first3 == "---"
+            # file appears to have a YAML header so process it as a page
+            page = Page.new(self.source, dir, f)
+            page.render(self.layouts, site_payload)
+            page.write(self.dest)
+          else
+            # otherwise copy the file without transforming it
+            FileUtils.mkdir_p(File.join(self.dest, dir))
+            FileUtils.cp(File.join(self.source, dir, f), File.join(self.dest, dir, f))
+          end
+        end
+      end
+    end
+
+    # Constructs a hash map of Posts indexed by the specified Post attribute
+    #
+    # Returns {post_attr => [<Post>]}
+    def post_attr_hash(post_attr)
+      # Build a hash map based on the specified post attribute ( post attr => array of posts )
+      # then sort each array in reverse order
+      hash = Hash.new { |hash, key| hash[key] = Array.new }
+      self.posts.each { |p| p.send(post_attr.to_sym).each { |t| hash[t] << p } }
+      hash.values.map { |sortme| sortme.sort! { |a, b| b <=> a} }
+      return hash
+    end
+
+    # The Hash payload containing site-wide data
+    #
+    # Returns {"site" => {"time" => <Time>,
+    #                     "posts" => [<Post>],
+    #                     "categories" => [<Post>],
+    #                     "topics" => [<Post>] }}
+    def site_payload
+      {"site" => {
+        "time" => Time.now, 
+        "posts" => self.posts.sort { |a,b| b <=> a },
+        "categories" => post_attr_hash('categories'),
+        "topics" => post_attr_hash('topics')
+      }}
+    end
+  end
+
+end

data/lib/jekyll/tags/highlight.rb

@@ -0,0 +1,41 @@
+module Jekyll
+  
+  class HighlightBlock < Liquid::Block
+    include Liquid::StandardFilters
+    
+    def initialize(tag_name, lang, tokens)
+      super
+      @lang = lang.strip
+    end
+  
+    def render(context)
+      if Jekyll.pygments
+        render_pygments(context, super.to_s)
+      else
+        render_codehighlighter(context, super.to_s)
+      end
+    end
+    
+    def render_pygments(context, code)
+      if Jekyll.content_type == :markdown
+        return "\n" + Albino.new(code, @lang).to_s + "\n"
+      else
+        "<notextile>" + Albino.new(code, @lang).to_s + "</notextile>"
+      end
+    end
+    
+    def render_codehighlighter(context, code)
+    #The div is required because RDiscount blows ass
+      <<-HTML
+<div>
+  <pre>
+    <code class='#{@lang}'>#{h(code).strip}</code>
+  </pre>
+</div>
+      HTML
+    end
+  end
+  
+end
+
+Liquid::Template.register_tag('highlight', Jekyll::HighlightBlock)

data/lib/jekyll/tags/include.rb

@@ -0,0 +1,31 @@
+module Jekyll
+  
+  class IncludeTag < Liquid::Tag
+    def initialize(tag_name, file, tokens)
+      super
+      @file = file.strip
+    end
+    
+    def render(context)
+      if @file !~ /^[a-zA-Z0-9_\/\.-]+$/ || @file =~ /\.\// || @file =~ /\/\./
+        return "Include file '#{@file}' contains invalid characters or sequences"
+      end
+      
+      Dir.chdir(File.join(Jekyll.source, '_includes')) do
+        choices = Dir['**/*'].reject { |x| File.symlink?(x) }
+        if choices.include?(@file)
+          source = File.read(@file)
+          partial = Liquid::Template.parse(source)
+          context.stack do
+            partial.render(context)
+          end
+        else
+          "Included file '#{@file}' not found in _includes directory"
+        end
+      end
+    end
+  end
+  
+end
+
+Liquid::Template.register_tag('include', Jekyll::IncludeTag)

data/lib/jekyll.rb

@@ -0,0 +1,64 @@
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+
+# rubygems
+require 'rubygems'
+
+# core
+require 'fileutils'
+require 'time'
+require 'yaml'
+
+# stdlib
+
+# 3rd party
+require 'liquid'
+require 'redcloth'
+begin
+  require 'maruku'
+  require 'maruku/ext/math'
+  # Switch off MathML output
+  MaRuKu::Globals[:html_math_output_mathml] = false
+  MaRuKu::Globals[:html_math_engine] = 'none'
+
+  # Turn on math to PNG support with blahtex
+  # Resulting PNGs stored in `images/latex`
+  MaRuKu::Globals[:html_math_output_png] = true
+  MaRuKu::Globals[:html_png_engine] =  'blahtex'
+  MaRuKu::Globals[:html_png_dir] = 'images/latex'
+  MaRuKu::Globals[:html_png_url] = '/images/latex/'
+rescue LoadError
+  puts "The maruku gem is required for markdown support!"
+end
+
+# internal requires
+require 'jekyll/core_ext'
+require 'jekyll/site'
+require 'jekyll/convertible'
+require 'jekyll/layout'
+require 'jekyll/page'
+require 'jekyll/post'
+require 'jekyll/filters'
+require 'jekyll/tags/highlight'
+require 'jekyll/tags/include'
+require 'jekyll/albino'
+
+module Jekyll
+  VERSION = '0.3.0'
+  
+  class << self
+    attr_accessor :source, :dest, :lsi, :pygments, :markdown_proc, :content_type, :permalink_style
+  end
+  
+  Jekyll.lsi = false
+  Jekyll.pygments = false
+  Jekyll.markdown_proc = Proc.new { |x| Maruku.new(x).to_html }
+  Jekyll.permalink_style = :date
+  
+  def self.process(source, dest)
+    require 'classifier' if Jekyll.lsi
+    
+    Jekyll.source = source
+    Jekyll.dest = dest
+    Jekyll::Site.new(source, dest).process
+  end
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib jekyll])
+
+require 'test/unit'
+
+include Jekyll
+
+def dest_dir
+  File.join(File.dirname(__FILE__), *%w[dest])
+end
+
+def clear_dest
+  FileUtils.rm_rf(dest_dir)
+end

data/test/source/_includes/sig.markdown

@@ -0,0 +1,3 @@
+--
+Tom Preston-Werner
+github.com/mojombo

data/test/source/_layouts/default.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en-us">
+<head>
+   <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+   <title>{{ page.title }}</title>
+   <meta name="author" content="<%= @page.author %>" />
+
+   <!-- CodeRay syntax highlighting CSS -->
+   <link rel="stylesheet" href="/css/coderay.css" type="text/css" />
+
+   <!-- Homepage CSS -->
+   <link rel="stylesheet" href="/css/screen.css" type="text/css" media="screen, projection" />
+</head>
+<body>
+
+<div class="site">
+  <div class="title">
+    Tom Preston-Werner
+  </div>
+  
+  {{ content }}
+</div>
+
+</body>
+</html>

data/test/source/_layouts/simple.html

@@ -0,0 +1 @@
+<<< {{ content }} >>>

data/test/source/_posts/2008-10-18-foo-bar.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Foo Bar
+---
+
+h1. {{ page.title }}
+
+Best *post* ever