<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>module ReVIEW::MakerHelper - 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-c-bindir">::bindir</a> <li ><a href="#method-c-copy_images_to_dir">::copy_images_to_dir</a> <li ><a href="#method-i-bindir">#bindir</a> <li ><a href="#method-i-copy_images_to_dir">#copy_images_to_dir</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“module-ReVIEW::MakerHelper”>
<h1 id="module-ReVIEW::MakerHelper" class="module"> module ReVIEW::MakerHelper </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-bindir" class="method-detail "> <div class="method-heading"> <span class="method-name">bindir</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Return review/bin directory</p> <div class="method-source-code" id="bindir-source"> <pre><span class="ruby-comment"># File lib/review/makerhelper.rb, line 16</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>bindir</span>
<span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"#{Pathname.new(__FILE__).realpath.dirname}/../../bin"</span>).<span class="ruby-identifier">realpath</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-c-copy_images_to_dir" class="method-detail "> <div class="method-heading"> <span class="method-name">copy_images_to_dir</span><span class="method-args">(from_dir, to_dir, options = {})</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Copy image files under from_dir to to_dir recursively</p>
<h4 id=“method-c-copy_images_to_dir-label-Args”>Args<span><a href=“#method-c-copy_images_to_dir-label-Args”>¶</a> <a href=“#top”>↑</a></span></h4> <dl class=“rdoc-list note-list”><dt>from_dir <dd> <p>path to the directory which has image files to be copied</p> </dd><dt>to_dir <dd> <p>path to the directory to which the image files are copied</p> </dd><dt>options <dd> <p>used to specify optional operations during copy</p> </dd></dl>
<h4 id=“method-c-copy_images_to_dir-label-Returns”>Returns<span><a href=“#method-c-copy_images_to_dir-label-Returns”>¶</a> <a href=“#top”>↑</a></span></h4>
<p>list of image files</p>
<h4 id=“method-c-copy_images_to_dir-label-Options”>Options<span><a href=“#method-c-copy_images_to_dir-label-Options”>¶</a> <a href=“#top”>↑</a></span></h4> <dl class=“rdoc-list note-list”><dt>:convert <dd> <p>Conversion rule</p> </dd></dl>
<h4 id=“method-c-copy_images_to_dir-label-Examples”>Examples<span><a href=“#method-c-copy_images_to_dir-label-Examples”>¶</a> <a href=“#top”>↑</a></span></h4>
<pre class=“ruby”><span class=“ruby-identifier”>copy_images_to_dir</span>(<span class=“ruby-string”>"/path/to/foo"</span>, <span class=“ruby-string”>"/path/to/bar"</span>, :<span class=“ruby-identifier”>convert</span> =<span class=“ruby-operator”>></span> {:<span class=“ruby-identifier”>eps</span> =<span class=“ruby-operator”>></span> :<span class=“ruby-identifier”>png</span>}) </pre>
<p>Image files are copied recursively, and each '.eps' file is converted into '.eps.png'</p>
<div class="method-source-code" id="copy_images_to_dir-source"> <pre><span class="ruby-comment"># File lib/review/makerhelper.rb, line 37</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>copy_images_to_dir</span>(<span class=“ruby-identifier”>from_dir</span>, <span class=“ruby-identifier”>to_dir</span>, <span class=“ruby-identifier”>options</span> = {})
<span class="ruby-identifier">image_files</span> = [] <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">from_dir</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dir</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">fname</span><span class="ruby-operator">|</span> <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">fname</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\./</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-node">"#{from_dir}/#{fname}"</span>) <span class="ruby-identifier">image_files</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">copy_images_to_dir</span>(<span class="ruby-node">"#{from_dir}/#{fname}"</span>, <span class="ruby-node">"#{to_dir}/#{fname}"</span>, <span class="ruby-identifier">options</span>) <span class="ruby-keyword">else</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">to_dir</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">to_dir</span>) <span class="ruby-identifier">is_converted</span> = <span class="ruby-keyword">false</span> (<span class="ruby-identifier">options</span>[<span class="ruby-value">:convert</span>] <span class="ruby-operator">||</span> {}).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">orig_type</span>, <span class="ruby-identifier">conv_type</span><span class="ruby-operator">|</span> <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-node">/\.#{orig_type}$/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">fname</span> <span class="ruby-identifier">is_converted</span> = <span class="ruby-identifier">system</span>(<span class="ruby-node">"convert #{from_dir}/#{fname} #{to_dir}/#{fname}.#{conv_type}"</span>) <span class="ruby-identifier">image_files</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{from_dir}/#{fname}.#{conv_type}"</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">exts</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:exts</span>] <span class="ruby-operator">||</span> <span class="ruby-node">%w(png gif jpg jpeg svg pdf eps ai tif)</span> <span class="ruby-identifier">exts_str</span> = <span class="ruby-identifier">exts</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'|'</span>) <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">is_converted</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">fname</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/\.(#{exts_str})$/i</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span> <span class="ruby-node">"#{from_dir}/#{fname}"</span>, <span class="ruby-identifier">to_dir</span> <span class="ruby-identifier">image_files</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{from_dir}/#{fname}"</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">image_files</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-bindir" class="method-detail "> <div class="method-heading"> <span class="method-name">bindir</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Return review/bin directory</p> <div class="method-source-code" id="bindir-source"> <pre><span class="ruby-comment"># File lib/review/makerhelper.rb, line 16</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>bindir</span>
<span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"#{Pathname.new(__FILE__).realpath.dirname}/../../bin"</span>).<span class="ruby-identifier">realpath</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-copy_images_to_dir" class="method-detail "> <div class="method-heading"> <span class="method-name">copy_images_to_dir</span><span class="method-args">(from_dir, to_dir, options = {})</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Copy image files under from_dir to to_dir recursively</p>
<h4 id=“method-i-copy_images_to_dir-label-Args”>Args<span><a href=“#method-i-copy_images_to_dir-label-Args”>¶</a> <a href=“#top”>↑</a></span></h4> <dl class=“rdoc-list note-list”><dt>from_dir <dd> <p>path to the directory which has image files to be copied</p> </dd><dt>to_dir <dd> <p>path to the directory to which the image files are copied</p> </dd><dt>options <dd> <p>used to specify optional operations during copy</p> </dd></dl>
<h4 id=“method-i-copy_images_to_dir-label-Returns”>Returns<span><a href=“#method-i-copy_images_to_dir-label-Returns”>¶</a> <a href=“#top”>↑</a></span></h4>
<p>list of image files</p>
<h4 id=“method-i-copy_images_to_dir-label-Options”>Options<span><a href=“#method-i-copy_images_to_dir-label-Options”>¶</a> <a href=“#top”>↑</a></span></h4> <dl class=“rdoc-list note-list”><dt>:convert <dd> <p>Conversion rule</p> </dd></dl>
<h4 id=“method-i-copy_images_to_dir-label-Examples”>Examples<span><a href=“#method-i-copy_images_to_dir-label-Examples”>¶</a> <a href=“#top”>↑</a></span></h4>
<pre class=“ruby”><span class=“ruby-identifier”>copy_images_to_dir</span>(<span class=“ruby-string”>"/path/to/foo"</span>, <span class=“ruby-string”>"/path/to/bar"</span>, :<span class=“ruby-identifier”>convert</span> =<span class=“ruby-operator”>></span> {:<span class=“ruby-identifier”>eps</span> =<span class=“ruby-operator”>></span> :<span class=“ruby-identifier”>png</span>}) </pre>
<p>Image files are copied recursively, and each '.eps' file is converted into '.eps.png'</p>
<div class="method-source-code" id="copy_images_to_dir-source"> <pre><span class="ruby-comment"># File lib/review/makerhelper.rb, line 37</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>copy_images_to_dir</span>(<span class=“ruby-identifier”>from_dir</span>, <span class=“ruby-identifier”>to_dir</span>, <span class=“ruby-identifier”>options</span> = {})
<span class="ruby-identifier">image_files</span> = [] <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">from_dir</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dir</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">fname</span><span class="ruby-operator">|</span> <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">fname</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\./</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-node">"#{from_dir}/#{fname}"</span>) <span class="ruby-identifier">image_files</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">copy_images_to_dir</span>(<span class="ruby-node">"#{from_dir}/#{fname}"</span>, <span class="ruby-node">"#{to_dir}/#{fname}"</span>, <span class="ruby-identifier">options</span>) <span class="ruby-keyword">else</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">to_dir</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">to_dir</span>) <span class="ruby-identifier">is_converted</span> = <span class="ruby-keyword">false</span> (<span class="ruby-identifier">options</span>[<span class="ruby-value">:convert</span>] <span class="ruby-operator">||</span> {}).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">orig_type</span>, <span class="ruby-identifier">conv_type</span><span class="ruby-operator">|</span> <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-node">/\.#{orig_type}$/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">fname</span> <span class="ruby-identifier">is_converted</span> = <span class="ruby-identifier">system</span>(<span class="ruby-node">"convert #{from_dir}/#{fname} #{to_dir}/#{fname}.#{conv_type}"</span>) <span class="ruby-identifier">image_files</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{from_dir}/#{fname}.#{conv_type}"</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">exts</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:exts</span>] <span class="ruby-operator">||</span> <span class="ruby-node">%w(png gif jpg jpeg svg pdf eps ai tif)</span> <span class="ruby-identifier">exts_str</span> = <span class="ruby-identifier">exts</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'|'</span>) <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">is_converted</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">fname</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/\.(#{exts_str})$/i</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span> <span class="ruby-node">"#{from_dir}/#{fname}"</span>, <span class="ruby-identifier">to_dir</span> <span class="ruby-identifier">image_files</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{from_dir}/#{fname}"</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">image_files</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>