wongi-engine 0.3.5 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f9d2adf82d8e36010a2ea956c308d58c073673cba49013352c420ed69180e5
-  data.tar.gz: 792ee293fce552b92c516f17749253fe9c6ba6c72f8b8e4c751b32b7f87902a6
+  metadata.gz: 461346062a679921c61fc0b35bc2e89ef0d06920745d650b48fedbbc452b780a
+  data.tar.gz: df2bf13a3551dc049e08398b11ac42440a34e4cb651f5092b74d3efdd5a3aecf
 SHA512:
-  metadata.gz: 319936296084020880b58d775a241eaa575bfce12246fac060e8150a0ff97a30aa7558653c771548616b7a1d0da450fa625dc11ce9ceca490cdf8affd2005231
-  data.tar.gz: 8f7397d233f1eb4cd714c0c69caa866cd18dd42a3304bc19c263662bafb122382b9be50ffd101bb9dacf50a9c4ce11804b4071dfefefeda6d72a38d60074b8f0
+  metadata.gz: 0a3495df610621e35c8cef1a0cbf39aa0b26a8cee6d699df2bf4cdb451f4c06db534d7943bb4f30778d21289406d54ba0264f54ecfe3b839e3b1d50ccd6b63b3
+  data.tar.gz: 8f85d69a8f476eec9a6ee8cf97ade3a4b8e9959616114511ca65007cd225feb0963613750628a450d5ea5f905fcaed65082662db828491a7caa9c533dc70db37

data/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Test
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.1", "3.0", "2.7", "jruby-head"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -18,3 +18,6 @@ test/tmp
 test/version_tmp
 tmp
 .ruby-version
+.idea
+.hugo_build.lock
+themes

data/.rubocop.yml

@@ -0,0 +1,86 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/FrozenStringLiteralComment:
+  Enabled: false # reconsider later
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false # temporary
+
+Lint/EmptyClass:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Naming:
+  Enabled: false
+
+Style/MixinUsage:
+  Exclude:
+    - examples/*.rb
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/SelectByRegexp:
+  Enabled: false
+
+Lint/EmptyBlock:
+  Enabled: false
+
+Security/CompoundHash:
+  Enabled: false # we actually need it to work
+
+Lint/HashCompareByIdentity:
+  Enabled: false # investigate later
+
+Style/AccessModifierDeclarations:
+  Enabled: false # maybe for the use of module_function which I think is better off being explicit instead of grouped
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.travis.yml

@@ -1,19 +1,12 @@
 language: ruby
+
 rvm:
-- 2.1.10
-- 2.2.6
-- 2.3.3
-- 2.4.0
-- jruby-9.0
+- 2.7
+- 3.0
+- 3.1
+- jruby
+
 sudo: false
-notifications:
-  hipchat:
-    rooms:
-      secure: OwpsmGlIxlSbLUWVZZI+xBErDkFc5XO2vmjs+ddQkNiL1E9N5SG35x75113S6EZ3qhqeNMPFBfZYDqem6jkhNOWsmH3EIH+QT1lWxnosrr0LgyJpvFosvjQaryvqJHVhT5tdBqzaWEYB6ObRLOUt7A5YrbtWHyTScB6ThpXCiR4=
-  webhooks:
-    urls:
-      - secure: Xm+R/3O6iG2sDbfrR8D5Y9AYJkB7DDjLBcKZEn+xaTVjuX/XFLF7p+v9n9v7Qs/v0VtU75pVX4Z++OmNJZJzJKB3Owgb4c1rMOGmctza2JPL+1yovmhpG0/S0hjMkO5g4CsAKKcQoaDXNrubUVHpEchLPP/aCx7/F4twCan9bfc=
-    on_success: always
-    on_failure: always
-    on_start: false
 
+notifications:
+  email: true

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in wongi-engine.gemspec
 gemspec
+
+gem 'rubocop', require: false
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false

data/README.md

@@ -1,28 +1,28 @@
 # Wongi::Engine
 
-[![Gem](https://img.shields.io/gem/v/wongi-engine.svg)](https://rubygems.org/gems/wongi-engine/)  
-[![Build Status](https://travis-ci.org/ulfurinn/wongi-engine.svg?branch=master)](https://travis-ci.org/ulfurinn/wongi-engine)
+[![Gem](https://img.shields.io/gem/v/wongi-engine.svg)](https://rubygems.org/gems/wongi-engine/)
+[![Build Status](https://github.com/ulfurinn/wongi-engine/actions/workflows/test.yml/badge.svg)](https://github.com/ulfurinn/wongi-engine/actions/workflows/test.yml)
 
-Ruby >= 2.1 and JRuby are supported. Rubinius should work but isn't actively supported.
+This is a pure-Ruby forward-chaining rule engine based on the classic [Rete algorithm](http://en.wikipedia.org/wiki/Rete_algorithm).
 
-## [Documentation](http://ulfurinn.github.io/wongi-engine/)
+Ruby >= 2.7 and JRuby are supported. Rubinius should work but isn't actively supported.
 
-This library contains a rule engine written in Ruby. It's based on the [Rete algorithm](http://en.wikipedia.org/wiki/Rete_algorithm) and uses a DSL to express rules in a readable way.
+## Documentation
 
-**Word of caution**: 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.
+There is no API documentation, as most of the library's interfaces are for internal use only and would not be safe to use directly.
 
-[Feature annoucements](https://github.com/ulfurinn/wongi-engine/issues?q=is%3Aopen+is%3Aissue+label%3Aannoucement)
+Instead, follow the [tutorial](https://ulfurinn.github.io/wongi-engine/) and stick to the constructs described in it.
+
+## Upgrading
+
+Until there is a 1.0 release, all minor versions should be treated as potentially breaking.
+
+Always test your rules extensively. There's always a chance of you finding a bug in the engine that is only triggered by a very specific rule configuration.
+
+[Feature annoucements](https://github.com/ulfurinn/wongi-engine/issues?q=is%3Aissue+label%3Aannoucement)
 
 [Open discussions](https://github.com/ulfurinn/wongi-engine/issues?q=is%3Aopen+is%3Aissue+label%3Adiscussion)
 
 ## Acknowledgements
 
 The Rete implementation in this library largely follows the outline presented in [\[Doorenbos, 1995\]](http://reports-archive.adm.cs.cmu.edu/anon/1995/CMU-CS-95-113.pdf).
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

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

data/examples/ex01.rb

@@ -2,7 +2,7 @@ include Wongi::Engine
 
 ds = Network.new
 
-ds << WME.new( "Alice", "friend", "Bob" )
+ds << WME.new("Alice", "friend", "Bob")
 
 puts "Enumerate all:"
 

data/examples/ex02.rb

@@ -4,7 +4,6 @@ include Wongi::Engine::DSL
 ds = Network.new
 
 ds << ruleset {
-
   name "Example"
 
   rule "symmetric" do
@@ -16,22 +15,19 @@ ds << ruleset {
       gen :B, :P, :A
     }
   end
-
 }
 
 puts "Installed ruleset"
 
-ds << WME.new( "friend", "symmetric", true )
-ds << WME.new( "Alice", "friend", "Bob" )
+ds << WME.new("friend", "symmetric", true)
+ds << WME.new("Alice", "friend", "Bob")
 
 puts "Asserted facts:"
 
 puts "Should print 3 facts:"
 puts ds.wmes.to_a
 
-
-ds.retract WME.new( "Alice", "friend", "Bob" )
+ds.retract WME.new("Alice", "friend", "Bob")
 
 puts "Should print 1 fact:"
 puts ds.wmes.to_a
-

data/examples/graphviz.rb

@@ -12,5 +12,5 @@ ds << rule('demo') {
 }
 
 File.open "rete.dot", "w" do |io|
-  Graph.new( ds ).dot( io )
+  Graph.new(ds).dot(io)
 end

data/examples/rdf.rb

@@ -4,7 +4,7 @@ require 'wongi-engine'
 engine = Wongi::Engine.create
 engine.rdf!
 parser = Wongi::RDF::Parser.new
-parser.parse_file File.expand_path( "rdf.n3", File.dirname(__FILE__) ), engine
+parser.parse_file File.expand_path("rdf.n3", File.dirname(__FILE__)), engine
 
 engine.each do |wme|
   puts wme

data/examples/timeline.rb

@@ -8,12 +8,12 @@ engine = Wongi::Engine.create
 
 engine.debug!
 
-engine.compile_alpha Wongi::Engine::Template.new( :_, :_, :_,  0 )
-engine.compile_alpha Wongi::Engine::Template.new( :_, :_, :_, -1 )
-engine.compile_alpha Wongi::Engine::Template.new( :_, :_, :_, -2 )
-engine.compile_alpha Wongi::Engine::Template.new( :_, :_, :_, -3 )
-engine.compile_alpha Wongi::Engine::Template.new( :_, :_, :_, -4 )
-engine.compile_alpha Wongi::Engine::Template.new( :_, :_, :_, -5 )
+engine.compile_alpha Wongi::Engine::Template.new(:_, :_, :_, 0)
+engine.compile_alpha Wongi::Engine::Template.new(:_, :_, :_, -1)
+engine.compile_alpha Wongi::Engine::Template.new(:_, :_, :_, -2)
+engine.compile_alpha Wongi::Engine::Template.new(:_, :_, :_, -3)
+engine.compile_alpha Wongi::Engine::Template.new(:_, :_, :_, -4)
+engine.compile_alpha Wongi::Engine::Template.new(:_, :_, :_, -5)
 
 engine.full_wme_dump
 

data/lib/wongi-engine/alpha_index.rb

@@ -0,0 +1,36 @@
+module Wongi::Engine
+  class AlphaIndex
+    attr_reader :pattern, :index
+    private :pattern
+    private :index
+
+    def initialize(pattern)
+      @pattern = pattern
+      @index = Hash.new { |h, k| h[k] = Set.new }
+    end
+
+    def add(wme)
+      collection_for_wme(wme).add(wme)
+    end
+
+    def remove(wme)
+      collection = collection_for_wme(wme)
+      collection.delete(wme)
+
+      # release some memory
+      index.delete(hashed_key(wme)) if collection.empty?
+    end
+
+    def collection_for_wme(wme)
+      index[hashed_key(wme)]
+    end
+
+    private def key(wme)
+      pattern.map { wme.public_send(_1) }
+    end
+
+    private def hashed_key(wme)
+      key(wme).map(&:hash)
+    end
+  end
+end

data/lib/wongi-engine/alpha_memory.rb

@@ -1,38 +1,28 @@
 module Wongi::Engine
-
   class AlphaMemory
-
     attr_reader :betas, :template, :rete
 
-    def initialize template, rete = nil
+    def initialize(template, rete)
       @template = template
       @rete = rete
       @betas = []
-      @wmes = []
       @frozen = false
     end
 
-    def activate wme
-      wme.overlay.add_wme(wme, self)
+    def activate(wme)
       # TODO: it used to activate before adding to the list. mandated by the original thesis. investigate. it appears to create duplicate tokens - needs a remedy in collecting nodes
       betas.each do |beta|
         beta.alpha_activate wme
       end
     end
 
-    def deactivate wme
-      wme.overlay.remove_wme(wme, self)
+    def deactivate(wme)
+      # p deactivate: {wme:}
       betas.each do |beta|
         beta.alpha_deactivate wme
       end
     end
 
-    def snapshot! alpha
-      alpha.wmes.map( &:dup ).each do |wme|
-        activate wme
-      end
-    end
-
     def inspect
       "<Alpha #{__id__} template=#{template}>"
     end
@@ -40,21 +30,5 @@ module Wongi::Engine
     def to_s
       inspect
     end
-
-    def size
-      wmes.count
-    end
-
-    def wmes
-      Enumerator.new do |y|
-        rete.overlays.each do |overlay|
-          overlay.raw_wmes(self).dup.each do |wme|
-            y << wme
-          end
-        end
-      end
-    end
-
   end
-
 end

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

@@ -0,0 +1,84 @@
+module Wongi::Engine
+  class AggregateNode < BetaNode
+    attr_reader :var, :over, :partition, :aggregate, :map
+
+    def initialize(parent, var, over, partition, aggregate, map)
+      super(parent)
+      @var = var
+      @over = over
+      @partition = make_partition_fn(partition)
+      @aggregate = make_aggregate_fn(aggregate)
+      @map = make_map_fn(map)
+    end
+
+    def make_partition_fn(partition)
+      return nil if partition.empty?
+
+      ->(token) { token.values_at(*partition) }
+    end
+
+    def make_aggregate_fn(agg)
+      agg
+    end
+
+    def make_map_fn(map)
+      if map.nil?
+        ->(token) { token[over] }
+      else
+        map
+      end
+    end
+
+    def beta_activate(token)
+      return if tokens.find { |t| t.duplicate? token }
+
+      overlay.add_token(token)
+      evaluate
+    end
+
+    def beta_deactivate(token)
+      overlay.remove_token(token)
+      beta_deactivate_children(token: token)
+      evaluate
+    end
+
+    def refresh_child(child)
+      evaluate(child: child)
+    end
+
+    def evaluate(child: nil)
+      return if tokens.empty?
+
+      groups =
+        if partition
+          tokens.group_by(&partition).values
+        else
+          # just a single group of everything
+          [tokens]
+        end
+
+      groups.each do |tokens|
+        aggregated = aggregate.call(tokens.map(&map))
+        assignment = { var => aggregated }
+        children = child ? [child] : self.children
+        children.each do |beta|
+          new_token = Token.new(beta, tokens, nil, assignment)
+          # nothing changed, skip useless traversal
+          next if beta.tokens.find { _1.duplicate?(new_token) }
+
+          beta.tokens.select { |child| tokens.any? { child.child_of?(_1) } }.each { beta.beta_deactivate(_1) }
+          beta.beta_activate(new_token)
+        end
+      end
+    end
+
+    protected
+
+    def matches?(token, wme)
+      @tests.each do |test|
+        return false unless test.matches?(token, wme)
+      end
+      true
+    end
+  end
+end

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

@@ -1,40 +1,37 @@
 module Wongi::Engine
-
   class AssignmentNode < BetaNode
-
-    def initialize parent, variable, body
-      super parent
-      @variable, @body = variable, body
+    def initialize(parent, variable, body)
+      super(parent)
+      @variable = variable
+      @body = body
     end
 
-    def beta_activate token, wme = nil, assignments = { }
+    def beta_activate(token, _wme = nil, _assignments = {})
+      return if tokens.find { |t| t.duplicate? token }
+
+      overlay.add_token(token)
       children.each do |child|
-        child.beta_activate Token.new( child, token, nil, { @variable => @body.respond_to?(:call) ? @body.call(token) : @body } )
+        value = @body.respond_to?(:call) ? @body.call(token) : @body
+        child.beta_activate Token.new(child, token, nil, { @variable => value })
       end
     end
 
-    def beta_deactivate token
+    def beta_deactivate(token)
+      overlay.remove_token(token)
       children.each do |child|
         child.tokens.each do |t|
-          if t.parent == token
+          if t.child_of?(token)
             child.beta_deactivate t
-            #token.destroy
+            # token.destroy
           end
         end
       end
     end
 
-    def refresh_child child
-      tmp = children
-      self.children = [ child ]
-      parent.tokens.each do |token|
-        children.each do |child|
-          child.beta_activate Token.new( child, token, nil, { @variable => @body.respond_to?(:call) ? @body.call(token) : @body } )
-        end
+    def refresh_child(child)
+      tokens.each do |token|
+        child.beta_activate Token.new(child, token, nil, { @variable => @body.respond_to?(:call) ? @body.call(token) : @body })
       end
-      self.children = tmp
     end
-
   end
-
 end