wongi-engine 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72c7ec74580f897b110a1c0f119805d82f2e0257
-  data.tar.gz: 0a4cea942993957a9a353ab5712cea0a44cb5bfa
+  metadata.gz: 42749e9f8fc743ae3e5a96e43d44185446c622c7
+  data.tar.gz: 55c35cd79c0ea900a27d173b76c4f949750f0f50
 SHA512:
-  metadata.gz: dbbbc1de9d70f925ba7dfdd9d29199528cbca93ed4e11ae886412392ff23b6f614074d0169ffac8b627bb699f64850aaf82f8a792dbcafd2d719e41cb02296ee
-  data.tar.gz: e59ac0a7bd484f94f00e65ad2e7c52d2ce5609a54c1e3a0fd8d1fc9c1b1d1d1c195e6b97199f70a59407b630bec5fffa681505c0f56ab6a29d1684f4f95abab4
+  metadata.gz: 1d1a6fa593a0d293bcb563c8ba0f1388541a12f44f0a7ec8de279a98b8f8cda8faa49a26d514f67f3eaff366e1a889561da0672ec0129a0c466e75ab1e2f1b0b
+  data.tar.gz: edb677ce97d0a79e986f1646350d6f358569e3ce3d070e92c437ca540b4b23758a990056df6e08c99676e3de6f0e9230808909b67f09f2896e7c5798e99d982e

data/README.md

@@ -213,9 +213,34 @@ Passes if the block evaluates to `true`. Having no arguments passes the entire t
 
 Not a *matcher*, strictly speaking, because it always passes. What it does instead is introduce a new variable bound to the block's return value.
 
+### Feedback loop prevention
+
+Consider the following rule:
+
+```ruby
+engine.rule "default value" do
+	forall {
+		neg :car, :colour, :_
+	}
+	make {
+		gen :car, :colour, "black"
+	}
+end
+```
+
+The intent here is to provide a default value for an attribute; however, how will it actually execute?
+
+1. The fact is missing, activate the rule, generate the fact.
+2. The fact is present, invalidate the rule, retract the generated fact.
+3. The fact is missing...
+
+...and so on until you get a stack overflow. In situations like this the engine will try to do the pragmatic thing and detect the loop, stopping after step 1. If you want to keep the "pure" behaviour, give the `unsafe: true` option to the `neg` rule and try to do the same thing with helper facts.
+
+**Note**: this is a specific use case; it is still perfectly possible to construct more elaborate infinite cascades involving several rules that will not be caught.
+
 ### Timeline
 
-Wongi::Engine has a limited concept of timed facts: time is discrete and only extends into the past. Matchers that accept a triple specification (`has`, `neg` and `maybe`) can also accept a fourth parameter, an integer <= 0, which will make them look at a past state of the system. "0" means the current state and is the default value, "-1" means the one just before the current, and so on.
+Wongi::Engine has a limited concept of timed facts: time is discrete and only extends into the past. Matchers that accept a triple specification (`has`, `neg` and `maybe`) can also accept a `time` option, an integer <= 0, which will make them look at a past state of the system. "0" means the current state and is the default value, "-1" means the one just before the current, and so on.
 
 To create past states, say:
 
@@ -234,8 +259,8 @@ The following matchers are nothing but syntactic sugar for a combination of prim
 Short for:
 	
 ```ruby
-neg subject, predicate, object, -1
-has subject, predicate, object, 0
+neg subject, predicate, object, time: -1
+has subject, predicate, object, time: 0
 ```
 
 That is, it passes if the fact was missing in the previous state but exists in the current one. Alias: `added`.
@@ -245,8 +270,8 @@ That is, it passes if the fact was missing in the previous state but exists in t
 Short for:
 
 ```ruby
-has subject, predicate, object, -1
-neg subject, predicate, object, 0
+has subject, predicate, object, time: -1
+neg subject, predicate, object, time: 0
 ```
 
 The reverse of `asserted`. Alias: `removed`.
@@ -256,8 +281,8 @@ The reverse of `asserted`. Alias: `removed`.
 Short for:
 
 ```ruby
-has subject, predicate, object, -1
-has subject, predicate, object, 0
+has subject, predicate, object, time: -1
+has subject, predicate, object, time: 0
 ```
 
 Alias: `still_has`.
@@ -267,8 +292,8 @@ Alias: `still_has`.
 Short for:
 
 ```ruby
-neg subject, predicate, object, -1
-neg subject, predicate, object, 0
+neg subject, predicate, object, time: -1
+neg subject, predicate, object, time: 0
 ```
 
 Alias: `still_missing`.
@@ -421,6 +446,10 @@ The Rete implementation in this library largely follows the outline presented in
 
 ## Changelog
 
+### 0.0.8
+
+* preventing the feedback loop introduced in 0.0.7; experimental
+
 ### 0.0.7
 
 * added a guard against introducing variables in neg clauses

data/lib/wongi-engine/beta/beta_node.rb

@@ -77,8 +77,8 @@ module Wongi::Engine
       node
     end
 
-    def neg_node alpha, tests, alpha_deaf
-      node = NegNode.new self, tests, alpha
+    def neg_node alpha, tests, alpha_deaf, unsafe
+      node = NegNode.new self, tests, alpha, unsafe
       alpha.betas << node unless alpha_deaf
       node.refresh
       node

data/lib/wongi-engine/beta/join_node.rb

@@ -91,7 +91,7 @@ module Wongi
 
       def self.compile condition, earlier, parameters
         tests = []
-        assignment = Template.new
+        assignment = Template.new :_, :_, :_
         [:subject, :predicate, :object].each do |field|
           member = condition.send field
           if Template.variable?( member )

data/lib/wongi-engine/beta/neg_node.rb

@@ -7,15 +7,15 @@ module Wongi
 
       attr_reader :tokens, :alpha, :tests
 
-      def initialize parent, tests, alpha
+      def initialize parent, tests, alpha, unsafe
         super(parent)
-        @tests, @alpha = tests, alpha
+        @tests, @alpha, @unsafe = tests, alpha, unsafe
         @tokens = []
       end
 
       def alpha_activate wme
         self.tokens.each do |token|
-          if matches?( token, wme )
+          if matches?( token, wme ) && ( @unsafe || ! token.generated?( wme ) )# feedback loop protection
             # order matters for proper invalidation
             make_join_result(token, wme)
             token.delete_children #if token.neg_join_results.empty? # TODO why was this check here? it seems to break things

data/lib/wongi-engine/dsl.rb

@@ -80,26 +80,26 @@ dsl {
 
   clause :asserted, :added
   body { |s, p, o|
-    missing s, p, o, -1
-    has s, p, o, 0
+    missing s, p, o, time: -1
+    has s, p, o, time: 0
   }
 
   clause :retracted, :removed
   body { |s, p, o|
-    has s, p, o, -1
-    missing s, p, o, 0
+    has s, p, o, time: -1
+    missing s, p, o, time: 0
   }
 
   clause :kept, :still_has
   body { |s, p, o|
-    has s, p, o, -1
-    has s, p, o, 0
+    has s, p, o, time: -1
+    has s, p, o, time: 0
   }
 
   clause :kept_missing, :still_missing
   body { |s, p, o|
-    missing s, p, o, -1
-    missing s, p, o, 0
+    missing s, p, o, time: -1
+    missing s, p, o, time: 0
   }
 
 

data/lib/wongi-engine/network.rb

@@ -244,7 +244,7 @@ module Wongi::Engine
       else
         if @timeline[time+1].nil?
           # => ensure lineage from 0 to time
-          compile_alpha condition.class.new(condition.subject, condition.predicate, condition.object, time + 1)
+          compile_alpha condition.class.new(condition.subject, condition.predicate, condition.object, time: time + 1)
           @timeline.unshift Hash.new
         end
         @timeline[time+1][ hash ] = alpha

data/lib/wongi-engine/template.rb

@@ -4,22 +4,25 @@ module Wongi::Engine
 
     include CoreExt
 
-    attr_reader :filters
+    attr_reader :filters, :unsafe
     attr_predicate debug: false
 
     def self.variable? thing
       Symbol === thing && thing =~ /^[A-Z]/
     end
 
-    def initialize s = :_, p = :_, o = :_, time = 0
+    def initialize s, p, o, options = { }
+      time = options[:time] || 0
+      unsafe = options[:unsafe] || false
       raise "Cannot work with continuous time" unless time.integer?
       raise "Cannot look into the future" if time > 0
-      super
+      super( s, p, o, time )
       @filters = []
+      @unsafe = unsafe
     end
 
     def import_into r
-      copy = self.class.new r.import( subject ), r.import( predicate ), r.import( object ), time
+      copy = self.class.new r.import( subject ), r.import( predicate ), r.import( object ), time: time, unsafe: unsafe
       @filters.each { |f| copy.filters << f }
       copy
     end
@@ -95,7 +98,7 @@ module Wongi::Engine
       tests, assignment = *JoinNode.compile( self, context.earlier, context.parameters )
       raise DefinitionError.new("Negative matches may not introduce new variables: #{assignment.variables}") unless assignment.root?
       alpha = context.rete.compile_alpha( self )
-      context.node = context.node.neg_node( alpha, tests, context.alpha_deaf )
+      context.node = context.node.neg_node( alpha, tests, context.alpha_deaf, unsafe )
       context.node.debug = debug?
       context.earlier << self
       context

data/lib/wongi-engine/token.rb

@@ -75,8 +75,12 @@ module Wongi::Engine
       end
     end
 
-    protected
+    def generated? wme
+      return true if generated_wmes.any? { |w| w == wme }
+      return children.any? { |t| t.generated? wme }
+    end
 
+    protected
 
     def retract_generated
 

data/lib/wongi-engine/version.rb

@@ -1,5 +1,5 @@
 module Wongi
   module Engine
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/spec/high_level_spec.rb

@@ -221,7 +221,7 @@ describe 'the engine' do
 
       production = rete.rule {
         forall {
-          has 1, 2, 3, -1
+          has 1, 2, 3, time: -1
         }
       }
 
@@ -237,7 +237,7 @@ describe 'the engine' do
 
       production = rete.rule {
         forall {
-          has 1, 2, 3, -1
+          has 1, 2, 3, time: -1
         }
       }
 

data/spec/rule_specs/negative_rule_spec.rb

@@ -31,12 +31,27 @@ describe "negative rule" do
 
   end
 
-  it "should create infinite feedback loops" do
+  it "should not create infinite feedback loops by default" do
+
+    engine << rule('feedback') {
+      forall {
+        neg :a, :b, :_
+      }
+      make {
+        gen :a, :b, :c
+      }
+    }
+
+    engine.should have(1).facts
+
+  end
+
+  it "should create infinite feedback loops with unsafe option" do
 
     proc = lambda {
       engine << rule('feedback') {
         forall {
-          neg :a, :b, :_
+          neg :a, :b, :_, unsafe: true
         }
         make {
           gen :a, :b, :c

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wongi-engine
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Valeri Sokolov