Skip to content

Commit

Permalink
support Rouge (#684)
Browse files Browse the repository at this point in the history 
* use classes instead of inline style attributes
* support rouge in CSS
* support //firstlinenum
  • Loading branch information
@takahashim
takahashim authored Dec 30, 2016
1 parent e33e856 commit 992c9b9
Show file tree
Hide file tree
Showing 8 changed files with 574 additions and 13 deletions.
4 changes: 2 additions & 2 deletions doc/config.yml.sample
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,9 @@ secnolevel: 2
# fontdir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
# font_ext: ["ttf", "woff", "otf"]

# ソースコードハイライトを利用する (pygmentsには外部gemが必要)
# ソースコードハイライトを利用する (rouge,pygmentsには外部gemが必要)
# highlight:
# html: "pygments"
# html: "rouge"
# latex: "listings"

# カタログファイル名を指定する
Expand Down
2 changes: 1 addition & 1 deletion doc/config.yml.sample-simple
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ colophon: true
## Syntax Highlighting

highlight:
html: "pygments"
html: "rouge"
latex: "listings"

## for HTML
Expand Down
214 changes: 214 additions & 0 deletions doc/sample.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,220 @@ p.flushright {
text-align: right;
}

/**
* from Rouge
*/
.highlight table td { padding: 5px; }
.highlight table pre { margin: 0; }
.highlight .cm {
color: #999988;
font-style: italic;
}
.highlight .cp {
color: #999999;
font-weight: bold;
}
.highlight .c1 {
color: #999988;
font-style: italic;
}
.highlight .cs {
color: #999999;
font-weight: bold;
font-style: italic;
}
.highlight .c, .highlight .cd {
color: #999988;
font-style: italic;
}
.highlight .err {
color: #a61717;
background-color: #e3d2d2;
}
.highlight .gd {
color: #000000;
background-color: #ffdddd;
}
.highlight .ge {
color: #000000;
font-style: italic;
}
.highlight .gr {
color: #aa0000;
}
.highlight .gh {
color: #999999;
}
.highlight .gi {
color: #000000;
background-color: #ddffdd;
}
.highlight .go {
color: #888888;
}
.highlight .gp {
color: #555555;
}
.highlight .gs {
font-weight: bold;
}
.highlight .gu {
color: #aaaaaa;
}
.highlight .gt {
color: #aa0000;
}
.highlight .kc {
color: #000000;
font-weight: bold;
}
.highlight .kd {
color: #000000;
font-weight: bold;
}
.highlight .kn {
color: #000000;
font-weight: bold;
}
.highlight .kp {
color: #000000;
font-weight: bold;
}
.highlight .kr {
color: #000000;
font-weight: bold;
}
.highlight .kt {
color: #445588;
font-weight: bold;
}
.highlight .k, .highlight .kv {
color: #000000;
font-weight: bold;
}
.highlight .mf {
color: #009999;
}
.highlight .mh {
color: #009999;
}
.highlight .il {
color: #009999;
}
.highlight .mi {
color: #009999;
}
.highlight .mo {
color: #009999;
}
.highlight .m, .highlight .mb, .highlight .mx {
color: #009999;
}
.highlight .sb {
color: #d14;
}
.highlight .sc {
color: #d14;
}
.highlight .sd {
color: #d14;
}
.highlight .s2 {
color: #d14;
}
.highlight .se {
color: #d14;
}
.highlight .sh {
color: #d14;
}
.highlight .si {
color: #d14;
}
.highlight .sx {
color: #d14;
}
.highlight .sr {
color: #009926;
}
.highlight .s1 {
color: #d14;
}
.highlight .ss {
color: #990073;
}
.highlight .s {
color: #d14;
}
.highlight .na {
color: #008080;
}
.highlight .bp {
color: #999999;
}
.highlight .nb {
color: #0086B3;
}
.highlight .nc {
color: #445588;
font-weight: bold;
}
.highlight .no {
color: #008080;
}
.highlight .nd {
color: #3c5d5d;
font-weight: bold;
}
.highlight .ni {
color: #800080;
}
.highlight .ne {
color: #990000;
font-weight: bold;
}
.highlight .nf {
color: #990000;
font-weight: bold;
}
.highlight .nl {
color: #990000;
font-weight: bold;
}
.highlight .nn {
color: #555555;
}
.highlight .nt {
color: #000080;
}
.highlight .vc {
color: #008080;
}
.highlight .vg {
color: #008080;
}
.highlight .vi {
color: #008080;
}
.highlight .nv {
color: #008080;
}
.highlight .ow {
color: #000000;
font-weight: bold;
}
.highlight .o {
color: #000000;
font-weight: bold;
}
.highlight .w {
color: #bbbbbb;
}
.highlight {
background-color: #f8f8f8;
}
.rouge-table { border-spacing: 0 }
.rouge-gutter { text-align: right }

/**
* from EBPAJ EPUB 3 File Creation Guide sample style
Expand Down
12 changes: 8 additions & 4 deletions lib/review/htmlbuilder.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,7 @@ def list_body(id, lines, lang)
class_names = ["list"]
lexer = lang || File.extname(id).gsub(/\./, '')
class_names.push("language-#{lexer}") unless lexer.blank?
class_names.push("highlight") if highlight?
print %Q[<pre class="#{class_names.join(" ")}">]
body = lines.inject(''){|i, j| i + detab(j) + "\n"}
puts highlight(:body => body, :lexer => lexer, :format => 'html')
Expand Down Expand Up @@ -494,11 +495,12 @@ def listnum_body(lines, lang)
body = lines.inject(''){|i, j| i + detab(j) + "\n"}
lexer = lang
first_line_number = get_line_num
puts highlight(:body => body, :lexer => lexer, :format => 'html',
:options => {:linenos => 'inline', :nowrap => false, :linenostart => first_line_number})
puts highlight(:body => body, :lexer => lexer, :format => 'html', :linenum => true,
:options => {:linenostart => first_line_number})
else
class_names = ["list"]
class_names.push("language-#{lang}") unless lang.blank?
class_names.push("highlight") if highlight?
print %Q[<pre class="#{class_names.join(" ")}">]
first_line_num = get_line_num
lines.each_with_index do |line, i|
Expand All @@ -515,6 +517,7 @@ def emlist(lines, caption = nil, lang = nil)
end
class_names = ["emlist"]
class_names.push("language-#{lang}") unless lang.blank?
class_names.push("highlight") if highlight?
print %Q[<pre class="#{class_names.join(" ")}">]
body = lines.inject(''){|i, j| i + detab(j) + "\n"}
lexer = lang
Expand All @@ -533,11 +536,12 @@ def emlistnum(lines, caption = nil, lang = nil)
body = lines.inject(''){|i, j| i + detab(j) + "\n"}
lexer = lang
first_line_number = get_line_num
puts highlight(:body => body, :lexer => lexer, :format => 'html',
:options => {:linenos => 'inline', :nowrap => false, :linenostart => first_line_number})
puts highlight(:body => body, :lexer => lexer, :format => 'html', :linenum => true,
:options => {:linenostart => first_line_number})
else
class_names = ["emlist"]
class_names.push("language-#{lang}") unless lang.blank?
class_names.push("highlight") if highlight?
print %Q[<pre class="#{class_names.join(" ")}">]
first_line_num = get_line_num
lines.each_with_index do |line, i|
Expand Down
50 changes: 48 additions & 2 deletions lib/review/htmlutils.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#

require 'cgi/util'
require 'rouge'
module ReVIEW

module HTMLUtils
Expand Down Expand Up @@ -44,14 +45,25 @@ def escape_comment(str)

def highlight?
@book.config["highlight"] &&
@book.config["highlight"]["html"] == "pygments"
@book.config["highlight"]["html"]
end

def highlight(ops)
if @book.config["pygments"].present?
raise ReVIEW::ConfigError, "'pygments:' in config.yml is obsoleted."
end
return ops[:body].to_s if !highlight?

if @book.config["highlight"]["html"] == "pygments"
highlight_pygments(ops)
elsif @book.config["highlight"]["html"] == "rouge"
highlight_rouge(ops)
else
raise ReVIEW::ConfigError, "unknown highlight method #{@book.config["highlight"]["html"]} in config.yml."
end
end

def highlight_pygments(ops)
body = ops[:body] || ''
if @book.config["highlight"] && @book.config["highlight"]["lang"]
lexer = @book.config["highlight"]["lang"] # default setting
Expand All @@ -61,10 +73,13 @@ def highlight(ops)
lexer = ops[:lexer] if ops[:lexer].present?
format = ops[:format] || ''
options = {:nowrap => true, :noclasses => true}
if ops[:linenum]
options[:nowrap] = false
options[:linenos] = 'inline'
end
if ops[:options] && ops[:options].kind_of?(Hash)
options.merge!(ops[:options])
end
return body if !highlight?

begin
require 'pygments'
Expand All @@ -81,6 +96,37 @@ def highlight(ops)
end
end

def highlight_rouge(ops)
body = ops[:body] || ''
if ops[:lexer].present?
lexer = ops[:lexer]
elsif @book.config["highlight"] && @book.config["highlight"]["lang"]
lexer = @book.config["highlight"]["lang"] # default setting
else
lexer = 'text'
end
format = ops[:format] || ''

first_line_num = 1 ## default
if ops[:options] && ops[:options][:linenostart]
first_line_num = ops[:options][:linenostart]
end

lexer = Rouge::Lexer.find(lexer)
raise "unknown lexer #{lexer}" unless lexer

formatter = Rouge::Formatters::HTML.new(:css_class => 'highlight')
if ops[:linenum]
formatter = Rouge::Formatters::HTMLTable.new(formatter,
:table_class => 'highlight rouge-table',
:start_line => first_line_num)
end
raise "unknown formatter #{formatter}" unless formatter

text = unescape_html(body)
formatter.format(lexer.lex(text))
end

def normalize_id(id)
if id =~ /\A[a-z][a-z0-9_.-]*\Z/i
return id
Expand Down
1 change: 1 addition & 0 deletions review.gemspec
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Gem::Specification.new do |gem|
gem.require_paths = ["lib"]

gem.add_dependency("rubyzip")
gem.add_dependency("rouge")
gem.add_development_dependency("rake")
gem.add_development_dependency("test-unit")
gem.add_development_dependency("pygments.rb")
Expand Down
Loading

0 comments on commit 992c9b9

Please sign in to comment.