Class: Gollum::Filter::Code

Inherits:
Gollum::Filter show all
Defined in:
lib/gollum-lib/filter/code.rb

Overview

Code

Render a block of code using the Rouge syntax-highlighter.

Instance Method Summary collapse

Methods inherited from Gollum::Filter

#initialize

Methods included from Helpers

#trim_leading_slash

Constructor Details

This class inherits a constructor from Gollum::Filter

Instance Method Details

#extract(data) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/gollum-lib/filter/code.rb', line 7

def extract(data)
  case @markup.format
  when :txt
    return data
  when :asciidoc
    data.gsub!(/^(\[source,([^\r\n]*)\]\n)?----\n(.+?)\n----$/m) do
      cache_codeblock(Regexp.last_match[2], Regexp.last_match[3])
    end
  when :org
    org_headers = %r{([ \t]*#\+HEADER[S]?:[^\r\n]*\n)*}
    org_name = %r{([ \t]*#\+NAME:[^\r\n]*\n)?}
    org_lang = %r{[ ]*([^\n \r]*)[ ]*[^\r\n]*}
    org_begin = %r{[ \t]*#\+BEGIN_SRC#{org_lang}\n}
    org_end = %r{\n[ \t]*#\+END_SRC[ \t]*}
    data.gsub!(/^#{org_headers}#{org_name}#{org_begin}(.+?)#{org_end}$/mi) do
      cache_codeblock(Regexp.last_match[3], Regexp.last_match[4])
    end
  when :markdown
    data.gsub!(/^([ \t]*)(~~~+) ?([^\r\n]+)?\r?\n(.+?)\r?\n\1(~~~+)[ \t\r]*$/m) do
      m_indent = Regexp.last_match[1]
      m_start  = Regexp.last_match[2] # ~~~
      m_lang   = Regexp.last_match[3]
      m_code   = Regexp.last_match[4]
      m_end    = Regexp.last_match[5] # ~~~
      # start and finish tilde fence must be the same length
      next '' if m_start.length != m_end.length
      lang = m_lang ? m_lang.strip : nil
      if lang
        lang = lang.match(/\.([^}\s]+)/)
        lang = lang[1] unless lang.nil?
      end
      "#{m_indent}#{cache_codeblock(lang, m_code, m_indent)}"
    end  
  end
  

  data.gsub!(/^([ \t]*)``` ?([^\r\n]+)?\r?\n(.+?)\r?\n\1```[ \t]*\r?$/m) do
    "#{Regexp.last_match[1]}#{cache_codeblock(Regexp.last_match[2].to_s.strip, Regexp.last_match[3], Regexp.last_match[1])}" # print the SHA1 ID with the proper indentation
  end
  data
end

#process(data) ⇒ Object

Process all code from the codemap and replace the placeholders with the final HTML.

data - The String data (with placeholders). encoding - Encoding Constant or String.

Returns the marked up String data.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/gollum-lib/filter/code.rb', line 56

def process(data)
  return data if data.nil? || data.size.zero? || @map.size.zero?

  blocks = []

  @map.each do |_id, spec|
    next if spec[:output] # cached

    code = spec[:code]

    remove_leading_space(code, /^#{spec[:indent]}/m)
    remove_leading_space(code, /^(  |\t)/m)

    blocks << [spec[:lang], code]
  end

  highlighted = []
  blocks.each do |lang, code|
    encoding = @markup.encoding || 'utf-8'

    if defined? Pygments
      # Set the default lexer to 'text' to prevent #153 and #154
      lang = lang || 'text'
      lexer = Pygments::Lexer[(lang)] || Pygments::Lexer['text']

      # must set startinline to true for php to be highlighted without <?
      hl_code = lexer.highlight(code, :options => { :encoding => encoding.to_s, :startinline => true })
    else # Rouge
      begin
        # if `lang` was not defined then assume plaintext
        lexer = Rouge::Lexer.find_fancy(lang || 'plaintext')
        formatter = Rouge::Formatters::HTML.new
        wrap_template = '<pre class="highlight"><code>%s</code></pre>'

        # if `lang` is defined but cannot be found then wrap it with an error
        if lexer.nil?
          lexer = Rouge::Lexers::PlainText
          wrap_template = '<pre class="highlight"><span class="err">%s</span></pre>'
        end

        formatted = formatter.format(lexer.lex(code))

        hl_code = Kernel.sprintf(wrap_template, formatted)
      rescue
        hl_code = code
      end
    end

    highlighted << hl_code
  end

  @map.each do |id, spec|
    body = spec[:output] || begin
      if (body = highlighted.shift.to_s).size > 0
        @markup.update_cache(:code, id, body)
        body
      else
        "<pre><code>#{CGI.escapeHTML(spec[:code])}</code></pre>"
      end
    end
    # Removes paragraph tags surrounding <pre> blocks, see issue https://github.com/gollum/gollum-lib/issues/97
    data.gsub!(/(<p>#{id}<\/p>|#{id})/) { body }
  end

  data
end