wongi-engine 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d9f803da98de1a0ec47f26a1adc83940f6ef2d3e8dbfc3dbfb9527c9efe4daf
-  data.tar.gz: 3d1ace03974a04999b3e4f969c64d0bad2b4da99dc11606db06b1723d056b881
+  metadata.gz: bf30142950fccfa0c3ecd20d55e5ac211c74c1fde464507725f262da6734f8b7
+  data.tar.gz: efd0a8acae7aef2510854d240e5fbe491ffcbf73986cd4e6d201cf662e912c0a
 SHA512:
-  metadata.gz: e7d0c9d09716e02cb60256f048b97d04742733e8587c110a8e3b80b0f641e0bc213f8a3baea543f89a3f4f454a7f9f987321b66b0ed6decd530d7ec568cdbe11
-  data.tar.gz: e5e3f2158f9975ad23aa7c4115886c17c4b92529967d97395f39c7a28d608dcf2adc7827cecdc9b6bcb1dd8200699c9ad61c8997e638c07cb15534bdbaa61701
+  metadata.gz: ba4e0818dff5b8d61b693e8a2974c0e2fa531736459e95aa788b7a3b79c56c0be5c1a3d5e9edd36cd0c71ce55a0bce31b41f1d39e2515c057753df873f288318
+  data.tar.gz: b0e6d77fa743e6d74340bc75478ce0178a72ce7e99df7cf5cebe0d60438acd779627fb1f68652ecdd3904054784c385e8684245e54dc66de6485d7e66e1a7a7a

data/.gitignore

@@ -18,3 +18,4 @@ test/tmp
 test/version_tmp
 tmp
 .ruby-version
+.idea

data/.rubocop.yml

@@ -0,0 +1,80 @@
+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
+
+RSpec:
+  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

data/.travis.yml

@@ -1,22 +1,12 @@
 language: ruby
+
 rvm:
-- 2.1
-- 2.2
-- 2.3
-- 2.4
-- 2.5
-- 2.6
 - 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,9 +1,9 @@
 # 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://travis-ci.com/ulfurinn/wongi-engine.svg?branch=master)](https://app.travis-ci.com/github/ulfurinn/wongi-engine)
 
-Ruby >= 2.1 and JRuby are supported. Rubinius should work but isn't actively supported.
+Ruby >= 2.7 and JRuby are supported. Rubinius should work but isn't actively supported.
 
 ## [Documentation](http://ulfurinn.github.io/wongi-engine/)
 

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_memory.rb

@@ -1,10 +1,8 @@
 module Wongi::Engine
-
   class AlphaMemory
-
     attr_reader :betas, :template, :rete
 
-    def initialize template, rete = nil
+    def initialize(template, rete = nil)
       @template = template
       @rete = rete
       @betas = []
@@ -12,7 +10,7 @@ module Wongi::Engine
       @frozen = false
     end
 
-    def activate wme
+    def activate(wme)
       wme.overlay.add_wme(wme, self)
       # 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|
@@ -20,15 +18,15 @@ module Wongi::Engine
       end
     end
 
-    def deactivate wme
+    def deactivate(wme)
       wme.overlay.remove_wme(wme, self)
       betas.each do |beta|
         beta.alpha_deactivate wme
       end
     end
 
-    def snapshot! alpha
-      alpha.wmes.map( &:dup ).each do |wme|
+    def snapshot!(alpha)
+      alpha.wmes.map(&:dup).each do |wme|
         activate wme
       end
     end
@@ -54,7 +52,5 @@ module Wongi::Engine
         end
       end
     end
-
   end
-
 end

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

@@ -0,0 +1,93 @@
+module Wongi::Engine
+  class AggregateNode < BetaNode
+    attr_reader :alpha, :tests, :assignment_pattern, :map, :function, :assign
+
+    def initialize(parent, alpha, tests, assignment, map, function, assign)
+      super(parent)
+      @alpha = alpha
+      @tests = tests
+      @assignment_pattern = assignment
+      @map = map
+      @function = function
+      @assign = assign
+    end
+
+    def equivalent?(alpha, tests, assignment_pattern)
+      return false if self.alpha != alpha
+      return false if self.assignment_pattern != assignment_pattern
+      return true if self.tests.empty? && tests.empty?
+      return false if self.tests.length != tests.length
+
+      self.tests.all? { |my_test|
+        tests.any? { |new_test|
+          my_test.equivalent? new_test
+        }
+      }
+    end
+
+    def alpha_activate(wme)
+      # we need to re-run all WMEs through the aggregator, so the new incoming one doesn't matter
+      parent.tokens.each do |token|
+        evaluate(wme, token)
+      end
+    end
+
+    def alpha_deactivate(wme)
+      # we need to re-run all WMEs through the aggregator, so the new incoming one doesn't matter
+      parent.tokens.each do |token|
+        evaluate(wme, token)
+      end
+    end
+
+    def beta_activate(token)
+      evaluate(nil, token)
+    end
+
+    def beta_deactivate(token)
+      children.each do |child|
+        child.tokens.each do |t|
+          child.beta_deactivate t if t.parent == token
+        end
+      end
+    end
+
+    def refresh_child(child)
+      parent.tokens.each do |token|
+        evaluate(nil, token, child)
+      end
+    end
+
+    def evaluate(wme, token, child = nil)
+      # clean up previous decisions
+      beta_deactivate(token)
+
+      candidates = alpha.wmes.select { |asserted_wme| matches?(token, asserted_wme) }
+
+      return if candidates.empty?
+
+      mapped = candidates.map(&map)
+      value = if function.is_a?(Symbol) && mapped.respond_to?(function)
+                mapped.send(function)
+              else
+                function.call(mapped)
+              end
+      assignments = { assign => value }
+      if child
+        child.beta_activate(Token.new(child, token, wme, assignments))
+      else
+        children.each do |beta|
+          beta.beta_activate(Token.new(beta, token, wme, assignments))
+        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,32 @@
 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 = {})
       children.each do |child|
-        child.beta_activate Token.new( child, token, nil, { @variable => @body.respond_to?(:call) ? @body.call(token) : @body } )
+        child.beta_activate Token.new(child, token, nil, { @variable => @body.respond_to?(:call) ? @body.call(token) : @body })
       end
     end
 
-    def beta_deactivate token
+    def beta_deactivate(token)
       children.each do |child|
         child.tokens.each do |t|
           if t.parent == token
             child.beta_deactivate t
-            #token.destroy
+            # token.destroy
           end
         end
       end
     end
 
-    def refresh_child child
-      tmp = children
-      self.children = [ child ]
+    def refresh_child(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
+        child.beta_activate Token.new(child, token, nil, { @variable => @body.respond_to?(:call) ? @body.call(token) : @body })
       end
-      self.children = tmp
     end
-
   end
-
 end

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

@@ -1,24 +1,24 @@
 module Wongi::Engine
-
   class BetaMemory < BetaNode
     include TokenContainer
 
-    def seed assignments = {}
+    def seed(assignments = {})
       @seed = assignments
-      t = Token.new( self, nil, nil, assignments )
+      t = Token.new(self, nil, nil, assignments)
       rete.default_overlay.add_token(t, self)
     end
 
-    def subst valuations
+    def subst(valuations)
       beta_deactivate(tokens.first)
-      token = Token.new( self, nil, nil, @seed )
+      token = Token.new(self, nil, nil, @seed)
       valuations.each { |variable, value| token.subst variable, value }
       beta_activate(token)
     end
 
-    def beta_activate token
+    def beta_activate(token)
       existing = tokens.find { |et| et.duplicate? token }
-      return if existing # TODO really?
+      return if existing # TODO: really?
+
       token.overlay.add_token(token, self)
       children.each do |child|
         child.beta_activate token
@@ -26,8 +26,9 @@ module Wongi::Engine
       token
     end
 
-    def beta_deactivate token
+    def beta_deactivate(token)
       return nil unless tokens.find token
+
       token.overlay.remove_token(token, self)
       token.deleted!
       if token.parent
@@ -39,11 +40,21 @@ module Wongi::Engine
       token
     end
 
-    def refresh_child child
+    def refresh_child(child)
       tokens.each do |token|
         child.beta_activate token
       end
     end
+  end
 
+  # SingletonBetaMemory is a memory node that only holds one token at a time.
+  # It should only be used after aggregate nodes.
+  class SingletonBetaMemory < BetaMemory
+    def beta_activate(token)
+      if (t = tokens.first)
+        beta_deactivate(t)
+      end
+      super
+    end
   end
 end

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

@@ -1,7 +1,5 @@
 module Wongi::Engine
-
   class BetaNode
-
     module TokenContainer
       def tokens
         Enumerator.new do |y|
@@ -9,7 +7,7 @@ module Wongi::Engine
             overlay.raw_tokens(self).dup.each do |token|
               y << token unless token.deleted?
             end
-            overlay.raw_tokens(self).reject! &:deleted?
+            overlay.raw_tokens(self).reject!(&:deleted?)
           end
         end
       end
@@ -26,16 +24,16 @@ module Wongi::Engine
     include CoreExt
 
     attr_writer :rete
+    # @return [Wongi::Engine::BetaNode]
     attr_reader :parent
     attr_accessor :children
+
     attr_predicate :debug
 
-    def initialize parent = nil
+    def initialize(parent = nil)
       @parent = parent
       @children = []
-      if parent
-        parent.children << self
-      end
+      parent.children << self if parent
     end
 
     def root?
@@ -44,16 +42,14 @@ module Wongi::Engine
 
     def depth
       @depth ||= if parent.nil?
-        0
-      else
-        parent.depth + 1
-      end
+                   0
+                 else
+                   parent.depth + 1
+                 end
     end
 
     def rete
-      @rete ||= if parent
-        parent.rete
-      end
+      @rete ||= (parent.rete if parent)
     end
 
     abstract :alpha_activate
@@ -63,7 +59,7 @@ module Wongi::Engine
     abstract :beta_deactivate
     abstract :beta_reactivate
 
-    def assignment_node variable, body
+    def assignment_node(variable, body)
       node = AssignmentNode.new self, variable, body
       node.refresh
       node
@@ -73,22 +69,18 @@ module Wongi::Engine
       parent.refresh_child self
     end
 
-    def refresh_child node
+    def refresh_child(_node)
       raise "#{self.class} must implement refresh_child"
     end
 
     private
 
-    def dp message
-      if debug?
-        puts "#{indent}#{message}"
-      end
+    def dp(message)
+      puts "#{indent}#{message}" if debug?
     end
 
     def indent
       '  ' * depth
     end
-
   end
-
 end

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

@@ -1,48 +1,45 @@
 module Wongi
   module Engine
-
     class FilterNode < BetaNode
-
+      # @return [Wongi::Engine::FilterTest]
       attr_accessor :test
 
-      def initialize parent, test
+      def initialize(parent, test)
         super parent
         self.test = test
       end
 
-      def beta_activate token
-        if test.passes? token
-          children.each do |child|
-            child.beta_activate Token.new( child, token, nil, {} )
-          end
+      def beta_activate(token)
+        return unless test.passes?(token)
+
+        children.each do |child|
+          child.beta_activate Token.new(child, token, nil, {})
         end
       end
 
-      def beta_deactivate token
+      def beta_deactivate(token)
         children.each do |child|
           child.tokens.each do |t|
             if t.parent == token
               child.beta_deactivate t
-              #token.destroy
+              # token.destroy
             end
           end
         end
       end
 
-      def equivalent? test
+      def equivalent?(test)
         test == self.test
       end
 
-      def refresh_child child
+      def refresh_child(child)
         tmp = children
-        self.children = [ child ]
+        self.children = [child]
         parent.tokens.each do |token|
           beta_activate token
         end
         self.children = tmp
       end
-
     end
-
   end
 end