csv_decision 0.2.0 → 0.3.0

data/doc/CSVDecision/Dictionary/Entry.html

@@ -174,6 +174,33 @@ it only contains constants.</p>
 default value.</p>
 </div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#indexed-instance_method" title="#indexed (instance method)">#<strong>indexed</strong>  &#x21d2; Boolean </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  <span class="private note title">private</span>
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns true if this column is indexed.</p>
+</div></span>
+  
 </li>
 
     
@@ -296,7 +323,7 @@ default value.</p>
   
     <span class="summary_desc"><div class='inline'>
 <p>Create a new column dictionary entry defaulting attributes from the column
-type, which is looked up in <code>ENTRY</code> table.</p>
+type, which is looked up in the above table.</p>
 </div></span>
   
 </li>
@@ -314,7 +341,7 @@ type, which is looked up in <code>ENTRY</code> table.</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name:, type:, eval: nil, set_if: nil)  &#x21d2; Entry </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name:, type:, eval: nil, set_if: nil, indexed: nil)  &#x21d2; Entry </a>
     
 
     
@@ -394,7 +421,7 @@ type, which is looked up in <code>ENTRY</code> table.</p>
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    #<strong>initialize</strong>(name:, type:, eval: nil, set_if: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="CSVDecision::Dictionary::Entry (class)">Entry</a></span></tt> 
+    #<strong>initialize</strong>(name:, type:, eval: nil, set_if: nil, indexed: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="CSVDecision::Dictionary::Entry (class)">Entry</a></span></tt> 
   
 
   
@@ -421,25 +448,27 @@ type, which is looked up in <code>ENTRY</code> table.</p>
       <pre class="lines">
 
 
-70
-71
-72
-73
-74
-75
-76
-77</pre>
+91
+92
+93
+94
+95
+96
+97
+98
+99</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 70</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 91</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>eval:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>set_if:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>eval:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>set_if:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>indexed:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
   <span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span>
   <span class='ivar'>@eval</span> <span class='op'>=</span> <span class='id identifier rubyid_eval'>eval</span>
   <span class='ivar'>@set_if</span> <span class='op'>=</span> <span class='id identifier rubyid_set_if'>set_if</span>
   <span class='ivar'>@function</span> <span class='op'>=</span> <span class='kw'>nil</span>
   <span class='ivar'>@ins</span> <span class='op'>=</span> <span class='const'>INS_TYPES</span><span class='period'>.</span><span class='id identifier rubyid_member?'>member?</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
+  <span class='ivar'>@indexed</span> <span class='op'>=</span> <span class='id identifier rubyid_indexed'>indexed</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -503,12 +532,12 @@ it only contains constants.</p>
       <pre class="lines">
 
 
-55
-56
-57</pre>
+75
+76
+77</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 55</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 75</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_eval'>eval</span>
   <span class='ivar'>@eval</span>
@@ -570,12 +599,12 @@ default value. If not a proc, then it&#39;s some type of constant.</p>
       <pre class="lines">
 
 
-64
-65
-66</pre>
+84
+85
+86</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 64</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 84</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_function'>function</span>
   <span class='ivar'>@function</span>
@@ -586,6 +615,71 @@ default value. If not a proc, then it&#39;s some type of constant.</p>
 </div>
     
       
+      <span id="indexed=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="indexed-instance_method">
+  
+    #<strong>indexed</strong>  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p class="note private">
+  <strong>This method is part of a private API.</strong>
+  You should avoid using this method if possible, as it may be removed or be changed in the future.
+</p>
+
+<p>Returns true if this column is indexed</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Returns true if this column is indexed</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+71
+72
+73</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 71</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_indexed'>indexed</span>
+  <span class='ivar'>@indexed</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
       <span id=""></span>
       <div class="method_details ">
   <h3 class="signature " id="name-instance_method">
@@ -635,12 +729,12 @@ default value. If not a proc, then it&#39;s some type of constant.</p>
       <pre class="lines">
 
 
-48
-49
-50</pre>
+65
+66
+67</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 48</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 65</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
   <span class='ivar'>@name</span>
@@ -704,12 +798,12 @@ value that must evaluate to a truthy value.</p>
       <pre class="lines">
 
 
-60
-61
-62</pre>
+80
+81
+82</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 60</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 80</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_set_if'>set_if</span>
   <span class='ivar'>@set_if</span>
@@ -769,12 +863,12 @@ value that must evaluate to a truthy value.</p>
       <pre class="lines">
 
 
-51
-52
-53</pre>
+68
+69
+70</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 51</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 68</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
   <span class='ivar'>@type</span>
@@ -808,7 +902,7 @@ value that must evaluate to a truthy value.</p>
 </p>
 
 <p>Create a new column dictionary entry defaulting attributes from the column
-type, which is looked up in <code>ENTRY</code> table.</p>
+type, which is looked up in the above table.</p>
 
 
   </div>
@@ -876,18 +970,26 @@ type, which is looked up in <code>ENTRY</code> table.</p>
       <pre class="lines">
 
 
-37
-38
-39
-40</pre>
+50
+51
+52
+53
+54
+55
+56
+57</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 37</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 50</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='const'>ENTRY</span><span class='lbracket'>[</span><span class='id identifier rubyid_type'>type</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>eval:</span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:eval</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>set_if:</span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:set_if</span><span class='rbracket'>]</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
+  <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
+      <span class='label'>eval:</span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:eval</span><span class='rbracket'>]</span><span class='comma'>,</span>              <span class='comment'># Set if the column requires functions evaluated
+</span>      <span class='label'>type:</span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span><span class='comma'>,</span>              <span class='comment'># Column type
+</span>      <span class='label'>set_if:</span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:set_if</span><span class='rbracket'>]</span><span class='comma'>,</span>          <span class='comment'># Set if the column has a conditional default
+</span>      <span class='label'>indexed:</span> <span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='symbol'>:guard</span><span class='rparen'>)</span> <span class='comment'># A guard column cannot be indexed.
+</span><span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -947,12 +1049,12 @@ type, which is looked up in <code>ENTRY</code> table.</p>
       <pre class="lines">
 
 
-43
-44
-45</pre>
+60
+61
+62</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 43</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 60</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_ins?'>ins?</span>
   <span class='ivar'>@ins</span>
@@ -1005,17 +1107,17 @@ type, which is looked up in <code>ENTRY</code> table.</p>
       <pre class="lines">
 
 
-82
-83
-84
-85
-86
-87
-88
-89</pre>
+104
+105
+106
+107
+108
+109
+110
+111</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 82</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 104</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
   <span class='lbrace'>{</span>
@@ -1035,7 +1137,7 @@ type, which is looked up in <code>ENTRY</code> table.</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Jan 13 10:02:47 2018 by
+  Generated on Sat Jan 20 15:44:36 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.4.0).
 </div>

data/doc/CSVDecision/Dictionary.html

@@ -151,7 +151,7 @@ table load time.</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#build-class_method" title="build (class method)">.<strong>build</strong>(header:, dictionary:)  &#x21d2; Hash&lt;Hash&gt; </a>
+      <a href="#build-class_method" title="build (class method)">.<strong>build</strong>(header:, dictionary:)  &#x21d2; Columns::Dictionary </a>
     
 
     
@@ -244,7 +244,7 @@ the header row.</p>
         <span class='name'>out</span>
       
       
-        <span class='type'>(<tt>false</tt>, <tt>Index</tt>)</span>
+        <span class='type'>(<tt>false</tt>, <tt><span class='object_link'><a href="Index.html" title="CSVDecision::Index (class)">Index</a></span></tt>)</span>
       
       
       
@@ -282,15 +282,15 @@ the header row.</p>
       <pre class="lines">
 
 
-111
-112
-113
-114
-115
-116</pre>
+17
+18
+19
+20
+21
+22</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 111</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 17</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_add_name'>add_name</span><span class='lparen'>(</span><span class='label'>columns:</span><span class='comma'>,</span> <span class='label'>name:</span><span class='comma'>,</span> <span class='label'>out:</span> <span class='kw'>false</span><span class='rparen'>)</span>
   <span class='const'><span class='object_link'><a href="Validate.html" title="CSVDecision::Validate (module)">Validate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_name'><span class='object_link'><a href="Validate.html#name-class_method" title="CSVDecision::Validate.name (method)">name</a></span></span><span class='lparen'>(</span><span class='label'>columns:</span> <span class='id identifier rubyid_columns'>columns</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>out:</span> <span class='id identifier rubyid_out'>out</span><span class='rparen'>)</span>
@@ -306,7 +306,7 @@ the header row.</p>
       <div class="method_details ">
   <h3 class="signature " id="build-class_method">
   
-    .<strong>build</strong>(header:, dictionary:)  &#x21d2; <tt>Hash&lt;Hash&gt;</tt> 
+    .<strong>build</strong>(header:, dictionary:)  &#x21d2; <tt><span class='object_link'><a href="Columns/Dictionary.html" title="CSVDecision::Columns::Dictionary (class)">Columns::Dictionary</a></span></tt> 
   
 
   
@@ -341,6 +341,22 @@ the header row.</p>
         &mdash;
         <div class='inline'>
 <p>The header row after removing any empty columns.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>dictionary</span>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Columns/Dictionary.html" title="CSVDecision::Columns::Dictionary (class)">Columns::Dictionary</a></span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Table&#39;s columns dictionary.</p>
 </div>
       
     </li>
@@ -353,13 +369,13 @@ the header row.</p>
     <li>
       
       
-        <span class='type'>(<tt>Hash&lt;Hash&gt;</tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Columns/Dictionary.html" title="CSVDecision::Columns::Dictionary (class)">Columns::Dictionary</a></span></tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>Column dictionary is a hash of hashes.</p>
+<p>Table&#39;s columns dictionary.</p>
 </div>
       
     </li>
@@ -372,16 +388,16 @@ the header row.</p>
       <pre class="lines">
 
 
-97
-98
-99
-100
-101
-102
-103</pre>
+120
+121
+122
+123
+124
+125
+126</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 97</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/dictionary.rb', line 120</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='label'>header:</span><span class='comma'>,</span> <span class='label'>dictionary:</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_header'>header</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cell'>cell</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='op'>|</span>
@@ -400,7 +416,7 @@ the header row.</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Jan 13 10:02:46 2018 by
+  Generated on Sat Jan 20 15:44:34 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.4.0).
 </div>

data/doc/CSVDecision/Error.html

@@ -129,7 +129,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Jan 13 10:02:46 2018 by
+  Generated on Sat Jan 20 15:44:35 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.4.0).
 </div>

data/doc/CSVDecision/FileError.html

@@ -133,7 +133,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Jan 13 10:02:46 2018 by
+  Generated on Sat Jan 20 15:44:35 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.12 (ruby-2.4.0).
 </div>