<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::Book::Volume - 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-count_file">::count_file</a> <li ><a href="#method-c-dummy">::dummy</a> <li ><a href="#method-c-new">::new</a> <li ><a href="#method-c-sum">::sum</a> <li ><a href="#method-i-2B">#+</a> <li ><a href="#method-i-kbytes">#kbytes</a> <li ><a href="#method-i-page">#page</a> <li ><a href="#method-i-to_s">#to_s</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::Book::Volume”>
<h1 id="class-ReVIEW::Book::Volume" class="class"> class ReVIEW::Book::Volume </h1> <section class="description"> </section> <section id="5Buntitled-5D" class="documentation-section"> <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> <div id="attribute-i-bytes" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">bytes</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-chars" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">chars</span><span class="attribute-access-type">[R]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-lines" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">lines</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-page_per_kbyte" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">page_per_kbyte</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> </div> </div> </section> <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> <div id="method-c-count_file" class="method-detail "> <div class="method-heading"> <span class="method-name">count_file</span><span class="method-args">(path)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="count_file-source"> <pre><span class="ruby-comment"># File lib/review/book/volume.rb, line 15</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>Volume</span>.<span class=“ruby-identifier”>count_file</span>(<span class=“ruby-identifier”>path</span>)
<span class="ruby-identifier">b</span> = <span class="ruby-identifier">c</span> = <span class="ruby-identifier">l</span> = <span class="ruby-value">0</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">foreach</span>(<span class="ruby-identifier">path</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">next</span> <span class="ruby-keyword">if</span> <span class="ruby-node">%r<\A\#@></span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">line</span> <span class="ruby-identifier">text</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\s+/</span>, <span class="ruby-string">''</span>) <span class="ruby-identifier">b</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">text</span>.<span class="ruby-identifier">bytesize</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">text</span>.<span class="ruby-identifier">charsize</span> <span class="ruby-identifier">l</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">new</span>(<span class="ruby-identifier">b</span>, <span class="ruby-identifier">c</span>, <span class="ruby-identifier">l</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-c-dummy" class="method-detail "> <div class="method-heading"> <span class="method-name">dummy</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="dummy-source"> <pre><span class="ruby-comment"># File lib/review/book/volume.rb, line 31</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>Volume</span>.<span class=“ruby-identifier”>dummy</span>
<span class="ruby-identifier">new</span>(<span class="ruby-value">-1</span>, <span class="ruby-value">-1</span>, <span class="ruby-value">-1</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">(bytes = 0, chars = 0, lines = 0)</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/volume.rb, line 35</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>bytes</span> = <span class=“ruby-value”>0</span>, <span class=“ruby-identifier”>chars</span> = <span class=“ruby-value”>0</span>, <span class=“ruby-identifier”>lines</span> = <span class=“ruby-value”>0</span>)
<span class="ruby-ivar">@bytes</span> = <span class="ruby-identifier">bytes</span> <span class="ruby-ivar">@chars</span> = <span class="ruby-identifier">chars</span> <span class="ruby-ivar">@lines</span> = <span class="ruby-identifier">lines</span> <span class="ruby-ivar">@page_per_kbyte</span> = <span class="ruby-keyword">nil</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-c-sum" class="method-detail "> <div class="method-heading"> <span class="method-name">sum</span><span class="method-args">(vols)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="sum-source"> <pre><span class="ruby-comment"># File lib/review/book/volume.rb, line 27</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-constant”>Volume</span>.<span class=“ruby-identifier”>sum</span>(<span class=“ruby-identifier”>vols</span>)
<span class="ruby-identifier">vols</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-identifier">new</span>()) {<span class="ruby-operator">|</span><span class="ruby-identifier">sum</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">sum</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">i</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-2B" class="method-detail "> <div class="method-heading"> <span class="method-name">+</span><span class="method-args">(other)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="2B-source"> <pre><span class="ruby-comment"># File lib/review/book/volume.rb, line 59</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-operator”>+</span>(<span class=“ruby-identifier”>other</span>)
<span class="ruby-constant">Volume</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@bytes</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">bytes</span>, <span class="ruby-ivar">@chars</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">chars</span>, <span class="ruby-ivar">@lines</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">lines</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-kbytes" class="method-detail "> <div class="method-heading"> <span class="method-name">kbytes</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="kbytes-source"> <pre><span class="ruby-comment"># File lib/review/book/volume.rb, line 47</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>kbytes</span>
(<span class="ruby-ivar">@bytes</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">/</span> <span class="ruby-value">1024</span>).<span class="ruby-identifier">ceil</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-page" class="method-detail "> <div class="method-heading"> <span class="method-name">page</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="page-source"> <pre><span class="ruby-comment"># File lib/review/book/volume.rb, line 51</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>page</span>
(<span class="ruby-identifier">kbytes</span>.<span class="ruby-identifier">to_f</span><span class="ruby-operator">/</span><span class="ruby-ivar">@page_per_kbyte</span>).<span class="ruby-identifier">ceil</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-to_s" class="method-detail "> <div class="method-heading"> <span class="method-name">to_s</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="to_s-source"> <pre><span class="ruby-comment"># File lib/review/book/volume.rb, line 55</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>to_s</span>
<span class="ruby-node">"#{kbytes()}KB #{@chars}C #{@lines}L #{page()}P"</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>