omf_rete 0.6.1 → 0.6.2

data/.gitignore

@@ -1,4 +1,5 @@
 .project
 Rakefile-back
 examples/of.rb
-lib/omf_rete/UNUSED/tuple_set.rb
+lib/omf_rete/UNUSED
+pkg/

data/lib/omf_rete/abstract_tuple_set.rb

@@ -6,37 +6,51 @@ module OMF::Rete
   # being called whenever a tuple is added or
   # removed.
   #
-  # The TupleSet is defined by a +description+. 
+  # The TupleSet is defined by a +description+.
   #
   # The +description+ is an array of the
   # same length as the tuples maintained. Each element,
   # if not nil, names the binding variable associated with it.
-  # The position of a binding can be retrieved with 
+  # The position of a binding can be retrieved with
   # +index_for_binding+.
   #
   class AbstractTupleSet
-    
+
     attr_reader :description
     attr_accessor :source
-    
+
     def initialize(description, source = nil)
       @description = description
       @source = source
     end
-    
+
+    def register_with_store(store, description)
+      @store = store
+      raise "BUG ALERT" unless description == @description
+      store.registerTSet(self, description)
+    end
+
+    # Detach all streams from each other as they are no longer in use
+    #
+    def detach()
+      @source.detach if @source
+      puts ">>> UNREGISTER"
+      @store.unregisterTSet(self) if @store
+    end
+
     def addTuple(tuple)
       raise 'Abstract class'
     end
- 
+
     def removeTuple(tuple)
       raise 'Abstract class'
     end
-   
+
     # Call block for every tuple stored in this set currently and
     # in the future. In other words, the block may be called even after this
-    # method returns. 
+    # method returns.
     #
-    # The block will be called with one parameters, the 
+    # The block will be called with one parameters, the
     # tuple added.
     #
     def on_add(&block)
@@ -47,7 +61,7 @@ module OMF::Rete
     def to_a
       raise 'Abstract class'
     end
-    
+
     # Retunr the index into the tuple for the binding variable +bname+.
     #
     # Note: This index is different to the set index used in +IndexedTupleSet+
@@ -57,7 +71,7 @@ module OMF::Rete
         el == bname
       end
     end
-    
+
     def binding_at(index)
       @description[index]
     end
@@ -65,8 +79,8 @@ module OMF::Rete
     def describe(out = STDOUT, offset = 0, incr = 2, sep = "\n")
       raise 'Abstract class'
     end
-    
-  
-  end # class 
+
+
+  end # class
 end # module
 

data/lib/omf_rete/indexed_tuple_set.rb

@@ -85,6 +85,8 @@ module OMF::Rete
       @index = {}
     end
 
+
+
     # Call block for every tuple stored in this set currently and
     # in the future. In other words, the block may be called even after this
     # method returns.
@@ -182,6 +184,8 @@ module OMF::Rete
       a
     end
 
+
+
     def describe(out = STDOUT, offset = 0, incr = 2, sep = "\n")
       out.write(" " * offset)
       desc = @description.collect do |e| e || '*' end

data/lib/omf_rete/join_op.rb

@@ -101,6 +101,15 @@ module OMF::Rete
       return false
     end
 
+    # Detach all streams from each other as they are no longer in use
+    #
+    def detach()
+      @left.detach
+      @right.detach
+      @results.clear
+    end
+
+
     def description()
       @resultSet.description
     end

data/lib/omf_rete/planner/final_plan.rb

@@ -0,0 +1,27 @@
+
+module OMF::Rete::Planner
+
+  # This plan holds the final result stream from which all other streams can be
+  # discovered and if necessary, freed.
+  #
+  #
+  class FinalPlan
+
+    def initialize(result_stream)
+      @result_stream = result_stream
+    end
+
+    def materialize(indexPattern, resultSet, opts, &block)
+      raise "Shouldn't be called - THis is just a place holder"
+    end
+
+    def describe(out = STDOUT, offset = 0, incr = 2, sep = "\n")
+      @result_stream.describe(out, offset, incr, sep)
+    end
+
+    def detach()
+      @result_stream.detach()
+    end
+  end
+
+end # module

data/lib/omf_rete/planner/plan_builder.rb

@@ -18,6 +18,7 @@ module OMF::Rete
     class PlannerException < Exception; end
 
     require 'omf_rete/planner/source_plan'
+    require 'omf_rete/planner/final_plan'
     require 'omf_rete/planner/plan_level_builder'
     require 'omf_rete/planner/plan_set'
     require 'omf_rete/planner/filter_plan'
@@ -88,6 +89,9 @@ module OMF::Rete
       # set.
       #
       def materialize(projectPattern = nil, plan = nil, opts = nil, &block)
+        unless block
+          raise PlannerException.new("Missing block to process result tuples with")
+        end
         unless plan
           plan = best_plan()
         end
@@ -96,7 +100,9 @@ module OMF::Rete
         end
         if (plan.is_a?(SourcePlan))
           # This is really just a simple pattern on the store
-          _materialize_simple_plan(projectPattern, plan, opts, &block)
+          #plan = SimpleSourcePlan.new(plan)
+          #plan.materialize(projectPattern, opts, &block)
+          endS = _materialize_simple_plan(projectPattern, plan, opts, &block)
         else
           # this is the root of the plan
           if projectPattern
@@ -106,8 +112,9 @@ module OMF::Rete
           end
           frontS, endS = _materialize_result_stream(plan, projectPattern, opts, &block)
           plan.materialize(nil, frontS, opts, &block)
-          endS
+          #endS
         end
+        FinalPlan.new(endS)
       end
 
 
@@ -267,7 +274,6 @@ module OMF::Rete
         frontS.source = src
 
         @store.registerTSet(src, plan.description) if @store
-
         endS
       end
 

data/lib/omf_rete/planner/source_plan.rb

@@ -51,7 +51,8 @@ module OMF::Rete
         else
           @source_set = OMF::Rete::IndexedTupleSet.new(@description, indexPattern)
         end
-        @store.registerTSet(@source_set, @description) if @store
+        #@store.registerTSet(@source_set, @description) if @store
+        @source_set.register_with_store(@store, @description)
       end
 
       # Return the cost of this plan.
@@ -69,11 +70,7 @@ module OMF::Rete
 
 
       def describe(out = STDOUT, offset = 0, incr = 2, sep = "\n")
-        out.write(" " * offset)
-        desc = @description.collect do |e| e || '*' end
-#          index = @result_set.to_a.sort
-#          out.write("src: [#{desc.join(', ')}] index: [#{index.join(', ')}] cost: #{cost}#{sep}")
-        out.write("src: [#{desc.join(', ')}] cost: #{cost}#{sep}")
+        @source_set.describe(out, offset, incr, sep) if @source_set
       end
 
     end # SourcePlan

data/lib/omf_rete/store.rb

@@ -7,6 +7,7 @@ module OMF::Rete::Store
   class StoreException < Exception; end
 
   class NotImplementedException < StoreException; end
+  class UnknownSubscriptionException < StoreException; end
 
   DEF_TYPE = :alpha
 
@@ -36,14 +37,46 @@ module OMF::Rete::Store
   # end
 
   def subscribe(name, query, out_pattern = nil, &block)
+    if name && @plans[name]
+      raise StoreException.new "Already have subscription '#{name}'."
+    end
+
     require 'omf_rete/planner/plan_builder'
 
     pb = OMF::Rete::Planner::PlanBuilder.new(query, self)
     pb.build
-    pb.materialize(out_pattern, &block)
+    plan = pb.materialize(out_pattern, &block)
+    if name
+      @plans[name] = plan
+    end
+    plan
   end
   alias :add_rule :subscribe
 
+  def unsubscribe(name_or_plan)
+    if name_or_plan.is_a? OMF::Rete::Planner::FinalPlan
+      plan = name_or_plan
+    else
+      plan = @plans.delete(name_or_plan)
+    end
+    unless plan
+      raise UnknownSubscriptionException.new("Unknown subscription '#{name_or_plan}'")
+    end
+    plan.detach
+  end
+
+  # Run a query against the store. This is essentially a short lived subscription
+  # may not be catch everything if there are inserts at the same time.
+  #
+  def query(query, out_pattern = nil)
+    result = []
+    plan = subscribe(null, query, out_pattern) do |t|
+      result << t
+    end
+    unsubscribe(plan)
+    result
+  end
+
   def addTuple(tarray)
     raise NotImplementedException.new
   end
@@ -98,5 +131,10 @@ module OMF::Rete::Store
     tuple.is_a?(Array) && tuple.length == @length
   end
 
+  protected
+  def store_initialize()
+    @plans = {}
+  end
+
 
 end

data/lib/omf_rete/store/alpha/alpha_element.rb

@@ -5,17 +5,18 @@ module OMF::Rete::Store::Alpha
     #
     class AlphaElement
 
-      def self.create(level, length)
+      def self.create(level, length, store)
         rem = length - level
         if (rem > 1)
-          AlphaInnerElement.new(level, length)
+          AlphaInnerElement.new(level, length, store)
         else
-          AlphaLeafElement.new(level)
+          AlphaLeafElement.new(level, store)
         end
       end
 
-      def initialize(level)
+      def initialize(level, store)
         @level = level
+        @store = store
       end
 
     end

data/lib/omf_rete/store/alpha/alpha_inner_element.rb

@@ -4,12 +4,12 @@ module OMF::Rete::Store::Alpha
 
     class AlphaInnerElement < AlphaElement
 
-      def initialize(level, length)
-        super(level)
+      def initialize(level, length, store)
+        super(level, store)
         @length = length
         @children = {}
         if (level < length)
-          @wildChild = AlphaElement.create(level + 1, length)
+          @wildChild = AlphaElement.create(level + 1, length, store)
         end
       end
 
@@ -18,7 +18,7 @@ module OMF::Rete::Store::Alpha
       def registerTSet(tset, pattern)
         pitem = pattern[@level]
         if (pitem)  # not nil
-          child = (@children[pitem] ||= AlphaElement.create(@level + 1, @length))
+          child = (@children[pitem] ||= AlphaElement.create(@level + 1, @length, @store))
           child.registerTSet(tset, pattern)
         else # wildcard
           @wildChild.registerTSet(tset, pattern)

data/lib/omf_rete/store/alpha/alpha_leaf_element.rb

@@ -7,7 +7,7 @@ module OMF::Rete::Store::Alpha
   #
   class AlphaLeafElement < AlphaElement
 
-    def initialize(level)
+    def initialize(level, store)
       super
       @tsetIndex = {}
       @tsetWildcards = []
@@ -18,11 +18,16 @@ module OMF::Rete::Store::Alpha
     def registerTSet(tset, pattern)
       pitem = pattern[@level]
       leaf = (@level == @length)
-      if (pitem)  # not nil
-        (@tsetIndex[pitem] ||= []) << tset
-      else # wildcard
-        @tsetWildcards << tset
+      a = pitem ? (@tsetIndex[pitem] ||= []) : @tsetWildcards
+      a << tset
+      @store.onUnregisterTSet(tset) do
+        a.delete(tset)
       end
+      # if (pitem)  # not nil
+        # (@tsetIndex[pitem] ||= []) << tset
+      # else # wildcard
+        # @tsetWildcards << tset
+      # end
     end
 
     def addTuple(tarray)

data/lib/omf_rete/store/alpha_store.rb

@@ -16,8 +16,10 @@ module OMF::Rete::Store
     # fixed length +length+.
     #
     def initialize(length, opts = {})
+      store_initialize()
       @length = length
-      @root = Alpha::AlphaInnerElement.new(0, length)
+      @root = Alpha::AlphaInnerElement.new(0, length, self)
+      @unregisterHandler = {}
       @index = []
       length.times do @index << {} end
     end
@@ -39,6 +41,14 @@ module OMF::Rete::Store
       tset
     end
 
+    def unregisterTSet(tset)
+      (@unregisterHandler[tset] || []).each do |proc|
+        proc.call
+      end
+      @unregisterHandler.delete(tset)
+    end
+
+
     def createTSet(description, indexPattern)
       tset = Moana::Filter::IndexedTupleSet.new(description, indexPattern)
       registerTSet(tset, description)
@@ -114,5 +124,12 @@ module OMF::Rete::Store
     def to_s()
       "Store"
     end
+
+    # Register a block to call whenever a TSet is being unregistered
+    #
+    def onUnregisterTSet(tset, &block)
+      (@unregisterHandler[tset] ||= []) << block
+    end
+
   end # Store
 end # Moana

data/lib/omf_rete/store/named_alpha_store.rb

@@ -20,6 +20,7 @@ module OMF::Rete::Store
     # is always 'name' (included in length)
     #
     def initialize(name, length, opts = {})
+      super(length, opts)
       @name = name
       super length, opts
       #@store = AlphaStore.new(length - 1)

data/lib/omf_rete/store/object_store.rb

@@ -23,6 +23,7 @@ module OMF::Rete::Store
 
     # @param opts :include_object Make the fist element the object
     def initialize(opts = {})
+      store_initialize()
       @include_object = opts[:name] || (opts[:include_object] == true ? self : nil)
       @object = nil
       @tsets = {}

data/lib/omf_rete/store/predicate_store.rb

@@ -30,6 +30,7 @@ module OMF::Rete::Store
     include OMF::Rete::Store
 
     def initialize(opts = {})
+      store_initialize()
       @stores = {}
     end
 

data/lib/omf_rete/tuple_stream.rb

@@ -28,6 +28,13 @@ module OMF::Rete
       raise "Method 'check_for_tuple' is not implemented"
     end
 
+    # Detach all streams from each other as they are no longer in use
+    #
+    def detach()
+      @source.detach if @source
+      @source = nil
+    end
+
     def describe(out = STDOUT, offset = 0, incr = 2, sep = "\n")
       out.write(" " * offset)
       _describe(out, sep)

data/lib/omf_rete/version.rb

@@ -1,7 +1,7 @@
 
 module OMF
   module Rete
-    VERSION = '0.6.1'
+    VERSION = '0.6.2'
     # Used for finding the example directory
     TOP_DIR = File.dirname(File.dirname(File.dirname(__FILE__)))
   end

data/tests/test_filter.rb

@@ -9,7 +9,7 @@ include OMF::Rete
 include OMF::Rete::Planner
 
 class TestFilter < Test::Unit::TestCase
-  
+
 
   def _test_plan(plan, storeSize, expected = nil, inTuples = nil, outTuples = nil, outPattern = nil)
     store = Store.create(storeSize)
@@ -22,12 +22,11 @@ class TestFilter < Test::Unit::TestCase
     result = pb.materialize(outPattern) do |t|
       resT << t.to_a
     end
-      
     out = StringIO.new
     #result.describe(out, 0, 0, '|')
     result.describe(out)
     assert_equal(expected, out.string) if expected
-    
+
     if (inTuples)
       inTuples.each do |t|
         store.addTuple(t)
@@ -36,10 +35,10 @@ class TestFilter < Test::Unit::TestCase
     end
     result
   end
-  
+
   def test_theshold_test
     plan = [
-      [:x?], 
+      [:x?],
       OMF::Rete.filter(:x?) do |x|
         x > 2
       end
@@ -53,10 +52,10 @@ out: [x?]
     resT = [[3], [4]]
     _test_plan plan, 1, exp, inT, resT
   end
-  
+
   def test_theshold_test2
     plan = [
-      [:x?, :y?], 
+      [:x?, :y?],
       OMF::Rete::filter(:x?) do |x|
         x > 2
       end,

data/tests/test_planner.rb

@@ -20,7 +20,7 @@ class TestPlanner < Test::Unit::TestCase
 
     # with empty store
     resT = []
-    result = store.subscribe(:test, plan, outPattern) do |t|
+    result = store.subscribe(nil, plan, outPattern) do |t|
       resT << t.to_a
     end
 
@@ -29,6 +29,8 @@ class TestPlanner < Test::Unit::TestCase
     result.describe(out)
     assert_equal(expected, out.string) if expected
 
+    #store.unsubscribe(result)
+
     if (inTuples)
 
       inTuples.each do |t|

metadata

@@ -1,39 +1,44 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: omf_rete
-version: !ruby/object:Gem::Version
-  version: 0.6.1
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 2
+  version: 0.6.2
 platform: ruby
-authors:
+authors: 
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-01-02 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: omf_base
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: Tuple store with query and filter functionality.
-email:
+email: 
 - omf-user@lists.nicta.com.au
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - README.md
 - Rakefile
@@ -43,6 +48,7 @@ files:
 - lib/omf_rete/join_op.rb
 - lib/omf_rete/planner/abstract_plan.rb
 - lib/omf_rete/planner/filter_plan.rb
+- lib/omf_rete/planner/final_plan.rb
 - lib/omf_rete/planner/join_plan.rb
 - lib/omf_rete/planner/plan_builder.rb
 - lib/omf_rete/planner/plan_level_builder.rb
@@ -71,29 +77,35 @@ files:
 - tests/test_predicate_store.rb
 - tests/test_readme.rb
 - tests/test_store.rb
+has_rdoc: true
 homepage: https://www.mytestbed.net
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: omf_rete
-rubygems_version: 1.8.23
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A Rete implementation.
 test_files: []
-has_rdoc: 
+