csv_decision 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb4d2ffd07c2aac31b030fd68f0a1e01150ef6c7
-  data.tar.gz: ce4aea2ef63a88aeaf20f74c5c5f06840a1d301b
+  metadata.gz: 67d87d1568c8a9427eca158d72473cceab9ea0cc
+  data.tar.gz: acaf91742be83cdee27cad0135feed854bff8f4d
 SHA512:
-  metadata.gz: f1ae251c6bf929f1066f3b72d67b3c992c605ecc7f26ff5938c7c4309ea785b3c373d9b6851dd1d527af5b986fd2dc7e3e7a608002d49659abb9837345056fca
-  data.tar.gz: d5d33bf46c8e02f0178e03c4dcd61b1cff7cf5dfe0c6c0885b9535721a573dee3a1de232d09ca80efa748bc80ca4ebe6b48bb12a8d5358be81e3a574579be85f
+  metadata.gz: 983a199ab2f592b3b78fb6cef1b95e0af0a45aaaca9f352d7ff22a7e7b5ade08268d6efb41530a137fbd00c77516e9d12f3d21e66c6901ea927611600c1d2c7a
+  data.tar.gz: a75924ebd838c43be4c876e52332bccb1b57be3ecd719c9a81283bc449a14174294f90df64e08db2f50df463920f42ffeec5a8ec148106c589332336d0bfee34

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.0, January 2018.
+*Additions*
+- Set values in the input hash either as a default or unconditionally.
+
 ## v0.1.0, 5 January 2018.
 *Additions*
 - Implement more checks on output columns that are duplicated or

data/README.md

@@ -198,7 +198,7 @@ may be simplified to:
 These comparison operators are also supported: `!=`, `>`, `>=`, `<`, `<=`.
 For more simple examples see `spec/csv_decision/examples_spec.rb`.
 
-#### Input guard conditions
+#### Input `guard` conditions
 Sometimes it's more convenient to write guard expressions in a single column specialized for that purpose. 
 For example:
 
@@ -222,7 +222,7 @@ Input `guard:` columns may be anonymous, and must contain non-constant expressio
 0-arity Ruby methods, the following comparison operators are allowed: `==`, `!=`,
 `>`, `>=`, `<` and `<=`. Also, regular expressions are supported - i.e., `=~` and `!~`.
 
-#### Output if conditions
+#### Output `if` conditions
 In some situations it is useful to apply filter conditions *after* all the output
 columns have been derived. For example:
 
@@ -245,6 +245,30 @@ Output `if:` columns may be anonymous, and must contain non-constant expressions
 0-arity Ruby methods, the following comparison operators are allowed: `==`, `!=`,
 `>`, `>=`, `<` and `<=`. Also, regular expressions are supported - i.e., `=~` and `!~`.
   
+#### Input `set` columns
+
+If you wish to set default values in the input hash, you can use a `set` column rather
+than an `in` column. The data row beneath the header is used to specify the default expression.
+There are three variations: `set` (unconditional default) `set/nil?`(set if `nil?` true) 
+and `set/blank?` (set if `blank?` true). 
+Note that the `decide!` method will mutate the input hash.
+
+```ruby
+data = <<~DATA
+  set/nil? :country, guard:,          set: class,    out :PAID, out: len,     if:
+  US,                ,                :class.upcase,
+  US,                :CUSIP.present?, != PRIVATE,    :CUSIP,    :PAID.length, :len == 9
+  !=US,              :ISIN.present?,  != PRIVATE,    :ISIN,     :PAID.length, :len == 12
+  US,                :CUSIP.present?, PRIVATE,       :CUSIP,    :PAID.length,
+  !=US,              :ISIN.present?,  PRIVATE,       :ISIN,     :PAID.length,
+DATA
+
+table = CSVDecision.parse(data)
+table.decide(CUSIP: '1234567890', class: 'Private') #=> {PAID: '1234567890', len: 10}
+table.decide(ISIN: '123456789012', country: 'GB', class: 'private') #=> {PAID: '123456789012', len: 12}
+
+```
+
 ### Testing
  
  `csv_decision` includes thorough [RSpec](http://rspec.info) tests:

data/csv_decision.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'csv_decision'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Brett Vickers']
   spec.email         = ['brett@phillips-vickers.com']
   spec.description   = 'CSV based Ruby decision tables.'

data/doc/CSVDecision/CellValidationError.html

@@ -106,7 +106,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>Error validating a cell when parsing input table data.</p>
+<p>Error validating a cell when parsing input table cell data.</p>
 
 
   </div>
@@ -133,7 +133,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sat Jan  6 20:03:01 2018 by
+  Generated on Sat Jan 13 10:02:46 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/Columns/Default.html

@@ -62,7 +62,7 @@
       <div id="content"><h1>Class: CSVDecision::Columns::Default
   
   
-  
+  <span class="private note title">Private</span>
 </h1>
 <div class="box_info">
   
@@ -103,8 +103,12 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    
-<p>Value object used for any columns with defaults</p>
+    <p class="note private">
+  <strong>This class is part of a private API.</strong>
+  You should avoid using this class if possible, as it may be removed or be changed in the future.
+</p>
+
+<p>Value object used for any columns with defaults.</p>
 
 
   </div>
@@ -122,7 +126,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#default_if-instance_method" title="#default_if (instance method)">#<strong>default_if</strong>  &#x21d2; Object </a>
+      <a href="#eval-instance_method" title="#eval (instance method)">#<strong>eval</strong>  &#x21d2; Object </a>
     
 
     
@@ -140,7 +144,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute default_if.</p>
+<p>Returns the value of attribute eval.</p>
 </div></span>
   
 </li>
@@ -197,6 +201,60 @@
 <p>Returns the value of attribute name.</p>
 </div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#set_if-instance_method" title="#set_if (instance method)">#<strong>set_if</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute set_if.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute type.</p>
+</div></span>
+  
 </li>
 
     
@@ -211,11 +269,11 @@
     <h2>Instance Attribute Details</h2>
     
       
-      <span id="default_if=-instance_method"></span>
+      <span id="eval=-instance_method"></span>
       <div class="method_details first">
-  <h3 class="signature first" id="default_if-instance_method">
+  <h3 class="signature first" id="eval-instance_method">
   
-    #<strong>default_if</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>eval</strong>  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -224,7 +282,7 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Returns the value of attribute default_if</p>
+<p>Returns the value of attribute eval</p>
 
 
   </div>
@@ -243,7 +301,7 @@
       
         &mdash;
         <div class='inline'>
-<p>the current value of default_if</p>
+<p>the current value of eval</p>
 </div>
       
     </li>
@@ -256,15 +314,15 @@
       <pre class="lines">
 
 
+12
 13
-14
-15</pre>
+14</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 12</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_default_if'>default_if</span>
-  <span class='ivar'>@default_if</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_eval'>eval</span>
+  <span class='ivar'>@eval</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -317,12 +375,12 @@
       <pre class="lines">
 
 
+12
 13
-14
-15</pre>
+14</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 12</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_function'>function</span>
   <span class='ivar'>@function</span>
@@ -378,12 +436,12 @@
       <pre class="lines">
 
 
+12
 13
-14
-15</pre>
+14</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 12</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
   <span class='ivar'>@name</span>
@@ -393,15 +451,137 @@
 </table>
 </div>
     
+      
+      <span id="set_if=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="set_if-instance_method">
+  
+    #<strong>set_if</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute set_if</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Object</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the current value of set_if</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+12
+13
+14</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 12</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_set_if'>set_if</span>
+  <span class='ivar'>@set_if</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id="type=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="type-instance_method">
+  
+    #<strong>type</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute type</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Object</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the current value of type</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+12
+13
+14</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 12</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
+  <span class='ivar'>@type</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
   </div>
 
 
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 26 15:19:37 2017 by
+  Generated on Sun Jan  7 14:53:45 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.12 (ruby-2.3.0).
+  0.9.12 (ruby-2.4.0).
 </div>
 
     </div>

data/doc/CSVDecision/Columns/Dictionary.html

@@ -106,9 +106,11 @@
   You should avoid using this class if possible, as it may be removed or be changed in the future.
 </p>
 
-<p>Dictionary of all data columns. The key of each hash is the header
-cell&#39;s array column index. Note that input and output columns can be
-interspersed and need not have unique names.</p>
+<p>Dictionary of all table data columns. The key of each hash is the header
+cell&#39;s array column index. Note that input and output columns may be
+interspersed, and multiple input columns may refer to the same input hash
+key symbol. However, output columns must have unique symbols, which cannot
+overlap with input column symbols.</p>
 
 
   </div>
@@ -147,6 +149,33 @@ interspersed and need not have unique names.</p>
 <p>All column names.</p>
 </div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#defaults-instance_method" title="#defaults (instance method)">#<strong>defaults</strong>  &#x21d2; Hash{Integer=&gt;Entry} </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  <span class="private note title">private</span>
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>All defaulted input column dictionary entries.</p>
+</div></span>
+  
 </li>
 
     
@@ -264,8 +293,7 @@ interspersed and need not have unique names.</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>TODO: Input columns with a default value (planned feature) attr_accessor
-:defaults.</p>
+<p>A new instance of Dictionary.</p>
 </div></span>
   
 </li>
@@ -293,8 +321,7 @@ interspersed and need not have unique names.</p>
   You should avoid using this method if possible, as it may be removed or be changed in the future.
 </p>
 
-<p>TODO: Input columns with a default value (planned feature) attr_accessor
-:defaults</p>
+<p>Returns a new instance of Dictionary</p>
 
 
   </div>
@@ -308,26 +335,24 @@ interspersed and need not have unique names.</p>
       <pre class="lines">
 
 
+35
 36
 37
 38
 39
 40
-41
-42
-43</pre>
+41</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 36</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 35</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
   <span class='ivar'>@columns</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+  <span class='ivar'>@defaults</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
   <span class='ivar'>@ifs</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
   <span class='ivar'>@ins</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
   <span class='ivar'>@outs</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
-  <span class='comment'># TODO: @path = {}
-</span>  <span class='comment'># TODO: @defaults = {}
-</span><span class='kw'>end</span></pre>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -404,6 +429,73 @@ interspersed and need not have unique names.</p>
 </div>
     
       
+      <span id="defaults=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="defaults-instance_method">
+  
+    #<strong>defaults</strong>  &#x21d2; <tt>Hash{Integer=&gt;Entry}</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 All defaulted input column dictionary entries. This is actually
+just a subset of :ins.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash{Integer=&gt;Entry}</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>All defaulted input column dictionary entries. This is actually just a
+subset of :ins.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+26
+27
+28</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 26</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_defaults'>defaults</span>
+  <span class='ivar'>@defaults</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
       <span id="ifs=-instance_method"></span>
       <div class="method_details ">
   <h3 class="signature " id="ifs-instance_method">
@@ -421,7 +513,8 @@ interspersed and need not have unique names.</p>
   You should avoid using this method if possible, as it may be removed or be changed in the future.
 </p>
 
-<p>Returns All if: column dictionary entries.</p>
+<p>Returns All if: column dictionary entries. This is actually just a subset
+of :outs.</p>
 
 
   </div>
@@ -440,7 +533,7 @@ interspersed and need not have unique names.</p>
       
         &mdash;
         <div class='inline'>
-<p>All if: column dictionary entries.</p>
+<p>All if: column dictionary entries. This is actually just a subset of :outs.</p>
 </div>
       
     </li>
@@ -453,12 +546,12 @@ interspersed and need not have unique names.</p>
       <pre class="lines">
 
 
-28
-29
-30</pre>
+33
+34
+35</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 28</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 33</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_ifs'>ifs</span>
   <span class='ivar'>@ifs</span>
@@ -583,12 +676,12 @@ interspersed and need not have unique names.</p>
       <pre class="lines">
 
 
-25
-26
-27</pre>
+29
+30
+31</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 29</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_outs'>outs</span>
   <span class='ivar'>@outs</span>
@@ -604,7 +697,7 @@ interspersed and need not have unique names.</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Jan  6 20:03:02 2018 by
+  Generated on Sat Jan 13 10:02:47 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>