Module: Webby::Helpers::CodeRayHelper

Defined in:
lib/webby/helpers/coderay_helper.rb

Instance Method Summary collapse

Instance Method Details

#coderay(*args, &block) ⇒ Object

The coderay method applies syntax highlighting to source code embedded in a webpage. The CodeRay highlighting engine is used for the HTML markup of the source code. The page sections to be highlighted are given as blocks of text to the coderay method.

Options can be passed to the CodeRay engine via attributes in the coderay method.

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

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



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
 
# File 'lib/webby/helpers/coderay_helper.rb', line 55

def coderay( *args, &block )
  opts = args.last.instance_of?(Hash) ? args.pop : {}

  text = capture_erb(&block)
  return if text.empty?

  defaults = ::Webby.site.coderay
  lang = opts.getopt(:lang, defaults.lang).to_sym

  cr_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|
    key = key.to_sym
    val = opts.getopt(key, defaults[key])
    next if val.nil?
    cr_opts[key] = val.send(convert)
  end

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

  # put some guards around the output (specifically for textile)
  out = _guard(out)

  concat_erb(out, block.binding)
  return
end