wongi-engine 0.0.6 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72c7ec74580f897b110a1c0f119805d82f2e0257
+  data.tar.gz: 0a4cea942993957a9a353ab5712cea0a44cb5bfa
+SHA512:
+  metadata.gz: dbbbc1de9d70f925ba7dfdd9d29199528cbca93ed4e11ae886412392ff23b6f614074d0169ffac8b627bb699f64850aaf82f8a792dbcafd2d719e41cb02296ee
+  data.tar.gz: e59ac0a7bd484f94f00e65ad2e7c52d2ce5609a54c1e3a0fd8d1fc9c1b1d1d1c195e6b97199f70a59407b630bec5fffa681505c0f56ab6a29d1684f4f95abab4

data/README.md

@@ -37,6 +37,12 @@ engine << [ "Alice", "friend", "Bob" ]
 engine << [ "Alice", "age", 35 ]
 ```
 
+To remove facts, say:
+
+```ruby
+engine.retract [ "Alice", "age", 35 ]
+```
+
 What can we do with this information?
 
 ### Simple iteration
@@ -65,7 +71,7 @@ friends = engine.rule "friends" do
 end
 ```
 
-Here's your first taste of the engine's DSL. A rule, generally speaking, consists of a number of conditions the dataset needs to meet; those are defined in the `forall` section (also spelled `for_all`, if you prefer that). `has` (or `fact`) specifies that there needs to be a fact that matches the given pattern; in this case, one with the predicate `"friends"`.
+Here's your first taste of the engine's DSL. A rule, generally speaking, consists of a number of conditions the dataset needs to meet; those are defined in the `forall` section (also spelled `for_all`, if you prefer that). `has` (or `fact`) specifies that there needs to be a fact that matches the given pattern; in this case, one with the predicate `"friend"`.
 
 When a pattern contains a symbol that starts with an uppercase letter, it introduces a variable which will be bound to an actual triple field. Their values can be retrieved from the result set:
 
@@ -143,11 +149,11 @@ engine.rule "self-printer" do
 end
 ```
 
-The `make` section (also spelled `do!`, if you find it more agreeable English, because `do` is a keyword in Ruby) lists everything that happens when a rule's conditions are fully matched (we say "the production node is **activated**"). Wongi::Engine provides only a small amount of built-in actions, but you can define your own ones, and the simplest one is just `action` with a block.
+The `make` section (also spelled `do!`, if you find it more agreeable English, because `do` is a keyword in Ruby) lists everything that happens when a rule's conditions are fully matched (we say "the production node is **activated**"). Wongi::Engine provides only a small amount of built-in actions, but you can define your own ones, and the simplest one is just `action` with a block. The block will be executed in the engine's context.
 
 ### More facts!
 
-Note how our facts define relations that always go from subject to object - they form a directed graph. In a perfect world, friendships go both ways, but to specify this in out model, we need to have two facts for each couple. Instead of duplicating everything by hand, let's automate that:
+Note how our facts define relations that always go from subject to object - they form a directed graph. In a perfect world, friendships go both ways, but to specify this in our model, we need to have two facts for each couple. Instead of duplicating everything by hand, let's automate that:
 
 ```ruby
 engine.rule "symmetric predicate" do
@@ -195,6 +201,10 @@ Passes if the arguments are equal. Alias: `eq`, `equal`.
 
 Passes if the arguments are not equal. Alias: `ne`.
 
+#### `less x, y`, `greater x, y`
+
+Should be obvious by now.
+
 #### `assert { |token| ... }`, `assert var1, var2, ... do |val1, val2, ... | ... end`
 
 Passes if the block evaluates to `true`. Having no arguments passes the entire token as an argument, listing some variables passes only their values.
@@ -411,6 +421,14 @@ The Rete implementation in this library largely follows the outline presented in
 
 ## Changelog
 
+### 0.0.7
+
+* added a guard against introducing variables in neg clauses
+* fixed execution context of simple action block (#7)
+* fixed #4 once more, better
+* fixed a bug with OptionalNode (#12)
+* fixed behaviour of neg nodes; this will cause feedback loops when a gen action creates a fact that invalidates the action's condition
+
 ### 0.0.6
 
 * fixed a bug caused by retracting facts from within a rule action (#4)

data/Rakefile

@@ -1,2 +1,9 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/wongi-engine.rb

@@ -19,6 +19,7 @@ end
 
 require 'wongi-engine/version'
 require 'wongi-engine/core_ext'
+require 'wongi-engine/error'
 require 'wongi-engine/template'
 require 'wongi-engine/wme'
 require 'wongi-engine/wme_match_data'

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

@@ -44,7 +44,12 @@ module Wongi::Engine
 
     def refresh_child child
       tokens.each do |token|
-        child.beta_activate token, nil, {}
+        case child
+        when BetaMemory, NegNode
+          child.beta_activate token, nil, {}
+        else
+          child.beta_activate token
+        end
       end
     end
 

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

@@ -16,8 +16,9 @@ module Wongi
       def alpha_activate wme
         self.tokens.each do |token|
           if matches?( token, wme )
-            token.delete_children if token.neg_join_results.empty?
+            # 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
           end
         end
       end
@@ -39,7 +40,7 @@ module Wongi
       end
 
       def refresh_child child
-        tokens.each do |token|
+        safe_tokens.each do |token|
           if token.neg_join_results.empty?
             child.beta_activate token, nil, {}
           end
@@ -72,6 +73,15 @@ module Wongi
         token.neg_join_results << njr
         wme.neg_join_results << njr
       end
+
+      def safe_tokens
+        Enumerator.new do |y|
+          @tokens.dup.each do |token|
+            y << token unless token.deleted?
+          end
+        end
+      end
+
     end
   end
 end

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

@@ -45,6 +45,7 @@ module Wongi
       def refresh_child child
         tmp = children
         self.children = [ child ]
+        refresh # do the beta part
         alpha.wmes.each do |wme|
           alpha_activate wme
         end

data/lib/wongi-engine/dsl.rb

@@ -66,6 +66,12 @@ dsl {
   clause :diff, :ne
   accept Wongi::Engine::InequalityTest
 
+  clause :less
+  accept Wongi::Engine::LessThanTest
+
+  clause :greater
+  accept Wongi::Engine::GreaterThanTest
+
   clause :assert, :dynamic
   accept Wongi::Engine::AssertingTest
 

data/lib/wongi-engine/dsl/actions/simple_action.rb

@@ -11,7 +11,9 @@ module Wongi::Engine
     end
 
     def execute token
-      if @action.respond_to? :call
+      if @action.is_a?( Proc ) || @action.respond_to?( :to_proc )
+        rete.instance_exec token, &@action
+      elsif @action.respond_to? :call
         @action.call token
       elsif @action.respond_to? :execute
         @action.execute token

data/lib/wongi-engine/dsl/actions/statement_generator.rb

@@ -31,7 +31,8 @@ module Wongi::Engine
         @template.object
       end
 
-      wme = WME.new subject, predicate, object
+      # link to rete here to ensure proper linking with token
+      wme = WME.new subject, predicate, object, rete
 
       production.tracer.trace( action: self, wme: wme ) if production.tracer
       if existing = rete.exists?( wme )
@@ -41,9 +42,11 @@ module Wongi::Engine
           existing.generating_tokens << token
         end
       else
-        added = rete << wme
-        token.generated_wmes << added
-        added.generating_tokens << token
+        token.generated_wmes << wme
+        wme.generating_tokens << token
+        # this MUST be done after we link the wme and the token
+        # in order for neg rule invalidation to work
+        rete << wme
       end
 
     end

data/lib/wongi-engine/error.rb

@@ -0,0 +1,11 @@
+module Wongi::Engine
+
+  class Error < ::Exception
+
+  end
+
+  class DefinitionError < Error
+
+  end
+
+end

data/lib/wongi-engine/filter.rb

@@ -2,3 +2,5 @@ require 'wongi-engine/filter/filter_test'
 require 'wongi-engine/filter/equality_test'
 require 'wongi-engine/filter/inequality_test'
 require 'wongi-engine/filter/asserting_test'
+require 'wongi-engine/filter/less_than_test'
+require 'wongi-engine/filter/greater_than_test'

data/lib/wongi-engine/filter/greater_than_test.rb

@@ -0,0 +1,36 @@
+module Wongi::Engine
+
+  class GreaterThanTest < FilterTest
+
+    attr_reader :x, :y
+
+    def initialize x, y
+      @x, @y = x, y
+    end
+
+    def passes? token
+
+      x = if Template.variable? @x
+        token[@x]
+      else
+        @x
+      end
+
+      y = if Template.variable? @y
+        token[@y]
+      else
+        @y
+      end
+
+      return false if x == :_ || y == :_
+      return x > y
+
+    end
+
+    def == other
+      super && x == other.x && y == other.y
+    end
+
+  end
+
+end

data/lib/wongi-engine/filter/less_than_test.rb

@@ -0,0 +1,36 @@
+module Wongi::Engine
+
+  class LessThanTest < FilterTest
+
+    attr_reader :x, :y
+
+    def initialize x, y
+      @x, @y = x, y
+    end
+
+    def passes? token
+
+      x = if Template.variable? @x
+        token[@x]
+      else
+        @x
+      end
+
+      y = if Template.variable? @y
+        token[@y]
+      else
+        @y
+      end
+
+      return false if x == :_ || y == :_
+      return x < y
+
+    end
+
+    def == other
+      super && x == other.x && y == other.y
+    end
+
+  end
+
+end

data/lib/wongi-engine/template.rb

@@ -28,6 +28,10 @@ module Wongi::Engine
       subject == :_ && predicate == :_ && object == :_
     end
 
+    def variables
+      array_form.select { |e| self.class.variable? e }
+    end
+
     def contains? var
       self.class.variable?( var ) && array_form.include?( var )
     end
@@ -88,7 +92,8 @@ module Wongi::Engine
   class NegTemplate < Template
     # :arg: context => Wongi::Rete::BetaNode::CompilationContext
     def compile context
-      tests, _ = *JoinNode.compile( self, context.earlier, context.parameters )
+      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.debug = debug?

data/lib/wongi-engine/token.rb

@@ -15,6 +15,7 @@ module Wongi::Engine
     def initialize token, wme, assignments
       @parent, @wme, @assignments = token, wme, assignments
       @children = []
+      @deleted = false
       @neg_join_results = []
       @opt_join_results = []
       @ncc_results = []
@@ -39,8 +40,8 @@ module Wongi::Engine
     end
 
     def to_s
-      str = "TOKEN [\n"
-      all_assignments.each_pair { |key, value| str << "\t#{key} => #{value}\n" }
+      str = "TOKEN [ "
+      all_assignments.each_pair { |key, value| str << "#{key} => #{value} " }
       str << "]"
       str
     end
@@ -55,15 +56,19 @@ module Wongi::Engine
 
     def delete
       delete_children
-      @node.tokens.delete self unless @node.kind_of?( NccPartner )
+      #@node.tokens.delete self unless @node.kind_of?( NccPartner )
       @wme.tokens.delete self if @wme
       @parent.children.delete self if @parent
 
       retract_generated
-
+      @deleted = true
       @node.delete_token self
     end
 
+    def deleted?
+      @deleted
+    end
+
     def delete_children
       while @children.first
         @children.first.delete

data/lib/wongi-engine/version.rb

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

data/spec/bug_specs/issue_4_spec.rb

@@ -91,4 +91,50 @@ describe "issue 4" do
 
   end
 
+
+  it "should not lose track when another rule affects a set" do
+    engine = Wongi::Engine.create
+
+    10.times{ |i| engine << [i, :is_number, true] }
+
+    engine.rule 'find odds' do
+      forall {
+        has :Number, :is_number, true
+        has :Number, :probably_odd, true
+      }
+      make {
+        action { |token|
+          number = token[:Number]
+          if number % 2 != 0
+            engine << [number, :is_odd, true]
+            engine.retract [number, :is_number, true]
+          end
+        }
+      }
+    end
+    engine.rule 'find evens' do
+      forall {
+        has :Number, :is_number, true
+        neg :Number, :is_odd, true
+      }
+      make {
+        action { |token|
+          number = token[:Number]
+          if number % 2 == 0
+            engine << [number, :is_even, true]
+          else
+            engine << [number, :probably_odd, true]
+          end
+        }
+      }
+    end
+
+    numbers = engine.select :_, :is_number, true
+    evens = engine.select :_, :is_even, true
+    odds = engine.select :_, :is_odd, true
+
+    # numbers.should be_empty
+    evens.should have(5).items
+    odds.should have(5).items
+  end
 end

data/spec/high_level_spec.rb

@@ -66,7 +66,7 @@ describe 'the engine' do
 
   it 'should check equality' do
 
-    rete << rule('equality') {
+    node = rete << rule('equality') {
       forall {
         fact :A, "same", :B
         same :A, :B
@@ -77,6 +77,42 @@ describe 'the engine' do
     }
 
     rete << [ 42, "same", 42 ]
+    node.should have(1).tokens
+
+  end
+
+  it 'should compare things' do
+
+    rete << rule('less') {
+      forall {
+        has :A, :age, :N1
+        has :B, :age, :N2
+        less :N1, :N2
+      }
+      make {
+        gen :A, :younger, :B
+      }
+    }
+
+    rete << rule('less') {
+      forall {
+        has :A, :age, :N1
+        has :B, :age, :N2
+        greater :N1, :N2
+      }
+      make {
+        gen :A, :older, :B
+      }
+    }
+
+    rete << ["Alice", :age, 42]
+    rete << ["Bob", :age, 43]
+
+    items = rete.select "Alice", :younger, "Bob"
+    items.should have(1).items
+
+    items = rete.select "Bob", :older, "Alice"
+    items.should have(1).items
 
   end
 

data/spec/rule_specs/maybe_rule_spec.rb

@@ -51,4 +51,24 @@ describe "MAYBE rule" do
 
   end
 
+  it "should pass with pre-added missing facts" do
+
+    engine << [1, 2, 3]
+
+    engine << rule('test') do
+      forall {
+        has 1, 2, :X
+        maybe :X, 4, :Y
+      }
+    end
+
+    prod = engine.productions['test']
+
+    prod.should have(1).tokens
+
+    prod.tokens.first[:X].should == 3
+    prod.tokens.first[:Y].should be_nil
+
+  end
+
 end

data/spec/rule_specs/negative_rule_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe "negative rule" do
+
+  before :each do
+    @engine = Wongi::Engine.create
+  end
+
+  def engine
+    @engine
+  end
+
+  it "should not introduce variables" do
+
+    proc = lambda {
+
+      engine << rule('one-option') {
+        forall {
+          neg :Foo, :bar, :_
+        }
+        make {
+          action { |tokens|
+            raise "This should never get executed #{tokens}"
+          }
+        }
+      }
+
+    }
+
+    proc.should raise_error( Wongi::Engine::DefinitionError )
+
+  end
+
+  it "should create infinite feedback loops" do
+
+    proc = lambda {
+      engine << rule('feedback') {
+        forall {
+          neg :a, :b, :_
+        }
+        make {
+          gen :a, :b, :c
+        }
+      }
+    }
+
+    proc.should raise_error( SystemStackError )
+
+  end
+
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wongi-engine
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - Valeri Sokolov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies: []
 description: A rule engine.
 email:
@@ -60,11 +59,14 @@ files:
 - lib/wongi-engine/dsl/ncc_production_rule.rb
 - lib/wongi-engine/dsl/production_rule.rb
 - lib/wongi-engine/dsl/query.rb
+- lib/wongi-engine/error.rb
 - lib/wongi-engine/filter.rb
 - lib/wongi-engine/filter/asserting_test.rb
 - lib/wongi-engine/filter/equality_test.rb
 - lib/wongi-engine/filter/filter_test.rb
+- lib/wongi-engine/filter/greater_than_test.rb
 - lib/wongi-engine/filter/inequality_test.rb
+- lib/wongi-engine/filter/less_than_test.rb
 - lib/wongi-engine/graph.rb
 - lib/wongi-engine/model_context.rb
 - lib/wongi-engine/network.rb
@@ -85,6 +87,7 @@ files:
 - spec/rule_specs/assign_spec.rb
 - spec/rule_specs/maybe_rule_spec.rb
 - spec/rule_specs/ncc_spec.rb
+- spec/rule_specs/negative_rule_spec.rb
 - spec/ruleset_spec.rb
 - spec/simple_action_spec.rb
 - spec/spec_helper.rb
@@ -92,27 +95,26 @@ files:
 - wongi-engine.gemspec
 homepage: https://github.com/ulfurinn/wongi-engine
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 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'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A rule engine.
 test_files:
 - spec/bug_specs/issue_4_spec.rb
@@ -124,6 +126,7 @@ test_files:
 - spec/rule_specs/assign_spec.rb
 - spec/rule_specs/maybe_rule_spec.rb
 - spec/rule_specs/ncc_spec.rb
+- spec/rule_specs/negative_rule_spec.rb
 - spec/ruleset_spec.rb
 - spec/simple_action_spec.rb
 - spec/spec_helper.rb