csv_decision 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67d87d1568c8a9427eca158d72473cceab9ea0cc
-  data.tar.gz: acaf91742be83cdee27cad0135feed854bff8f4d
+  metadata.gz: 91948b110f220bb5a54cc74494d51b189bf5af51
+  data.tar.gz: 23cd2d5e7aa16a301f09186ccc00b57260d3b275
 SHA512:
-  metadata.gz: 983a199ab2f592b3b78fb6cef1b95e0af0a45aaaca9f352d7ff22a7e7b5ade08268d6efb41530a137fbd00c77516e9d12f3d21e66c6901ea927611600c1d2c7a
-  data.tar.gz: a75924ebd838c43be4c876e52332bccb1b57be3ecd719c9a81283bc449a14174294f90df64e08db2f50df463920f42ffeec5a8ec148106c589332336d0bfee34
+  metadata.gz: '0149f4aa493e08f157e859a79ab09a03f3a980523d1affe16ad1179c6a2ee58e94906daefc1e5bf0456b8d507c8e2fb82e710939ac8ca84648beabb564b045b0'
+  data.tar.gz: 8adce55f750392d0478b0e985ff6a400d4a755e8385684ce29f586220669aa3ddc1ce9fb85efe3a9b108282a89e92a83e2eb4036e9736b1f0b2ed73461f6aa61

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## v0.2.0, January 2018.
+## v0.3.0, 20 January 2018.
+*Additions*
+- Index one or more text-only input columns for faster lookup performance.
+
+## v0.2.0, 13 January 2018.
 *Additions*
 - Set values in the input hash either as a default or unconditionally.
 

data/README.md

@@ -36,7 +36,7 @@ see `benchmarks/rufus_decision.rb`.)
 To get started, just add `csv_decision` to your `Gemfile`, and then run `bundle`:
  
  ```ruby
- gem 'csv_decision', '~> 0.1'
+ gem 'csv_decision'
  ```
  
  or simply
@@ -126,7 +126,8 @@ Complete documentation of all table parameters is in the code - see
 ### CSV Decision features
  * Either returns the first matching row as a hash (default), or accumulates all matches as an 
  array of hashes (i.e., `parse` option `first_match: false` or CSV file option `accumulate`).
- * Fast decision-time performance (see `benchmarks` folder).
+ * Fast decision-time performance (see `benchmarks` folder). Automatically indexes all 
+ text-only columns that do not contain any empty strings.
  * In addition to simple strings, `csv_decision` can match basic Ruby constants (e.g., `=nil`), 
  regular expressions (e.g., `=~ on|off`), comparisons (e.g., `> 100.0` ) and 
  Ruby-style ranges (e.g., `1..10`)
@@ -282,13 +283,15 @@ table.decide(ISIN: '123456789012', country: 'GB', class: 'private') #=> {PAID: '
 ### Planned features
  `csv_decision` is still a work in progress, and will be enhanced to support
  the following features:
- * Text-only input columns may be indexed for faster lookup performance.
- * Input hash values may be (conditionally) defaulted with a constant or a function call.
- * Output columns may construct interpolated strings referencing column symbols.
- * Supply a pre-defined library of functions that can be called within input columns to 
-   implement matching logic or from the output columns to formulate the final decision.
+ * Supply a pre-defined library of functions that may be called within input columns to 
+   implement custom matching logic, or from the output columns to formulate the final 
+   decision.
+ * Built-in lookup functions evaluate other decision tables to implement guard conditions,
+   or supply output values.
  * Available functions may be extended with a user-supplied library of Ruby methods 
-   for tailored logic.
+   for custom logic.
+ * Output columns may construct interpolated strings containing references to column 
+   symbols.
  
 ### Reasons for the limitations of column expressions
 The simple column expressions allowed by `csv_decision` are purposely limited for reasons of

data/benchmarks/rufus_decision.rb

@@ -13,7 +13,15 @@ RUFUS_OPTIONS = { open_uri: false, ruby_eval: false }.freeze
 
 benchmarks = [
   {
-    name: 'String compares only (no index)',
+    name: 'String compares only with index',
+    data: 'index_example.csv',
+    input: { 'topic' => 'politics', 'region' => 'Arctic' },
+    # Expected results for first_match and accumulate
+    first_match: { 'team_member' => 'Henry' },
+    accumulate: { 'team_member' => ['Henry', 'Zach'] }
+  },
+  {
+    name: 'String compares only',
     data: 'simple_example.csv',
     input: { 'topic' => 'culture', 'region' => 'America' },
     # Expected results for first_match and accumulate

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.2.0'
+  spec.version       = '0.3.0'
   spec.authors       = ['Brett Vickers']
   spec.email         = ['brett@phillips-vickers.com']
   spec.description   = 'CSV based Ruby decision tables.'

data/doc/CSVDecision/CellValidationError.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>

data/doc/CSVDecision/Columns/Dictionary.html

@@ -335,16 +335,16 @@ overlap with input column symbols.</p>
       <pre class="lines">
 
 
-35
-36
-37
-38
-39
-40
-41</pre>
+118
+119
+120
+121
+122
+123
+124</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 35</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 118</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>
@@ -413,12 +413,12 @@ overlap with input column symbols.</p>
       <pre class="lines">
 
 
-19
-20
-21</pre>
+102
+103
+104</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 19</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 102</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_columns'>columns</span>
   <span class='ivar'>@columns</span>
@@ -480,12 +480,12 @@ subset of :ins.</p>
       <pre class="lines">
 
 
-26
-27
-28</pre>
+109
+110
+111</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 109</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_defaults'>defaults</span>
   <span class='ivar'>@defaults</span>
@@ -546,12 +546,12 @@ of :outs.</p>
       <pre class="lines">
 
 
-33
-34
-35</pre>
+116
+117
+118</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 33</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 116</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_ifs'>ifs</span>
   <span class='ivar'>@ifs</span>
@@ -611,12 +611,12 @@ of :outs.</p>
       <pre class="lines">
 
 
-22
-23
-24</pre>
+105
+106
+107</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 22</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 105</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_ins'>ins</span>
   <span class='ivar'>@ins</span>
@@ -676,12 +676,12 @@ of :outs.</p>
       <pre class="lines">
 
 
-29
-30
-31</pre>
+112
+113
+114</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 29</span>
+      <pre class="code"><span class="info file"># File 'lib/csv_decision/columns.rb', line 112</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_outs'>outs</span>
   <span class='ivar'>@outs</span>
@@ -697,7 +697,7 @@ of :outs.</p>
 </div>
 
       <div id="footer">
-  Generated on Sat Jan 13 10:02:47 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>