dirtravel 0.0.5 → 0.0.6

data/doc/DirTravel/FileEntry.html

@@ -6,7 +6,7 @@
 <title>
   Class: DirTravel::FileEntry
   
-    &mdash; Documentation by YARD 0.8.6.1
+    &mdash; Documentation by YARD 0.8.7.6
   
 </title>
 
@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '../';
-  framesUrl = "../frames.html#!" + escape(window.location.href);
+  framesUrl = "../frames.html#!DirTravel/FileEntry.html";
 </script>
 
 
@@ -217,7 +217,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>A new instance of FileEntry.</p>
+<p>Set name, suffix, and basename.</p>
 </div></span>
   
 </li>
@@ -253,13 +253,33 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>A new instance of FileEntry</p>
+<p>Set name, suffix, and basename.</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>name</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>File name.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 
 </div><table class="source_code">
   <tr>
@@ -267,14 +287,14 @@
       <pre class="lines">
 
 
-179
-180
-181
-182
-183</pre>
+191
+192
+193
+194
+195</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 179</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 191</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
     <span class='kw'>super</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
@@ -319,12 +339,12 @@
       <pre class="lines">
 
 
-177
-178
-179</pre>
+186
+187
+188</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 177</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 186</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_basename'>basename</span>
   <span class='ivar'>@basename</span>
@@ -362,12 +382,12 @@
       <pre class="lines">
 
 
-177
-178
-179</pre>
+186
+187
+188</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 177</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 186</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_suffix'>suffix</span>
   <span class='ivar'>@suffix</span>
@@ -383,9 +403,9 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jan 23 19:01:13 2014 by
+  Generated on Sun Apr 19 15:01:50 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.6.1 (ruby-1.9.3).
+  0.8.7.6 (ruby-2.1.2).
 </div>
 
   </body>

data/doc/DirTravel/Travel.html

@@ -6,7 +6,7 @@
 <title>
   Class: DirTravel::Travel
   
-    &mdash; Documentation by YARD 0.8.6.1
+    &mdash; Documentation by YARD 0.8.7.6
   
 </title>
 
@@ -17,7 +17,7 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '../';
-  framesUrl = "../frames.html#!" + escape(window.location.href);
+  framesUrl = "../frames.html#!DirTravel/Travel.html";
 </script>
 
 
@@ -102,27 +102,32 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Create directory recursion tree (with Travel.filetree). Optionally filter
+<p>Create directory recursion tree (with <span class='object_link'><a href="#filetree-class_method" title="DirTravel::Travel.filetree (method)">Travel.filetree</a></span>). Optionally filter
 with suffix and modify tree building with options Hash (see below).</p>
 
-<h2>Parameters:</h2>
-<table class="rdoc-list"><tr><td class="rdoc-term"><p>sort</p></td>
-<td>
+<p>If basedir is absolute path, the root name is the search path. If basedir
+is relative path, before search the current directory is changed to
+referenced directory and root name is the current directory, single level.</p>
+
+<h2 id="label-Parameters%3A">Parameters:</h2>
+<dl class="rdoc-list note-list"><dt>sort
+<dd>
 <p>Sort directory entries (default: false).</p>
-</td></tr><tr><td class="rdoc-term"><p>suffix</p></td>
-<td>
-<p>Limit search to files with "suffix" (default: nil).</p>
-</td></tr><tr><td class="rdoc-term"><p>files</p></td>
-<td>
+</dd><dt>suffix
+<dd>
+<p>Limit search to files with “suffix” (default: nil).</p>
+</dd><dt>files
+<dd>
 <p>Include files to search (default: true).</p>
-</td></tr><tr><td class="rdoc-term"><p>inclusive</p></td>
-<td>
+</dd><dt>inclusive
+<dd>
 <p>Basedirs parent becomes the basedir (default: false).</p>
-</td></tr></table>
+</dd></dl>
 
 <p>Example:</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_d1'>d1</span> <span class='op'>=</span> <span class='const'>DirTravel</span><span class='op'>::</span><span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_filetree'>filetree</span><span class='lparen'>(</span> <span class='id identifier rubyid_dir1'>dir1</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:sort</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:suffix</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.mp3</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='rparen'>)</span></code></pre>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_d1'>d1</span> <span class='op'>=</span> <span class='const'>DirTravel</span><span class='op'>::</span><span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_filetree'>filetree</span><span class='lparen'>(</span> <span class='id identifier rubyid_dir1'>dir1</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:sort</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:suffix</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.mp3</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span> <span class='rparen'>)</span>
+</code></pre>
 
 
   </div>
@@ -185,7 +190,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Starting directory for Travel.</p>
+<p>Starting directory for <span class='object_link'><a href="" title="DirTravel::Travel (class)">Travel</a></span>.</p>
 </div></span>
   
 </li>
@@ -212,7 +217,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Default options for Travel.</p>
+<p>Default options for <span class='object_link'><a href="" title="DirTravel::Travel (class)">Travel</a></span>.</p>
 </div></span>
   
 </li>
@@ -239,7 +244,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Root DirEntry of Travel.</p>
+<p>Root <span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span> of <span class='object_link'><a href="" title="DirTravel::Travel (class)">Travel</a></span>.</p>
 </div></span>
   
 </li>
@@ -261,7 +266,7 @@ with suffix and modify tree building with options Hash (see below).</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#filetree-class_method" title="filetree (class method)">+ (DirEntry) <strong>filetree</strong>(basedir = '.', options = {}) </a>
+      <a href="#filetree-class_method" title="filetree (class method)">+ (DirEntry) <strong>filetree</strong>(basedir = &#39;.&#39;, options = {}) </a>
     
 
     
@@ -276,7 +281,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Create directory recursion tree.</p>
+<p>Create directory recursion tree and return root.</p>
 </div></span>
   
 </li>
@@ -311,7 +316,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>A new instance of Travel.</p>
+<p>Create directory recursion object.</p>
 </div></span>
   
 </li>
@@ -359,13 +364,68 @@ with suffix and modify tree building with options Hash (see below).</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>A new instance of Travel</p>
+<p>Create directory recursion object. Overlay options on top of defaults.
+Initialize root <span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span>.</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>basedir</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Starting directory (top).</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>abspath</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Absolute path for root.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p><span class='object_link'><a href="" title="DirTravel::Travel (class)">DirTravel::Travel</a></span> options.</p>
+</div>
+      
+    </li>
   
+</ul>
+
 
 </div><table class="source_code">
   <tr>
@@ -373,35 +433,35 @@ with suffix and modify tree building with options Hash (see below).</p>
       <pre class="lines">
 
 
-256
-257
-258
-259
-260
-261
-262
-263
-264
-265
-266
-267
-268
-269
-270</pre>
+312
+313
+314
+315
+316
+317
+318
+319
+320
+321
+322
+323
+324
+325
+326</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 256</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 312</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_abspath'>abspath</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rparen'>)</span>
     <span class='ivar'>@basedir</span> <span class='op'>=</span> <span class='id identifier rubyid_basedir'>basedir</span>
     <span class='ivar'>@abspath</span> <span class='op'>=</span> <span class='id identifier rubyid_abspath'>abspath</span>
 
     <span class='ivar'>@defaults</span> <span class='op'>=</span> <span class='lbrace'>{</span>
-        <span class='symbol'>:suffix</span>    <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>   
-        <span class='symbol'>:sort</span>      <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span> 
-        <span class='symbol'>:files</span>     <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span>  
-        <span class='symbol'>:inclusive</span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>  
-    <span class='rbrace'>}</span>                
+        <span class='symbol'>:suffix</span>    <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>
+        <span class='symbol'>:sort</span>      <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>
+        <span class='symbol'>:files</span>     <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span>
+        <span class='symbol'>:inclusive</span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>
+    <span class='rbrace'>}</span>
 
     <span class='ivar'>@defaults</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
 
@@ -445,12 +505,12 @@ with suffix and modify tree building with options Hash (see below).</p>
       <pre class="lines">
 
 
-215
-216
-217</pre>
+232
+233
+234</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 215</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 232</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_abspath'>abspath</span>
   <span class='ivar'>@abspath</span>
@@ -474,7 +534,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Starting directory for Travel.</p>
+<p>Starting directory for <span class='object_link'><a href="" title="DirTravel::Travel (class)">DirTravel::Travel</a></span>.</p>
 
 
   </div>
@@ -488,12 +548,12 @@ with suffix and modify tree building with options Hash (see below).</p>
       <pre class="lines">
 
 
-214
-215
-216</pre>
+231
+232
+233</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 214</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 231</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_basedir'>basedir</span>
   <span class='ivar'>@basedir</span>
@@ -517,7 +577,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Default options for Travel.</p>
+<p>Default options for <span class='object_link'><a href="" title="DirTravel::Travel (class)">DirTravel::Travel</a></span>.</p>
 
 
   </div>
@@ -531,12 +591,12 @@ with suffix and modify tree building with options Hash (see below).</p>
       <pre class="lines">
 
 
-211
-212
-213</pre>
+228
+229
+230</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 211</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 228</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_defaults'>defaults</span>
   <span class='ivar'>@defaults</span>
@@ -560,7 +620,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Root DirEntry of Travel.</p>
+<p>Root <span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span> of <span class='object_link'><a href="" title="DirTravel::Travel (class)">DirTravel::Travel</a></span>.</p>
 
 
   </div>
@@ -574,12 +634,12 @@ with suffix and modify tree building with options Hash (see below).</p>
       <pre class="lines">
 
 
-208
-209
-210</pre>
+225
+226
+227</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 208</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 225</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_root'>root</span>
   <span class='ivar'>@root</span>
@@ -599,7 +659,7 @@ with suffix and modify tree building with options Hash (see below).</p>
       <div class="method_details first">
   <h3 class="signature first" id="filetree-class_method">
   
-    + (<tt><span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span></tt>) <strong>filetree</strong>(basedir = '.', options = {}) 
+    + (<tt><span class='object_link'><a href="DirEntry.html" title="DirTravel::DirEntry (class)">DirEntry</a></span></tt>) <strong>filetree</strong>(basedir = &#39;.&#39;, options = {}) 
   
 
   
@@ -608,7 +668,7 @@ with suffix and modify tree building with options Hash (see below).</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Create directory recursion tree.</p>
+<p>Create directory recursion tree and return root.</p>
 
 
   </div>
@@ -625,7 +685,7 @@ with suffix and modify tree building with options Hash (see below).</p>
         <span class='type'>(<tt>String</tt>)</span>
       
       
-        <em class="default">(defaults to: <tt>'.'</tt>)</em>
+        <em class="default">(defaults to: <tt>&#39;.&#39;</tt>)</em>
       
       
         &mdash;
@@ -648,7 +708,7 @@ with suffix and modify tree building with options Hash (see below).</p>
       
         &mdash;
         <div class='inline'>
-<p>Hash optionally including keys: :sort, :suffix, :files.</p>
+<p><span class='object_link'><a href="" title="DirTravel::Travel (class)">DirTravel::Travel</a></span> options.</p>
 </div>
       
     </li>
@@ -667,7 +727,7 @@ with suffix and modify tree building with options Hash (see below).</p>
       
         &mdash;
         <div class='inline'>
-<p>Root item of the file system hierarchy.</p>
+<p>Root of the file travel hierarchy.</p>
 </div>
       
     </li>
@@ -680,25 +740,6 @@ with suffix and modify tree building with options Hash (see below).</p>
       <pre class="lines">
 
 
-221
-222
-223
-224
-225
-226
-227
-228
-229
-230
-231
-232
-233
-234
-235
-236
-237
-238
-239
 240
 241
 242
@@ -712,43 +753,124 @@ with suffix and modify tree building with options Hash (see below).</p>
 250
 251
 252
-253</pre>
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262
+263
+264
+265
+266
+267
+268
+269
+270
+271
+272
+273
+274
+275
+276
+277
+278
+279
+280
+281
+282
+283
+284
+285
+286
+287
+288
+289
+290
+291
+292
+293
+294
+295
+296
+297
+298
+299
+300
+301
+302
+303</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 221</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 240</span>
+
+<span class='kw'>def</span> <span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_filetree'>filetree</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rparen'>)</span>
 
-<span class='kw'>def</span> <span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_filetree'>filetree</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rparen'>)</span>
+    <span class='comment'># Non-nil if directory needs to be changed.
+</span>    <span class='id identifier rubyid_pwd'>pwd</span> <span class='op'>=</span> <span class='kw'>nil</span>
 
-    <span class='id identifier rubyid_pwd'>pwd</span> <span class='op'>=</span> <span class='kw'>nil</span>
+    <span class='kw'>if</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span>
 
-    <span class='kw'>if</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span>
-        <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
+        <span class='comment'># Absolue path.
+</span>        <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_basedir'>basedir</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
         <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_travel'>travel</span>
+
     <span class='kw'>else</span>
-        <span class='id identifier rubyid_pwd'>pwd</span> <span class='op'>=</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_pwd'>pwd</span>
-        <span class='id identifier rubyid_full'>full</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_absolute_path'>absolute_path</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span> <span class='rparen'>)</span>
+
+        <span class='comment'># Relative path.
+</span>
+        <span class='comment'># Store current directory before chdir.
+</span>        <span class='id identifier rubyid_pwd'>pwd</span> <span class='op'>=</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_pwd'>pwd</span>
+
+        <span class='comment'># Generate target directory for chdir. One up from
+</span>        <span class='comment'># the reference.
+</span>        <span class='id identifier rubyid_full'>full</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_absolute_path'>absolute_path</span><span class='lparen'>(</span> <span class='id identifier rubyid_basedir'>basedir</span> <span class='rparen'>)</span>
         <span class='id identifier rubyid_base'>base</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span> <span class='id identifier rubyid_full'>full</span> <span class='rparen'>)</span>
         <span class='id identifier rubyid_dir'>dir</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span> <span class='id identifier rubyid_full'>full</span> <span class='rparen'>)</span>
-        <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_chdir'>chdir</span><span class='lparen'>(</span> <span class='id identifier rubyid_dir'>dir</span> <span class='rparen'>)</span>
+
+        <span class='comment'># Goto target.
+</span>        <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_chdir'>chdir</span><span class='lparen'>(</span> <span class='id identifier rubyid_dir'>dir</span> <span class='rparen'>)</span>
+
         <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='const'>Travel</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_base'>base</span><span class='comma'>,</span> <span class='id identifier rubyid_full'>full</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='rparen'>)</span>
         <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_travel'>travel</span>
     <span class='kw'>end</span>
 
+
     <span class='kw'>if</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_defaults'>defaults</span><span class='lbracket'>[</span> <span class='symbol'>:inclusive</span> <span class='rbracket'>]</span>
-        <span class='id identifier rubyid_uppath'>uppath</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_abspath'>abspath</span> <span class='rparen'>)</span>
-        <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_uppath'>uppath</span>
+
+        <span class='comment'># With inclusive the root is changed to one-up from
+</span>        <span class='comment'># target.
+</span>
+        <span class='comment'># One up from root.
+</span>        <span class='id identifier rubyid_uppath'>uppath</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_abspath'>abspath</span> <span class='rparen'>)</span>
         <span class='kw'>if</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_relative?'>relative?</span>
             <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span> <span class='id identifier rubyid_uppath'>uppath</span> <span class='rparen'>)</span>
+        <span class='kw'>else</span>
+            <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_uppath'>uppath</span>
         <span class='kw'>end</span>
-        <span class='id identifier rubyid_newRoot'>newRoot</span> <span class='op'>=</span> <span class='const'>DirEntry</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_uppath'>uppath</span> <span class='rparen'>)</span>
-        <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_rename'>rename</span><span class='lparen'>(</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_tip'>tip</span> <span class='rparen'>)</span>
-        <span class='id identifier rubyid_newRoot'>newRoot</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span> <span class='rparen'>)</span>
-        <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span> <span class='op'>=</span> <span class='id identifier rubyid_newRoot'>newRoot</span>
+
+        <span class='comment'># Create the &quot;one-up&quot; root.
+</span>        <span class='id identifier rubyid_newRoot'>newRoot</span> <span class='op'>=</span> <span class='const'>DirEntry</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_uppath'>uppath</span> <span class='rparen'>)</span>
+
+        <span class='comment'># Rename old root.
+</span>        <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_rename'>rename</span><span class='lparen'>(</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span><span class='period'>.</span><span class='id identifier rubyid_tip'>tip</span> <span class='rparen'>)</span>
+
+        <span class='comment'># Add to one-up root.
+</span>        <span class='id identifier rubyid_newRoot'>newRoot</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span> <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span> <span class='rparen'>)</span>
+
+        <span class='comment'># Set root to one-up root.
+</span>        <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span> <span class='op'>=</span> <span class='id identifier rubyid_newRoot'>newRoot</span>
     <span class='kw'>end</span>
 
-    <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_chdir'>chdir</span><span class='lparen'>(</span> <span class='id identifier rubyid_pwd'>pwd</span> <span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_pwd'>pwd</span>
+    <span class='comment'># Return back to start directory if dir changed.
+</span>    <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_chdir'>chdir</span><span class='lparen'>(</span> <span class='id identifier rubyid_pwd'>pwd</span> <span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_pwd'>pwd</span>
 
-    <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span>
+    <span class='comment'># Return root {DirEntry}.
+</span>    <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -787,12 +909,12 @@ with suffix and modify tree building with options Hash (see below).</p>
       <pre class="lines">
 
 
-275
-276
-277</pre>
+331
+332
+333</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 275</span>
+      <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 331</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_travel'>travel</span><span class='lparen'>(</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='op'>=</span> <span class='ivar'>@defaults</span><span class='lbracket'>[</span> <span class='symbol'>:suffix</span> <span class='rbracket'>]</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_entriesIn'>entriesIn</span><span class='lparen'>(</span> <span class='ivar'>@basedir</span><span class='comma'>,</span> <span class='ivar'>@root</span><span class='comma'>,</span> <span class='id identifier rubyid_suffix'>suffix</span> <span class='rparen'>)</span>
@@ -807,9 +929,9 @@ with suffix and modify tree building with options Hash (see below).</p>
 </div>
 
     <div id="footer">
-  Generated on Thu Jan 23 19:01:13 2014 by
+  Generated on Sun Apr 19 15:01:50 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.6.1 (ruby-1.9.3).
+  0.8.7.6 (ruby-2.1.2).
 </div>
 
   </body>