csv_decision 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dd656bc42ac4a7e5bc1b3ba49599f972179fbe9
-  data.tar.gz: 8f97105d30b993279dbadf380798fb4fbc36d4dd
+  metadata.gz: 0ae0f8b7985c3403c552bac2d32f6d6dbcf72046
+  data.tar.gz: 447fc311c43a0ed399866f8a032b4abd56583790
 SHA512:
-  metadata.gz: d7c5bb91fcb110d0ef7a39def02096ae65e6cfc4eb1b9b17ad4e17407baa02004d5e835a7ce24df016b9b47683afebfeb37e632372447082e0229cb46174a6de
-  data.tar.gz: bc3313687f8a01cdd82efdd59190bea881a4707382a23275c20b192b2d048db747a3200163e0b773c31fe9a500269484c10d990d363c9f75956df956ff1379c8
+  metadata.gz: 2e0bac50f203c9c4403894da74f853885792f0d4d80a09e8452c89bf98af7390a1d89b220fe03b65bf4ca0b8a2f88ca6b76797833a922920967071abc7b36bb4
+  data.tar.gz: f1f479e5d022cad346d50dfcfdd73093dadc14df906ca8cc09574a5fb5b4c8cdf89f354b9750d3468f01fb5c63e82394d9f7a2118f054a74e8460f69289a7550

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+exclude_patterns:
+- "doc/"

data/.gitignore

@@ -10,4 +10,5 @@ pkg/*
 # IDE files
 .idea
 .DS_Store
-coverage/
+coverage/
+.yardoc/

data/.travis.yml

@@ -1,10 +1,9 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=787a2f89b15c637323c7340d65ec17e898ac44480706b4b4122ea040c2a88f1d
 language: ruby
+sudo: false
 rvm:
   - 2.3.0
   - 2.3.6
   - 2.4.3
+  - 2.5.0
 script:
   - bundle exec rspec

data/CHANGELOG.md

@@ -1,2 +1,20 @@
-## v0.0.1, 28 December 2017.
+## v0.0.4, 26 December 2017.
+*Additions*
+- Adds symbol expressions for input columns.
+- Adds non-string constants for output columns.
+- Support Ruby 2.5.0
+- Include yard documentation.
+
+*Changes*
+- Move `benchmark.rb` to `benchmarks` folder and rename to `rufus_decision.rb`
+
+## v0.0.3, 18 December 2017.
+*Additions*
+- Add non-string constants for input columns.
+
+## v0.0.2, 18 December 2017.
+*Additions*
+- Adds accumulate option.
+
+## v0.0.1, 18 December 2017.
 - Initial release

data/README.md

@@ -4,7 +4,8 @@ CSV Decision
 [![Gem Version](https://badge.fury.io/rb/csv_decision.svg)](https://badge.fury.io/rb/csv_decision)
 [![Build Status](https://travis-ci.org/bpvickers/csv_decision.svg?branch=master)](https://travis-ci.org/bpvickers/csv_decision)
 [![Coverage Status](https://coveralls.io/repos/github/bpvickers/csv_decision/badge.svg?branch=master)](https://coveralls.io/github/bpvickers/csv_decision?branch=master)
-<a href="https://codeclimate.com/github/bpvickers/csv_decision/maintainability"><img src="https://api.codeclimate.com/v1/badges/466a6c52e8f6a3840967/maintainability" /></a>
+[![Maintainability](https://api.codeclimate.com/v1/badges/466a6c52e8f6a3840967/maintainability)](https://codeclimate.com/github/bpvickers/csv_decision/maintainability)
+[![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 
 ### CSV based Ruby decision tables (a lightweight Hash transformation gem)
 
@@ -15,10 +16,11 @@ It accepts decision tables implemented as a
 which can then be used to execute complex conditional logic against an input hash, 
 producing a decision as an output hash.
 
- ### `csv_decision` features
+ ### CSV Decision features
  * Fast decision-time performance (see `benchmark.rb`).
- * In addition to simple string matching, can use regular expressions, 
- numeric comparisons and Ruby-style ranges.
+ * In addition to simple string matching, can match common Ruby constants, 
+ regular expressions, numeric comparisons and Ruby-style ranges.
+ * Can use column symbols in comparisons for guard conditions -- e.g., > :column.
  * Accepts data as a file, CSV string or an array of arrays. (For safety all input data is 
  force encoded to UTF-8, and non-ascii strings are converted to empty strings.)
  * All CSV cells are parsed for correctness, and helpful error messages generated for bad 
@@ -27,14 +29,14 @@ producing a decision as an output hash.
  array of hashes.
  
  ### Planned features
- `csv_decision` is currently a work in progress, and will be enhanced to support
+ `csv_decision` is still a work in progress, and will be enhanced to support
  the following features:
  * Input columns may be indexed for faster lookup performance.
  * May use functions in the output columns to formulate the final decision.
  * Input hash values may be conditionally defaulted using a constant or a function call
  * Use of column symbol references or built-in guard functions in the input
  columns for matching.
- * Output columns may used interpolated strings referencing column symbols.
+ * Output columns may use interpolated strings referencing column symbols.
  * May be extended with user-defined Ruby functions for tailored logic.
  * Can use post-match guard conditions to filter the results of multi-row 
  decision output.
@@ -149,7 +151,7 @@ table.decide(topic: 'finance', region: 'Europe') # returns team_member: %w[Donal
  ### Constants other than strings
  Although `csv_decision` is string oriented, it does recognise other types of constant
  present in the input hash. Specifically, the following classes are recognized: 
- `Integer`, `BigDecimal` and `NilClass`. 
+ `Integer`, `BigDecimal`, `NilClass`, `TrueClass` and `FalseClass`. 
  
  This is accomplished by prefixing the value with one of the operators `=`, `==` or `:=`. 
  (The syntax is intentionally lax.)
@@ -157,20 +159,51 @@ table.decide(topic: 'finance', region: 'Europe') # returns team_member: %w[Donal
  For example:
  ```ruby
     data = <<~DATA
-      in :constant, out :type
-      :=nil,        NilClass
-      ==false,      FALSE
-      =true,        TRUE
-      = 0,          Zero
-      :=100.0,      100%
+      in :constant, out :value
+      :=nil,        :=nil
+      ==false,      ==false
+      =true,        =true
+      = 0,          = 0
+      :=100.0,      :=100.0
     DATA
           
   table = CSVDecision.parse(data)
-  table.decide(constant: nil) # returns type: 'NilClass'        
-  table.decide(constant: 0) # returns type: 'Zero'        
-  table.decide(constant: BigDecimal.new('100.0')) # returns type: '100%'        
+  table.decide(constant: nil) # returns value: nil      
+  table.decide(constant: 0) # returns value: 0        
+  table.decide(constant: BigDecimal('100.0')) # returns value: BigDecimal('100.0')       
 ```
  
+ ### Column header symbols
+ All input and output column names are symbolized, and can be used to form simple
+ expressions that refer to values in the input hash.
+ 
+ For example:
+ ```ruby
+    data = <<~DATA
+      in :node, in :parent, out :top?
+      ,         == :node,   yes
+      ,         ,           no
+    DATA
+    
+    table = CSVDecision.parse(data)
+    table.decide(node: 0, parent: 0) # returns top?: 'yes'
+    table.decide(node: 1, parent: 0) # returns top?: 'no'
+ ```
+ 
+ Note that there is no need to include an input column for `:node` in the decision 
+ table - it just needs to be present in the input hash. Also, `== :node` can be 
+ shortened to just `:node`, so the above decision table may be simplified to:
+ 
+ ```ruby
+    data = <<~DATA
+      in :parent, out :top?
+         :node,   yes
+      ,           no
+    DATA
+ ```
+ These comparison operators are also supported: `!=`, `>`, `>=`, `<`, `<=`.
+ For more simple examples see `spec/csv_decision/examples_spec.rb`.
+ 
  ### Testing
  
  `csv_decision` includes thorough [RSpec](http://rspec.info) tests:

data/{benchmark.rb → benchmarks/rufus_decision.rb}

@@ -6,7 +6,7 @@ require 'rufus/decision'
 require 'ice_nine'
 require 'ice_nine/core_ext/object'
 
-require_relative 'lib/csv_decision'
+require_relative '../lib/csv_decision'
 
 SPEC_DATA_VALID ||= File.join(CSVDecision.root, 'spec', 'data', 'valid')
 

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

data/doc/CSVDecision/CellValidationError.html

@@ -0,0 +1,143 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Exception: CSVDecision::CellValidationError
+  
+    &mdash; Documentation by YARD 0.9.12
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "CSVDecision::CellValidationError";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../CSVDecision.html" title="CSVDecision (module)">CSVDecision</a></span></span>
+     &raquo; 
+    <span class="title">CellValidationError</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Exception: CSVDecision::CellValidationError
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="Error.html" title="CSVDecision::Error (class)">Error</a></span></span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">StandardError</li>
+          
+            <li class="next"><span class='object_link'><a href="Error.html" title="CSVDecision::Error (class)">Error</a></span></li>
+          
+            <li class="next">CSVDecision::CellValidationError</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/csv_decision/parse.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Error validating a cell when parsing input table data.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+
+  
+  
+  
+  
+  
+  
+  
+
+</div>
+
+      <div id="footer">
+  Generated on Tue Dec 26 18:31:37 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.12 (ruby-2.3.0).
+</div>
+
+    </div>
+  </body>
+</html>