<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::Book::Index - 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><span class="include">Enumerable</span> </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-item_class">::item_class</a> <li ><a href="#method-c-new">::new</a> <li ><a href="#method-c-parse">::parse</a> <li ><a href="#method-i-5B-5D">#[]</a> <li ><a href="#method-i-each">#each</a> <li ><a href="#method-i-has_key-3F">#has_key?</a> <li ><a href="#method-i-item_type">#item_type</a> <li ><a href="#method-i-key-3F">#key?</a> <li ><a href="#method-i-number">#number</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::Book::Index”>
<h1 id="class-ReVIEW::Book::Index" class="class"> class ReVIEW::Book::Index </h1> <section class="description"> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="constants-list"> <header> <h3>Constants</h3> </header> <dl> <dt id="Item">Item <dd> </dl> </section> <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> <div id="method-c-item_class" class="method-detail "> <div class="method-heading"> <span class="method-name">item_class</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="item_class-source"> <pre><span class="ruby-comment"># File lib/review/book/index.rb, line 36</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>Index</span>.<span class=“ruby-identifier”>item_class</span>
<span class="ruby-keyword">self</span><span class="ruby-operator">::</span><span class="ruby-constant">Item</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(items)</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/book/index.rb, line 46</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>items</span>)
<span class="ruby-ivar">@items</span> = <span class="ruby-identifier">items</span> <span class="ruby-ivar">@index</span> = {} <span class="ruby-identifier">items</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">warn</span> <span class="ruby-node">"warning: duplicate ID: #{i.id} (#{i})"</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@index</span>[<span class="ruby-identifier">i</span>.<span class="ruby-identifier">id</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-ivar">@index</span>[<span class="ruby-identifier">i</span>.<span class="ruby-identifier">id</span>] = <span class="ruby-identifier">i</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@image_finder</span> = <span class="ruby-keyword">nil</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-c-parse" class="method-detail "> <div class="method-heading"> <span class="method-name">parse</span><span class="method-args">(src, *args)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="parse-source"> <pre><span class="ruby-comment"># File lib/review/book/index.rb, line 19</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>Index</span>.<span class=“ruby-identifier”>parse</span>(<span class=“ruby-identifier”>src</span>, <span class=“ruby-operator”>*</span><span class=“ruby-identifier”>args</span>)
<span class="ruby-identifier">items</span> = [] <span class="ruby-identifier">seq</span> = <span class="ruby-value">1</span> <span class="ruby-identifier">src</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-node">%r<^//#{item_type()}></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">if</span> <span class="ruby-identifier">id</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">slice</span>(<span class="ruby-regexp">/\[(.*?)\]/</span>, <span class="ruby-value">1</span>) <span class="ruby-identifier">items</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">item_class</span>().<span class="ruby-identifier">new</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">seq</span>) <span class="ruby-identifier">seq</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">==</span> <span class="ruby-string">""</span> <span class="ruby-identifier">warn</span> <span class="ruby-node">"warning: no ID of #{item_type()} in #{line}"</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">new</span>(<span class="ruby-identifier">items</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</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-5B-5D" class="method-detail "> <div class="method-heading"> <span class="method-name">[]</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="5B-5D-source"> <pre><span class="ruby-comment"># File lib/review/book/index.rb, line 56</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-operator”>[]</span>(<span class=“ruby-identifier”>id</span>)
<span class="ruby-ivar">@index</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">id</span>)
<span class=“ruby-keyword”>rescue</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@index</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\|/</span>).<span class="ruby-identifier">last</span> }.<span class="ruby-identifier">flatten</span>. <span class="ruby-comment"># unfold all ids</span> <span class="ruby-identifier">each_with_object</span>(<span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">0</span>)){<span class="ruby-operator">|</span><span class="ruby-identifier">i</span>, <span class="ruby-identifier">h</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">i</span>] <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>}. <span class="ruby-comment"># number of occurrences</span> <span class="ruby-identifier">select</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> }.<span class="ruby-identifier">present?</span> <span class="ruby-comment"># detect duplicated</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">KeyError</span>, <span class="ruby-node">"key '#{id}' is ambiguous for #{self.class}"</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@items</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">id</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\|/</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">id</span>) <span class="ruby-keyword">return</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">KeyError</span>, <span class="ruby-node">"not found key '#{id}' for #{self.class}"</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-each" class="method-detail "> <div class="method-heading"> <span class="method-name">each</span><span class="method-args">(&block)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="each-source"> <pre><span class="ruby-comment"># File lib/review/book/index.rb, line 77</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>each</span>(<span class=“ruby-operator”>&</span><span class=“ruby-identifier”>block</span>)
<span class="ruby-ivar">@items</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-has_key-3F" class="method-detail method-alias"> <div class="method-heading"> <span class="method-name">has_key?</span><span class="method-args">(id)</span> </div> <div class="method-description"> </div> <div class="aliases"> Alias for: <a href="Index.html#method-i-key-3F">key?</a> </div> </div> <div id="method-i-item_type" class="method-detail "> <div class="method-heading"> <span class="method-name">item_type</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="item_type-source"> <pre><span class="ruby-comment"># File lib/review/book/index.rb, line 42</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>item_type</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">item_type</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-key-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">key?</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="key-3F-source"> <pre><span class="ruby-comment"># File lib/review/book/index.rb, line 81</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>key?</span>(<span class=“ruby-identifier”>id</span>)
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@index</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">id</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> <div class="aliases"> Also aliased as: <a href="Index.html#method-i-has_key-3F">has_key?</a> </div> </div> <div id="method-i-number" class="method-detail "> <div class="method-heading"> <span class="method-name">number</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="number-source"> <pre><span class="ruby-comment"># File lib/review/book/index.rb, line 73</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>number</span>(<span class=“ruby-identifier”>id</span>)
<span class="ruby-keyword">self</span>[<span class="ruby-identifier">id</span>].<span class="ruby-identifier">number</span>.<span class="ruby-identifier">to_s</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>