Module: ReVIEW::HTMLUtils

Included in:
HTMLBuilder, IDGXMLBuilder, MARKDOWNBuilder, WEBTOCPrinter
Defined in:
lib/review/htmlutils.rb

Instance Method Summary collapse

Instance Method Details

#escape(str) ⇒ Object Also known as: escape_html, h 



18
19
20
 
# File 'lib/review/htmlutils.rb', line 18

def escape(str)
  CGI.escapeHTML(str)
end

#escape_comment(str) ⇒ Object 



36
37
38
 
# File 'lib/review/htmlutils.rb', line 36

def escape_comment(str)
  str.gsub('-', '-')
end

#highlight(ops) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/review/htmlutils.rb', line 45

def highlight(ops)
  if @book.config['pygments'].present?
    raise ReVIEW::ConfigError, %Q('pygments:' in config.yml is obsoleted.)
  end
  return ops[:body].to_s unless highlight?

  if @book.config['highlight']['html'] == 'pygments'
    highlight_pygments(ops)
  elsif @book.config['highlight']['html'] == 'rouge'
    highlight_rouge(ops)
  else
    raise ReVIEW::ConfigError, "unknown highlight method #{@book.config['highlight']['html']} in config.yml."
  end
end

#highlight? ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
43
 
# File 'lib/review/htmlutils.rb', line 40

def highlight?
  @book.config['highlight'] &&
    @book.config['highlight']['html']
end

#highlight_pygments(ops) ⇒ Object 



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
 
# File 'lib/review/htmlutils.rb', line 60

def highlight_pygments(ops)
  body = ops[:body] || ''
  format = ops[:format] || ''
  lexer = if ops[:lexer].present?
            ops[:lexer]
          elsif @book.config['highlight'] && @book.config['highlight']['lang']
            @book.config['highlight']['lang'] # default setting
          else
            'text'
          end
  options = { nowrap: true, noclasses: true }
  if ops[:linenum]
    options[:nowrap] = false
    options[:linenos] = 'inline'
  end
  if ops[:options] && ops[:options].is_a?(Hash)
    options.merge!(ops[:options])
  end

  begin
    require 'pygments'
    begin
      Pygments.highlight(body,
                         options: options,
                         formatter: format,
                         lexer: lexer)
    rescue MentosError
      body
    end
  rescue LoadError
    body
  end
end

#highlight_rouge(ops) ⇒ Object 



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
122
123
124
125
126
127
128
129
 
# File 'lib/review/htmlutils.rb', line 94

def highlight_rouge(ops)
  body = ops[:body] || ''
  lexer = if ops[:lexer].present?
            ops[:lexer]
          elsif @book.config['highlight'] && @book.config['highlight']['lang']
            @book.config['highlight']['lang'] # default setting
          else
            'text'
          end
  # format = ops[:format] || ''

  first_line_num = 1 ## default
  if ops[:options] && ops[:options][:linenostart]
    first_line_num = ops[:options][:linenostart]
  end

  require 'rouge'
  lexer = Rouge::Lexer.find(lexer)

  unless lexer
    return body
  end

  formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
  if ops[:linenum]
    formatter = Rouge::Formatters::HTMLTable.new(formatter,
                                                 table_class: 'highlight rouge-table',
                                                 start_line: first_line_num)
  end

  unless formatter
    return body
  end

  formatter.format(lexer.lex(body))
end

#normalize_id(id) ⇒ Object 



131
132
133
134
135
136
137
138
139
 
# File 'lib/review/htmlutils.rb', line 131

def normalize_id(id)
  if /\A[a-z][a-z0-9_.-]*\Z/i.match?(id)
    id
  elsif /\A[0-9_.-][a-z0-9_.-]*\Z/i.match?(id)
    "id_#{id}" # dummy prefix
  else
    "id_#{CGI.escape(id.gsub('_', '__')).tr('%', '_').tr('+', '-')}" # escape all
  end
end

#strip_html(str) ⇒ Object 



32
33
34
 
# File 'lib/review/htmlutils.rb', line 32

def strip_html(str)
  str.gsub(%r{</?[^>]*>}, '')
end

#unescape(str) ⇒ Object Also known as: unescape_html 



25
26
27
28
 
# File 'lib/review/htmlutils.rb', line 25

def unescape(str)
  # FIXME: better code
  str.gsub('&quot;', '"').gsub('&gt;', '>').gsub('&lt;', '<').gsub('&amp;', '&')
end