wongi-engine 0.1.0.alpha1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a090dea5a39943ac1d887178b7d1b9a5df3f618c
-  data.tar.gz: ceca588238658bf643d067e3502643e554719ef5
+  metadata.gz: 242f2dfca581ccebad701500d1329f56645942a6
+  data.tar.gz: fa9eb4e93e95ab0e06ea8dc5475fbfc8b07e5fcd
 SHA512:
-  metadata.gz: cb3fc2402bcdfe4afbd0b0f5bf72aba18b32f40a89c013c429f0507414f7f243962f42dff3aa31bf412a5345f449eb6d13b152fc9f6120efacd2cade85b4290d
-  data.tar.gz: 39063e5d6c69a37bd3b10a52badf24666d79c0d887a110f528e3b94b498a5e21273c702e4c8e80f024e0b6d1d6723c8cdb91ab9cb200a4c56ad35b487580ffcf
+  metadata.gz: 9db3fcb8333c246b124137c6ba0dcb654816283f3c389c2162268230a2c9acc818f986956a4f0171057564f3dd172ec9b6fdc551b9e1523a44d864ac8fbf7f98
+  data.tar.gz: 1bdef60a60134e32676e880c61f02948e42b34c43baff937b7713d40e2b17fb40c5e5da19fceb1b9845c2f61753ee93e591fd166c1a477e96d5b83fe6d9a472b

data/README.md

@@ -6,7 +6,7 @@ This library contains a rule engine written in Ruby. It's based on the [Rete alg
 
 ## Word of caution
 
-This is complex and fragile machinery, and there may be subtle bugs that are only revealed with nontrivial usage. Please test your rules extensively and report any behaviour that is not consistent with your expectations.
+This is complex and fragile machinery, and there may be subtle bugs that are only revealed with nontrivial usage. Be conservative with upgrades, test your rules extensively, and please report any behaviour that is not consistent with your expectations.
 
 ## Tutorial
 
@@ -459,6 +459,10 @@ The Rete implementation in this library largely follows the outline presented in
 
 ## Changelog
 
+### 0.1.0
+
+* massively rewritten rule activation; this simplifies development and debugging and opens the road for useful features such as fully reversible custom actions
+
 ### 0.0.17
 
 * introduced the `assuming` matcher

data/lib/wongi-engine/core_ext.rb

@@ -18,12 +18,12 @@ module Wongi::Engine
         names_hash.each do |name, def_value|
 
           varname = "@#{name}".to_sym
-          getname = "#{name}?".to_sym
+          predname = "#{name}?".to_sym
           setname = "#{name}=".to_sym
           exclname = "#{name}!".to_sym
           noexclname = "no_#{name}!".to_sym
 
-          define_method getname do
+          define_method predname do
             if instance_variable_defined?( varname )
               instance_variable_get( varname )
             else

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

@@ -33,6 +33,7 @@ module Wongi::Engine
 
       # link to rete here to ensure proper linking with token
       wme = WME.new subject, predicate, object, rete
+      wme.manual = false
 
       production.tracer.trace( action: self, wme: wme ) if production.tracer
       if existing = rete.exists?( wme )
@@ -58,7 +59,7 @@ module Wongi::Engine
           l << wme if wme.generating_tokens.empty?
         end
       end.each do |wme|
-        rete.retract wme
+        rete.retract wme, automatic: true
       end
     end
 

data/lib/wongi-engine/network.rb

@@ -92,9 +92,9 @@ module Wongi::Engine
       end
     end
 
-    def retract wme
+    def retract wme, options = { }
       @next_cascade ||= []
-      @next_cascade << [:retract, wme]
+      @next_cascade << [:retract, wme, options]
       if @current_cascade.nil?
         @current_cascade = @next_cascade
         @next_cascade = nil
@@ -105,12 +105,12 @@ module Wongi::Engine
     def process_cascade
       iterations = 0
       while @current_cascade
-        @current_cascade.each do |(operation, wme)|
+        @current_cascade.each do |(operation, wme, options)|
           case operation
           when :assert
             real_assert wme
           when :retract
-            real_retract wme
+            real_retract wme, options
           end
         end
         @current_cascade = @next_cascade
@@ -130,7 +130,10 @@ module Wongi::Engine
         wme.context = @current_context
       end
 
-      return if @cache.has_key?(wme)
+      if existing = @cache[wme]
+        existing.manual! if wme.manual?
+        return
+      end
 
       # puts "ASSERTING #{wme}"
       @cache[wme] = wme
@@ -218,27 +221,31 @@ module Wongi::Engine
       end
     end
 
-    def real_retract wme, is_real = false
+    def real_retract wme, options
 
       if wme.is_a? Array
-        return real_retract( WME.new(*wme), is_real )
+        return real_retract( WME.new(*wme), options )
       end
 
-      if ! is_real
-        if @current_context
-          @current_context.retracted_wmes << wme
+      real = @cache[wme]
+
+      return if real.nil?
+      if real.generated? # still some generator tokens left
+        if real.manual?
+          real.manual = false
+        else
+          raise "cannot retract automatic facts"
+        end
+      else
+        if options[:automatic] && real.manual? # auto-retracting a fact that has been added manually
+          return
         end
       end
 
-      real = if is_real
-        wme
-      else
-        #find(wme.subject, wme.predicate, wme.object)
-        @cache[wme]
+      if @current_context
+        @current_context.retracted_wmes << wme
       end
 
-      return if real.nil?
-      raise "Cannot retract inferred statements" unless real.manual?
       @cache.delete(real)
 
       alphas_for( real ).each { |a| a.deactivate real }
@@ -323,6 +330,7 @@ module Wongi::Engine
       end
     end
 
+    # TODO: contexts are probably broken with the new improved handling of manual & generated
     def retract_context name
       return unless @contexts.has_key?(name)
 

data/lib/wongi-engine/version.rb

@@ -1,5 +1,5 @@
 module Wongi
   module Engine
-    VERSION = "0.1.0.alpha1"
+    VERSION = "0.1.0"
   end
 end

data/lib/wongi-engine/wme.rb

@@ -9,9 +9,12 @@ module Wongi::Engine
     attr_reader :alphas, :tokens, :generating_tokens
     attr_reader :neg_join_results, :opt_join_results
     attr_predicate :deleted
+    attr_predicate :manual
 
     def initialize s, p, o, r = nil
 
+      manual!
+
       @deleted = false
       @alphas = []
       @tokens = []
@@ -30,11 +33,15 @@ module Wongi::Engine
     end
 
     def import_into r
-      self.class.new subject, predicate, object, r
+      self.class.new( subject, predicate, object, r ).tap do |wme|
+        wme.manual = self.manual?
+      end
     end
 
     def dup
-      self.class.new subject, predicate, object, rete
+      self.class.new( subject, predicate, object, rete ).tap do |wme|
+        wme.manual = self.manual?
+      end
     end
 
     def == other
@@ -49,12 +56,8 @@ module Wongi::Engine
       end
     end
 
-    def manual?
-      generating_tokens.empty?
-    end
-
     def generated?
-      !manual?
+      !generating_tokens.empty?
     end
 
     # def destroy

data/spec/generation_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe Wongi::Engine::StatementGenerator do
+
+  let( :engine ) { Wongi::Engine.create }
+
+  let( :transitive_rule ) {
+    rule {
+      forall {
+        has :P, :transitive, true
+        has :X, :P, :Y
+        has :Y, :P, :Z
+      }
+      make {
+        gen :X, :P, :Z
+      }
+    }
+  }
+
+  let( :production ) { engine << transitive_rule }
+
+  shared_examples 'generation' do
+
+    it 'should generate facts' do
+      engine << %w( Alice relative Bob )
+      engine << %w( Bob relative Dwight )
+
+      expect( production ).to have(1).token
+      expect( engine.find *%w( Alice relative Dwight ) ).not_to be_nil
+    end
+
+    it 'should retrct generated facts' do
+      engine << %w( Alice relative Bob )
+      engine << %w( Bob relative Dwight )
+      engine.retract %w( Bob relative Dwight )
+
+      expect( production ).to have(0).tokens
+      expect( engine.find *%w( Alice relative Dwight ) ).to be_nil
+    end
+
+    context 'transitive diamond' do
+
+      before :each do
+        engine << %w( Alice relative Bob )
+        engine << %w( Bob relative Dwight )
+        engine << %w( Alice relative Claire )
+        engine << %w( Claire relative Dwight )
+      end
+
+      it 'should be created', :debug do
+        expect( production ).to have(2).tokens
+        expect( engine.find *%w( Alice relative Dwight ) ).not_to be_nil
+      end
+
+      it 'should remain after a single retraction' do
+        engine.retract %w( Claire relative Dwight )
+
+        expect( production ).to have(1).token
+        expect( engine.find *%w( Alice relative Dwight ) ).not_to be_nil
+      end
+
+      it 'should be destroyed after both retractions' do
+        engine.retract %w( Claire relative Dwight )
+        engine.retract %w( Alice relative Bob )
+
+        expect( production ).to have(0).tokens
+        expect( engine.find *%w( Alice relative Dwight ) ).to be_nil
+      end
+
+    end
+
+  end
+
+  context "pre-asserted", :pre do
+
+    before :each do
+      engine << [ "relative", :transitive, true ]
+    end
+
+    it_behaves_like 'generation'
+
+  end
+
+  context "post-asserted", :post do
+
+    before :each do
+      production
+      engine << [ "relative", :transitive, true ]
+    end
+
+    it_behaves_like 'generation'
+
+    it 'should not retract generated facts marked as manual', :wip do
+      engine << %w( Alice relative Bob )
+      engine << %w( Bob relative Dwight )
+      engine << %w( Alice relative Dwight )
+      engine.retract %w( Alice relative Bob )
+
+      expect( production ).to have(0).tokens
+      expect( engine.find *%w( Alice relative Dwight ) ).not_to be_nil
+    end
+
+    it 'should retract generated facts unmarked as manual', :wip do
+      engine << %w( Alice relative Bob )
+      engine << %w( Bob relative Dwight )
+      engine << %w( Alice relative Dwight )
+      engine.retract %w( Alice relative Dwight )
+      engine.retract %w( Alice relative Bob )
+
+      expect( production ).to have(0).tokens
+      expect( engine.find *%w( Alice relative Dwight ) ).to be_nil
+    end
+
+  end
+
+end

data/wongi-engine.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/wongi-engine/version', __FILE__)
+
+module GemHelper
+  def self.git?
+    File.exists?(".git")
+  end
+
+  def self.hg?
+    File.exists?(".hg")
+  end
+end
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Valeri Sokolov"]
+  gem.email         = ["ulfurinn@ulfurinn.net"]
+  gem.description   = %q{A rule engine.}
+  gem.summary       = %q{A forward-chaining rule engine in pure Ruby.}
+  gem.homepage      = "https://github.com/ulfurinn/wongi-engine"
+  gem.licenses      = %w(MIT)
+
+  if GemHelper.git?
+    gem.files       = `git ls-files`.split($\)
+  elsif GemHelper.hg?
+    gem.files       = `hg st -cn`.split($\)
+  else
+    raise "cannot enumerate files: not a git or hg repository"
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "wongi-engine"
+  gem.require_paths = ["lib"]
+  gem.version       = Wongi::Engine::VERSION
+
+  gem.add_development_dependency 'rake', '~> 10.0'
+  # gem.add_development_dependency 'pry', '~> 0.10'
+  # gem.add_development_dependency 'pry-byebug', '~> 2.0'
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'rspec-collection_matchers', '~> 1.1'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wongi-engine
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha1
+  version: 0.1.0
 platform: ruby
 authors:
 - Valeri Sokolov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ files:
 - spec/dsl_spec.rb
 - spec/filter_specs/assert_test_spec.rb
 - spec/filter_specs/less_test_spec.rb
+- spec/generation_spec.rb
 - spec/high_level_spec.rb
 - spec/network_spec.rb
 - spec/rule_specs/any_rule_spec.rb
@@ -142,6 +143,7 @@ files:
 - spec/simple_action_spec.rb
 - spec/spec_helper.rb
 - spec/wme_spec.rb
+- wongi-engine.gemspec
 homepage: https://github.com/ulfurinn/wongi-engine
 licenses:
 - MIT
@@ -157,9 +159,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -173,6 +175,7 @@ test_files:
 - spec/dsl_spec.rb
 - spec/filter_specs/assert_test_spec.rb
 - spec/filter_specs/less_test_spec.rb
+- spec/generation_spec.rb
 - spec/high_level_spec.rb
 - spec/network_spec.rb
 - spec/rule_specs/any_rule_spec.rb