rufus-decision 1.1.0 → 1.2.0

data/README.txt

@@ -10,10 +10,13 @@ or at
 
 http://rubyforge.org/frs/?group_id=4812
 
+== intro blog post
+
+http://jmettraux.wordpress.com/2009/04/25/rufus-decision-11-ruby-decision-tables/
 
 == usage
 
-more info at http://rufus.rubyforge.org/rufus-decision/classes/Rufus/Decision/Table.html, but here is a recap.
+More info at http://rufus.rubyforge.org/rufus-decision/classes/Rufus/Decision/Table.html but here is a recap.
 
 An example where a few rules determine which salesperson should interact with a customer with given characteristics.
 

data/lib/rufus/decision.rb

@@ -35,7 +35,7 @@ require 'rufus/hashes'
 module Rufus
 module Decision
 
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 
   #
   # A decision table is a description of a set of rules as a CSV (comma
@@ -171,6 +171,11 @@ module Decision
   #
   #   will yield { result => [ 'normal', 'large' ]} for f0 => 56
   #
+  # * "unbounded", by default, string matching is 'bounded', "apple" will match
+  #   'apple', but not 'greenapple'. When "unbounded" is set, 'greenapple' will
+  #   match. ('bounded', in reality, means the target value is surrounded
+  #   by ^ and $)
+  #
   # === Setting options at table initialization
   #
   # It's OK to set the options at initialization time :
@@ -250,33 +255,58 @@ module Decision
     #
     attr_accessor :accumulate
 
+    # when set to true, evaluation of ruby code for output is allowed. False
+    # by default.
+    #
+    attr_accessor :ruby_eval
+
+    # false (bounded) by default : exact matches for string matching. When
+    # 'unbounded', target 'apple' will match for values like 'greenapples' or
+    # 'apple seed'.
+    #
+    attr_accessor :unbound
+
     # The constructor for DecisionTable, you can pass a String, an Array
     # (of arrays), a File object. The CSV parser coming with Ruby will take
     # care of it and a DecisionTable instance will be built.
     #
-    # parameters (options) are :through, :ignore_case, :accumulate (which
+    # Options are :through, :ignore_case, :accumulate (which
     # forces :through to true when set) and :ruby_eval. See
     # Rufus::Decision::Table for more details.
     #
-    def initialize (csv, params={})
-
-      @first_match = (params[:through] != true)
-      @ignore_case = params[:ignore_case] || params[:ignorecase]
-      @accumulate = params[:accumulate]
-      @ruby_eval = params[:ruby_eval]
-
-      @first_match = false if @accumulate
+    # Options passed to this method do override the options defined
+    # in the CSV itself.
+    #
+    # == options
+    #
+    # * :through : when set, all the rows of the decision table are considered
+    # * :ignore_case : case is ignored (not ignored by default)
+    # * :accumulate : gather instead of overriding (implies :through)
+    # * :ruby_eval : ruby code evaluation is OK
+    #
+    def initialize (csv, options={})
 
       @rows = Rufus::Decision.csv_to_a(csv)
 
       extract_options
+
       parse_header_row
+
+      @first_match = false if options[:through] == true
+      @first_match = true if @first_match.nil?
+
+      set_opt(options, :ignore_case, :ignorecase)
+      set_opt(options, :accumulate)
+      set_opt(options, :ruby_eval)
+      set_opt(options, :unbounded)
+
+      @first_match = false if @accumulate
     end
 
     # Like transform, but the original hash doesn't get touched,
     # a copy of it gets transformed and finally returned.
     #
-    def transform (hash, options={})
+    def transform (hash)
 
       transform!(hash.dup)
     end
@@ -284,10 +314,9 @@ module Decision
     # Passes the hash through the decision table and returns it,
     # transformed.
     #
-    def transform! (hash, options={})
+    def transform! (hash)
 
-      hash = Rufus::Decision::EvalHashFilter.new(hash) \
-        if @ruby_eval || options[:ruby_eval] == true
+      hash = Rufus::Decision::EvalHashFilter.new(hash) if @ruby_eval
 
       @rows.each do |row|
         next unless matches?(row, hash)
@@ -304,11 +333,24 @@ module Decision
     #
     def to_csv
 
-      a = [ @header.to_csv ]
-      @rows.inject(a) { |a, row| a << row.join(',') }.join("\n")
+      @rows.inject([ @header.to_csv ]) { |a, row|
+        a << row.join(',')
+      }.join("\n")
+    end
+
+    protected
+
+    def set_opt (options, *optnames)
+
+      optnames.each do |oname|
+
+        v = options[oname]
+        next unless v != nil
+        instance_variable_set("@#{optnames.first.to_s}", v)
+        return
+      end
     end
 
-    private
 
     # Returns true if the hash matches the in: values for this row
     #
@@ -332,7 +374,7 @@ module Decision
         else
 
           range = to_ruby_range(cell)
-          range ? range.include?(value) : regex_compare(value, cell)
+          range ? range.include?(value) : string_compare(value, cell)
         end
 
         return false unless b
@@ -341,12 +383,13 @@ module Decision
       true
     end
 
-    def regex_compare (value, cell)
+    def string_compare (value, cell)
 
       modifiers = 0
       modifiers += Regexp::IGNORECASE if @ignore_case
 
-      rcell = Regexp.new(cell, modifiers)
+      rcell = @unbounded ?
+        Regexp.new(cell, modifiers) : Regexp.new("^#{cell}$", modifiers)
 
       rcell.match(value)
     end
@@ -423,6 +466,8 @@ module Decision
         elsif cell == 'accumulate'
           @first_match = false
           @accumulate = true
+        elsif cell == 'unbounded'
+          @unbounded = true
         end
       end
 
@@ -435,13 +480,16 @@ module Decision
     # an "out:"
     #
     def is_vertical_table? (first_row)
+
       bin = false
       bout = false
+
       first_row.each do |cell|
         bin ||= cell.match(IN)
         bout ||= cell.match(OUT)
         return false if bin and bout
       end
+
       true
     end
 

data/test/decision_0_test.rb

@@ -7,7 +7,7 @@
 
 require 'test/unit'
 
-require File.dirname(__FILE__) + '/test_base.rb'
+require File.join(File.dirname(__FILE__), 'test_base.rb')
 
 
 class Decision0Test < Test::Unit::TestCase
@@ -28,13 +28,13 @@ e,f,2
       "fx" => "c",
       "fy" => "d"
     }
-    do_test(CSV0, wi, {}, { "fz" => "1" }, false)
+    do_test(CSV0, wi, { "fz" => "1" }, false)
 
     wi = {
       "fx" => "a",
       "fy" => "d"
     }
-    do_test(CSV0, wi, {}, { "fz" => nil }, false)
+    do_test(CSV0, wi, { "fz" => nil }, false)
   end
 
   CSV0B = %{
@@ -51,7 +51,7 @@ e,f,2
       "fx" => "c",
       "fy" => "d"
     }
-    do_test(CSV0B, wi, {}, { "fz" => "1" }, false)
+    do_test(CSV0B, wi, { "fz" => "1" }, false)
   end
 
   # test 1 moved to decision_1_test.rb
@@ -67,10 +67,10 @@ e,   f,   2
   def test_2
 
     wi = { "fx" => "c", "fy" => "d" }
-    do_test(CSV2, wi, {}, { "fz" => "1" }, false)
+    do_test(CSV2, wi, { "fz" => "1" }, false)
 
     wi = { "fx" => "a", "fy" => "d" }
-    do_test(CSV2, wi, {}, { "fz" => nil }, false)
+    do_test(CSV2, wi, { "fz" => nil }, false)
   end
 
   CSV3 = %{
@@ -89,19 +89,19 @@ cloudy,   ,     no
       "weather" => "raining",
       "month" => "december"
     }
-    do_test(CSV3, wi, {}, { "take_umbrella?" => "yes" }, false)
+    do_test(CSV3, wi, { "take_umbrella?" => "yes" }, false)
 
     wi = {
       "weather" => "cloudy",
       "month" => "june"
     }
-    do_test(CSV3, wi, {}, { "take_umbrella?" => "yes" }, false)
+    do_test(CSV3, wi, { "take_umbrella?" => "yes" }, false)
 
     wi = {
       "weather" => "cloudy",
       "month" => "march"
     }
-    do_test(CSV3, wi, {}, { "take_umbrella?" => "no" }, false)
+    do_test(CSV3, wi, { "take_umbrella?" => "no" }, false)
   end
 
   def test_3b
@@ -109,17 +109,17 @@ cloudy,   ,     no
     h = {}
     h["weather"] = "raining"
     h["month"] = "december"
-    do_test(CSV3, h, {}, { "take_umbrella?" => "yes" }, false)
+    do_test(CSV3, h, { "take_umbrella?" => "yes" }, false)
 
     h = {}
     h["weather"] = "cloudy"
     h["month"] = "june"
-    do_test(CSV3, h, {}, { "take_umbrella?" => "yes" }, false)
+    do_test(CSV3, h, { "take_umbrella?" => "yes" }, false)
 
     h = {}
     h["weather"] = "cloudy"
     h["month"] = "march"
-    do_test(CSV3, h, {}, { "take_umbrella?" => "no" }, false)
+    do_test(CSV3, h, { "take_umbrella?" => "no" }, false)
   end
 
   def test_3c
@@ -144,35 +144,6 @@ cloudy,   ,     no
     assert_equal "Henry",  h["team_member"]
   end
 
-  CSV3D = "http://spreadsheets.google.com/pub?key=pCkopoeZwCNsMWOVeDjR1TQ&output=csv&gid=0"
-
-  def test_3d
-
-    #return unless online?
-
-    h = {}
-    h["weather"] = "raining"
-    h["month"] = "december"
-
-    do_test(CSV3D, h, {}, { "take_umbrella?" => "yes" }, false)
-
-    h = {}
-    h["weather"] = "cloudy"
-    h["month"] = "june"
-
-    sleep 0.5 # don't request the doc too often
-
-    do_test(CSV3D, h, {}, { "take_umbrella?" => "yes" }, false)
-
-    h = {}
-    h["weather"] = "cloudy"
-    h["month"] = "march"
-
-    sleep 0.5 # don't request the doc too often
-
-    do_test(CSV3D, h, {}, { "take_umbrella?" => "no" }, false)
-  end
-
   def test_3e
 
     table = Rufus::DecisionTable.new(%{
@@ -208,13 +179,13 @@ cloudy,   ,     no
     }
 
     wi = { 'fx' => 'a', 'fy' => 'a' }
-    do_test(table, wi, {}, { 'fX' => 'true', 'fY' => 'true' }, false)
+    do_test(table, wi, { 'fX' => 'true', 'fY' => 'true' }, false)
 
     wi = { 'fx' => 'a', 'fy' => 'b' }
-    do_test(table, wi, {}, { 'fX' => 'true', 'fY' => 'false' }, false)
+    do_test(table, wi, { 'fX' => 'true', 'fY' => 'false' }, false)
 
     wi = { 'fx' => 'A', 'fy' => 'b' }
-    do_test(table, wi, {}, { 'fX' => 'true', 'fY' => 'false' }, false)
+    do_test(table, wi, { 'fX' => 'true', 'fY' => 'false' }, false)
   end
 
   def test_through_and_ignorecase_set_at_table_initialization
@@ -232,13 +203,13 @@ cloudy,   ,     no
       table, :through => true, :ignore_case => true)
 
     wi = { 'fx' => 'a', 'fy' => 'a' }
-    do_test(table, wi, {}, { 'fX' => 'true', 'fY' => 'true' }, false)
+    do_test(table, wi, { 'fX' => 'true', 'fY' => 'true' }, false)
 
     wi = { 'fx' => 'a', 'fy' => 'b' }
-    do_test(table, wi, {}, { 'fX' => 'true', 'fY' => 'false' }, false)
+    do_test(table, wi, { 'fX' => 'true', 'fY' => 'false' }, false)
 
     wi = { 'fx' => 'A', 'fy' => 'b' }
-    do_test(table, wi, {}, { 'fX' => 'true', 'fY' => 'false' }, false)
+    do_test(table, wi, { 'fX' => 'true', 'fY' => 'false' }, false)
   end
 
   #
@@ -258,12 +229,12 @@ in:fx, out:fy
     wi = {
       "fx" => "5"
     }
-    do_test(CSV6, wi, {}, { "fy" => "a" }, false)
+    do_test(CSV6, wi, { "fy" => "a" }, false)
 
     wi = {
       "fx" => "100.0001"
     }
-    do_test(CSV6, wi, {}, { "fy" => "c" }, false)
+    do_test(CSV6, wi, { "fy" => "c" }, false)
   end
 
   #
@@ -283,17 +254,17 @@ in:fx, out:fy
     wi = {
       "fx" => "5"
     }
-    do_test(CSV7, wi, {}, { "fy" => "c" }, false)
+    do_test(CSV7, wi, { "fy" => "c" }, false)
 
     wi = {
       "fx" => "10"
     }
-    do_test(CSV7, wi, {}, { "fy" => "b" }, false)
+    do_test(CSV7, wi, { "fy" => "b" }, false)
 
     wi = {
       "fx" => "10a"
     }
-    do_test(CSV7, wi, {}, { "fy" => "a" }, false)
+    do_test(CSV7, wi, { "fy" => "a" }, false)
   end
 
   CSV8 = %{
@@ -317,16 +288,10 @@ e,f,2
 
   def test_ruby_eval
 
-    wi = { 'fx' => 'c', 'fy' => 'd' }
-    do_test(CSV9, wi, { :ruby_eval => true }, { 'fz' => '3' }, false)
-  end
-
-  def test_ruby_eval_set_at_table_initialization
-
     table = Rufus::Decision::Table.new(CSV9, :ruby_eval => true)
 
     wi = { 'fx' => 'c', 'fy' => 'd' }
-    do_test(table, wi, {}, { 'fz' => '3' }, false)
+    do_test(table, wi, { 'fz' => '3' }, false)
   end
 
   CSV10 = %{
@@ -338,13 +303,13 @@ in:fx,in:fx,out:fz
   def test_10
 
     wi = { "fx" => "91" }
-    do_test(CSV10, wi, {}, { "fz" => "ok" }, false)
+    do_test(CSV10, wi, { "fz" => "ok" }, false)
 
     wi = { "fx" => "95" }
-    do_test(CSV10, wi, {}, { "fz" => "bad" }, false)
+    do_test(CSV10, wi, { "fz" => "bad" }, false)
 
     wi = { "fx" => "81" }
-    do_test(CSV10, wi, {}, { "fz" => "bad" }, false)
+    do_test(CSV10, wi, { "fz" => "bad" }, false)
   end
 
   CSV11 = %{
@@ -361,7 +326,7 @@ in:f1,in:f1,in:f2,in:f3,out:o1,out:e1,out:e2
   def test_fu_zhang
 
     wi = { 'f1' => 97, 'f2' => 5 }
-    do_test CSV11, wi, {}, { 'o1' => 'Expection1' }, false
+    do_test CSV11, wi, { 'o1' => 'Expection1' }, false
   end
 
   CSV12 = %{
@@ -378,14 +343,14 @@ b,   ,    yellow, beige
   def test_accumulate
 
     wi = { "fx" => "a", "fy" => "a" }
-    do_test CSV12, wi, {}, { "fX" => "red;blue", "fY" => "green;purple" }, false
+    do_test CSV12, wi, { "fX" => "red;blue", "fY" => "green;purple" }, false
 
     wi = { "fx" => "a", "fy" => "a", "fX" => "BLACK" }
-    do_test CSV12, wi, {}, {
+    do_test CSV12, wi, {
       "fX" => "BLACK;red;blue", "fY" => "green;purple" }, false
 
     wi = { "fx" => "a", "fy" => "a", "fX" => [ "BLACK", "BLUE" ] }
-    do_test CSV12, wi, {}, {
+    do_test CSV12, wi, {
       "fX" => "BLACK;BLUE;red;blue", "fY" => "green;purple" }, false
   end
 
@@ -424,14 +389,13 @@ in:fx,out:fz
   def test_range
 
     wi = { "fx" => "91" }
-    do_test CSV13, wi, {}, { "fz" => "ok" }, false
+    do_test CSV13, wi, { "fz" => "ok" }, false
 
     wi = { "fx" => "95" }
-    do_test CSV13, wi, {}, { "fz" => "bad" }, false
+    do_test CSV13, wi, { "fz" => "bad" }, false
 
     wi = { "fx" => "81" }
-    do_test CSV13, wi, {}, { "fz" => "bad" }, false
+    do_test CSV13, wi, { "fz" => "bad" }, false
   end
-
 end
 

data/test/decision_1_test.rb

@@ -7,7 +7,7 @@
 
 require 'test/unit'
 
-require File.dirname(__FILE__) + '/test_base.rb'
+require File.join(File.dirname(__FILE__), 'test_base.rb')
 
 
 class Decision1Test < Test::Unit::TestCase
@@ -26,22 +26,26 @@ g,h,${r:'${fx}' + '${fy}'}
   def test_1
 
     wi = { 'fx' => 'c', 'fy' => 'd' }
-    do_test(CSV1, wi, {}, { 'fz' => 'c' }, false)
+    do_test(CSV1, wi, { 'fz' => 'c' }, false)
 
     wi = { 'fx' => 'a', 'fy' => 'a' }
-    do_test(CSV1, wi, {}, { 'fz' => '0' }, false)
+    do_test(CSV1, wi, { 'fz' => '0' }, false)
   end
 
   def test_1b
 
+    table = Rufus::Decision::Table.new(CSV1, :ruby_eval => true)
+
     h = { 'fx' => 'e', 'fy' => 'f' }
-    do_test(CSV1, h, { :ruby_eval => true }, { 'fz' => '7' }, false)
+    do_test(table, h, { 'fz' => '7' }, false)
   end
 
   def test_1c
 
+    table = Rufus::Decision::Table.new(CSV1, :ruby_eval => true)
+
     h = { 'fx' => 'g', 'fy' => 'h' }
-    do_test(CSV1, h, { :ruby_eval => true }, { 'fz' => 'gh' }, false)
+    do_test(table, h, { 'fz' => 'gh' }, false)
   end
 
   CSV2 = [
@@ -55,7 +59,7 @@ g,h,${r:'${fx}' + '${fy}'}
   def test_with_array_table
 
     wi = { 'fx' => 'c', 'fy' => 'd' }
-    do_test(CSV2, wi, {}, { 'fz' => 'c' }, false)
+    do_test(CSV2, wi, { 'fz' => 'c' }, false)
   end
 
   def test_empty_string_to_float
@@ -70,7 +74,7 @@ g,h,${r:'${fx}' + '${fy}'}
       [ '', 'maniac', 'Korolev' ]
     ]
 
-    do_test(table, wi, {}, { 'salesperson' => 'Korolev' }, false)
+    do_test(table, wi, { 'salesperson' => 'Korolev' }, false)
   end
 
   def test_vertical_rules
@@ -78,7 +82,7 @@ g,h,${r:'${fx}' + '${fy}'}
     table = CSV2.transpose
 
     wi = { 'fx' => 'c', 'fy' => 'd' }
-    do_test(table, wi, {}, { 'fz' => 'c' }, false)
+    do_test(table, wi, { 'fz' => 'c' }, false)
   end
 
   def test_vertical_rules_2
@@ -90,7 +94,7 @@ out:team_member,Alice,Bob,Charly,Donald,Ernest,Fujio,Gilbert,Henry,Zach
     }
 
     h = { 'topic' => 'politics', 'region' => 'america' }
-    do_test(table, h, {}, { 'team_member' => 'Gilbert' }, false)
+    do_test(table, h, { 'team_member' => 'Gilbert' }, false)
   end
 
 end

data/test/decision_2_test.rb

@@ -0,0 +1,45 @@
+
+#
+# Testing rufus-decision
+#
+# Sun Oct 29 15:41:44 JST 2006
+#
+
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), 'test_base.rb')
+
+
+class Decision2Test < Test::Unit::TestCase
+  include DecisionTestMixin
+
+  CSV3D = "http://spreadsheets.google.com/pub?key=pCkopoeZwCNsMWOVeDjR1TQ&output=csv&gid=0"
+
+  def test_3d
+
+    #return unless online?
+
+    h = {}
+    h["weather"] = "raining"
+    h["month"] = "december"
+
+    do_test(CSV3D, h, { "take_umbrella?" => "yes" }, false)
+
+    h = {}
+    h["weather"] = "cloudy"
+    h["month"] = "june"
+
+    sleep 0.3 # don't request the doc too often
+
+    do_test(CSV3D, h, { "take_umbrella?" => "yes" }, false)
+
+    h = {}
+    h["weather"] = "cloudy"
+    h["month"] = "march"
+
+    sleep 0.3 # don't request the doc too often
+
+    do_test(CSV3D, h, { "take_umbrella?" => "no" }, false)
+  end
+end
+

data/test/decision_3_test.rb

@@ -0,0 +1,56 @@
+
+#
+# Testing rufus-decision
+#
+# Mon Sep  7 13:42:09 JST 2009
+#
+
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), 'test_base.rb')
+
+
+class Decision3Test < Test::Unit::TestCase
+  include DecisionTestMixin
+
+  CSV14 = %{
+in:fstate,out:result
+apple,1
+orange,2
+}
+
+  def test_bounded_match
+
+    dt = Rufus::DecisionTable.new(CSV14)
+
+    assert_equal(
+      { 'fstate' => 'greenapples' },
+      dt.transform({ 'fstate' => 'greenapples' }))
+  end
+
+  def test_unbounded_match
+
+    dt = Rufus::DecisionTable.new(CSV14, :unbounded => true)
+
+    assert_equal(
+      { 'fstate' => 'apples', 'result' => '1' },
+      dt.transform({ 'fstate' => 'apples' }))
+  end
+
+  CSV14b = %{
+unbounded,
+in:fstate,out:result
+apple,1
+orange,2
+}
+
+  def test_unbounded_match_set_in_table
+
+    dt = Rufus::DecisionTable.new(CSV14b)
+
+    assert_equal(
+      { 'fstate' => 'apples', 'result' => '1' },
+      dt.transform({ 'fstate' => 'apples' }))
+  end
+end
+

data/test/test_base.rb

@@ -14,7 +14,7 @@ module DecisionTestMixin
 
   protected
 
-  def do_test (table_data, h, options, expected_result, verbose=false)
+  def do_test (table_data, h, expected_result, verbose=false)
 
     table = table_data.is_a?(Rufus::Decision::Table) ?
       table_data :
@@ -29,7 +29,7 @@ module DecisionTestMixin
       p h
     end
 
-    h = table.transform!(h, options)
+    h = table.transform!(h)
 
     if verbose
       puts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-decision
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-25 00:00:00 +09:00
+date: 2009-09-07 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,11 +44,14 @@ extra_rdoc_files:
 - CREDITS.txt
 files: 
 - bin/rufus_decide
+- lib/rufus
 - lib/rufus/decision.rb
 - lib/rufus/hashes.rb
 - lib/rufus-decision.rb
 - test/decision_0_test.rb
 - test/decision_1_test.rb
+- test/decision_2_test.rb
+- test/decision_3_test.rb
 - test/eval_test.rb
 - test/goal.csv
 - test/input.csv
@@ -61,8 +64,6 @@ files:
 - CREDITS.txt
 has_rdoc: true
 homepage: http://rufus.rubyforge.org/rufus-decision
-licenses: []
-
 post_install_message: 
 rdoc_options: []
 
@@ -84,9 +85,9 @@ requirements:
 - rufus-dollar
 - rufus-treechecker
 rubyforge_project: rufus
-rubygems_version: 1.3.2
+rubygems_version: 1.3.1
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: CSV based Ruby decision tables
 test_files: 
 - test/test.rb