jberkel-jekyll 0.5.4

data/lib/jekyll/site.rb

@@ -0,0 +1,316 @@
+module Jekyll
+
+  class Site
+    attr_accessor :config, :layouts, :posts, :categories, :exclude,
+                  :source, :dest, :lsi, :pygments, :permalink_style, :tags
+                  
+    attr_accessor :sass, :post_defaults, :collated_posts
+
+
+    # Initialize the site
+    #   +config+ is a Hash containing site configurations details
+    #
+    # Returns <Site>
+    def initialize(config)
+      self.config          = config.clone
+
+      self.source          = config['source']
+      self.dest            = config['destination']
+      self.lsi             = config['lsi']
+      self.pygments        = config['pygments']
+      self.permalink_style = config['permalink'].to_sym
+      self.post_defaults   = config['post_defaults'] || {}
+      self.exclude         = config['exclude'] || []
+
+      self.reset
+      self.setup
+    end
+
+    def reset
+      self.layouts         = {}
+      self.posts           = []
+      self.collated_posts  = Hash.new {|h,k| h[k] = Hash.new {|h,k| h[k] = Hash.new {|h,k| h[k] = [] } } }
+      self.categories      = Hash.new { |hash, key| hash[key] = [] }
+      self.tags            = Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    def setup
+      # Check to see if LSI is enabled.
+      require 'classifier' if self.lsi
+      
+      if self.config['sass']
+        begin
+          require 'sass'
+          self.sass = true
+          puts 'Using Sass for CSS generation'
+        rescue LoadError
+          puts 'You must have the haml gem installed first'
+        end
+      end
+      
+      if self.config['haml']
+        begin
+          require 'haml'
+          require 'jekyll/haml_helpers'
+          helpers = File.join(source, '_helpers.rb')
+          require helpers if File.exist?(helpers)
+          puts 'Enabled Haml'
+        rescue LoadError => e
+          raise "You must have the haml gem installed first: #{e}"
+        end
+      end
+      
+      # Set the Markdown interpreter (and Maruku self.config, if necessary)
+      case self.config['markdown']
+        when 'rdiscount'
+          begin
+            require 'rdiscount'
+
+            def markdown(content)
+              RDiscount.new(content).to_html
+            end
+
+          rescue LoadError
+            puts 'You must have the rdiscount gem installed first'
+          end
+        when 'maruku'
+          begin
+            require 'maruku'
+
+            def markdown(content)
+              Maruku.new(content).to_html
+            end
+
+            if self.config['maruku']['use_divs']
+              require 'maruku/ext/div'
+              puts 'Maruku: Using extended syntax for div elements.'
+            end
+
+            if self.config['maruku']['use_tex']
+              require 'maruku/ext/math'
+              puts "Maruku: Using LaTeX extension. Images in `#{self.config['maruku']['png_dir']}`."
+
+              # 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] =  self.config['maruku']['png_engine']
+              MaRuKu::Globals[:html_png_dir] = self.config['maruku']['png_dir']
+              MaRuKu::Globals[:html_png_url] = self.config['maruku']['png_url']
+            end
+          rescue LoadError
+            puts "The maruku gem is required for markdown support!"
+          end
+        else
+          raise "Invalid Markdown processor: '#{self.config['markdown']}' -- did you mean 'maruku' or 'rdiscount'?"
+      end
+    end
+
+    def textile(content)
+      RedCloth.new(content).to_html
+    end
+
+    # Do the actual work of processing the site and generating the
+    # real deal.
+    #
+    # Returns nothing
+    def process
+      self.reset
+      self.read_layouts
+      self.transform_pages
+      self.transform_sass if self.sass
+      self.write_posts
+    end
+
+    # Read all the files in <source>/_layouts into memory for later use.
+    #
+    # Returns nothing
+    def read_layouts
+      base = File.join(self.source, "_layouts")
+      entries = []
+      Dir.chdir(base) { entries = filter_entries(Dir['*.*']) }
+
+      entries.each do |f|
+        name = f.split(".")[0..-2].join(".")
+        self.layouts[name] = Layout.new(self, base, f)
+      end
+    rescue Errno::ENOENT => e
+      # ignore missing layout dir
+    end
+
+    # Read all the files in <base>/_posts 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 = filter_entries(Dir['**/*']) }
+
+      # first pass processes, but does not yet render post content
+      entries.each do |f|
+        if Post.valid?(f)
+          post = Post.new(self, self.source, dir, f)
+
+          if post.published
+            self.posts << post
+            post.categories.each { |c| self.categories[c] << post }
+            post.tags.each { |c| self.tags[c] << post }
+          end
+        end
+      end
+
+      self.posts.sort!
+
+      # second pass renders each post now that full site payload is available
+      self.posts.each do |post|
+        post.render(self.layouts, site_payload)
+        self.collated_posts[post.date.year][post.date.month][post.date.day].unshift(post)
+      end
+
+      self.categories.values.map { |ps| ps.sort! { |a, b| b <=> a} }
+      self.tags.values.map { |ps| ps.sort! { |a, b| b <=> a} }
+    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 "#" 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 = filter_entries(Dir.entries(base))
+      directories = entries.select { |e| File.directory?(File.join(base, e)) }
+      files = entries.reject { |e| File.directory?(File.join(base, e)) || File.symlink?(File.join(base, e)) }
+
+      # we need to make sure to process _posts *first* otherwise they
+      # might not be available yet to other templates as {{ site.posts }}
+      if directories.include?('_posts')
+        directories.delete('_posts')
+        read_posts(dir)
+      end
+
+      [directories, files].each do |entries|
+        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))
+          elsif Pager.pagination_enabled?(self.config, f)
+            paginate_posts(f, dir)
+          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, 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
+    end
+
+    # Transform all *.sass files from <dest> to css with the same name
+    # and delete source sass files.
+    # Returns nothing
+    def transform_sass(dir = '')
+      base = File.join(self.source, dir)
+      entries = Dir.entries(base)
+      entries = entries.reject { |e| ['.', '_'].include?(e[0..0]) }
+      directories = entries.select { |e| File.directory?(File.join(base, e)) }
+      directories.each { |d| transform_sass(File.join(dir, d)) }
+      files = entries.reject { |e| File.directory?(File.join(base, e)) }
+      files = files.select { |f| File.extname(File.join(base, f)) == ".sass" }
+      files.each do |f|
+        input = File.open(File.join(base, f), "r")
+        result = Sass::Engine.new(input.read, :style => :compact, :load_paths => base).render
+        FileUtils.mkdir_p(File.join(self.dest, dir))
+        output = File.open(File.join(self.dest, dir, f).gsub(/.sass\Z/, ".css"), "w") do |o|
+          o.write(result)
+        end
+        FileUtils.rm(File.join(self.dest, dir, f))
+      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>]}
+    def site_payload
+      {"site" => self.config.merge({
+          "time"       => Time.now,
+          "posts"      => self.posts.sort { |a,b| b <=> a },
+          "categories" => post_attr_hash('categories'),
+          "tags"       => post_attr_hash('tags')})}
+    end
+
+    # Filter out any files/directories that are hidden or backup files (start
+    # with "." or "#" or end with "~") or contain site content (start with "_")
+    # unless they are "_posts" directories or web server files such as
+    # '.htaccess'
+    def filter_entries(entries)
+      entries = entries.reject do |e|
+        unless ['_posts', '.htaccess'].include?(e)
+          ['.', '_', '#'].include?(e[0..0]) || e[-1..-1] == '~' || self.exclude.include?(e)
+        end
+      end
+    end
+
+    # Paginates the blog's posts. Renders the index.html file into paginated directories, ie: page2, page3...
+    # and adds more wite-wide data
+    #
+    # {"paginator" => { "page" => <Number>,
+    #                   "per_page" => <Number>,
+    #                   "posts" => [<Post>],
+    #                   "total_posts" => <Number>,
+    #                   "total_pages" => <Number>,
+    #                   "previous_page" => <Number>,
+    #                   "next_page" => <Number> }}
+    def paginate_posts(file, dir)
+      all_posts = self.posts.sort { |a,b| b <=> a }
+      pages = Pager.calculate_pages(all_posts, self.config['paginate'].to_i)
+      pages += 1
+      (1..pages).each do |num_page|
+        pager = Pager.new(self.config, num_page, all_posts, pages)
+        page = Page.new(self, self.source, dir, file)
+        page.render(self.layouts, site_payload.merge({'paginator' => pager.to_hash}))
+        suffix = "page#{num_page}" if num_page > 1
+        page.write(self.dest, suffix)
+      end
+    end
+  end
+end

data/lib/jekyll/tags/highlight.rb

@@ -0,0 +1,56 @@
+module Jekyll
+
+  class HighlightBlock < Liquid::Block
+    include Liquid::StandardFilters
+
+    # we need a language, but the linenos argument is optional.
+    SYNTAX = /(\w+)\s?(:?linenos)?\s?/
+
+    def initialize(tag_name, markup, tokens)
+      super
+      if markup =~ SYNTAX
+        @lang = $1
+        if defined? $2
+          # additional options to pass to Albino.
+          @options = { 'O' => 'linenos=inline' }
+        else
+          @options = {}
+        end
+      else
+        raise SyntaxError.new("Syntax Error in 'highlight' - Valid syntax: highlight <lang> [linenos]")
+      end
+    end
+
+    def render(context)
+      if context.registers[:site].pygments
+        render_pygments(context, super.to_s)
+      else
+        render_codehighlighter(context, super.to_s)
+      end
+    end
+
+    def render_pygments(context, code)
+      if context["content_type"] == "markdown"
+        return "\n" + Albino.new(code, @lang).to_s(@options) + "\n"
+      elsif context["content_type"] == "textile"
+        return "<notextile>" + Albino.new(code, @lang).to_s(@options) + "</notextile>"
+      else
+        return highlighted_code
+      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(context.registers[:site].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,86 @@
+$:.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'
+
+# internal requires
+require 'jekyll/core_ext'
+require 'jekyll/pager'
+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
+  # Default options. Overriden by values in _config.yml or command-line opts.
+  # Strings are used instead of symbols for YAML compatibility.
+  DEFAULTS = {
+    'auto'         => false,
+    'server'       => false,
+    'server_port'  => 4000,
+
+    'source'       => '.',
+    'destination'  => File.join('.', '_site'),
+
+    'lsi'          => false,
+    'pygments'     => false,
+    'sass'         => false,
+    'markdown'     => 'maruku',
+    'permalink'    => 'date',
+
+    'maruku'       => {
+      'use_tex'    => false,
+      'use_divs'   => false,
+      'png_engine' => 'blahtex',
+      'png_dir'    => 'images/latex',
+      'png_url'    => '/images/latex'
+    }
+  }
+
+  # Generate a Jekyll configuration Hash by merging the default options
+  # with anything in _config.yml, and adding the given options on top
+  #   +override+ is a Hash of config directives
+  #
+  # Returns Hash
+  def self.configuration(override)
+    # _config.yml may override default source location, but until
+    # then, we need to know where to look for _config.yml
+    source = override['source'] || Jekyll::DEFAULTS['source']
+
+    # Get configuration from <source>/_config.yml
+    config_file = File.join(source, '_config.yml')
+    begin
+      config = YAML.load_file(config_file)
+      raise "Invalid configuration - #{config_file}" if !config.is_a?(Hash)
+      STDOUT.puts "Configuration from #{config_file}"
+    rescue => err
+      STDERR.puts "WARNING: Could not read configuration. Using defaults (and options)."
+      STDERR.puts "\t" + err.to_s
+      config = {}
+    end
+
+    # Merge DEFAULTS < _config.yml < override
+    Jekyll::DEFAULTS.deep_merge(config).deep_merge(override)
+  end
+
+  def self.version
+    yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
+    "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+gem 'RedCloth', '>= 4.1.1'
+
+require File.join(File.dirname(__FILE__), *%w[.. lib jekyll])
+
+require 'test/unit'
+require 'redgreen'
+require 'shoulda'
+require 'rr'
+
+include Jekyll
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+
+  def dest_dir(*subdirs)
+    File.join(File.dirname(__FILE__), 'dest', *subdirs)
+  end
+
+  def source_dir(*subdirs)
+    File.join(File.dirname(__FILE__), 'source', *subdirs)
+  end
+
+  def clear_dest
+    FileUtils.rm_rf(dest_dir)
+  end
+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-02-02-not-published.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Not published!
+published: false
+category: publish_test
+---
+
+This should *not* be published!

data/test/source/_posts/2008-02-02-published.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Publish
+category: publish_test
+---
+
+This should be published.
+

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

data/test/source/_posts/2008-11-21-complex.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Complex
+---
+
+url: {{ page.url }}
+date: {{ page.date }}
+id: {{ page.id }}

data/test/source/_posts/2008-12-03-permalinked-post.textile

@@ -0,0 +1,9 @@
+---
+title: Post with Permalink
+permalink: my_category/permalinked-post
+---
+
+h1. {{ page.title }}
+
+
+<p>Best <strong>post</strong> ever</p>

data/test/source/_posts/2008-12-13-include.markdown

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Include
+---
+
+{% include sig.markdown %}
+
+This _is_ cool

data/test/source/_posts/2009-01-27-array-categories.textile

@@ -0,0 +1,10 @@
+---
+layout: default
+title: Array categories in YAML
+categories:
+- foo
+- bar
+- baz
+---
+
+Best *post* ever

data/test/source/_posts/2009-01-27-categories.textile

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Categories in YAML
+categories: foo bar baz
+---
+
+Best *post* ever

data/test/source/_posts/2009-01-27-category.textile

@@ -0,0 +1,7 @@
+---
+layout: default
+title: Category in YAML
+category: foo
+---
+
+Best *post* ever

data/test/source/_posts/2009-03-12-hash-#1.markdown

@@ -0,0 +1,6 @@
+---
+layout: default
+title: Hash #1
+---
+
+Hashes are nice

data/test/source/_posts/2009-05-18-tag.textile

@@ -0,0 +1,6 @@
+---
+title: A Tag
+tag: code
+---
+
+Whoa.

data/test/source/_posts/2009-05-18-tags.textile

@@ -0,0 +1,9 @@
+---
+title: Some Tags
+tags:
+- food
+- cooking
+- pizza
+---
+
+Awesome!

data/test/source/_posts/2009-06-22-empty-yaml.textile

@@ -0,0 +1,3 @@
+---
+---
+Empty YAML.

data/test/source/_posts/2009-06-22-no-yaml.textile

@@ -0,0 +1 @@
+No YAML.

data/test/source/about.html

@@ -0,0 +1,6 @@
+---
+title: About
+permalink: /about/
+---
+
+About the site