use pygments for code highlighting if --pygments is specified

This commit is contained in:
Tom Preston-Werner 2008-12-12 19:58:40 -08:00
parent 1e13d2f91f
commit f00272ea52
5 changed files with 147 additions and 3 deletions

View File

@ -1,4 +1,6 @@
==
* Major Features
* Code highlighting with Pygments if --pygments is specified
* Minor Enhancements
* Output informative message if RDiscount is not available [github.com/JackDanger]
* Bug Fixes

View File

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

View File

@ -28,10 +28,17 @@ require 'jekyll/page'
require 'jekyll/post'
require 'jekyll/filters'
require 'jekyll/blocks'
require 'jekyll/albino'
module Jekyll
VERSION = '0.1.4'
class << self
attr_accessor :pygments
end
Jekyll.pygments = false
def self.process(source, dest)
Jekyll::Site.new(source, dest).process
end

116
lib/jekyll/albino.rb Normal file
View File

@ -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

View File

@ -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)