<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::Repository - 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=“class”> <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"> <div id="parent-class-section" class="nav-section"> <h3>Parent</h3> <p class="link"><a href="../Object.html">Object</a>
</div>
<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> <li><a class="include" href="TextUtils.html">ReVIEW::TextUtils</a> <li><a class="include" href="ErrorUtils.html">ReVIEW::ErrorUtils</a> </ul>
</div>
<!-- Method Quickref -->
<div id=“method-list-section” class=“nav-section”>
<h3>Methods</h3> <ul class="link-list" role="directory"> <li ><a href="#method-c-new">::new</a> <li ><a href="#method-i-_parse_file">#_parse_file</a> <li ><a href="#method-i-canonical">#canonical</a> <li ><a href="#method-i-check_spec">#check_spec</a> <li ><a href="#method-i-check_type">#check_type</a> <li ><a href="#method-i-fetch">#fetch</a> <li ><a href="#method-i-fetch_file">#fetch_file</a> <li ><a href="#method-i-fetch_range">#fetch_range</a> <li ><a href="#method-i-file_descripter">#file_descripter</a> <li ><a href="#method-i-git-3F">#git?</a> <li ><a href="#method-i-parse_file">#parse_file</a> <li ><a href="#method-i-parse_git_blob">#parse_git_blob</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::Repository”>
<h1 id="class-ReVIEW::Repository" class="class"> class ReVIEW::Repository </h1> <section class="description"> </section> <section id="5Buntitled-5D" class="documentation-section"> <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(param)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 368</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>param</span>)
<span class="ruby-ivar">@repository</span> = {} <span class="ruby-ivar">@config</span> = <span class="ruby-identifier">param</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> </section> <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> <div id="method-i-fetch" class="method-detail "> <div class="method-heading"> <span class="method-name">fetch</span><span class="method-args">(file, type, name)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="fetch-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 381</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>fetch</span>(<span class=“ruby-identifier”>file</span>, <span class=“ruby-identifier”>type</span>, <span class=“ruby-identifier”>name</span>)
<span class="ruby-identifier">table</span> = <span class="ruby-identifier">file_descripter</span>(<span class="ruby-identifier">file</span>)[<span class="ruby-identifier">type</span>] <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-identifier">table</span>[<span class="ruby-identifier">name</span>]
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-fetch_file" class="method-detail "> <div class="method-heading"> <span class="method-name">fetch_file</span><span class="method-args">(file)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="fetch_file-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 373</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>fetch_file</span>(<span class=“ruby-identifier”>file</span>)
<span class="ruby-identifier">file_descripter</span>(<span class="ruby-identifier">file</span>)[<span class="ruby-string">'file'</span>]
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-fetch_range" class="method-detail "> <div class="method-heading"> <span class="method-name">fetch_range</span><span class="method-args">(file, name)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="fetch_range-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 377</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>fetch_range</span>(<span class=“ruby-identifier”>file</span>, <span class=“ruby-identifier”>name</span>)
<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">file</span>, <span class="ruby-string">'range'</span>, <span class="ruby-identifier">name</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> </section> <section id="private-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Private Instance Methods</h3> </header> <div id="method-i-_parse_file" class="method-detail "> <div class="method-heading"> <span class="method-name">_parse_file</span><span class="method-args">(f)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="_parse_file-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 412</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>_parse_file</span>(<span class=“ruby-identifier”>f</span>)
<span class="ruby-identifier">whole</span> = [] <span class="ruby-identifier">repo</span> = {<span class="ruby-string">'file'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">whole</span>} <span class="ruby-identifier">curr</span> = {<span class="ruby-string">'WHOLE'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">whole</span>} <span class="ruby-identifier">lineno</span> = <span class="ruby-value">1</span> <span class="ruby-identifier">yacchack</span> = <span class="ruby-keyword">false</span> <span class="ruby-comment"># remove ';'-only lines.</span> <span class="ruby-identifier">opened</span> = [[<span class="ruby-string">'(not opened)'</span>, <span class="ruby-string">'(not opened)'</span>]] <span class="ruby-operator">*</span> <span class="ruby-value">3</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span> <span class="ruby-keyword">case</span> <span class="ruby-identifier">line</span> <span class="ruby-keyword">when</span> <span class="ruby-node">/(?:\A\#@|\#@@)([a-z]+)_(begin|end)\((.*)\)/</span> <span class="ruby-identifier">type</span> = <span class="ruby-identifier">check_type</span>(<span class="ruby-node">$1</span>) <span class="ruby-identifier">direction</span> = <span class="ruby-node">$2</span> <span class="ruby-identifier">spec</span> = <span class="ruby-identifier">check_spec</span>(<span class="ruby-node">$3</span>) <span class="ruby-keyword">case</span> <span class="ruby-identifier">direction</span> <span class="ruby-keyword">when</span> <span class="ruby-string">'begin'</span> <span class="ruby-identifier">key</span> = <span class="ruby-node">"#{type}/#{spec}"</span> <span class="ruby-identifier">error</span> <span class="ruby-node">"begin x2: #{key}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">curr</span>[<span class="ruby-identifier">key</span>] (<span class="ruby-identifier">repo</span>[<span class="ruby-identifier">type</span>] <span class="ruby-operator">||=</span> {})[<span class="ruby-identifier">spec</span>] = <span class="ruby-identifier">curr</span>[<span class="ruby-identifier">key</span>] = [] <span class="ruby-keyword">when</span> <span class="ruby-string">'end'</span> <span class="ruby-identifier">curr</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-node">"#{type}/#{spec}"</span>) <span class="ruby-keyword">or</span> <span class="ruby-identifier">error</span> <span class="ruby-node">"end before begin: #{type}/#{spec}"</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-string">'must not happen'</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">when</span> <span class="ruby-node">%r<(?:\A\#@|\#@@)([a-z]+)/(\w+)\{></span> <span class="ruby-identifier">type</span> = <span class="ruby-identifier">check_type</span>(<span class="ruby-node">$1</span>) <span class="ruby-identifier">spec</span> = <span class="ruby-identifier">check_spec</span>(<span class="ruby-node">$2</span>) <span class="ruby-identifier">key</span> = <span class="ruby-node">"#{type}/#{spec}"</span> <span class="ruby-identifier">error</span> <span class="ruby-node">"begin x2: #{key}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">curr</span>[<span class="ruby-identifier">key</span>] (<span class="ruby-identifier">repo</span>[<span class="ruby-identifier">type</span>] <span class="ruby-operator">||=</span> {})[<span class="ruby-identifier">spec</span>] = <span class="ruby-identifier">curr</span>[<span class="ruby-identifier">key</span>] = [] <span class="ruby-identifier">opened</span>.<span class="ruby-identifier">push</span> [<span class="ruby-identifier">type</span>, <span class="ruby-identifier">spec</span>] <span class="ruby-keyword">when</span> <span class="ruby-node">%r<(?:\A\#@|\#@@)([a-z]+)/(\w+)\}></span> <span class="ruby-identifier">type</span> = <span class="ruby-identifier">check_type</span>(<span class="ruby-node">$1</span>) <span class="ruby-identifier">spec</span> = <span class="ruby-identifier">check_spec</span>(<span class="ruby-node">$2</span>) <span class="ruby-identifier">curr</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-node">"#{type}/#{spec}"</span>) <span class="ruby-keyword">or</span> <span class="ruby-identifier">error</span> <span class="ruby-node">"end before begin: #{type}/#{spec}"</span> <span class="ruby-identifier">opened</span>.<span class="ruby-identifier">delete</span> <span class="ruby-node">"#{type}/#{spec}"</span> <span class="ruby-keyword">when</span> <span class="ruby-node">%r<(?:\A\#@|\#@@)\}></span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">spec</span> = <span class="ruby-identifier">opened</span>.<span class="ruby-identifier">last</span> <span class="ruby-identifier">curr</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-node">"#{type}/#{spec}"</span>) <span class="ruby-keyword">or</span> <span class="ruby-identifier">error</span> <span class="ruby-node">"closed before open: #{type}/#{spec}"</span> <span class="ruby-identifier">opened</span>.<span class="ruby-identifier">pop</span> <span class="ruby-keyword">when</span> <span class="ruby-node">/(?:\A\#@|\#@@)yacchack/</span> <span class="ruby-identifier">yacchack</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">when</span> <span class="ruby-node">/\A\#@-/</span> <span class="ruby-comment"># does not increment line number.</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">canonical</span>(<span class="ruby-node">$'</span>) <span class="ruby-identifier">curr</span>.<span class="ruby-identifier">each_value</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">list</span><span class="ruby-operator">|</span> <span class="ruby-identifier">list</span>.<span class="ruby-identifier">push</span> <span class="ruby-constant">Line</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">line</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">else</span> <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">yacchack</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">strip</span> <span class="ruby-operator">==</span> <span class="ruby-string">';'</span> <span class="ruby-identifier">line</span> = <span class="ruby-identifier">canonical</span>(<span class="ruby-identifier">line</span>) <span class="ruby-identifier">curr</span>.<span class="ruby-identifier">each_value</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">list</span><span class="ruby-operator">|</span> <span class="ruby-identifier">list</span>.<span class="ruby-identifier">push</span> <span class="ruby-constant">Line</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">lineno</span>, <span class="ruby-identifier">line</span>) <span class="ruby-keyword">end</span> <span class="ruby-identifier">lineno</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">curr</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> <span class="ruby-identifier">curr</span>.<span class="ruby-identifier">delete</span> <span class="ruby-string">'WHOLE'</span> <span class="ruby-identifier">curr</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">range</span>, <span class="ruby-identifier">lines</span><span class="ruby-operator">|</span> <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{filename()}: unclosed range: #{range} (begin @#{lines.first.number})"</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ApplicationError</span>, <span class="ruby-string">"ERROR"</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">repo</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-canonical" class="method-detail "> <div class="method-heading"> <span class="method-name">canonical</span><span class="method-args">(line)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="canonical-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 488</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>canonical</span>(<span class=“ruby-identifier”>line</span>)
<span class="ruby-identifier">tabwidth</span> = <span class="ruby-value">8</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">'tabwidth'</span>] <span class="ruby-identifier">tabwidth</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">'tabwidth'</span>] <span class="ruby-keyword">end</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">tabwidth</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-identifier">detab</span>(<span class="ruby-identifier">line</span>, <span class="ruby-identifier">tabwidth</span>).<span class="ruby-identifier">rstrip</span> <span class="ruby-operator">+</span> <span class="ruby-string">"\n"</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">line</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-check_spec" class="method-detail "> <div class="method-heading"> <span class="method-name">check_spec</span><span class="method-args">(spec)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="check_spec-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 507</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>check_spec</span>(<span class=“ruby-identifier”>spec</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-regexp">/\A\w+\z/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">spec</span> <span class="ruby-identifier">error</span> <span class="ruby-node">"wrong spec: #{spec.inspect}"</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">spec</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-check_type" class="method-detail "> <div class="method-heading"> <span class="method-name">check_type</span><span class="method-args">(type)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="check_type-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 500</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>check_type</span>(<span class=“ruby-identifier”>type</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-constant">Preprocessor</span><span class="ruby-operator">::</span><span class="ruby-constant">TYPES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">type</span>) <span class="ruby-identifier">error</span> <span class="ruby-node">"wrong type: #{type.inspect}"</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">type</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-file_descripter" class="method-detail "> <div class="method-heading"> <span class="method-name">file_descripter</span><span class="method-args">(fname)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="file_descripter-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 388</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>file_descripter</span>(<span class=“ruby-identifier”>fname</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@repository</span>[<span class="ruby-identifier">fname</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@repository</span>[<span class="ruby-identifier">fname</span>] <span class="ruby-ivar">@repository</span>[<span class="ruby-identifier">fname</span>] = <span class="ruby-identifier">git?</span>(<span class="ruby-identifier">fname</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">parse_git_blob</span>(<span class="ruby-identifier">fname</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">parse_file</span>(<span class="ruby-identifier">fname</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-git-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">git?</span><span class="method-args">(fname)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="git-3F-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 394</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>git?</span>(<span class=“ruby-identifier”>fname</span>)
<span class="ruby-identifier">fname</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">'git|'</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-parse_file" class="method-detail "> <div class="method-heading"> <span class="method-name">parse_file</span><span class="method-args">(fname)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="parse_file-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 405</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>parse_file</span>(<span class=“ruby-identifier”>fname</span>)
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">fname</span>, <span class="ruby-string">'r:BOM|utf-8'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">init_ErrorUtils</span> <span class="ruby-identifier">f</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">_parse_file</span>(<span class="ruby-identifier">f</span>) }
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-parse_git_blob" class="method-detail "> <div class="method-heading"> <span class="method-name">parse_git_blob</span><span class="method-args">(g_obj)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="parse_git_blob-source"> <pre><span class="ruby-comment"># File lib/review/preprocessor.rb, line 398</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>parse_git_blob</span>(<span class=“ruby-identifier”>g_obj</span>)
<span class="ruby-constant">IO</span>.<span class="ruby-identifier">popen</span>(<span class="ruby-string">'git show '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">g_obj</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/\Agit\|/</span>, <span class="ruby-string">''</span>), <span class="ruby-string">'r'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">init_ErrorUtils</span> <span class="ruby-identifier">f</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">_parse_file</span>(<span class="ruby-identifier">f</span>) <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </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>