edoors-ruby 0.0.6

data/lib/edoors/spin.rb

@@ -0,0 +1,168 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2012 Jérémy Zurcher <jeremy@asynk.ch>
+#
+# This file is part of edoors-ruby.
+#
+# edoors-ruby is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# edoors-ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with edoors-ruby.  If not, see <http://www.gnu.org/licenses/>.
+
+#
+module Edoors
+    #
+    class Spin < Room
+        #
+        def initialize n, o={}
+            super n, nil
+            #
+            @pool       = {}    # per particle class free list
+            @world      = {}    # global iotas index
+            @sys_fifo   = []    # system particles fifo list
+            @app_fifo   = []    # application particles fifo list
+            #
+            @run = false
+            @hibernation    = o['hibernation']||false
+            @hibernate_path = 'edoors-hibernate-'+n+'.json'
+            @debug_errors   = o[:debug_errors]||o['debug_errors']||false
+            @debug_routing  = o[:debug_routing]||o['debug_routing']||false
+            #
+            if not o.empty?
+                room = o['inner_room']
+                if room
+                    room['iotas'].each do |name,iota|
+                        eval( iota['kls'] ).json_create(iota.merge!('parent'=>self))
+                    end
+                    room['links'].each do |src,links|
+                        links.each do |link|
+                            add_link Edoors::Link.json_create(link)
+                        end
+                    end
+                end
+                o['app_fifo'].each do |particle|
+                    @app_fifo << Edoors::Particle.json_create(particle.merge!('spin'=>self))
+                end if o['app_fifo']
+                o['sys_fifo'].each do |particle|
+                    @sys_fifo <<  Edoors::Particle.json_create(particle.merge!('spin'=>self))
+                end if o['sys_fifo']
+            end
+        end
+        #
+        attr_accessor :run, :hibernate_path, :debug_errors, :debug_routing
+        #
+        def to_json *a
+            {
+                'kls'           => self.class.name,
+                'timestamp'     => Time.now,
+                'name'          => @name,
+                'hibernation'   => @hibernation,
+                'inner_room'    => { :iotas=>@iotas, :links=>@links },
+                'sys_fifo'      => @sys_fifo,
+                'app_fifo'      => @app_fifo,
+                'debug_errors'  => @debug_errors,
+                'debug_routing' => @debug_routing
+            }.to_json(*a)
+        end
+        #
+        def self.json_create o
+            raise Edoors::Exception.new "JSON #{o['kls']} != #{self.name}" if o['kls'] != self.name
+            self.new o['name'], o
+        end
+        #
+        def add_to_world iota
+            @world[iota.path] = iota
+        end
+        #
+        def search_world path
+            @world[path]
+        end
+        #
+        def clear!
+            @iotas.clear
+            @world.clear
+            @pool.clear
+            @sys_fifo.clear
+            @app_fifo.clear
+        end
+        #
+        #
+        def release_p p
+            # hope there is no circular loop
+            while p2=p.merged_shift
+                release_p p2
+            end
+            p.reset!
+            ( @pool[p.class] ||= [] ) << p
+        end
+        #
+        def require_p p_kls
+            l = @pool[p_kls]
+            return p_kls.new if l.nil?
+            p = l.pop
+            return p_kls.new if p.nil?
+            p
+        end
+        #
+        def post_p p
+            @app_fifo << p
+        end
+        #
+        def post_sys_p p
+            @sys_fifo << p
+        end
+        #
+        def process_sys_p p
+            if p.action==Edoors::SYS_ACT_HIBERNATE
+                stop!
+                hibernate! p[FIELD_HIBERNATE_PATH]
+            else
+                super p
+            end
+        end
+        #
+        def spin!
+            @iotas.values.each do |iota| iota.start! end unless @hibernation
+            @run = true
+            @hibernation = false
+            while @run and (@sys_fifo.length>0 or @app_fifo.length>0)
+                while @run and @sys_fifo.length>0
+                    p = @sys_fifo.shift
+                    p.dst.process_sys_p p
+                end
+                while @run and @app_fifo.length>0
+                    p = @app_fifo.shift
+                    p.dst.process_p p
+                    break
+                end
+            end
+            @iotas.values.each do |iota| iota.stop! end unless @hibernation
+        end
+        #
+        def stop!
+            @run=false
+        end
+        #
+        def hibernate! path=nil
+            @hibernation = true
+            File.open(path||@hibernate_path,'w') do |f| f << JSON.pretty_generate(self) end
+        end
+        #
+        def self.resume! path
+            self.json_create JSON.load File.open(path,'r') { |f| f.read }
+        end
+        #
+    end
+    #
+end
+#
+# EOF

data/lib/version.rb

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2012 Jérémy Zurcher <jeremy@asynk.ch>
+#
+# This file is part of edoors-ruby.
+#
+# edoors-ruby is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# edoors-ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with edoors-ruby.  If not, see <http://www.gnu.org/licenses/>.
+
+#
+module Edoors
+    #
+    VERSION = "0.0.6"
+    #
+end
+#
+# EOF

data/spec/board_spec.rb

@@ -0,0 +1,92 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+
+require 'spec_helper'
+#
+describe Edoors::Board do
+    #
+    before (:all) do
+        @spin = Edoors::Spin.new 'dom0'
+    end
+    #
+    before(:each) do
+        @spin.clear!
+    end
+    #
+    it "require_p release_p" do
+        board = Edoors::Board.new 'hell', @spin
+        p0 = board.require_p Edoors::Particle
+        p1 = board.require_p Edoors::Particle
+        (p0===p1).should be_false
+        board.release_p p0
+        p2 = board.require_p Edoors::Particle
+        (p0===p2).should be_true
+    end
+    #
+    it "particle wait and merge" do
+        p0 = Edoors::Particle.new
+        p0['k0'] = 'v0'
+        p0['k1'] = 'neither'
+        p0['k2'] = 'v2'
+        p0.set_link_fields 'k0,k2'
+        p0.link_value.should eql 'v0v2'
+        p1 = Edoors::Particle.new
+        p1['k0'] = 'v0'
+        p1['k1'] = 'nore'
+        p1['k2'] = 'v2'
+        p1.set_link_fields 'k0,k2'
+        p1.link_value.should eql 'v0v2'
+        P0 = p0
+        P1 = p1
+        class Board0 < Edoors::Board
+            attr_reader :ok, :follow
+            def receive_p p
+                @ok = false
+                case p.action
+                when Edoors::ACT_FOLLOW
+                    @follow = true
+                    @ok = (p===P0 and p.merged(0)===P1)
+                else
+                    @follow = false
+                    @ok = (p===P1 and p.merged(0)===P0)
+                end
+            end
+        end
+        b0 = Board0.new 'door0', @spin
+        b0.process_p p0
+        p0.merged(0).should be_nil
+        b0.process_p p1
+        b0.ok.should be_true
+        b0.follow.should be_false
+        #
+        p1.merged_shift
+        #
+        b0.process_p p0
+        p0.merged(0).should be_nil
+        # need to set it to p0 too, so case in Board0 is ok
+        p0.add_dst Edoors::ACT_FOLLOW
+        p0.split_dst!
+        p1.add_dst Edoors::ACT_FOLLOW
+        p1.split_dst!
+        b0.process_p p1
+        b0.ok.should be_true
+        b0.follow.should be_true
+    end
+    #
+    it "board->json->board" do
+        board = Edoors::Board.new 'hell', @spin
+        p0 = Edoors::Particle.new
+        p1 = Edoors::Particle.new
+        p1['v0']=0
+        p1.set_link_fields 'v0'
+        board.process_p p0
+        board.process_p p1
+        hell = Edoors::Board.json_create( JSON.load( JSON.generate(board) ) )
+        board.name.should eql hell.name
+        JSON.generate(board).should eql JSON.generate(hell)
+    end
+    #
+end
+#
+# EOF

data/spec/door_spec.rb

@@ -0,0 +1,95 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+
+require 'spec_helper'
+#
+describe Edoors::Door do
+    #
+    before (:all) do
+        @spin = Edoors::Spin.new 'dom0'
+    end
+    #
+    before(:each) do
+        @spin.clear!
+    end
+    #
+    it "require_p release_p" do
+        door = Edoors::Door.new 'hell', @spin
+        p0 = door.require_p Edoors::Particle
+        p1 = door.require_p Edoors::Particle
+        (p0===p1).should be_false
+        door.release_p p0
+        p2 = door.require_p Edoors::Particle
+        (p0===p2).should be_true
+    end
+    #
+    it "NoMethodError when receive_p not overridden" do
+        class Door0 < Edoors::Door
+        end
+        f = Fake.new 'fake', @spin
+        d0 = Door0.new 'door0', f
+        p0 = d0.require_p Edoors::Particle
+        lambda { d0.process_p p0 }.should raise_error(NoMethodError)
+    end
+    #
+    it "send_p, send_sys_p, release_p and release of lost particles" do
+        class Door0 < Edoors::Door
+            def receive_p p
+                case p.action
+                when 'RELEASE'
+                    release_p p
+                when 'SEND'
+                    send_p p
+                when 'SEND_SYS'
+                    send_sys_p p
+                else
+                    # lost!!
+                end
+            end
+        end
+        f = Fake.new 'fake', @spin
+        d0 = Door0.new 'door0', f
+        p0 = d0.require_p Edoors::Particle
+        #
+        p0.add_dst 'SEND'
+        p0.split_dst!
+        d0.process_p p0
+        f.p.should eql p0
+        p0.clear_dsts!
+        #
+        p0.add_dst 'SEND_SYS'
+        p0.split_dst!
+        d0.process_p p0
+        f.sp.should eql p0
+        p0.clear_dsts!
+        #
+        p0.add_dst 'RELEASE'
+        p0.split_dst!
+        d0.process_p p0
+        p1 = d0.require_p Edoors::Particle
+        p1.should be p0
+        p0.clear_dsts!
+        #
+        p0.add_dst 'LOST'
+        p0.split_dst!
+        d0.process_p p0
+        p1 = d0.require_p Edoors::Particle
+        p1.should be p0
+        p0.clear_dsts!
+        #
+        d0.process_sys_p p0
+        p1 = @spin.require_p Edoors::Particle
+        p1.should be p0
+    end
+    #
+    it "door->json->door" do
+        door = Edoors::Door.new 'hell', @spin
+        hell = Edoors::Door.json_create( JSON.load( JSON.generate(door) ) )
+        door.name.should eql hell.name
+        JSON.generate(door).should eql JSON.generate(hell)
+    end
+    #
+end
+#
+# EOF

data/spec/link_spec.rb

@@ -0,0 +1,38 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+
+require 'spec_helper'
+#
+describe Edoors::Link do
+    #
+    it "from particle data" do
+        @spin = Edoors::Spin.new 'dom0'
+        p = @spin.require_p Edoors::Particle
+        p.set_data Edoors::LNK_SRC, 'input1'
+        p.set_data Edoors::LNK_DSTS, 'concat1?follow,output1'
+        p.set_data Edoors::LNK_FIELDS, 'f0,f2'
+        p.set_data Edoors::LNK_CONDF, 'f0,f1,f2'
+        p.set_data Edoors::LNK_CONDV, 'v0v1v2'
+        lnk = Edoors::Link.from_particle_data p
+        lnk.src.should eql 'input1'
+        lnk.dsts.should eql 'concat1?follow,output1'
+        lnk.fields.should eql 'f0,f2'
+        lnk.cond_fields.should eql 'f0,f1,f2'
+        lnk.cond_value.should eql 'v0v1v2'
+    end
+    #
+    it "link->json->link" do
+        link = Edoors::Link.new  'input1', 'concat1?follow,output1', 'f0,f2', 'f0,f1,f2', 'v0v1v2'
+        lnk = Edoors::Link.json_create( JSON.load( JSON.generate(link) ) )
+        link.src.should eql lnk.src
+        link.dsts.should eql lnk.dsts
+        link.fields.should eql lnk.fields
+        link.cond_fields.should eql lnk.cond_fields
+        link.cond_value.should eql lnk.cond_value
+        JSON.generate(link).should eql JSON.generate(lnk)
+    end
+    #
+end
+#
+# EOF

data/spec/particle_spec.rb

@@ -0,0 +1,266 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+
+require 'spec_helper'
+#
+describe Edoors::Particle do
+    #
+    it "payload manipulation" do
+        p = Edoors::Particle.new
+        #
+        p['key']=666
+        p['key'].should eql 666
+        p.data('key').should eql 666
+        p.get_data('key').should eql 666
+        #
+        p.set_data 'key', 69
+        p['key'].should eql 69
+        p.data('key').should eql 69
+        p.get_data('key').should eql 69
+    end
+    #
+    it "payload clone" do
+        p = Edoors::Particle.new
+        p['k00'] = { 'k0'=>0,'k1'=>1}
+        p['k11'] = [1,2,3]
+        o = Edoors::Particle.new
+        o.clone_data p
+        p['k00']=nil
+        p['k00'].should be_nil
+        o['k00']['k0'].should eql 0
+        o['k00']['k1'].should eql 1
+        p['k11']=nil
+        p['k11'].should be_nil
+        o['k11'][0].should eql 1
+        o['k11'][1].should eql 2
+        o['k11'][2].should eql 3
+    end
+    #
+    it "particle merge" do
+        spin = Edoors::Spin.new 'dom0'
+        p = Edoors::Particle.new
+        q = Edoors::Particle.new
+        o = Edoors::Particle.new
+        p.merge! q
+        p.merge! o
+        p.merged(0).should be q
+        p.merged(1).should be o
+        p.merged(2).should be_nil
+        p.merged_shift.should be q
+        p.merged(0).should be o
+        p.merged(1).should be_nil
+        p.merged_shift.should be o
+        p.merged(0).should be_nil
+        p.merge! q
+        p.merge! o
+        p.merged(0).should be q
+        p.merged(1).should be o
+        p.clear_merged!
+        p.merged(0).should be_nil
+        p.merge! q
+        p.merge! o
+        p.merged(0).should be q
+        p.merged(1).should be o
+        p.clear_merged! spin
+        p.merged(0).should be_nil
+        spin.require_p(Edoors::Particle).should be o
+        spin.require_p(Edoors::Particle).should be q
+    end
+    #
+    it "routing: add_dsts, next_dst and dst_routed!" do
+        p = Edoors::Particle.new
+        d0 = Edoors::Door.new 'door0', nil
+        d1 = Edoors::Door.new 'door1', nil
+        p.dst.should be_nil
+        p.next_dst.should be_nil
+        p.add_dsts 'some?where,room0/room1/door?action,room/door,door'
+        p.next_dst.should eql 'some?where'
+        p.dst_routed! d0
+        p.dst.should be d0
+        p.next_dst.should eql 'room0/room1/door?action'
+        p.dst_routed! d1
+        p.dst.should be d1
+        p.next_dst.should eql 'room/door'
+        p.dst_routed! nil
+        p.dst.should be_nil
+        p.next_dst.should eql 'door'
+    end
+    #
+    it "wrong path should raise exeption" do
+        p = Edoors::Particle.new
+        lambda { p.add_dst 'action', '/room' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst 'action', 'room/' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst '', 'room/' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst 'action', 'room//door' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst ' ' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst ' ', '' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst 'f f' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst '', ' d' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst '' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst '', '' }.should raise_error(Edoors::Exception)
+        lambda { p.add_dst nil }.should raise_error(TypeError)
+        lambda { p.add_dst 'action', nil }.should raise_error(NoMethodError)
+    end
+    #
+    it "routing: set_dst!" do
+        p = Edoors::Particle.new
+        d0 = Edoors::Door.new 'door0', nil
+        #
+        p.set_dst! 'action', d0
+        p.action.should eql 'action'
+        p.dst.should be d0
+    end
+    #
+    it "routing: add_dst and split_dst!" do
+        p = Edoors::Particle.new
+        d0 = Edoors::Door.new 'door0', nil
+        #
+        p.split_dst!
+        p.room.should be_nil
+        p.door.should be_nil
+        p.action.should be_nil
+        #
+        p.add_dst 'action', 'room0/room1/door'
+        p.split_dst!
+        p.room.should eql 'room0/room1'
+        p.door.should eql 'door'
+        p.action.should eql 'action'
+        p.clear_dsts!
+        #
+        p.add_dst 'action', 'room/door'
+        p.split_dst!
+        p.room.should eql 'room'
+        p.door.should eql 'door'
+        p.action.should eql 'action'
+        p.clear_dsts!
+        #
+        p.add_dst 'action', ''
+        p.split_dst!
+        p.room.should be_nil
+        p.door.should be_nil
+        p.action.should eql 'action'
+        p.clear_dsts!
+        #
+        p.add_dst 'action'
+        p.split_dst!
+        p.room.should be_nil
+        p.door.should be_nil
+        p.action.should eql 'action'
+        p.clear_dsts!
+        #
+        p.add_dsts 'door?action,?action'
+        p.split_dst!
+        p.room.should be_nil
+        p.door.should eql 'door'
+        p.action.should eql 'action'
+        #
+        p.dst_routed! d0
+        #
+        p.dst.should be d0
+        p.split_dst!
+        p.room.should be_nil
+        p.door.should be_nil
+        p.action.should eql 'action'
+        #
+    end
+    #
+    it "routing: error!" do
+        p = Edoors::Particle.new
+        d = Edoors::Door.new 'door', nil
+        p.init! d
+        p.add_dsts 'door?action,?action'
+        p.next_dst.should eql 'door?action'
+        p.error! 'err_msg'
+        p[Edoors::FIELD_ERROR_MSG].should eql 'err_msg'
+        p.action.should eq Edoors::ACT_ERROR
+        p.dst.should be d
+    end
+    #
+    it "link fields and link value" do
+        p = Edoors::Particle.new
+        p['k0'] = 'v0'
+        p['k1'] = 'v1'
+        p['k2'] = 'v2'
+        p.set_link_fields 'k0,k2'
+        p.link_value.should eql 'v0v2'
+        p.set_link_fields 'k1,k0'
+        p.link_value.should eql 'v1v0'
+        p['k0']='vx'
+        p.link_value.should eql 'v1vx'
+    end
+    #
+    it "apply_link!" do
+        p = Edoors::Particle.new
+        p['k0'] = 'v0'
+        p['k1'] = 'v1'
+        p['k2'] = 'v2'
+        p.set_link_fields 'k0,k2'
+        p.add_dsts 'door?action,?action'
+        p.src.should be_nil
+        p.link_value.should eql 'v0v2'
+        p.next_dst.should eql 'door?action'
+        lnk = Edoors::Link.new('door0', 'door1?get,door2', 'k1', 'f0,f1', 'v0v1')
+        f = Fake.new 'fake', nil
+        lnk.door = f
+        p.apply_link! lnk
+        p.src.should be f
+        p.next_dst.should eql 'door1?get'
+        p.link_value.should eql 'v1'
+    end
+    #
+    it "particle->json->particle" do
+        s0 = Edoors::Spin.new 'top'
+        s1 = Edoors::Room.new 'room0', s0
+        s2 = Edoors::Room.new 'room1', s1
+        s3 = Edoors::Door.new 'doora', s2
+        s4 = Edoors::Door.new 'doorb', s1
+        p0 = Edoors::Particle.new
+        p0['k0'] = 'v0'
+        p0['k1'] = 'v1'
+        p0['k2'] = 'v2'
+        p0.init! s3
+        p0.set_link_fields 'k0,k2'
+        p0.add_dsts 'room0/room1/room2/doorX?myaction,door?action,?action'
+        p0.split_dst!
+        p1 = Edoors::Particle.new
+        p1['k3'] = 'v6'
+        p1['k4'] = 'v7'
+        p1['k5'] = 'v8'
+        p1.init! s3
+        p1.dst_routed! s4
+        p1.set_link_fields 'k5,k4,k3'
+        p1.add_dsts 'room0/room1/door?action,output?action'
+        p0.merge! p1
+        o = JSON.load( JSON.generate(p0) )
+        o['spin'] = s0
+        px = Edoors::Particle.json_create( o )
+        ((px.ts-p0.ts)<0.5).should be_true
+        px.src.should be s3
+        px.dst.should be_nil
+        px.room.should eql 'room0/room1/room2'
+        px.door.should eql 'doorX'
+        px.action.should eql 'myaction'
+        px.next_dst.should eql 'room0/room1/room2/doorX?myaction'
+        px.link_value.should eql 'v0v2'
+        px['k0'].should eql 'v0'
+        px['k1'].should eql 'v1'
+        px['k2'].should eql 'v2'
+        py = px.merged(0)
+        ((py.ts-p1.ts)<0.5).should be_true
+        py.src.should be s3
+        py.dst.should be s4
+        py.room.should be_nil
+        py.door.should be_nil
+        py.action.should be_nil
+        py.next_dst.should eql 'room0/room1/door?action'
+        py.link_value.should eql 'v8v7v6'
+        py['k3'].should eql 'v6'
+        py['k4'].should eql 'v7'
+        py['k5'].should eql 'v8'
+        JSON.generate(p0).should eql JSON.generate(px)
+    end
+    #
+end
+#
+# EOF