<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>module ReVIEW::HTMLUtils - review-2.2.0 Documentation</title>
<script type=“text/javascript”>
var rdoc_rel_prefix = "../"; var index_rel_prefix = "../";
</script>
<script src=“../js/jquery.js”></script> <script src=“../js/darkfish.js”></script>
<link href=“../css/fonts.css” rel=“stylesheet”> <link href=“../css/rdoc.css” rel=“stylesheet”>
<body id=“top” role=“document” class=“module”> <nav role=“navigation”>
<div id="project-navigation"> <div id="home-section" role="region" title="Quick navigation" class="nav-section"> <h2> <a href="../index.html" rel="home">Home</a> </h2> <div id="table-of-contents-navigation"> <a href="../table_of_contents.html#pages">Pages</a> <a href="../table_of_contents.html#classes">Classes</a> <a href="../table_of_contents.html#methods">Methods</a> </div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> <div id="search-field-wrapper"> <input id="search-field" role="combobox" aria-label="Search" aria-autocomplete="list" aria-controls="search-results" type="text" name="search" placeholder="Search" spellcheck="false" title="Type to search, Up and Down to navigate, Enter to load"> </div> <ul id="search-results" aria-label="Search Results" aria-busy="false" aria-expanded="false" aria-atomic="false" class="initially-hidden"></ul> </form>
</div>
</div> <div id="class-metadata"> <!-- Method Quickref -->
<div id=“method-list-section” class=“nav-section”>
<h3>Methods</h3> <ul class="link-list" role="directory"> <li ><a href="#method-i-escape">#escape</a> <li ><a href="#method-i-escape_comment">#escape_comment</a> <li ><a href="#method-i-escape_html">#escape_html</a> <li ><a href="#method-i-h">#h</a> <li ><a href="#method-i-highlight">#highlight</a> <li ><a href="#method-i-highlight-3F">#highlight?</a> <li ><a href="#method-i-highlight_pygments">#highlight_pygments</a> <li ><a href="#method-i-highlight_rouge">#highlight_rouge</a> <li ><a href="#method-i-normalize_id">#normalize_id</a> <li ><a href="#method-i-strip_html">#strip_html</a> <li ><a href="#method-i-unescape">#unescape</a> <li ><a href="#method-i-unescape_html">#unescape_html</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“module-ReVIEW::HTMLUtils”>
<h1 id="module-ReVIEW::HTMLUtils" class="module"> module ReVIEW::HTMLUtils </h1> <section class="description"> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> <dt id="ESC">ESC <dd> </dl> </section> <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> <div id="method-i-escape" class="method-detail method-alias"> <div class="method-heading"> <span class="method-name">escape</span><span class="method-args">(str)</span> </div> <div class="method-description"> </div> <div class="aliases"> Alias for: <a href="HTMLUtils.html#method-i-escape_html">escape_html</a> </div> </div> <div id="method-i-escape_comment" class="method-detail "> <div class="method-heading"> <span class="method-name">escape_comment</span><span class="method-args">(str)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="escape_comment-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 41</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>escape_comment</span>(<span class=“ruby-identifier”>str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'-'</span>, <span class="ruby-string">'&#45;'</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-escape_html" class="method-detail "> <div class="method-heading"> <span class="method-name">escape_html</span><span class="method-args">(str)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="escape_html-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 22</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>escape_html</span>(<span class=“ruby-identifier”>str</span>)
<span class="ruby-identifier">t</span> = <span class="ruby-constant">ESC</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/[&"<>]/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">t</span>[<span class="ruby-identifier">c</span>] }
<span class=“ruby-keyword”>end</span></pre>
</div> </div> <div class="aliases"> Also aliased as: <a href="HTMLUtils.html#method-i-escape">escape</a>, <a href="HTMLUtils.html#method-i-h">h</a> </div> </div> <div id="method-i-h" class="method-detail method-alias"> <div class="method-heading"> <span class="method-name">h</span><span class="method-args">(str)</span> </div> <div class="method-description"> </div> <div class="aliases"> Alias for: <a href="HTMLUtils.html#method-i-escape_html">escape_html</a> </div> </div> <div id="method-i-highlight" class="method-detail "> <div class="method-heading"> <span class="method-name">highlight</span><span class="method-args">(ops)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="highlight-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 50</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>highlight</span>(<span class=“ruby-identifier”>ops</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"pygments"</span>].<span class="ruby-identifier">present?</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">ConfigError</span>, <span class="ruby-string">"'pygments:' in config.yml is obsoleted."</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:body</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">highlight?</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>][<span class="ruby-string">"html"</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"pygments"</span> <span class="ruby-identifier">highlight_pygments</span>(<span class="ruby-identifier">ops</span>) <span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>][<span class="ruby-string">"html"</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"rouge"</span> <span class="ruby-identifier">highlight_rouge</span>(<span class="ruby-identifier">ops</span>) <span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">ConfigError</span>, <span class="ruby-node">"unknown highlight method #{@book.config["highlight"]["html"]} in config.yml."</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-highlight-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">highlight?</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="highlight-3F-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 45</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>highlight?</span>
<span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>] <span class="ruby-operator">&&</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>][<span class="ruby-string">"html"</span>]
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-highlight_pygments" class="method-detail "> <div class="method-heading"> <span class="method-name">highlight_pygments</span><span class="method-args">(ops)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="highlight_pygments-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 65</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>highlight_pygments</span>(<span class=“ruby-identifier”>ops</span>)
<span class="ruby-identifier">body</span> = <span class="ruby-identifier">ops</span>[<span class="ruby-value">:body</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>] <span class="ruby-operator">&&</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>][<span class="ruby-string">"lang"</span>] <span class="ruby-identifier">lexer</span> = <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>][<span class="ruby-string">"lang"</span>] <span class="ruby-comment"># default setting</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">lexer</span> = <span class="ruby-string">'text'</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">lexer</span> = <span class="ruby-identifier">ops</span>[<span class="ruby-value">:lexer</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:lexer</span>].<span class="ruby-identifier">present?</span> <span class="ruby-identifier">format</span> = <span class="ruby-identifier">ops</span>[<span class="ruby-value">:format</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span> <span class="ruby-identifier">options</span> = {<span class="ruby-value">:nowrap</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:noclasses</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>} <span class="ruby-keyword">if</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:linenum</span>] <span class="ruby-identifier">options</span>[<span class="ruby-value">:nowrap</span>] = <span class="ruby-keyword">false</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:linenos</span>] = <span class="ruby-string">'inline'</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:options</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:options</span>].<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">ops</span>[<span class="ruby-value">:options</span>]) <span class="ruby-keyword">end</span> <span class="ruby-keyword">begin</span> <span class="ruby-identifier">require</span> <span class="ruby-string">'pygments'</span> <span class="ruby-keyword">begin</span> <span class="ruby-constant">Pygments</span>.<span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">unescape_html</span>(<span class="ruby-identifier">body</span>), <span class="ruby-value">:options</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>, <span class="ruby-value">:formatter</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">format</span>, <span class="ruby-value">:lexer</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">lexer</span>) <span class="ruby-keyword">rescue</span> <span class="ruby-constant">MentosError</span> <span class="ruby-identifier">body</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">rescue</span> <span class="ruby-constant">LoadError</span> <span class="ruby-identifier">body</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-highlight_rouge" class="method-detail "> <div class="method-heading"> <span class="method-name">highlight_rouge</span><span class="method-args">(ops)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="highlight_rouge-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 98</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>highlight_rouge</span>(<span class=“ruby-identifier”>ops</span>)
<span class="ruby-identifier">body</span> = <span class="ruby-identifier">ops</span>[<span class="ruby-value">:body</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:lexer</span>].<span class="ruby-identifier">present?</span> <span class="ruby-identifier">lexer</span> = <span class="ruby-identifier">ops</span>[<span class="ruby-value">:lexer</span>] <span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>] <span class="ruby-operator">&&</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>][<span class="ruby-string">"lang"</span>] <span class="ruby-identifier">lexer</span> = <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"highlight"</span>][<span class="ruby-string">"lang"</span>] <span class="ruby-comment"># default setting</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">lexer</span> = <span class="ruby-string">'text'</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">format</span> = <span class="ruby-identifier">ops</span>[<span class="ruby-value">:format</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span> <span class="ruby-identifier">first_line_num</span> = <span class="ruby-value">1</span> <span class="ruby-comment">## default</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:options</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:options</span>][<span class="ruby-value">:linenostart</span>] <span class="ruby-identifier">first_line_num</span> = <span class="ruby-identifier">ops</span>[<span class="ruby-value">:options</span>][<span class="ruby-value">:linenostart</span>] <span class="ruby-keyword">end</span> <span class="ruby-identifier">require</span> <span class="ruby-string">'rouge'</span> <span class="ruby-identifier">lexer</span> = <span class="ruby-constant">Rouge</span><span class="ruby-operator">::</span><span class="ruby-constant">Lexer</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">lexer</span>) <span class="ruby-identifier">raise</span> <span class="ruby-node">"unknown lexer #{lexer}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">lexer</span> <span class="ruby-identifier">formatter</span> = <span class="ruby-constant">Rouge</span><span class="ruby-operator">::</span><span class="ruby-constant">Formatters</span><span class="ruby-operator">::</span><span class="ruby-constant">HTML</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:css_class</span> =<span class="ruby-operator">></span> <span class="ruby-string">'highlight'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">ops</span>[<span class="ruby-value">:linenum</span>] <span class="ruby-identifier">formatter</span> = <span class="ruby-constant">Rouge</span><span class="ruby-operator">::</span><span class="ruby-constant">Formatters</span><span class="ruby-operator">::</span><span class="ruby-constant">HTMLTable</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">formatter</span>, <span class="ruby-value">:table_class</span> =<span class="ruby-operator">></span> <span class="ruby-string">'highlight rouge-table'</span>, <span class="ruby-value">:start_line</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">first_line_num</span>) <span class="ruby-keyword">end</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"unknown formatter #{formatter}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">formatter</span> <span class="ruby-identifier">text</span> = <span class="ruby-identifier">unescape_html</span>(<span class="ruby-identifier">body</span>) <span class="ruby-identifier">formatter</span>.<span class="ruby-identifier">format</span>(<span class="ruby-identifier">lexer</span>.<span class="ruby-identifier">lex</span>(<span class="ruby-identifier">text</span>))
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-normalize_id" class="method-detail "> <div class="method-heading"> <span class="method-name">normalize_id</span><span class="method-args">(id)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="normalize_id-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 130</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>normalize_id</span>(<span class=“ruby-identifier”>id</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\A[a-z][a-z0-9_.-]*\Z/i</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">id</span> <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\A[0-9_.-][a-z0-9_.-]*\Z/i</span> <span class="ruby-keyword">return</span> <span class="ruby-node">"id_#{id}"</span> <span class="ruby-comment"># dummy prefix</span> <span class="ruby-keyword">else</span> <span class="ruby-keyword">return</span> <span class="ruby-node">"id_#{CGI.escape(id.gsub("_", "__")).gsub("%", "_").gsub("+", "-")}"</span> <span class="ruby-comment"># escape all</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-strip_html" class="method-detail "> <div class="method-heading"> <span class="method-name">strip_html</span><span class="method-args">(str)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="strip_html-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 37</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>strip_html</span>(<span class=“ruby-identifier”>str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/<\/?[^>]*>/</span>, <span class="ruby-string">""</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-unescape" class="method-detail method-alias"> <div class="method-heading"> <span class="method-name">unescape</span><span class="method-args">(str)</span> </div> <div class="method-description"> </div> <div class="aliases"> Alias for: <a href="HTMLUtils.html#method-i-unescape_html">unescape_html</a> </div> </div> <div id="method-i-unescape_html" class="method-detail "> <div class="method-heading"> <span class="method-name">unescape_html</span><span class="method-args">(str)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="unescape_html-source"> <pre><span class="ruby-comment"># File lib/review/htmlutils.rb, line 30</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>unescape_html</span>(<span class=“ruby-identifier”>str</span>)
<span class="ruby-comment"># FIXME: better code</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'&quot;'</span>, <span class="ruby-string">'"'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'&gt;'</span>, <span class="ruby-string">'>'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'&lt;'</span>, <span class="ruby-string">'<'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-string">'&amp;'</span>, <span class="ruby-string">'&'</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> <div class="aliases"> Also aliased as: <a href="HTMLUtils.html#method-i-unescape">unescape</a> </div> </div> </section> </section>
</main>
<footer id=“validator-badges” role=“contentinfo”>
<p><a href="http://validator.w3.org/check/referer">Validate</a> <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>