jekyll 0.4.1 → 0.5.1

data/lib/jekyll/site.rb

@@ -1,84 +1,147 @@
 module Jekyll
-  
+
   class Site
-    attr_accessor :source, :dest
-    attr_accessor :layouts, :posts, :categories
-    
+    attr_accessor :config, :layouts, :posts, :categories, :exclude
+    attr_accessor :source, :dest, :lsi, :pygments, :permalink_style
+
     # 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
+    #   +config+ is a Hash containing site configurations details
     #
     # Returns <Site>
-    def initialize(source, dest)
-      self.source = source
-      self.dest = dest
-      self.layouts = {}
-      self.posts = []
-      self.categories = Hash.new { |hash, key| hash[key] = Array.new }
+    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.exclude         = config['exclude'] || []
+
+      self.reset
+      self.setup
+    end
+
+    def reset
+      self.layouts         = {}
+      self.posts           = []
+      self.categories      = Hash.new { |hash, key| hash[key] = Array.new }
+    end
+
+    def setup
+      # Check to see if LSI is enabled.
+      require 'classifier' if self.lsi
+
+      # 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
+      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.write_posts
     end
-    
-    # Read all the files in <source>/_layouts except backup files
-    # (end with "~") into memory for later use.
+
+    # 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.entries(base)
-      entries = entries.reject { |e| e[-1..-1] == '~' }
-      entries = entries.reject { |e| File.directory?(File.join(base, e)) }
-      
+      entries = []
+      Dir.chdir(base) { entries = filter_entries(Dir['*.*']) }
+
       entries.each do |f|
         name = f.split(".")[0..-2].join(".")
-        self.layouts[name] = Layout.new(base, f)
+        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 except backup files (end with "~")
-    # and create a new Post object with each one.
+
+    # 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 = Dir['**/*'] }
-      entries = entries.reject { |e| e[-1..-1] == '~' }
-      entries = entries.reject { |e| File.directory?(File.join(base, e)) }
+      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.source, dir, f)
-          self.posts << post
-          post.categories.each { |c| self.categories[c] << post }
+          post = Post.new(self, self.source, dir, f)
+
+          if post.published
+            self.posts << post
+            post.categories.each { |c| self.categories[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)
       end
-      
-      self.posts.sort!
+
       self.categories.values.map { |cats| cats.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
@@ -87,10 +150,10 @@ module Jekyll
         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 "_")
+    # 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
@@ -99,18 +162,14 @@ module Jekyll
     # 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
+      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)) }
 
-      # we need to make sure to process _posts *first* otherwise they 
+      # 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')
+      if directories.include?('_posts')
+        directories.delete('_posts')
         read_posts(dir)
       end
       [directories, files].each do |entries|
@@ -120,10 +179,10 @@ module Jekyll
             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 = Page.new(self, self.source, dir, f)
               page.render(self.layouts, site_payload)
               page.write(self.dest)
             else
@@ -156,12 +215,23 @@ module Jekyll
     #                     "topics" => [<Post>] }}
     def site_payload
       {"site" => {
-        "time" => Time.now, 
+        "time" => Time.now,
         "posts" => self.posts.sort { |a,b| b <=> a },
         "categories" => post_attr_hash('categories'),
         "topics" => post_attr_hash('topics')
       }}
     end
-  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
+  end
 end

data/lib/jekyll/tags/highlight.rb

@@ -1,10 +1,11 @@
 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
@@ -19,23 +20,25 @@ module Jekyll
         raise SyntaxError.new("Syntax Error in 'highlight' - Valid syntax: highlight <lang> [linenos]")
       end
     end
-  
+
     def render(context)
-      if Jekyll.pygments
+      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 Jekyll.content_type == :markdown
+      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
-        "<notextile>" + Albino.new(code, @lang).to_s(@options) + "</notextile>"
+        return Albino.new(code, @lang).to_s(@options)
       end
     end
-    
+
     def render_codehighlighter(context, code)
     #The div is required because RDiscount blows ass
       <<-HTML
@@ -47,7 +50,7 @@ module Jekyll
       HTML
     end
   end
-  
+
 end
 
 Liquid::Template.register_tag('highlight', Jekyll::HighlightBlock)

data/lib/jekyll/tags/include.rb

@@ -1,17 +1,17 @@
 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
+
+      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)
@@ -25,7 +25,7 @@ module Jekyll
       end
     end
   end
-  
+
 end
 
 Liquid::Template.register_tag('include', Jekyll::IncludeTag)

data/test/helper.rb

@@ -1,13 +1,27 @@
+require 'rubygems'
+gem 'RedCloth', '= 4.1.0'
+
 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 clear_dest
-  FileUtils.rm_rf(dest_dir)
-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/_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/source/_posts/2009-03-12-hash-#1.markdown

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

data/test/test_filters.rb

@@ -1,37 +1,49 @@
 require File.dirname(__FILE__) + '/helper'
 
 class TestFilters < Test::Unit::TestCase
-  
   class JekyllFilter
     include Jekyll::Filters
   end
-  
-  def setup
-    @filter = JekyllFilter.new
-  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
+
+    should "escape space as plus" do
+      assert_equal "my+things", @filter.cgi_escape("my things")
+    end
+
+    should "escape special characters" do
+      assert_equal "hey%21", @filter.cgi_escape("hey!")
+    end
   end
-  
 end