term_utils 0.3.2 → 0.5.0

data/doc/TermUtils/FF/Query.html

@@ -6,15 +6,15 @@
 <title>
   Class: TermUtils::FF::Query
   
-    &mdash; Documentation by YARD 0.9.20
+    &mdash; Documentation by YARD 0.9.34
   
 </title>
 
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
 
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
 
-<script type="text/javascript" charset="utf-8">
+<script type="text/javascript">
   pathId = "TermUtils::FF::Query";
   relpath = '../../';
 </script>
@@ -118,6 +118,63 @@
 
 
   
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#accept_entry_name%3F-class_method" title="accept_entry_name? (class method)">.<strong>accept_entry_name?</strong>(ctx, name)  &#x21d2; Boolean </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Tests whether a given entry should be accepted.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#search-class_method" title="search (class method)">.<strong>search</strong>(ctx, parent_entry)  &#x21d2; nil </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Searches a directory.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
     <h2>
       Instance Method Summary
       <small><a href="#" class="summary_toggle">collapse</a></small>
@@ -128,7 +185,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#exec-instance_method" title="#exec (instance method)">#<strong>exec</strong>(path)  &#x21d2; TermUtils::FF::Cursor </a>
+      <a href="#exec-instance_method" title="#exec (instance method)">#<strong>exec</strong>(path, &amp;block)  &#x21d2; Array&lt;Entry&gt; </a>
     
 
     
@@ -152,7 +209,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#ignore-instance_method" title="#ignore (instance method)">#<strong>ignore</strong>(regexp)  &#x21d2; TermUtils::FF::Query </a>
+      <a href="#ignore-instance_method" title="#ignore (instance method)">#<strong>ignore</strong>(regexp)  &#x21d2; Query </a>
     
 
     
@@ -167,7 +224,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Adds a Regexp to ignore.</p>
+<p>Adds a Regexp for ignoring file names.</p>
 </div></span>
   
 </li>
@@ -193,7 +250,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>A new instance of Query.</p>
+<p>Constructs a new Query.</p>
 </div></span>
   
 </li>
@@ -224,7 +281,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#max_depth-instance_method" title="#max_depth (instance method)">#<strong>max_depth</strong>(depth)  &#x21d2; TermUtils::FF::Query </a>
+      <a href="#max_depth-instance_method" title="#max_depth (instance method)">#<strong>max_depth</strong>(depth)  &#x21d2; Query </a>
     
 
     
@@ -248,7 +305,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#min_depth-instance_method" title="#min_depth (instance method)">#<strong>min_depth</strong>(depth)  &#x21d2; TermUtils::FF::Query </a>
+      <a href="#min_depth-instance_method" title="#min_depth (instance method)">#<strong>min_depth</strong>(depth)  &#x21d2; Query </a>
     
 
     
@@ -272,7 +329,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#sort-instance_method" title="#sort (instance method)">#<strong>sort</strong>(sorted = true)  &#x21d2; TermUtils::FF::Query </a>
+      <a href="#sort-instance_method" title="#sort (instance method)">#<strong>sort</strong>(mode = :forward, &amp;block)  &#x21d2; Query </a>
     
 
     
@@ -287,7 +344,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Sets whether results shall be sorted.</p>
+<p>Sets the sorting mode.</p>
 </div></span>
   
 </li>
@@ -311,7 +368,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns a new instance of Query</p>
+<p>Constructs a new Query.</p>
 
 
   </div>
@@ -325,12 +382,12 @@
       <pre class="lines">
 
 
-23
-24
-25</pre>
+26
+27
+28</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 23</span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 26</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
   <span class='ivar'>@config</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Config.html" title="TermUtils::FF::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Config.html#initialize-instance_method" title="TermUtils::FF::Config#initialize (method)">new</a></span></span>
@@ -343,6 +400,234 @@
 </div>
 
 
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="accept_entry_name?-class_method">
+  
+    .<strong>accept_entry_name?</strong>(ctx, name)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Tests whether a given entry should be accepted.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>ctx</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Context.html" title="TermUtils::FF::Context (class)">Context</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>name</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+135
+136
+137
+138
+139
+140</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 135</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_accept_entry_name?'>accept_entry_name?</span><span class='lparen'>(</span><span class='id identifier rubyid_ctx'>ctx</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_ignore_list'>ignore_list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span>
+    <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+  <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="search-class_method">
+  
+    .<strong>search</strong>(ctx, parent_entry)  &#x21d2; <tt>nil</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Searches a directory.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>ctx</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Context.html" title="TermUtils::FF::Context (class)">Context</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>parent_entry</span>
+      
+      
+        <span class='type'>(<tt>entry</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>nil</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+99
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 99</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='id identifier rubyid_ctx'>ctx</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_entry'>parent_entry</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='id identifier rubyid_parent_entry'>parent_entry</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
+  <span class='kw'>unless</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_sorting_mode'>sorting_mode</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='kw'>if</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_sorting_compare'>sorting_compare</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+      <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_sort!'>sort!</span>
+    <span class='kw'>else</span>
+      <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_sort!'>sort!</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_sorting_compare'>sorting_compare</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+    <span class='kw'>if</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_sorting_mode'>sorting_mode</span> <span class='op'>==</span> <span class='symbol'>:reverse</span>
+      <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_reverse!'>reverse!</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_name'>name</span><span class='op'>|</span>
+    <span class='kw'>next</span> <span class='kw'>if</span> <span class='qwords_beg'>%w[</span><span class='tstring_content'>.</span><span class='words_sep'> </span><span class='tstring_content'>..</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_name'>name</span>
+    <span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_accept_entry_name?'>accept_entry_name?</span><span class='lparen'>(</span><span class='id identifier rubyid_ctx'>ctx</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
+
+    <span class='id identifier rubyid_new_entry'>new_entry</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Entry.html" title="TermUtils::FF::Entry (class)">Entry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Entry.html#initialize-instance_method" title="TermUtils::FF::Entry#initialize (method)">new</a></span></span>
+    <span class='id identifier rubyid_new_entry'>new_entry</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
+    <span class='id identifier rubyid_new_entry'>new_entry</span><span class='period'>.</span><span class='id identifier rubyid_relative_path_comps'>relative_path_comps</span> <span class='op'>=</span> <span class='id identifier rubyid_parent_entry'>parent_entry</span><span class='period'>.</span><span class='id identifier rubyid_relative_path_comps'>relative_path_comps</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_new_entry'>new_entry</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_base_path'>base_path</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_new_entry'>new_entry</span><span class='period'>.</span><span class='id identifier rubyid_relative_path_comps'>relative_path_comps</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+    <span class='kw'>if</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_min_depth'>min_depth</span> <span class='op'>&lt;=</span> <span class='id identifier rubyid_new_entry'>new_entry</span><span class='period'>.</span><span class='id identifier rubyid_depth'>depth</span>
+      <span class='id identifier rubyid_new_entry'>new_entry</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_index_seq'>index_seq</span>
+      <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_index_seq'>index_seq</span> <span class='op'>+=</span> <span class='int'>1</span>
+      <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_new_entry'>new_entry</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_block'>block</span>
+      <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_new_entry'>new_entry</span>
+    <span class='kw'>end</span>
+    <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_directory?'>directory?</span><span class='lparen'>(</span><span class='id identifier rubyid_new_entry'>new_entry</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_max_depth'>max_depth</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_max_depth'>max_depth</span> <span class='op'>&gt;</span> <span class='id identifier rubyid_new_entry'>new_entry</span><span class='period'>.</span><span class='id identifier rubyid_depth'>depth</span><span class='rparen'>)</span>
+      <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='id identifier rubyid_ctx'>ctx</span><span class='comma'>,</span> <span class='id identifier rubyid_new_entry'>new_entry</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
 
@@ -350,7 +635,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="exec-instance_method">
   
-    #<strong>exec</strong>(path)  &#x21d2; <tt><span class='object_link'><a href="Cursor.html" title="TermUtils::FF::Cursor (class)">TermUtils::FF::Cursor</a></span></tt> 
+    #<strong>exec</strong>(path, &amp;block)  &#x21d2; <tt>Array&lt;<span class='object_link'><a href="Entry.html" title="TermUtils::FF::Entry (class)">Entry</a></span>&gt;</tt> 
   
 
   
@@ -387,7 +672,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="Cursor.html" title="TermUtils::FF::Cursor (class)">TermUtils::FF::Cursor</a></span></tt>)</span>
+        <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Entry.html" title="TermUtils::FF::Entry (class)">Entry</a></span>&gt;</tt>)</span>
       
       
       
@@ -401,15 +686,55 @@
       <pre class="lines">
 
 
-61
-62
-63</pre>
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92
+93</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 61</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_exec'>exec</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
-  <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Cursor.html" title="TermUtils::FF::Cursor (class)">Cursor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Cursor.html#initialize-instance_method" title="TermUtils::FF::Cursor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_bootstrap'><span class='object_link'><a href="Cursor.html#bootstrap-instance_method" title="TermUtils::FF::Cursor#bootstrap (method)">bootstrap</a></span></span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 71</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_exec'>exec</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ctx'>ctx</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Context.html" title="TermUtils::FF::Context (class)">Context</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+  <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
+  <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_min_depth'>min_depth</span> <span class='op'>=</span> <span class='int'>0</span> <span class='kw'>if</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_min_depth'>min_depth</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_base_path'>base_path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
+  <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_block'>block</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
+  <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_index_seq'>index_seq</span> <span class='op'>=</span> <span class='int'>0</span>
+  <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_first_entry'>first_entry</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Entry.html" title="TermUtils::FF::Entry (class)">Entry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Entry.html#initialize-instance_method" title="TermUtils::FF::Entry#initialize (method)">new</a></span></span>
+  <span class='id identifier rubyid_first_entry'>first_entry</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
+  <span class='id identifier rubyid_first_entry'>first_entry</span><span class='period'>.</span><span class='id identifier rubyid_relative_path_comps'>relative_path_comps</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_first_entry'>first_entry</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_min_depth'>min_depth</span> <span class='op'>==</span> <span class='int'>0</span>
+    <span class='id identifier rubyid_first_entry'>first_entry</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span> <span class='op'>=</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_index_seq'>index_seq</span>
+    <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_index_seq'>index_seq</span> <span class='op'>+=</span> <span class='int'>1</span>
+    <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_first_entry'>first_entry</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_block'>block</span>
+    <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_first_entry'>first_entry</span>
+  <span class='kw'>end</span>
+  <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_directory?'>directory?</span><span class='lparen'>(</span><span class='id identifier rubyid_first_entry'>first_entry</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_max_depth'>max_depth</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_max_depth'>max_depth</span> <span class='op'>&gt;</span> <span class='int'>0</span><span class='rparen'>)</span>
+    <span class='const'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../FF.html" title="TermUtils::FF (module)">FF</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></span><span class='period'>.</span><span class='id identifier rubyid_search'><span class='object_link'><a href="#search-class_method" title="TermUtils::FF::Query.search (method)">search</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ctx'>ctx</span><span class='comma'>,</span> <span class='id identifier rubyid_first_entry'>first_entry</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_ctx'>ctx</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -419,7 +744,7 @@
       <div class="method_details ">
   <h3 class="signature " id="ignore-instance_method">
   
-    #<strong>ignore</strong>(regexp)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt> 
+    #<strong>ignore</strong>(regexp)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt> 
   
 
   
@@ -428,7 +753,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Adds a Regexp to ignore.</p>
+<p>Adds a Regexp for ignoring file names.</p>
 
 
   </div>
@@ -456,7 +781,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt>)</span>
       
       
       
@@ -470,13 +795,13 @@
       <pre class="lines">
 
 
-33
-34
-35
-36</pre>
+38
+39
+40
+41</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 33</span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 38</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_ignore'>ignore</span><span class='lparen'>(</span><span class='id identifier rubyid_regexp'>regexp</span><span class='rparen'>)</span>
   <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_ignore_list'>ignore_list</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_regexp'>regexp</span>
@@ -502,17 +827,17 @@
       <pre class="lines">
 
 
-26
-27
-28
-29</pre>
+30
+31
+32
+33</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 30</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize_copy'>initialize_copy</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
-  <span class='ivar'>@config</span> <span class='op'>=</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
   <span class='kw'>super</span>
+  <span class='ivar'>@config</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -522,7 +847,7 @@
       <div class="method_details ">
   <h3 class="signature " id="max_depth-instance_method">
   
-    #<strong>max_depth</strong>(depth)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt> 
+    #<strong>max_depth</strong>(depth)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt> 
   
 
   
@@ -559,7 +884,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt>)</span>
       
       
       
@@ -573,13 +898,13 @@
       <pre class="lines">
 
 
-47
-48
-49
-50</pre>
+54
+55
+56
+57</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 47</span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 54</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_max_depth'>max_depth</span><span class='lparen'>(</span><span class='id identifier rubyid_depth'>depth</span><span class='rparen'>)</span>
   <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_max_depth'>max_depth</span> <span class='op'>=</span> <span class='id identifier rubyid_depth'>depth</span>
@@ -593,7 +918,7 @@
       <div class="method_details ">
   <h3 class="signature " id="min_depth-instance_method">
   
-    #<strong>min_depth</strong>(depth)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt> 
+    #<strong>min_depth</strong>(depth)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt> 
   
 
   
@@ -630,7 +955,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt>)</span>
       
       
       
@@ -644,13 +969,13 @@
       <pre class="lines">
 
 
-40
-41
-42
-43</pre>
+46
+47
+48
+49</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 40</span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 46</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_min_depth'>min_depth</span><span class='lparen'>(</span><span class='id identifier rubyid_depth'>depth</span><span class='rparen'>)</span>
   <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_min_depth'>min_depth</span> <span class='op'>=</span> <span class='id identifier rubyid_depth'>depth</span>
@@ -664,7 +989,7 @@
       <div class="method_details ">
   <h3 class="signature " id="sort-instance_method">
   
-    #<strong>sort</strong>(sorted = true)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt> 
+    #<strong>sort</strong>(mode = :forward, &amp;block)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt> 
   
 
   
@@ -673,7 +998,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Sets whether results shall be sorted.</p>
+<p>Sets the sorting mode.</p>
 
 
   </div>
@@ -684,14 +1009,19 @@
   
     <li>
       
-        <span class='name'>sorted</span>
+        <span class='name'>mode</span>
       
       
-        <span class='type'>(<tt>Boolean</tt>)</span>
+        <span class='type'>(<tt>Symbol</tt>)</span>
+      
       
+        <em class="default">(defaults to: <tt>:forward</tt>)</em>
       
-        <em class="default">(defaults to: <tt>true</tt>)</em>
       
+        &mdash;
+        <div class='inline'>
+<p>Either ‘:forward`, `:reverse` or `nil` (default).</p>
+</div>
       
     </li>
   
@@ -703,7 +1033,7 @@
     <li>
       
       
-        <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">TermUtils::FF::Query</a></span></tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="" title="TermUtils::FF::Query (class)">Query</a></span></tt>)</span>
       
       
       
@@ -717,16 +1047,18 @@
       <pre class="lines">
 
 
-54
-55
-56
-57</pre>
+62
+63
+64
+65
+66</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 54</span>
+      <pre class="code"><span class="info file"># File 'lib/term_utils/ff/query.rb', line 62</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_sort'>sort</span><span class='lparen'>(</span><span class='id identifier rubyid_sorted'>sorted</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
-  <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_sorted'>sorted</span> <span class='op'>=</span> <span class='id identifier rubyid_sorted'>sorted</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_sort'>sort</span><span class='lparen'>(</span><span class='id identifier rubyid_mode'>mode</span> <span class='op'>=</span> <span class='symbol'>:forward</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+  <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_sorting_mode'>sorting_mode</span> <span class='op'>=</span> <span class='id identifier rubyid_mode'>mode</span>
+  <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_sorting_compare'>sorting_compare</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -739,9 +1071,9 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Feb  7 18:54:40 2020 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.5).
+  Generated on Wed Aug  9 17:34:26 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.34 (ruby-3.2.2).
 </div>
 
     </div>