<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::Catalog - 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>
<!-- 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-appendix">#appendix</a> <li ><a href="#method-i-chaps">#chaps</a> <li ><a href="#method-i-parts">#parts</a> <li ><a href="#method-i-parts_with_chaps">#parts_with_chaps</a> <li ><a href="#method-i-postdef">#postdef</a> <li ><a href="#method-i-predef">#predef</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::Catalog”>
<h1 id="class-ReVIEW::Catalog" class="class"> class ReVIEW::Catalog </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">(file)</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/catalog.rb, line 5</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>file</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:read</span> <span class="ruby-ivar">@yaml</span> = <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">file</span>.<span class="ruby-identifier">read</span>) <span class="ruby-keyword">else</span> <span class="ruby-comment">## as Object</span> <span class="ruby-ivar">@yaml</span> = <span class="ruby-identifier">file</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@yaml</span> <span class="ruby-operator">||=</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-appendix" class="method-detail "> <div class="method-heading"> <span class="method-name">appendix</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="appendix-source"> <pre><span class="ruby-comment"># File lib/review/catalog.rb, line 46</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>appendix</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"APPENDIX"</span>] <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"APPENDIX"</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-chaps" class="method-detail "> <div class="method-heading"> <span class="method-name">chaps</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="chaps-source"> <pre><span class="ruby-comment"># File lib/review/catalog.rb, line 19</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>chaps</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"CHAPS"</span>] <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"CHAPS"</span>].<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span> <span class="ruby-identifier">entry</span> <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">values</span> <span class="ruby-comment"># chaps in a part</span> <span class="ruby-keyword">end</span> }.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-parts" class="method-detail "> <div class="method-heading"> <span class="method-name">parts</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="parts-source"> <pre><span class="ruby-comment"># File lib/review/catalog.rb, line 31</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>parts</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"CHAPS"</span>] <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"CHAPS"</span>].<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">keys</span> <span class="ruby-keyword">end</span> }.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-parts_with_chaps" class="method-detail "> <div class="method-heading"> <span class="method-name">parts_with_chaps</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="parts_with_chaps-source"> <pre><span class="ruby-comment"># File lib/review/catalog.rb, line 41</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>parts_with_chaps</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"CHAPS"</span>] <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"CHAPS"</span>].<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">compact</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-postdef" class="method-detail "> <div class="method-heading"> <span class="method-name">postdef</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="postdef-source"> <pre><span class="ruby-comment"># File lib/review/catalog.rb, line 51</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>postdef</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"POSTDEF"</span>] <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"POSTDEF"</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-predef" class="method-detail "> <div class="method-heading"> <span class="method-name">predef</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="predef-source"> <pre><span class="ruby-comment"># File lib/review/catalog.rb, line 14</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>predef</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"PREDEF"</span>] <span class="ruby-ivar">@yaml</span>[<span class="ruby-string">"PREDEF"</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</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="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>