moparisthebest/android.moparisthebest.org
1
0
Fork 0
mirror of https://github.com/moparisthebest/android.moparisthebest.org synced 2024-12-24 16:38:49 -05:00
Code Issues Releases Wiki Activity

Improvements to Code embedding features

Browse Source 
1. Removed lots of duplication
2. Added warnings and fixed some dim regex
3. New: set a start line number for any code snippet
4. New: set a start, end, or range for include_code
5. New: added option to disable line numbers linenos:false

Closes #478 Closes #484
This commit is contained in:
Brandon Mathis 2012-05-27 02:14:37 -05:00
parent 0b088433ca
commit 5c9a470515
5 changed files with 132 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
plugins/backtick_code_block.rb
View File

@ -5,35 +5,28 @@ module BacktickCodeBlock
AllOptions = /([^\s]+)\s+(.+?)(https?:\/\/\S+)\s*(.+)?/i
LangCaption = /([^\s]+)\s*(.+)?/i
def render_code_block(input)
@options = nil
@caption = nil
@lang = nil
@url = nil
@title = nil
input.encode!("UTF-8")
input.gsub(/^`{3} *([^\n]+)?\n([\S\s]+?)\n`{3}/m) do
@options = $1 || ''
str = $2
if @options =~ AllOptions
@lang = $1
@caption = "<figcaption><span>#{$2}</span><a href='#{$3}'>#{$4 || 'link'}</a></figcaption>"
elsif @options =~ LangCaption
@lang = $1
@caption = "<figcaption><span>#{$2}</span></figcaption>"
end
if @lang.nil? || @lang == 'plain'
code = tableize_code(str.gsub('<','&lt;').gsub('>','&gt;'))
"<figure class='code'>#{@caption}#{code}</figure>"
else
if @lang.include? "-raw"
raw = "``` #{@options.sub('-raw', '')}\n"
raw += str
raw += "\n```\n"
input.gsub /^`{3}(.+?)`{3}/m do
str = $1.to_s
linenos = true
start = 1
str.gsub /([^\n]+)?\n(.+?)\Z/m do
@options = $1 || ''
code = $2.to_s
if @options =~ /\s*linenos:false/i
linenos = false
@options = @options.sub(/\s*linenos:false/i,'')
end
if @options =~ /\s*start:(\d+)/i
start = $1.to_i
@options = @options.sub(/\s*start:\d+/i,'')
end
if @options =~ AllOptions
highlight(code, $1, {caption: $2, url: $3, anchor: $4 || 'Link', linenos: linenos, start: start})
elsif @options =~ LangCaption
highlight(code, $1, {caption: $2 || '', linenos: linenos, start: start})
else
code = highlight(str, @lang)
"<figure class='code'>#{@caption}#{code}</figure>"
highlight(code, 'plain', {linenos: linenos, start: start})
end
end
end

52
plugins/code_block.rb
View File

@ -48,48 +48,44 @@ module Jekyll
class CodeBlock < Liquid::Block
include HighlightCode
include TemplateWrapper
CaptionUrlTitle = /(\S[\S\s]*)\s+(https?:\/\/)(\S+)\s+(.+)/i
CaptionUrl = /(\S[\S\s]*)\s+(https?:\/\/)(\S+)/i
Caption = /(\S[\S\s]*)/
def initialize(tag_name, markup, tokens)
@title = nil
@caption = nil
@filetype = nil
@highlight = true
@url = nil
@lang = nil
@start = 1
if markup =~ /\s*lang:(\w+)/i
@filetype = $1
@lang = $1
markup = markup.sub(/lang:\w+/i,'')
end
if markup =~ CaptionUrlTitle
@file = $1
@caption = "<figcaption><span>#{$1}</span><a href='#{$2 + $3}'>#{$4}</a></figcaption>"
elsif markup =~ CaptionUrl
@file = $1
@caption = "<figcaption><span>#{$1}</span><a href='#{$2 + $3}'>link</a></figcaption>"
elsif markup =~ Caption
@file = $1
@caption = "<figcaption><span>#{$1}</span></figcaption>\n"
if markup =~ /\s*start:(\d+)/i
@start = $1.to_i
markup = markup.sub(/\s*start:\d+/i,'')
end
if @file =~ /\S[\S\s]*\w+\.(\w+)/ && @filetype.nil?
@filetype = $1
if markup =~ CaptionUrlTitle
@caption = $1
@url = $2 + $3
@anchor = $4
elsif markup =~ CaptionUrl
@caption = $1
@url = $2 + $3
elsif markup =~ Caption
@caption = $1
end
if @caption =~ /\S[\S\s]*\w+\.(\w+)/ && @lang.nil?
@lang = $1
end
super
end
def render(context)
code = super
source = "<figure class='code'>"
source += @caption if @caption
if @filetype
source += " #{highlight(code, @filetype)}</figure>"
else
source += "#{tableize_code(code.lstrip.rstrip.gsub(/</,'&lt;'))}</figure>"
end
source = safe_wrap(source)
source = context['pygments_prefix'] + source if context['pygments_prefix']
source = source + context['pygments_suffix'] if context['pygments_suffix']
source
code = super.strip
code = highlight(code, @lang, {caption: @caption, url: @url, anchor: @anchor, start: @start})
code = context['pygments_prefix'] + code if context['pygments_prefix']
code = code + context['pygments_suffix'] if context['pygments_suffix']
code
end
end
end

28
plugins/include_code.rb
View File

@ -21,21 +21,34 @@
#
require './plugins/pygments_code'
require './plugins/raw'
require 'pathname'
module Jekyll
class IncludeCodeTag < Liquid::Tag
include HighlightCode
include TemplateWrapper
def initialize(tag_name, markup, tokens)
@title = nil
@file = nil
@start = 1
@end = nil
if markup.strip =~ /\s*lang:(\w+)/i
@filetype = $1
markup = markup.strip.sub(/lang:\w+/i,'')
end
if markup =~ /\s*start:(\d+)/i
@start = $1.to_i
markup = markup.sub(/\s*start:\d+/i,'')
end
if markup =~ /\s*end:(\d+)/i
@end = $1.to_i
markup = markup.sub(/\s*end:\d+/i,'')
end
if markup =~ /\s*range:(\d+),(\d+)/i
@start = $1.to_i
@end = $2.to_i
markup = markup.sub(/\s*range:\d+,\d+/i,'')
end
if markup.strip =~ /(.*)?(\s+|^)(\/*\S+)/i
@title = $1 || nil
@file = $3
@ -58,12 +71,17 @@ module Jekyll
Dir.chdir(code_path) do
code = file.read
length = code.lines.count
@end ||= length
return "#{file} is #{length} lines long, cannot begin at line #{@start}" if @start > length
return "#{file} is #{length} lines long, cannot read beyond line #{@end}" if @end > length
if @start > 1 or @end < length
code = code.split(/\n/).slice(@start -1, @end + 1 - @start).join("\n")
end
@filetype = file.extname.sub('.','') if @filetype.nil?
title = @title ? "#{@title} (#{file.basename})" : file.basename
url = "/#{code_dir}/#{@file}"
source = "<figure class='code'><figcaption><span>#{title}</span> <a href='#{url}'>download</a></figcaption>\n"
source += " #{highlight(code, @filetype)}</figure>"
safe_wrap(source)
highlight(code, @filetype, {caption: title, url: url, anchor: 'download', start: @start})
end
end
end

2
plugins/octopress_filters.rb
View File

@ -9,10 +9,10 @@ module OctopressFilters
include BacktickCodeBlock
include TemplateWrapper
def pre_filter(input)
input = render_code_block(input)
input.gsub /(<figure.+?>.+?<\/figure>)/m do
safe_wrap($1)
end
input = render_code_block(input)
end
def post_filter(input)
input = unwrap(input)

82
plugins/pygments_code.rb
View File

@ -1,3 +1,5 @@
#require 'albino'
require './plugins/raw'
require 'pygments'
require 'fileutils'
require 'digest/md5'
@ -6,33 +8,77 @@ PYGMENTS_CACHE_DIR = File.expand_path('../../.pygments-cache', __FILE__)
FileUtils.mkdir_p(PYGMENTS_CACHE_DIR)
module HighlightCode
def highlight(str, lang)
lang = 'ruby' if lang == 'ru'
lang = 'objc' if lang == 'm'
lang = 'perl' if lang == 'pl'
lang = 'yaml' if lang == 'yml'
str = pygments(str, lang).match(/<pre>(.+)<\/pre>/m)[1].to_s.gsub(/ *$/, '') #strip out divs <div class="highlight">
tableize_code(str, lang)
end
include TemplateWrapper
def pygments(code, lang)
path = File.join(PYGMENTS_CACHE_DIR, "#{lang}-#{Digest::MD5.hexdigest(code)}.html") if defined?(PYGMENTS_CACHE_DIR)
if File.exist?(path)
highlighted_code = File.read(path)
else
highlighted_code = Pygments.highlight(code, :lexer => lang, :formatter => 'html', :options => {:encoding => 'utf-8'})
#highlighted_code = Albino.new(code, lang, :html)
highlighted_code = Pygments.highlight(code, :lexer => lang, :formatter => 'html', :options => {:encoding => 'utf-8'})
File.open(path, 'w') {|f| f.print(highlighted_code) } if path
end
highlighted_code
highlighted_code.to_s
rescue
puts $!,$@
end
def tableize_code (str, lang = '')
table = '<div class="highlight"><table><tr><td class="gutter"><pre class="line-numbers">'
code = ''
str.lines.each_with_index do |line,index|
table += "<span class='line-number'>#{index+1}</span>\n"
code += "<span class='line'>#{line}</span>"
def highlight(code, lang, options = {})
lang = 'ruby' if lang == 'ru'
lang = 'objc' if lang == 'm'
lang = 'perl' if lang == 'pl'
lang = 'yaml' if lang == 'yml'
lang = 'coffeescript' if lang == 'coffee'
lang = 'plain' if lang == '' or lang.nil?
caption = options[:caption] || nil
url = options[:url] || nil
anchor = options[:anchor] || nil
wrap = options[:wrap] || true
linenos = options[:linenos]
start = options[:start]
if lang == 'plain'
# Escape html tags
code = code.gsub('<','&lt;').gsub('>','&gt;')
elsif lang.include? "-raw"
output = "``` #{$1.sub('-raw', '')}\n"
output += code
output += "\n```\n"
else
code = pygments(code, lang).match(/<pre>(.+)<\/pre>/m)[1].gsub(/ *$/, '') #strip out divs <div class="highlight">
end
table += "</pre></td><td class='code'><pre><code class='#{lang}'>#{code}</code></pre></td></tr></table></div>"
code = tableize_code(code, lang, { linenos: linenos, start: start })
caption = captionize(caption, url, anchor) if caption
figure = "<figure class='code'>#{caption}#{code}</figure>"
figure = safe_wrap(figure) if wrap
figure
end
def captionize (caption, url, anchor)
figcaption = "<figcaption><span>#{caption}</span>"
figcaption += "<a href='#{url}' title='Download code'> #{anchor || 'link'}</a>" if url
figcaption += "</figcaption>"
end
def tableize_code (code, lang, options = {})
start = options[:start]
lines = options[:linenos] || true
table = "<div class='highlight'><table>"
table += number_lines(start, code.lines.count) if lines
table += "<td class='code'><pre><code class='#{lang}'>"
table += code.gsub /^((.+)?(\n?))/, '<span class=\'line\'>\1</span>'
table +="</code></pre></td></tr></table></div>"
end
def number_lines (start, count)
start ||= 1
lines = "<td class='gutter'><pre class='line-numbers'>"
count.times do |index|
lines += "<span class='line-number'>#{index + start}</span>\n"
end
lines += "</pre></td>"
end
end