array_logic 0.1.2 → 0.2.0

data/README.rdoc

@@ -1,4 +1,4 @@
-== array_logic
+= ArrayLogic
 
 A system that allows me to define the logic for comparing arrays of objects.
 
@@ -39,7 +39,7 @@ and *blockers*:
 
 See test/array_logic/rule_test for more examples
 
-=== Combinations that match
+== Combinations that match
 
 Two methods allow you to determine sample combinations that match the current
 rule.  
@@ -57,3 +57,69 @@ and so would [1,2,3]. However, arrays that only contain 1 or 2 would not match
 Run example.rb to see some more examples
 
     ruby /lib/example.rb
+
+== Functions
+
+Version 0.2 introduces the concept of functions to ArrayLogic. The function
+syntax is:
+
+    <function>(<object_method as symbol>) <operator> <number>
+
+where:
+
+[function]       One of the functions listed below
+[object_method]  A method that can be called on all of the objects in the array
+[operator]       one of: <, <=, >, >=, ==
+[number]         a number to compare with the result
+
+Using this array as an example:
+
+    answers = [Answer.find(1), Answer.find(5), Answer.find(6)]
+
+=== sum
+
+Sums the values returned by the object_method and compares them with the number
+
+    rule = ArrayLogic::Rule.new 'sum(:id) == 12'
+    rule.match(answers)   --> true
+
+    rule = ArrayLogic::Rule.new 'sum(:id) > 12'
+    rule.match(answers)   --> false
+
+    rule = ArrayLogic::Rule.new 'sum(:id) >= 12'
+    rule.match(answers)   --> true
+
+=== average
+
+Averages the values returned by the object_method and compares them with the number
+
+    rule = ArrayLogic::Rule.new 'average(:id) == 4'
+    rule.match(answers)   --> true
+
+    rule = ArrayLogic::Rule.new 'average(:id) < 4'
+    rule.match(answers)   --> false
+
+    rule = ArrayLogic::Rule.new 'average(:id) <= 4'
+    rule.match(answers)   --> true
+
+=== count
+
+Counts the number of items not returning nil.
+
+    rule = ArrayLogic::Rule.new 'count(:id) == 3'
+    rule.match(answers)   --> true
+
+If answer has a method :is_odd? that returned nil if the :id is even:
+
+    rule = ArrayLogic::Rule.new 'count(:is_odd?) == 2'
+    rule.match(answers)   --> true
+
+=== Combining functions with other rules
+
+functions can be combined with other rules:
+
+    rule = ArrayLogic::Rule.new 'sum(:id) == 12 and a6'
+    rule.match(answers)   --> true
+
+    rule = ArrayLogic::Rule.new '(sum(:id) == 12) and not a6'
+    rule.match(answers)   --> false

data/Rakefile

@@ -9,7 +9,7 @@ Rake::RDocTask.new do |rdoc|
   files =['README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb']
   rdoc.rdoc_files.add(files)
   rdoc.main = "README.rdoc" # page to start on
-  rdoc.title = "Dibber Docs"
+  rdoc.title = "ArrayLogic Docs"
   rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
   rdoc.options << '--line-numbers'
 end

data/lib/array_logic.rb

@@ -1,4 +1,3 @@
-require_relative('array_logic/thing')
 require_relative('array_logic/rule')
 module ArrayLogic
     

data/lib/array_logic/rule.rb

@@ -82,6 +82,7 @@ module ArrayLogic
     end
 
     def rule_processing_steps
+      replace_item(function_pattern, value_of_function_called_on_id_objects)
       add_space_around_puctuation_characters
       make_everything_lower_case
       replace_logic_words_with_operators
@@ -114,6 +115,27 @@ module ArrayLogic
     def ids_include_this_id
       lambda {|s| thing_ids.include?(s[/\d+/].to_i)}
     end
+        
+    def function_pattern
+      /(#{array_functions.keys.join('|')})\(\s*\:(\w+[\?\!]?)\s*\)\s*((==|[\<\>]=?)\s*\d+(\.\d+)?)/
+    end
+    
+    def array_functions
+      {
+        :sum => 'inject(:+)',
+        :average => 'reduce(:+) / size.to_f',
+        :count => 'compact.size'
+      }
+    end
+    
+    def value_of_function_called_on_id_objects
+      lambda do |string|
+        all, array_function, function, operator = function_pattern.match(string).to_a
+        values = things.collect &function.to_sym
+        result = values.instance_eval(array_functions[array_function.to_sym])
+        "( #{result} #{operator} )"
+      end
+    end
 
     def processed_rule
       @processed_rule ||= rule.clone
@@ -171,11 +193,12 @@ module ArrayLogic
       {
         :brackets => ['\(', '\)'],
         :in_pattern => ['\d+\s+in'],
-        :ids => ['\w\d+'],
+        :ids => [thing_id_pattern],
         :logic_words => %w{and or not},
         :logic_chrs => ['&&', '\|\|', '!'],
         :commas => ['\,'],
         :white_space => ['\s'],
+        :function_pattern => [function_pattern]
       }
     end
     

data/lib/array_logic/version.rb

@@ -1,10 +1,14 @@
 module ArrayLogic
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end
 
 # History
 # =======
 # 
+# Version 0.2.0
+# =============
+# Adds functions: sum, count and average
+# 
 # Version 0.1.2
 # =============
 # Refactor to tidy up code and make private, rule methods that don't need exposing

data/test/array_logic/rule_test.rb

@@ -144,7 +144,115 @@ module ArrayLogic
       assert_thing_match([1, 2, 3], @rule)
       assert_no_thing_match([3], @rule)
       assert_thing_match([4], @rule) 
-    end    
+    end
+    
+    def test_cost
+      assert_equal(2, Thing.new(1).cost)
+    end
+    
+    def test_sum
+      @rule.rule = 'sum(:cost) == 2'
+      assert_no_thing_match([1, 2], @rule)
+      assert_no_thing_match([1, 2, 3], @rule)
+      assert_thing_match([3], @rule)
+      assert_thing_match([4], @rule) 
+    end
+    
+    def test_sum_greater_than
+      @rule.rule = 'sum(:cost) > 2'
+      assert_thing_match([1, 2], @rule)
+      assert_thing_match([1, 2, 3], @rule)
+      assert_no_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule) 
+    end
+    
+    def test_sum_less_than
+      @rule.rule = 'sum(:cost) < 3'
+      assert_no_thing_match([1, 2], @rule)
+      assert_no_thing_match([1, 2, 3], @rule)
+      assert_thing_match([3], @rule)
+      assert_thing_match([4], @rule) 
+    end
+    
+    def test_average
+      @rule.rule = 'average(:id) == 2'
+      assert_no_thing_match([1, 2], @rule)
+      assert_thing_match([1, 2, 3], @rule)
+      assert_no_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule) 
+    end
+    
+    def test_average_with_decimal
+      @rule.rule = 'average(:id) == 1.5'
+      assert_thing_match([1, 2], @rule)
+      assert_no_thing_match([1, 2, 3], @rule)
+      assert_no_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule)       
+    end
+    
+    def test_average_greater_than
+      @rule.rule = 'average(:id) > 2'
+      assert_no_thing_match([1, 2], @rule)
+      assert_no_thing_match([1, 2, 3], @rule)
+      assert_thing_match([3], @rule)
+      assert_thing_match([4], @rule) 
+    end
+    
+    def test_average_less_than
+      @rule.rule = 'average(:id) <= 2'
+      assert_thing_match([1, 2], @rule)
+      assert_thing_match([1, 2, 3], @rule)
+      assert_no_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule) 
+    end
+    
+    def test_count
+      @rule.rule = 'count(:id) == 2'
+      assert_thing_match([1, 2], @rule)
+      assert_no_thing_match([1, 2, 3], @rule)
+      assert_no_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule) 
+    end
+    
+    def test_count_greater_than
+      @rule.rule = 'count(:id) > 2'
+      assert_no_thing_match([1, 2], @rule)
+      assert_thing_match([1, 2, 3], @rule)
+      assert_no_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule) 
+    end
+    
+    def test_count_less_than
+      @rule.rule = 'count(:id) <= 2'
+      assert_thing_match([1, 2], @rule)
+      assert_no_thing_match([1, 2, 3], @rule)
+      assert_thing_match([3], @rule)
+      assert_thing_match([4], @rule) 
+    end
+    
+    def test_count_with_method_that_can_return_nil
+      @rule.rule = 'count(:id_odd?) == 1'
+      assert_thing_match([1, 2], @rule)
+      assert_no_thing_match([1, 2, 3], @rule)
+      assert_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule) 
+    end
+    
+    def test_function_with_other_rule
+      @rule.rule = 'sum(:id) >= 3 and t3'
+      assert_no_thing_match([1, 2], @rule)
+      assert_thing_match([1, 2, 3], @rule)
+      assert_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule) 
+    end
+    
+    def test_function_with_other_rule_with_brackets
+      @rule.rule = '(sum(:id) >= 3) and t3'
+      assert_no_thing_match([1, 2], @rule)
+      assert_thing_match([1, 2, 3], @rule)
+      assert_thing_match([3], @rule)
+      assert_no_thing_match([4], @rule) 
+    end
     
     def test_match_without_rule
       assert_raise RuntimeError do

data/test/array_logic/test_case.rb

@@ -1,5 +1,6 @@
 require 'test/unit'
 require_relative '../../lib/array_logic'
+require_relative 'thing'
 
 module ArrayLogic
   class TestCase < Test::Unit::TestCase

data/{lib → test}/array_logic/thing.rb

@@ -8,6 +8,14 @@ module ArrayLogic
       @id = number
     end
     
+    def cost
+      2
+    end
+    
+    def id_odd?
+      return true if id % 2 != 0
+    end
+    
     def self.make(number)
       things = Hash.new
       (1..number).each{|n| things[n] = new(n)}

data/test/array_logic/thing_test.rb

@@ -10,5 +10,15 @@ module ArrayLogic
       assert_equal((1..number).to_a, things.values.collect(&:id))
       assert_equal((1..number).to_a, things.keys)
     end
+    
+    def test_cost
+      thing = Thing.new(1)
+      assert_equal(2, thing.cost)
+    end
+    
+    def test_id_odd
+      things = Thing.make(4)
+      assert_equal([true, nil, true, nil], things.values.collect(&:id_odd?))
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: array_logic
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies: []
 description: Allow a user to define a set of rules, and then test to see if an array
   of object match those rules.
@@ -20,13 +20,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/array_logic/version.rb
-- lib/array_logic/thing.rb
 - lib/array_logic/rule.rb
 - lib/array_logic.rb
 - lib/example.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
+- test/array_logic/thing.rb
 - test/array_logic/test_case.rb
 - test/array_logic/rule_test.rb
 - test/array_logic/thing_test.rb
@@ -55,6 +55,7 @@ signing_key:
 specification_version: 3
 summary: Matches arrays of objects against logical rules.
 test_files:
+- test/array_logic/thing.rb
 - test/array_logic/test_case.rb
 - test/array_logic/rule_test.rb
 - test/array_logic/thing_test.rb