henrik-jekyll 0.5.0

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 Albino.new(code, @lang).to_s(@options)
+      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,83 @@
+$:.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/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.yaml or command-line opts.
+  # (Strings rather symbols used for compatability with YAML)
+  DEFAULTS = {
+    'auto'         => false,
+    'server'       => false,
+    'server_port'  => 4000,
+
+    'source'       => '.',
+    'destination'  => File.join('.', '_site'),
+
+    'lsi'          => false,
+    'pygments'     => 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.yaml
+    config = {}
+    config_file = File.join(source, '_config.yml')
+    begin
+      config = YAML.load_file(config_file)
+      puts "Configuration from #{config_file}"
+    rescue => err
+      puts "WARNING: Could not read configuration. Using defaults (and options)."
+      puts "\t" + err
+    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,24 @@
+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/category/_posts/2008-9-23-categories.textile

@@ -0,0 +1,6 @@
+---
+layout: default
+title: Categories
+---
+
+Categories _should_ work

data/test/source/css/screen.css

@@ -0,0 +1,76 @@
+/*****************************************************************************/
+/*
+/* Common
+/*
+/*****************************************************************************/
+
+/* Global Reset */
+
+* {
+  margin: 0;
+  padding: 0;
+}
+
+html, body {
+  height: 100%;
+}
+
+body {
+  background-color: white;
+  font: 13.34px helvetica, arial, clean, sans-serif;
+  *font-size: small;
+  text-align: center;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-size: 100%;
+}
+
+h1 {
+  margin-bottom: 1em;
+}
+
+p {
+  margin: 1em 0;
+}
+
+a {
+  color: #00a;
+}
+
+a:hover {
+  color: black;
+}
+
+a:visited {
+  color: #a0a;
+}
+
+table {
+  font-size: inherit;
+  font: 100%;
+}
+
+/*****************************************************************************/
+/*
+/* Site
+/*
+/*****************************************************************************/
+
+.site {
+  font-size: 110%;
+  text-align: justify;
+  width: 40em;
+  margin: 3em auto 2em auto;
+  line-height: 1.5em;
+}
+
+.title {
+  color: #a00;
+  font-weight: bold;
+  margin-bottom: 2em;
+}
+
+.site .meta {
+  color: #aaa;
+}

data/test/source/foo/_posts/bar/2008-12-12-topical-post.textile

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Topical Post
+---
+
+h1. {{ page.title }}
+
+This post has a topic.

data/test/source/index.html

@@ -0,0 +1,22 @@
+---
+layout: default
+title: Tom Preston-Werner
+---
+
+h1. Welcome to my site
+
+h2. Please read our {{ site.posts | size }} Posts
+
+<ul>
+  {% for post in site.posts %}
+    <li>{{ post.date }} <a href="{{ post.url }}">{{ post.title }}</a></li>
+  {% endfor %}
+</ul>
+
+{% assign first_post = site.posts.first %}
+<div id="first_post">
+  <h1>{{ first_post.title }}</h1>
+  <div>
+    {{ first_post.content }}
+  </div>
+</div>

data/test/source/z_category/_posts/2008-9-23-categories.textile

@@ -0,0 +1,6 @@
+---
+layout: default
+title: Categories
+---
+
+Categories _should_ work. Even if ordered after index.

data/test/suite.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+# for some reason these tests fail when run via TextMate
+# but succeed when run on the command line.
+
+tests = Dir["#{File.dirname(__FILE__)}/test_*.rb"]
+tests.each do |file|
+  require file
+end

data/test/test_filters.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestFilters < Test::Unit::TestCase
+  class JekyllFilter
+    include Jekyll::Filters
+  end
+
+  context "filters" do
+    setup do
+      @filter = JekyllFilter.new
+    end
+
+    should "textilize with simple string" do
+      assert_equal "<p>something <strong>really</strong> simple</p>", @filter.textilize("something *really* simple")
+    end
+
+    should "convert array to sentence string with no args" do
+      assert_equal "", @filter.array_to_sentence_string([])
+    end
+
+    should "convert array to sentence string with one arg" do
+      assert_equal "1", @filter.array_to_sentence_string([1])
+      assert_equal "chunky", @filter.array_to_sentence_string(["chunky"])
+    end
+
+    should "convert array to sentence string with two args" do
+      assert_equal "1 and 2", @filter.array_to_sentence_string([1, 2])
+      assert_equal "chunky and bacon", @filter.array_to_sentence_string(["chunky", "bacon"])
+    end
+
+    should "convert array to sentence string with multiple args" do
+      assert_equal "1, 2, 3, and 4", @filter.array_to_sentence_string([1, 2, 3, 4])
+      assert_equal "chunky, bacon, bits, and pieces", @filter.array_to_sentence_string(["chunky", "bacon", "bits", "pieces"])
+    end
+
+    should "escape xml with ampersands" do
+      assert_equal "AT&amp;T", @filter.xml_escape("AT&T")
+      assert_equal "&lt;code&gt;command &amp;lt;filename&amp;gt;&lt;/code&gt;", @filter.xml_escape("<code>command &lt;filename&gt;</code>")
+    end
+  end
+end

data/test/test_generated_site.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestGeneratedSite < Test::Unit::TestCase
+  context "generated sites" do
+    setup do
+      clear_dest
+      stub(Jekyll).configuration do
+        Jekyll::DEFAULTS.merge({'source' => source_dir, 'destination' => dest_dir})
+      end
+
+      @site = Site.new(Jekyll.configuration)
+      @site.process
+      @index = File.read(dest_dir('index.html'))
+    end
+
+    should "insert site.posts into the index" do
+      assert @index.include?("#{@site.posts.size} Posts")
+    end
+
+    should "render post.content" do
+      latest_post = Dir[source_dir('_posts', '*')].last
+      post = Post.new(@site, source_dir, '', File.basename(latest_post))
+      post.transform
+      assert @index.include?(post.content)
+    end
+
+    should "hide unpublished posts" do
+      published = Dir[dest_dir('publish_test/2008/02/02/*.html')].map {|f| File.basename(f)}
+
+      assert_equal 1, published.size
+      assert_equal "published.html", published.first
+    end
+
+    should "not copy _posts directory" do
+      assert !File.exist?(dest_dir('_posts'))
+    end
+  end
+end

data/test/test_post.rb

@@ -0,0 +1,145 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestPost < Test::Unit::TestCase
+  def setup_post(file)
+    Post.new(@site, source_dir, '', file)
+  end
+
+  def do_render(post)
+    layouts = { "default" => Layout.new(@site, source_dir('_layouts'), "simple.html")}
+    post.render(layouts, {"site" => {"posts" => []}})
+  end
+
+  context "A Post" do
+    setup do
+      clear_dest
+      stub(Jekyll).configuration { Jekyll::DEFAULTS }
+      @site = Site.new(Jekyll.configuration)
+    end
+
+    should "ensure valid posts are valid" do
+      assert Post.valid?("2008-10-19-foo-bar.textile")
+      assert Post.valid?("foo/bar/2008-10-19-foo-bar.textile")
+
+      assert !Post.valid?("lol2008-10-19-foo-bar.textile")
+      assert !Post.valid?("blah")
+    end
+
+    context "processing posts" do
+      setup do
+        @post = Post.allocate
+        @post.site = @site
+
+        @real_file = "2008-10-18-foo-bar.textile"
+        @fake_file = "2008-10-19-foo-bar.textile"
+        @source = source_dir('_posts')
+      end
+
+      should "keep date, title, and markup type" do
+        @post.process(@fake_file)
+
+        assert_equal Time.parse("2008-10-19"), @post.date
+        assert_equal "foo-bar", @post.slug
+        assert_equal ".textile", @post.ext
+      end
+
+      should "create url based on date and title" do
+        @post.categories = []
+        @post.process(@fake_file)
+        assert_equal "/2008/10/19/foo-bar.html", @post.url
+      end
+
+      should "respect permalink" do
+        file = "2008-12-03-permalinked-post.textile"
+        @post.process(file)
+        @post.read_yaml(@source, file)
+
+        assert_equal "my_category/permalinked-post", @post.permalink
+        assert_equal "my_category/", @post.dir
+        assert_equal "my_category/permalinked-post", @post.url
+      end
+
+      should "read yaml front-matter" do
+        @post.read_yaml(@source, @real_file)
+
+        assert_equal({"title" => "Foo Bar", "layout" => "default"}, @post.data)
+        assert_equal "\nh1. {{ page.title }}\n\nBest *post* ever", @post.content
+      end
+
+      should "transform textile" do
+        @post.process(@real_file)
+        @post.read_yaml(@source, @real_file)
+        @post.transform
+
+        assert_equal "<h1>{{ page.title }}</h1>\n<p>Best <strong>post</strong> ever</p>", @post.content
+      end
+    end
+
+    context "initializing posts" do
+      should "publish when published yaml is no specified" do
+        post = setup_post("2008-02-02-published.textile")
+        assert_equal true, post.published
+      end
+
+      should "not published when published yaml is false" do
+        post = setup_post("2008-02-02-not-published.textile")
+        assert_equal false, post.published
+      end
+
+      should "recognize category in yaml" do
+        post = setup_post("2009-01-27-category.textile")
+        assert post.categories.include?('foo')
+      end
+
+      should "recognize several categories in yaml" do
+        post = setup_post("2009-01-27-categories.textile")
+        assert post.categories.include?('foo')
+        assert post.categories.include?('bar')
+        assert post.categories.include?('baz')
+      end
+
+      context "rendering" do
+        setup do
+          clear_dest
+        end
+
+        should "render properly" do
+          post = setup_post("2008-10-18-foo-bar.textile")
+          do_render(post)
+          assert_equal "<<< <h1>Foo Bar</h1>\n<p>Best <strong>post</strong> ever</p> >>>", post.output
+        end
+
+        should "write properly" do
+          post = setup_post("2008-10-18-foo-bar.textile")
+          do_render(post)
+          post.write(dest_dir)
+
+          assert File.directory?(dest_dir)
+          assert File.exists?(File.join(dest_dir, '2008', '10', '18', 'foo-bar.html'))
+        end
+
+        should "insert data" do
+          post = setup_post("2008-11-21-complex.textile")
+          do_render(post)
+
+          assert_equal "<<< <p>url: /2008/11/21/complex.html<br />\ndate: #{Time.parse("2008-11-21")}<br />\nid: /2008/11/21/complex</p> >>>", post.output
+        end
+
+        should "include templates" do
+          post = setup_post("2008-12-13-include.markdown")
+          post.site.source = File.join(File.dirname(__FILE__), 'source')
+          do_render(post)
+
+          assert_equal "<<< <hr />\n<p>Tom Preston-Werner github.com/mojombo</p>\n\n<p>This <em>is</em> cool</p> >>>", post.output
+        end
+      end
+    end
+
+    should "generate categories and topics" do
+      post = Post.new(@site, File.join(File.dirname(__FILE__), *%w[source]), 'foo', 'bar/2008-12-12-topical-post.textile')
+      assert_equal ['foo'], post.categories
+      assert_equal ['bar'], post.topics
+    end
+
+  end
+end