2018-07-23 10:05:22 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2018-03-07 12:14:41 +00:00
|
|
|
require 'rouge/plugins/common_mark'
|
2015-08-27 20:09:01 +00:00
|
|
|
|
2019-01-23 11:21:12 +00:00
|
|
|
# Generated HTML is transformed back to GFM by app/assets/javascripts/behaviors/markdown/nodes/code_block.js
|
2015-12-15 14:51:16 +00:00
|
|
|
module Banzai
|
|
|
|
module Filter
|
2015-08-27 20:09:01 +00:00
|
|
|
# HTML Filter to highlight fenced code blocks
|
|
|
|
#
|
|
|
|
class SyntaxHighlightFilter < HTML::Pipeline::Filter
|
|
|
|
def call
|
|
|
|
doc.search('pre > code').each do |node|
|
|
|
|
highlight_node(node)
|
|
|
|
end
|
|
|
|
|
|
|
|
doc
|
|
|
|
end
|
|
|
|
|
|
|
|
def highlight_node(node)
|
2018-07-23 10:05:22 +00:00
|
|
|
css_classes = +'code highlight js-syntax-highlight'
|
2018-01-31 21:48:18 +00:00
|
|
|
lang = node.attr('lang')
|
|
|
|
retried = false
|
2017-11-22 03:12:04 +00:00
|
|
|
|
2018-01-31 21:48:18 +00:00
|
|
|
if use_rouge?(lang)
|
|
|
|
lexer = lexer_for(lang)
|
2017-11-22 03:12:04 +00:00
|
|
|
language = lexer.tag
|
2018-01-31 21:48:18 +00:00
|
|
|
else
|
|
|
|
lexer = Rouge::Lexers::PlainText.new
|
|
|
|
language = lang
|
|
|
|
end
|
|
|
|
|
|
|
|
begin
|
|
|
|
code = Rouge::Formatters::HTMLGitlab.format(lex(lexer, node.text), tag: language)
|
|
|
|
css_classes << " #{language}" if language
|
|
|
|
rescue
|
|
|
|
# Gracefully handle syntax highlighter bugs/errors to ensure users can
|
|
|
|
# still access an issue/comment/etc. First, retry with the plain text
|
|
|
|
# filter. If that fails, then just skip this entirely, but that would
|
|
|
|
# be a pretty bad upstream bug.
|
|
|
|
return if retried
|
2017-11-22 03:12:04 +00:00
|
|
|
|
2018-01-31 21:48:18 +00:00
|
|
|
language = nil
|
|
|
|
lexer = Rouge::Lexers::PlainText.new
|
|
|
|
retried = true
|
2017-11-22 03:12:04 +00:00
|
|
|
|
2018-01-31 21:48:18 +00:00
|
|
|
retry
|
2015-09-10 15:23:10 +00:00
|
|
|
end
|
2015-08-27 20:09:01 +00:00
|
|
|
|
2017-11-22 03:12:04 +00:00
|
|
|
highlighted = %(<pre class="#{css_classes}" lang="#{language}" v-pre="true"><code>#{code}</code></pre>)
|
2016-07-16 01:22:35 +00:00
|
|
|
|
2016-07-01 09:16:48 +00:00
|
|
|
# Extracted to a method to measure it
|
|
|
|
replace_parent_pre_element(node, highlighted)
|
2015-08-27 20:09:01 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
2016-08-03 14:52:08 +00:00
|
|
|
# Separate method so it can be instrumented.
|
|
|
|
def lex(lexer, code)
|
|
|
|
lexer.lex(code)
|
|
|
|
end
|
|
|
|
|
|
|
|
def lexer_for(language)
|
|
|
|
(Rouge::Lexer.find(language) || Rouge::Lexers::PlainText).new
|
|
|
|
end
|
|
|
|
|
2016-07-01 09:16:48 +00:00
|
|
|
def replace_parent_pre_element(node, highlighted)
|
|
|
|
# Replace the parent `pre` element with the entire highlighted block
|
|
|
|
node.parent.replace(highlighted)
|
|
|
|
end
|
2017-11-22 03:12:04 +00:00
|
|
|
|
|
|
|
def use_rouge?(language)
|
2018-12-13 19:17:19 +00:00
|
|
|
%w(math mermaid plantuml suggestion).exclude?(language)
|
2017-11-22 03:12:04 +00:00
|
|
|
end
|
2015-08-27 20:09:01 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|