jekyll 0.1.4 → 0.1.5

data/History.txt

@@ -1,3 +1,13 @@
+== 0.1.5 / 2008-12-12
+  * Major Features
+    * Code highlighting with Pygments if --pygments is specified
+    * Disable true LSI by default, enable with --lsi
+  * Minor Enhancements
+    * Output informative message if RDiscount is not available [github.com/JackDanger]
+  * Bug Fixes
+    * Prevent Jekyll from picking up the output directory as a source [github.com/JackDanger]
+    * Skip related_posts when there is only one post [github.com/JackDanger]
+
 == 0.1.4 / 2008-12-08
   * Bug Fixes
     * DATA does not work properly with rubygems

data/Manifest.txt

@@ -5,11 +5,12 @@ Rakefile
 bin/jekyll
 jekyll.gemspec
 lib/jekyll.rb
-lib/jekyll/convertible.rb
+lib/jekyll/albino.rb
+lib/jekyll/blocks.rb
 lib/jekyll/converters/csv.rb
 lib/jekyll/converters/mephisto.rb
+lib/jekyll/convertible.rb
 lib/jekyll/filters.rb
-lib/jekyll/blocks.rb
 lib/jekyll/layout.rb
 lib/jekyll/page.rb
 lib/jekyll/post.rb
@@ -21,6 +22,7 @@ test/source/_posts/2008-10-18-foo-bar.textile
 test/source/_posts/2008-11-21-complex.textile
 test/source/css/screen.css
 test/source/index.html
+test/source/posts/2008-12-03-permalinked-post.textile
 test/suite.rb
 test/test_jekyll.rb
 test/test_post.rb

data/README.textile

@@ -38,10 +38,18 @@ h2. Run
   $ cd /path/to/proto/site
   $ jekyll
 
-This will generate the site and place it in /path/to/proto/site/_site. There is an autobuild feature that will regenerate your site if any of the files change:
+This will generate the site and place it in /path/to/proto/site/_site.
+
+There is an autobuild feature that will regenerate your site if any of the files change:
 
   $ jekyll --auto
 
+By default, the "related posts" functionality will produce crappy results.
+In order to get high quality results with a true LSI algorithm, you must
+enable it (it may take some time to run if you have many posts):
+
+  $ jekyll --lsi
+
 If you'd like the generated site placed somewhere else:
 
   $ jekyll /path/to/place/generated/site

data/Rakefile

@@ -5,7 +5,7 @@ require 'lib/jekyll'
 Hoe.new('jekyll', Jekyll::VERSION) do |p|
   p.developer('Tom Preston-Werner', 'tom@mojombo.com')
   p.summary = "Jekyll is a simple, blog aware, static site generator."
-  p.extra_deps = ['RedCloth', 'liquid', 'classifier', 'rdiscount', 'directory_watcher']
+  p.extra_deps = ['RedCloth', 'liquid', 'classifier', 'rdiscount', 'directory_watcher', 'open4']
 end
 
 desc "Open an irb session preloaded with this library"

data/bin/jekyll

@@ -24,6 +24,14 @@ opts = OptionParser.new do |opts|
   opts.on("--auto", "Auto-regenerate") do
     options[:auto] = true
   end
+  
+  opts.on("--lsi", "Use LSI for better related posts") do
+    Jekyll.lsi = true
+  end
+  
+  opts.on("--pygments", "Use pygments to highlight code") do
+    Jekyll.pygments = true
+  end
 end
 
 opts.parse!

data/jekyll.gemspec

@@ -1,15 +1,15 @@
 Gem::Specification.new do |s|
   s.name = %q{jekyll}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tom Preston-Werner"]
-  s.date = %q{2008-12-06}
+  s.date = %q{2008-12-12}
   s.default_executable = %q{jekyll}
   s.email = ["tom@mojombo.com"]
   s.executables = ["jekyll"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.textile", "Rakefile", "bin/jekyll", "jekyll.gemspec", "lib/jekyll.rb", "lib/jekyll/convertible.rb", "lib/jekyll/converters/csv.rb", "lib/jekyll/converters/mephisto.rb", "lib/jekyll/filters.rb", "lib/jekyll/blocks.rb", "lib/jekyll/layout.rb", "lib/jekyll/page.rb", "lib/jekyll/post.rb", "lib/jekyll/site.rb", "test/helper.rb", "test/source/_layouts/default.html", "test/source/_layouts/simple.html", "test/source/_posts/2008-10-18-foo-bar.textile", "test/source/_posts/2008-11-21-complex.textile", "test/source/css/screen.css", "test/source/index.html", "test/suite.rb", "test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
+  s.files = ["History.txt", "Manifest.txt", "README.textile", "Rakefile", "bin/jekyll", "jekyll.gemspec", "lib/jekyll.rb", "lib/jekyll/albino.rb", "lib/jekyll/blocks.rb", "lib/jekyll/converters/csv.rb", "lib/jekyll/converters/mephisto.rb", "lib/jekyll/convertible.rb", "lib/jekyll/filters.rb", "lib/jekyll/layout.rb", "lib/jekyll/page.rb", "lib/jekyll/post.rb", "lib/jekyll/site.rb", "test/helper.rb", "test/source/_layouts/default.html", "test/source/_layouts/simple.html", "test/source/_posts/2008-10-18-foo-bar.textile", "test/source/_posts/2008-11-21-complex.textile", "test/source/css/screen.css", "test/source/index.html", "test/source/posts/2008-12-03-permalinked-post.textile", "test/suite.rb", "test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
   s.has_rdoc = true
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<classifier>, [">= 0"])
       s.add_runtime_dependency(%q<rdiscount>, [">= 0"])
       s.add_runtime_dependency(%q<directory_watcher>, [">= 0"])
+      s.add_runtime_dependency(%q<open4>, [">= 0"])
       s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
     else
       s.add_dependency(%q<RedCloth>, [">= 0"])
@@ -35,6 +36,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<classifier>, [">= 0"])
       s.add_dependency(%q<rdiscount>, [">= 0"])
       s.add_dependency(%q<directory_watcher>, [">= 0"])
+      s.add_dependency(%q<open4>, [">= 0"])
       s.add_dependency(%q<hoe>, [">= 1.8.0"])
     end
   else
@@ -43,6 +45,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<classifier>, [">= 0"])
     s.add_dependency(%q<rdiscount>, [">= 0"])
     s.add_dependency(%q<directory_watcher>, [">= 0"])
+    s.add_dependency(%q<open4>, [">= 0"])
     s.add_dependency(%q<hoe>, [">= 1.8.0"])
   end
 end

data/lib/jekyll.rb

@@ -12,7 +12,11 @@ require 'time'
 # 3rd party
 require 'liquid'
 require 'redcloth'
-require 'rdiscount' rescue puts "The rdiscount gem is required for markdown support!"
+begin
+  require 'rdiscount'
+rescue LoadError
+  puts "The rdiscount gem is required for markdown support!"
+end
 require 'classifier'
 require 'directory_watcher'
 
@@ -24,11 +28,19 @@ require 'jekyll/page'
 require 'jekyll/post'
 require 'jekyll/filters'
 require 'jekyll/blocks'
+require 'jekyll/albino'
 
 module Jekyll
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
+  
+  class << self
+    attr_accessor :lsi, :pygments
+  end
+  
+  Jekyll.lsi = false
+  Jekyll.pygments = false
   
   def self.process(source, dest)
     Jekyll::Site.new(source, dest).process
   end
-end
+end

data/lib/jekyll/albino.rb

@@ -0,0 +1,116 @@
+##
+# Wrapper for the Pygments command line tool, pygmentize.
+#
+# Pygments: http://pygments.org/
+#
+# Assumes pygmentize is in the path.  If not, set its location
+# with Albino.bin = '/path/to/pygmentize'
+#
+# Use like so:
+#
+#   @syntaxer = Albino.new('/some/file.rb', :ruby)
+#   puts @syntaxer.colorize
+#
+# This'll print out an HTMLized, Ruby-highlighted version
+# of '/some/file.rb'.
+#
+# To use another formatter, pass it as the third argument:
+#
+#   @syntaxer = Albino.new('/some/file.rb', :ruby, :bbcode)
+#   puts @syntaxer.colorize
+#
+# You can also use the #colorize class method:
+#
+#   puts Albino.colorize('/some/file.rb', :ruby)
+#
+# Another also: you get a #to_s, for somewhat nicer use in Rails views.
+#
+#   ... helper file ...
+#   def highlight(text)
+#     Albino.new(text, :ruby)
+#   end
+#
+#   ... view file ...
+#   <%= highlight text %>
+#
+# The default lexer is 'text'.  You need to specify a lexer yourself;
+# because we are using STDIN there is no auto-detect.
+#
+# To see all lexers and formatters available, run `pygmentize -L`.
+#
+# Chris Wanstrath // chris@ozmm.org 
+#         GitHub // http://github.com
+#
+require 'open4'
+
+class Albino
+  @@bin = Rails.development? ? 'pygmentize' : '/usr/bin/pygmentize' rescue 'pygmentize'
+
+  def self.bin=(path)
+    @@bin = path
+  end
+
+  def self.colorize(*args)
+    new(*args).colorize
+  end
+
+  def initialize(target, lexer = :text, format = :html)
+    @target  = File.exists?(target) ? File.read(target) : target rescue target
+    @options = { :l => lexer, :f => format }
+  end
+
+  def execute(command)
+    pid, stdin, stdout, stderr = Open4.popen4(command)
+    stdin.puts @target
+    stdin.close
+    stdout.read.strip
+  end
+
+  def colorize(options = {})
+    execute @@bin + convert_options(options)
+  end
+  alias_method :to_s, :colorize
+
+  def convert_options(options = {})
+    @options.merge(options).inject('') do |string, (flag, value)|
+      string + " -#{flag} #{value}"
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'rubygems'
+  require 'test/spec'
+  require 'mocha'
+  begin require 'redgreen'; rescue LoadError; end
+
+  context "Albino" do
+    setup do
+      @syntaxer = Albino.new(__FILE__, :ruby)
+    end
+
+    specify "defaults to text" do
+      syntaxer = Albino.new(__FILE__)
+      syntaxer.expects(:execute).with('pygmentize -f html -l text').returns(true)
+      syntaxer.colorize
+    end
+
+    specify "accepts options" do
+      @syntaxer.expects(:execute).with('pygmentize -f html -l ruby').returns(true)
+      @syntaxer.colorize
+    end
+
+    specify "works with strings" do
+      syntaxer = Albino.new('class New; end', :ruby)
+      assert_match %r(highlight), syntaxer.colorize
+    end
+
+    specify "aliases to_s" do
+      assert_equal @syntaxer.colorize, @syntaxer.to_s
+    end
+
+    specify "class method colorize" do
+      assert_equal @syntaxer.colorize, Albino.colorize(__FILE__, :ruby)
+    end
+  end
+end

data/lib/jekyll/blocks.rb

@@ -1,4 +1,5 @@
 module Jekyll
+  
   class Highlight < Liquid::Block
     include Liquid::StandardFilters
     
@@ -8,15 +9,29 @@ module Jekyll
     end
   
     def render(context)
-      #The div is required because RDiscount blows ass
+      if Jekyll.pygments
+        render_pygments(context, super.to_s)
+      else
+        render_codehighlighter(context, super.to_s)
+      end
+    end
+    
+    def render_pygments(context, code)
+      "<notextile>" + Albino.new(code, @lang).to_s + "</notextile>"
+    end
+    
+    def render_codehighlighter(context, code)
+    #The div is required because RDiscount blows ass
       <<-HTML
 <div>
   <pre>
-    <code class='#{@lang}'>#{h(super.to_s).strip}</code>
+    <code class='#{@lang}'>#{h(code).strip}</code>
   </pre>
 </div>
       HTML
-    end    
+    end
   end
+  
 end
+
 Liquid::Template.register_tag('highlight', Jekyll::Highlight)

data/lib/jekyll/convertible.rb

@@ -34,7 +34,7 @@ module Jekyll
       end
     end
     
-    # Add any necessary layouts to this post
+    # Add any necessary layouts to this convertible document
     #   +layouts+ is a Hash of {"name" => "layout"}
     #   +site_payload+ is the site payload hash
     #
@@ -42,7 +42,6 @@ module Jekyll
     def do_layout(payload, layouts, site_payload)
       # construct payload
       payload = payload.merge(site_payload)
-      
       # render content
       self.content = Liquid::Template.parse(self.content).render(payload, [Jekyll::Filters])
       self.transform
@@ -60,4 +59,4 @@ module Jekyll
       end
     end
   end
-end
+end

data/lib/jekyll/page.rb

@@ -9,7 +9,7 @@ module Jekyll
     # 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 post file
+    #   +name+ is the String filename of the file
     #
     # Returns <Page>
     def initialize(base, dir, name)
@@ -24,8 +24,8 @@ module Jekyll
       #self.transform
     end
     
-    # Extract information from the post filename
-    #   +name+ is the String filename of the post file
+    # Extract information from the page filename
+    #   +name+ is the String filename of the page file
     #
     # Returns nothing
     def process(name)

data/lib/jekyll/post.rb

@@ -96,16 +96,22 @@ module Jekyll
     #
     # Returns [<Post>]
     def related_posts(posts)
-      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
+      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]
+        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
@@ -145,4 +151,4 @@ module Jekyll
     end
   end
 
-end
+end

data/lib/jekyll/site.rb

@@ -54,7 +54,7 @@ module Jekyll
       base = File.join(self.source, "_posts")
       entries = Dir.entries(base)
       entries = entries.reject { |e| File.directory?(e) }
-      
+
       entries.each do |f|
         self.posts << Post.new(base, f) if Post.valid?(f)
       end
@@ -74,26 +74,31 @@ module Jekyll
       end
     end
     
-    # Recursively transform and write all non-post pages to <dest>/
-    #   +dir+ is the String path part representing the path from
-    #         <source> to the currently processing dir (default '')
+    # Copy all regular files from <source> to <dest>/ ignoring
+    # any files/directories that are hidden (start with ".") or contain
+    # site content (start with "_")
+    #   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| ['.', '_'].include?(e[0..0]) }
-      
+
       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 the file appears to have a YAML header then process it as a page
           if first3 == "---"
             page = Page.new(self.source, dir, f)
             page.add_layout(self.layouts, site_payload)
             page.write(self.dest)
+          # otherwise copy the file without transforming it
           else
             FileUtils.mkdir_p(File.join(self.dest, dir))
             FileUtils.cp(File.join(self.source, dir, f), File.join(self.dest, dir, f))
@@ -110,4 +115,4 @@ module Jekyll
     end
   end
 
-end
+end

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

@@ -1,6 +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
+end

data/test/test_post.rb

@@ -56,7 +56,7 @@ class TestPost < Test::Unit::TestCase
     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\n\n\t<p>Best <strong>post</strong> ever</p>", p.content
+    assert_equal "<h1>{{ page.title }}</h1>\n<p>Best <strong>post</strong> ever</p>", p.content
   end
   
   def test_add_layout
@@ -64,7 +64,7 @@ class TestPost < Test::Unit::TestCase
     layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
     p.add_layout(layouts, {"site" => {"posts" => []}})
     
-    assert_equal "<<< <h1>Foo Bar</h1>\n\n\n\t<p>Best <strong>post</strong> ever</p> >>>", p.output
+    assert_equal "<<< <h1>Foo Bar</h1>\n<p>Best <strong>post</strong> ever</p> >>>", p.output
   end
   
   def test_write
@@ -81,6 +81,6 @@ class TestPost < Test::Unit::TestCase
     layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
     p.add_layout(layouts, {"site" => {"posts" => []}})
     
-    assert_equal "<<< <p>url: /2008/11/21/complex.html\ndate: Fri Nov 21 00:00:00 -0800 2008\nid: /2008/11/21/complex</p> >>>", p.output
+    assert_equal "<<< <p>url: /2008/11/21/complex.html<br />\ndate: Fri Nov 21 00:00:00 -0800 2008<br />\nid: /2008/11/21/complex</p> >>>", p.output
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jekyll
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-08 00:00:00 -08:00
+date: 2008-12-12 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -90,11 +100,12 @@ files:
 - bin/jekyll
 - jekyll.gemspec
 - lib/jekyll.rb
-- lib/jekyll/convertible.rb
+- lib/jekyll/albino.rb
+- lib/jekyll/blocks.rb
 - lib/jekyll/converters/csv.rb
 - lib/jekyll/converters/mephisto.rb
+- lib/jekyll/convertible.rb
 - lib/jekyll/filters.rb
-- lib/jekyll/blocks.rb
 - lib/jekyll/layout.rb
 - lib/jekyll/page.rb
 - lib/jekyll/post.rb
@@ -106,6 +117,7 @@ files:
 - test/source/_posts/2008-11-21-complex.textile
 - test/source/css/screen.css
 - test/source/index.html
+- test/source/posts/2008-12-03-permalinked-post.textile
 - test/suite.rb
 - test/test_jekyll.rb
 - test/test_post.rb