class Gollum::Filter::Code

Code

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

Public Instance Methods

extract(data) click to toggle source
# 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) click to toggle source

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.

# 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

Private Instance Methods

cache_codeblock(language, code, indent = "") click to toggle source
# File lib/gollum-lib/filter/code.rb, line 136
def cache_codeblock(language, code, indent = "")
  language = language.to_s.empty? ? nil : language
  id = Digest::SHA1.hexdigest("#{language}.#{code}")
  cached = @markup.check_cache(:code, id)
  @map[id] = cached ?
    { :output => cached } :
    { :lang => language, :code => code, :indent => indent }
  id
end
remove_leading_space(code, regex) click to toggle source

Remove the leading space from a code block. Leading space is only removed if every single line in the block has leading whitespace.

code - The code block to remove spaces from regex - A regex to match whitespace

# File lib/gollum-lib/filter/code.rb, line 130
def remove_leading_space(code, regex)
  if code.lines.all? { |line| line =~ /\A\r?\n\Z/ || line =~ regex }
    code.gsub!(regex) { '' }
  end
end