decision_table 0.0.1 → 0.0.2

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 .redcar
 vendor/ruby
 bin
+.rvmrc

data/README.textile

@@ -0,0 +1,23 @@
+h1.  Decision Table
+ 
+decision_table is a gem to build, parse and evaluate simple rules than can be expressed in a table.  We've extracted this gem from code on real projects and seen in come in quite handy elsewhere.  A simple example is probably the best way to show what it's all about.
+
+Let's say you're building a system to recommend home improvements to homeowners.  For each improvement, there is a table that expresses how to decide if an improvement is recommended.  Here's the example rule to determine if replacing insulation in the attic is recommended:
+
+| is_well_insulated?  | attic_accessible? | recommended     |
+| true                |                   | false           |
+| false               | true              | true            |
+| false               | flase             | false           |
+
+decision_table will interpret tables like this expressed as a 2D array and produce a DecisionTable::Ruleset.  
+A ruleset, when given a domain object that implements insulation_r_value and attr_accessible? methods, 
+will return the result of the first applicable rule, applicable being defined as a match for all 
+non-blank colums.
+
+For cases where you only have a single applicable rule, you can express it as string like so:
+
+bc..  drinks_coffee?:false,writes_ruby?:true,number_of_children:2
+
+h2. Other stuff you should look at
+
+This gem is just what you want if you can already express your rules in this format and know the order of precedence.  If you don't know this, you might need some fancier machine-learning classification thingie. In this case, might I recommend taking a look at "ai4r":http://ai4r.rubyforge.org.  In particular the ID3 decision trees algorithm might be what you need.

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end

data/decision_table.gemspec

@@ -21,5 +21,7 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
   s.add_development_dependency "rspec-given"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rake"
   s.add_runtime_dependency "activesupport"
 end

data/lib/decision_table/rule.rb

@@ -1,19 +1,28 @@
 module DecisionTable
   class Rule
-    
+
     attr_accessor :criteria, :result
-    
+
     def initialize(criteria, result)
-      @criteria = criteria
-      @result = result
+      if criteria.is_a?(Hash)
+        @criteria = criteria
+        @result = result
+      else
+        @criteria = {}
+        keys = criteria
+        values = result
+        keys.pop if keys.size == values.size
+        keys.each_with_index { |key, index| @criteria[key] = values[index] }
+        @result = values.last
+      end
     end
-    
+
     def applies?(candidate)
       criteria.all? do |k, v|
         v.blank? || matches?(candidate, k, v)
       end
     end
-    
+
     def matches?(candidate, key, value)
       if value.to_s == "true"
         candidate.send(key)
@@ -23,7 +32,7 @@ module DecisionTable
         candidate.send(key) == value
       end
     end
-    
+
     def self.parse(rule_string)
       criteria = {}
       rule_string.split(",").each do |crit|
@@ -32,6 +41,6 @@ module DecisionTable
       end
       Rule.new(criteria, true)
     end
-    
+
   end
 end

data/lib/decision_table/ruleset.rb

@@ -1,18 +1,25 @@
+require 'csv'
+
 module DecisionTable
   class Ruleset
     attr_accessor :rules
     def initialize(rules)
-      @rules = rules
+      if rules[0].is_a?(Rule)
+        @rules = rules
+      else
+        keys = rules.shift
+        @rules = rules.map { |values| Rule.new(keys, values) }
+      end
     end
-    
+
     def evaluate(candidate)
       rule = rules.detect { |rule| rule.applies?(candidate) }
       rule.result if rule
     end
-    
+
     def self.parse_csv(csv)
-      data = FasterCSV.parse(csv)
-      keys = data.shift
+      data = CSV.parse(csv)
+      Ruleset.new(data)
     end
   end
 end

data/lib/decision_table/version.rb

@@ -1,3 +1,3 @@
 module DecisionTable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/rule_spec.rb

@@ -2,30 +2,36 @@ require 'spec_helper'
 
 describe DecisionTable::Rule do
   Given(:candidate) { double(:candidate, :foo => "bar", :bing => "baz") }
-  
+
+  describe "constructing from arrays" do
+    Given(:rule) { DecisionTable::Rule.new(["foo", "bing", "outcome"], ["bar", "baz", "good"])}
+    Then { rule.applies?(candidate).should be_true }
+    Then { rule.result.should == "good" }
+  end
+
   describe("applies") do
     context "when all values match" do
       Given(:rule) { DecisionTable::Rule.new({:foo => "bar", :bing => "baz"}, true) }
       Then { rule.applies?(candidate).should be_true}
     end
-    
+
     context "when all specified values match" do
       Given(:rule ) { DecisionTable::Rule.new({:foo => "bar", :bing => ""}, true) }
       Then { rule.applies?(candidate).should be_true}
     end
-      
+
     context "when values don't match" do
       Given(:rule) { DecisionTable::Rule.new({:foo => "not bar", :bing => "baz"}, true) }
       Then { rule.applies?(candidate).should be_false}
     end
-    
+
   end
-  
+
   describe("parsing rule") do
     Given(:rule_string) { "foo:bar,bing:baz" }
     When(:rule) { DecisionTable::Rule.parse(rule_string) }
     Then { rule.applies?(candidate).should be_true }
-    
+
     context "with boolean rules" do
       Given(:candidate) { double(:candidate, foo: true, bar: false) }
       Given(:non_matching) { double(:candidate, foo: nil, bar: true) }
@@ -34,5 +40,5 @@ describe DecisionTable::Rule do
       Then { rule.applies?(non_matching).should be_false }
     end
   end
-  
+
 end

data/spec/ruleset_spec.rb

@@ -22,12 +22,17 @@ module DecisionTable
         Then { Ruleset.new([rule]).evaluate(candidate).should be_nil }
       end
     end
-    
+
+    describe "instantiating from 2d array of strings" do
+      Given(:ruleset) { Ruleset.new [["foo", "baz", "result"],["bar", "bing", true]]}
+      Then { ruleset.rules.size.should == 1}
+      Then { ruleset.evaluate(candidate).should == true }
+    end
+
     describe "parsing CSV" do
-      pending "maybe later"
-      # Given(:csv_data) { File.read(File.join(File.dirname(__FILE__), "rules.csv")) }
-      # When(:ruleset) { Ruleset.parse_csv(csv_data) }
-      # Then { ruleset.rules.size.should == 2}
+      Given(:csv_data) { File.read(File.join(File.dirname(__FILE__), "rules.csv")) }
+      When(:ruleset) { Ruleset.parse_csv(csv_data) }
+      Then { ruleset.rules.size.should == 2}
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'rspec/given'
+require 'pry'
 require 'decision_table' # and any other gems you need
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decision_table
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70177089993400 !ruby/object:Gem::Requirement
+  requirement: &70175504320560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177089993400
+  version_requirements: *70175504320560
 - !ruby/object:Gem::Dependency
   name: rspec-given
-  requirement: &70177089992480 !ruby/object:Gem::Requirement
+  requirement: &70175504314500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177089992480
+  version_requirements: *70175504314500
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70175500209920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70175500209920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70175500204980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70175500204980
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70177089991940 !ruby/object:Gem::Requirement
+  requirement: &70175500201560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70177089991940
+  version_requirements: *70175500201560
 description: If you have decision algorithm that can be easily expressed in a table,
   this gem can help
 email:
@@ -54,6 +76,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.textile
 - Rakefile
 - decision_table.gemspec
 - lib/decision_table.rb