Class: Webby::Filters::CodeRay

Inherits:
Object
  • Object
show all
Defined in:
lib/webby/filters/coderay.rb

Overview

The CodeRay applies syntax highlighting to source code embedded in a webpage. The CodeRay highlighting engine is used for the HTML markup of the source code. A set of <coderay>…</coderay> tags is used to denote which sections of the page should be highlighted.

Options can be passed to the CodeRay engine via attributes in the <coderay> tag.

<coderay lang="ruby" line_numbers="inline">
# Initializer for the class.
def initialize( string )
  @str = stirng
end
</coderay>

The supported CodeRay options are the following:

lang               : the language to highlight (ruby, c, html, ...)
line_numbers       : include line numbers in 'table', 'inline',
                     or 'list'
line_number_start  : where to start with line number counting
bold_every         : make every n-th number appear bold
tab_width          : convert tab characters to n spaces

Instance Method Summary collapse

Constructor Details

#initialize(str, filters = nil) ⇒ CodeRay

call-seq:

CodeRay.new( string, filters = nil )

Creates a new CodeRay filter that will operate on the given string.



41
42
43
44
 
# File 'lib/webby/filters/coderay.rb', line 41

def initialize( str, filters = nil )
  @str = str
  @filters = filters
end

Instance Method Details

#to_html ⇒ Object

call-seq:

to_html    => string

Process the original text string passed to the filter when it was created and output HTML formatted text. Any text between <coderay>…</coderay> tags will have syntax highlighting applied to the text via the CodeRay gem.



54
55
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
 
# File 'lib/webby/filters/coderay.rb', line 54

def to_html
  doc = Hpricot(@str)
  doc.search('//coderay') do |cr|
    text = cr.inner_html.strip
    lang = (cr['lang'] || 'ruby').to_sym

    opts = {}
    %w(line_numbers       to_sym
       line_number_start  to_i
       bold_every         to_i
       tab_width          to_i).each_slice(2) do |key,convert|
      next if cr[key].nil?
      opts[key.to_sym] = cr[key].send(convert)
    end

    #cr.swap(CodeRay.scan(text, lang).html(opts).div)
    out = "<div class=\"CodeRay\"><pre>\n"
    out << ::CodeRay.scan(text, lang).html(opts)
    out << "\n</pre></div>"

    @filters.each do |f|
      case f
      when 'textile'
        out.insert 0, "<notextile>\n"
        out << "\n</notextile>"
      end
    end unless @filters.nil?

    cr.swap out
  end

  doc.to_html
end