sixones-jekyll 0.4.1 → 0.5.0

data/lib/jekyll.rb

@@ -13,55 +13,71 @@ require 'yaml'
 # 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/custom_filters'
 require 'jekyll/layout'
 require 'jekyll/page'
 require 'jekyll/post'
 require 'jekyll/filters'
-require 'jekyll/custom_filters'
 require 'jekyll/tags/highlight'
 require 'jekyll/tags/include'
 require 'jekyll/albino'
 
 module Jekyll
-  class << self
-    attr_accessor :source, :dest, :lsi, :pygments, :markdown_proc, :content_type, :permalink_style, :custom_filters
-  end
-  
-  Jekyll.lsi = false
-  Jekyll.pygments = false
-  Jekyll.markdown_proc = Proc.new { |x| Maruku.new(x).to_html }
-  Jekyll.permalink_style = :date
-  Jekyll.custom_filters = true
-  
-  def self.process(source, dest)
-    require 'classifier' if Jekyll.lsi
-    
-    Jekyll.source = source
-    Jekyll.dest = dest
-    Jekyll::Site.new(source, dest).process
+  # 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',
+    'custom_filters' => false,
+
+    '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]}"

data/test/helper.rb

@@ -2,13 +2,23 @@ require File.join(File.dirname(__FILE__), *%w[.. lib jekyll])
 
 require 'test/unit'
 require 'redgreen'
+require 'shoulda'
+require 'rr'
 
 include Jekyll
 
-def dest_dir
-  File.join(File.dirname(__FILE__), *%w[dest])
-end
+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)
+  def clear_dest
+    FileUtils.rm_rf(dest_dir)
+  end
 end

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/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/test_filters.rb

@@ -1,41 +1,41 @@
 require File.dirname(__FILE__) + '/helper'
 
 class TestFilters < Test::Unit::TestCase
-  
   class JekyllFilter
     include Jekyll::Filters
   end
-  
-  def setup
-    @filter = JekyllFilter.new
-  end
 
-  def test_textilize_with_simple_string
-    assert_equal "<p>something <strong>really</strong> simple</p>", @filter.textilize("something *really* simple")
-  end
-  
-  def test_array_to_sentence_string_with_no_args
-    assert_equal "", @filter.array_to_sentence_string([])
-  end
+  context "filters" do
+    setup do
+      @filter = JekyllFilter.new
+    end
 
-  def test_array_to_sentence_string_with_one_arg
-    assert_equal "1", @filter.array_to_sentence_string([1])
-    assert_equal "chunky", @filter.array_to_sentence_string(["chunky"])
-  end
-  
-  def test_array_to_sentence_string_with_two_args
-    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
-  
-  def test_array_to_sentence_string_with_multiple_args
-    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
-  
-  def test_xml_escape_with_ampersands
-    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>")
+    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

@@ -1,32 +1,38 @@
 require File.dirname(__FILE__) + '/helper'
 
 class TestGeneratedSite < Test::Unit::TestCase
-  def setup
-    clear_dest
-    @source = File.join(File.dirname(__FILE__), *%w[source])
-    @s = Site.new(@source, dest_dir)
-    @s.process
-    @index = File.read(File.join(dest_dir, 'index.html'))
-  end
-  
-  def test_site_posts_in_index
-    # confirm that {{ site.posts }} is working
-    assert @index.include?("#{@s.posts.size} Posts")
-  end
+  context "generated sites" do
+    setup do
+      clear_dest
+      stub(Jekyll).configuration do
+        Jekyll::DEFAULTS.merge({'source' => source_dir, 'destination' => dest_dir})
+      end
 
-  def test_post_content_in_index
-    # confirm that the {{ post.content }} is rendered OK
-    latest_post = Dir[File.join(@source, '_posts/*')].last
-    post = Post.new(@source, '', File.basename(latest_post))
-    Jekyll.content_type = post.determine_content_type
-    post.transform
-    assert @index.include?(post.content)
-  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
 
-  def test_unpublished_posts_are_hidden
-    published = Dir[File.join(dest_dir, 'publish_test/2008/02/02/*.html')].map {|f| File.basename(f)}
-    
-    assert_equal 1, published.size
-    assert_equal "published.html", published.first
+    should "not copy _posts directory" do
+      assert !File.exist?(dest_dir('_posts'))
+    end
   end
 end

data/test/test_post.rb

@@ -1,135 +1,145 @@
 require File.dirname(__FILE__) + '/helper'
 
 class TestPost < Test::Unit::TestCase
-  def setup
-    
+  def setup_post(file)
+    Post.new(@site, source_dir, '', file)
   end
-  
-  def test_valid
-    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
-  
-  def test_process
-    p = Post.allocate
-    p.process("2008-10-19-foo-bar.textile")
-    
-    assert_equal Time.parse("2008-10-19"), p.date
-    assert_equal "foo-bar", p.slug
-    assert_equal ".textile", p.ext
-  end
-  
-  def test_url
-    p = Post.allocate
-    p.categories = []
-    p.process("2008-10-19-foo-bar.textile")
-    
-    assert_equal "/2008/10/19/foo-bar.html", p.url
-  end
-  
-  def test_permalink
-    p = Post.allocate
-    p.process("2008-12-03-permalinked-post.textile")
-    p.read_yaml(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-12-03-permalinked-post.textile")
 
-    assert_equal "my_category/permalinked-post", p.permalink
+  def do_render(post)
+    layouts = { "default" => Layout.new(@site, source_dir('_layouts'), "simple.html")}
+    post.render(layouts, {"site" => {"posts" => []}})
   end
 
-  def test_dir_respects_permalink
-    p = Post.allocate
-    p.process("2008-12-03-permalinked-post.textile")
-    p.read_yaml(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-12-03-permalinked-post.textile")
+  context "A Post" do
+    setup do
+      clear_dest
+      stub(Jekyll).configuration { Jekyll::DEFAULTS }
+      @site = Site.new(Jekyll.configuration)
+    end
 
-    assert_equal "my_category/", p.dir
-  end
-  
-  def test_url_respects_permalink
-    p = Post.allocate
-    p.process("2008-12-03-permalinked-post.textile")
-    p.read_yaml(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-12-03-permalinked-post.textile")
+    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_equal "my_category/permalinked-post", p.url
-  end
+      assert !Post.valid?("lol2008-10-19-foo-bar.textile")
+      assert !Post.valid?("blah")
+    end
 
-  def test_read_yaml
-    p = Post.allocate
-    p.read_yaml(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-10-18-foo-bar.textile")
-    
-    assert_equal({"title" => "Foo Bar", "layout" => "default"}, p.data)
-    assert_equal "\nh1. {{ page.title }}\n\nBest *post* ever", p.content
-  end
-  
-  def test_transform
-    p = Post.allocate
-    p.process("2008-10-18-foo-bar.textile")
-    p.read_yaml(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-10-18-foo-bar.textile")
-    p.transform
-    
-    assert_equal "<h1>{{ page.title }}</h1>\n<p>Best <strong>post</strong> ever</p>", p.content
-  end
+    context "processing posts" do
+      setup do
+        @post = Post.allocate
+        @post.site = @site
 
-  def test_published
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '',  "2008-02-02-published.textile")
-		assert_equal true, p.published
-  end
+        @real_file = "2008-10-18-foo-bar.textile"
+        @fake_file = "2008-10-19-foo-bar.textile"
+        @source = source_dir('_posts')
+      end
 
-  def test_not_published
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '',  "2008-02-02-not-published.textile")
-		assert_equal false, p.published
-  end
+      should "keep date, title, and markup type" do
+        @post.process(@fake_file)
 
-  def test_yaml_category
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '',  "2009-01-27-category.textile")
-    assert p.categories.include?('foo')
-  end
+        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
 
-  def test_yaml_categories
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '',  "2009-01-27-categories.textile")
-    assert p.categories.include?('foo')
-    assert p.categories.include?('bar')
-    assert p.categories.include?('baz')
-  end
-  
-  def test_render
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '',  "2008-10-18-foo-bar.textile")
-    layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
-    p.render(layouts, {"site" => {"posts" => []}})
-    
-    assert_equal "<<< <h1>Foo Bar</h1>\n<p>Best <strong>post</strong> ever</p> >>>", p.output
-  end
-  
-  def test_write
-    clear_dest
-    
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '', "2008-10-18-foo-bar.textile")
-    layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
-    p.render(layouts, {"site" => {"posts" => []}})
-    p.write(dest_dir)
-  end
-  
-  def test_data
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '', "2008-11-21-complex.textile")
-    layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
-    p.render(layouts, {"site" => {"posts" => []}})
-    
-    assert_equal "<<< <p>url: /2008/11/21/complex.html<br />\ndate: #{Time.parse("2008-11-21")}<br />\nid: /2008/11/21/complex</p> >>>", p.output
-  end
-  
-  def test_categories_and_topics
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), 'foo', 'bar/2008-12-12-topical-post.textile')
-    assert_equal ['foo'], p.categories
-    assert_equal ['bar'], p.topics
-  end    
-  
-  def test_include
-    Jekyll.source = File.join(File.dirname(__FILE__), *%w[source])
-    p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '', "2008-12-13-include.markdown")
-    layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
-    p.render(layouts, {"site" => {"posts" => []}})
-    
-    assert_equal "<<< <hr />\n<p>Tom Preston-Werner github.com/mojombo</p>\n\n<p>This <em>is</em> cool</p> >>>", p.output
   end
 end