iotas 0.0.2

data/lib/iotas/room.rb

@@ -0,0 +1,192 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2012 Jérémy Zurcher <jeremy@asynk.ch>
+#
+# This file is part of iotas.
+#
+# iotas 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.
+#
+# iotas 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 iotas.  If not, see <http://www.gnu.org/licenses/>.
+
+#
+module Iotas
+    #
+    ERROR_ROUTE_NS      = 'routing error: no source'.freeze
+    ERROR_ROUTE_RRWD    = 'routing error: right room, wrong door'.freeze
+    ERROR_ROUTE_DDWR    = 'routing error: drill down, wrong room'.freeze
+    ERROR_ROUTE_TRWR    = 'routing error: top room, wrong room'.freeze
+    ERROR_ROUTE_NDNL    = 'routing error: no destination, no link'.freeze
+    ERROR_ROUTE_SND     = 'routing error: system no destination'.freeze
+    #
+    class Room < Iota
+        #
+        def initialize n, p
+            super n, p
+            @iotas = {}
+            @links = {}
+        end
+        #
+        def to_json *a
+            {
+                'kls'   => self.class.name,
+                'name'  => @name,
+                'iotas' => @iotas,
+                'links' => @links
+            }.to_json *a
+        end
+        #
+        def self.json_create o
+            raise Iotas::Exception.new "JSON #{o['kls']} != #{self.name}" if o['kls'] != self.name
+            room = self.new o['name'], o['parent']
+            o['iotas'].each do |name,iota|
+                eval( iota['kls'] ).json_create(iota.merge!('parent'=>room))
+            end
+            o['links'].each do |src,links|
+                links.each do |link|
+                    room.add_link Iotas::Link.json_create(link)
+                end
+            end
+            room
+        end
+        #
+        def add_iota s
+            raise Iotas::Exception.new "Iota #{s.name} already has #{s.parent.name} as parent" if not s.parent.nil? and s.parent!=self
+            raise Iotas::Exception.new "Iota #{s.name} already exists in #{path}" if @iotas.has_key? s.name
+            s.parent = self if s.parent.nil?
+            @iotas[s.name]=s
+        end
+        #
+        def add_link l
+            l.door = @iotas[l.src]
+            raise Iotas::Exception.new "Link source #{l.src} does not exist in #{path}" if l.door.nil?
+            (@links[l.src] ||= [])<< l
+        end
+        #
+        def start!
+            puts " * start #{path}" if @spin.debug_routing
+            @iotas.values.each do |iota| iota.start! end
+        end
+        #
+        def stop!
+            puts " * stop #{path}" if @spin.debug_routing
+            @iotas.values.each do |iota| iota.stop! end
+        end
+        #
+        def search_down spath
+            return self if spath==path
+            return nil if (spath=~/^#{path}\/(\w+)\/?/)!=0
+            if iota = @iotas[$1]
+                return iota if iota.path==spath    # needed as Door doesn't implement #search_down
+                return iota.search_down spath
+            end
+            nil
+        end
+        #
+        def try_links p
+            puts "   -> try_links ..." if @spin.debug_routing
+            links = @links[p.src.name]
+            return false if links.nil?
+            pending_link = nil
+            apply_link = false
+            links.each do |link|
+                apply_link = link.cond_fields.nil?  # unconditional link
+                p.set_link_fields link.cond_fields if not apply_link
+                if apply_link or (p.link_value==link.cond_value)
+                    # link matches !
+                    if pending_link
+                        p2 = @spin.require_p p.class
+                        p2.clone_data p
+                        p2.apply_link! link
+                        send_p p2
+                    end
+                    pending_link = link
+                end
+            end
+            if pending_link
+                p.apply_link! pending_link
+                send_p p
+            end
+            (not pending_link.nil?)
+        end
+        #
+        def route_p p
+            if p.room.nil? or p.room==path
+                if door = @iotas[p.door]
+                    p.dst_routed! door
+                else
+                    p.error! Iotas::ERROR_ROUTE_RRWD
+                end
+            elsif (p.room=~/^#{path}\/(.*)/)==0
+                room, *more = $1.split Iotas::PATH_SEP
+                if child=@iotas[room]
+                    child.route_p p
+                else
+                    p.error! Iotas::ERROR_ROUTE_DDWR
+                end
+            elsif @parent
+                @parent.route_p p
+            else
+                p.error! Iotas::ERROR_ROUTE_TRWR
+            end
+        end
+        #
+        def send_p p
+            puts " * send_p #{(p.next_dst.nil? ? 'no dst' : p.next_dst)} ..." if @spin.debug_routing
+            if p.src.nil?
+                # do not route orphan particles !!
+                p.error! Iotas::ERROR_ROUTE_NS, @spin
+            elsif p.next_dst
+                p.split_dst!
+                if p.door
+                    route_p p
+                else
+                    # boomerang
+                    p.dst_routed! p.src
+                end
+            elsif try_links p
+                return
+            else
+                p.error! Iotas::ERROR_ROUTE_NDNL
+            end
+            puts "   -> #{p.dst.path}#{Iotas::ACT_SEP}#{p.action}" if @spin.debug_routing
+            @spin.post_p p
+        end
+        #
+        def send_sys_p p
+            puts " * send_sys_p #{(p.next_dst.nil? ? 'no dst' : p.next_dst)} ..." if @spin.debug_routing
+            if p.next_dst
+                p.split_dst!
+                if p.door
+                    route_p p
+                elsif p.action
+                    p.dst_routed! @spin
+                end
+            else
+                p.error! Iotas::ERROR_ROUTE_SND
+            end
+            puts "   -> #{p.dst.path}#{Iotas::ACT_SEP}#{p.action}" if @spin.debug_routing
+            @spin.post_sys_p p
+        end
+        #
+        def process_sys_p p
+            if p.action==Iotas::SYS_ACT_ADD_LINK
+                add_link Iotas::Link.from_particle_data p
+            end
+            @spin.release_p p
+        end
+        #
+    end
+    #
+end
+#
+# EOF

data/lib/iotas/spin.rb

@@ -0,0 +1,150 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2012 Jérémy Zurcher <jeremy@asynk.ch>
+#
+# This file is part of iotas.
+#
+# iotas 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.
+#
+# iotas 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 iotas.  If not, see <http://www.gnu.org/licenses/>.
+
+#
+module Iotas
+    #
+    class Spin < Room
+        #
+        def initialize n, o={}
+            super n, nil
+            #
+            @pool       = {}    # per particle class free list
+            @sys_fifo   = []    # system particles fifo list
+            @app_fifo   = []    # application particles fifo list
+            #
+            @run = false
+            @hibernation    = o['hibernation']||false
+            @hibernate_path = 'iotas-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?
+                o['iotas'].each do |name,iota|
+                    Iotas::Room.json_create(iota.merge!('parent'=>self))
+                end if o['iotas']
+                o['app_fifo'].each do |particle|
+                    @app_fifo << Iotas::Particle.json_create(particle.merge!('spin'=>self))
+                end if o['app_fifo']
+                o['sys_fifo'].each do |particle|
+                    @sys_fifo <<  Iotas::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,
+                'iotas'         => @iotas,
+                '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 Iotas::Exception.new "JSON #{o['kls']} != #{self.name}" if o['kls'] != self.name
+            self.new o['name'], o
+        end
+        #
+        def clear!
+            @iotas.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
+            ( @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.reset!
+            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==Iotas::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/iotas.rb

@@ -0,0 +1,51 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+# Copyright 2012 Jérémy Zurcher <jeremy@asynk.ch>
+#
+# This file is part of iotas.
+#
+# iotas 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.
+#
+# iotas 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 iotas.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'version'
+#
+module Iotas
+    #
+    PATH_SEP = '/'.freeze
+    LINK_SEP = ','.freeze
+    ACT_SEP = '?'.freeze
+    #
+    ACT_GET = 'get'.freeze
+    ACT_ERROR = 'error'.freeze
+    #
+    SYS_ACT_HIBERNATE = 'hibernate'.freeze
+    SYS_ACT_ADD_LINK = 'sys_add_link'.freeze
+    #
+    FIELD_ERROR_MSG     = 'edoors_error'.freeze
+    FIELD_HIBERNATE_PATH= 'hibernate_path'.freeze
+    #
+    class Exception < ::Exception; end
+    #
+end
+#
+require 'json'
+require 'iotas/particle'
+require 'iotas/iota'
+require 'iotas/room'
+require 'iotas/spin'
+require 'iotas/door'
+require 'iotas/board'
+require 'iotas/link'
+#
+# 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 iotas.
+#
+# iotas 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.
+#
+# iotas 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 iotas.  If not, see <http://www.gnu.org/licenses/>.
+
+#
+module Iotas
+    #
+    VERSION = "0.0.2"
+    #
+end
+#
+# EOF

data/spec/board_spec.rb

@@ -0,0 +1,95 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+
+require 'spec_helper'
+#
+describe Iotas::Board do
+    #
+    before (:all) do
+        @spin = Iotas::Spin.new 'dom0'
+    end
+    #
+    before(:each) do
+        @spin.clear!
+    end
+    #
+    it "require_p release_p" do
+        board = Iotas::Board.new 'hell', @spin
+        p0 = board.require_p Iotas::Particle
+        p0.src.should be board
+        p1 = board.require_p Iotas::Particle
+        p1.src.should be board
+        (p0===p1).should be_false
+        board.release_p p0
+        p2 = board.require_p Iotas::Particle
+        p2.src.should be board
+        (p0===p2).should be_true
+    end
+    #
+    it "particle wait and merge" do
+        p0 = Iotas::Particle.new
+        p0['k0'] = 'v0'
+        p0['k1'] = 'neither'
+        p0['k2'] = 'v2'
+        p0.set_link_fields 'k0,k2'
+        p0.link_value.should eql 'v0v2'
+        p1 = Iotas::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 < Iotas::Board
+            attr_reader :ok, :follow
+            def receive_p p
+                @ok = false
+                case p.action
+                when Iotas::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.set_dst! Iotas::ACT_FOLLOW
+        p0.split_dst!
+        p1.set_dst! Iotas::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 = Iotas::Board.new 'hell', @spin
+        p0 = Iotas::Particle.new
+        p1 = Iotas::Particle.new
+        p1['v0']=0
+        p1.set_link_fields 'v0'
+        board.process_p p0
+        board.process_p p1
+        hell = Iotas::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,94 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+
+require 'spec_helper'
+#
+describe Iotas::Door do
+    #
+    before (:all) do
+        @spin = Iotas::Spin.new 'dom0'
+    end
+    #
+    before(:each) do
+        @spin.clear!
+    end
+    #
+    it "require_p release_p" do
+        door = Iotas::Door.new 'hell', @spin
+        p0 = door.require_p Iotas::Particle
+        p0.src.should be door
+        p1 = door.require_p Iotas::Particle
+        p1.src.should be door
+        (p0===p1).should be_false
+        door.release_p p0
+        p2 = door.require_p Iotas::Particle
+        p2.src.should be door
+        (p0===p2).should be_true
+    end
+    #
+    it "NoMethodError when receive_p not overridden" do
+        class Door0 < Iotas::Door
+        end
+        f = Fake.new 'fake', @spin
+        d0 = Door0.new 'door0', f
+        p0 = d0.require_p Iotas::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 < Iotas::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 Iotas::Particle
+        #
+        p0.set_dst! 'SEND'
+        p0.split_dst!
+        d0.process_p p0
+        f.p.should eql p0
+        #
+        p0.set_dst! 'SEND_SYS'
+        p0.split_dst!
+        d0.process_p p0
+        f.sp.should eql p0
+        #
+        p0.set_dst! 'RELEASE'
+        p0.split_dst!
+        d0.process_p p0
+        p1 = d0.require_p Iotas::Particle
+        p1.should be p0
+        #
+        p0.set_dst! 'LOST'
+        p0.split_dst!
+        d0.process_p p0
+        p1 = d0.require_p Iotas::Particle
+        p1.should be p0
+        #
+        d0.process_sys_p p0
+        p1 = @spin.require_p Iotas::Particle
+        p1.should be p0
+    end
+    #
+    it "door->json->door" do
+        door = Iotas::Door.new 'hell', @spin
+        hell = Iotas::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 Iotas::Link do
+    #
+    it "from particle data" do
+        @spin = Iotas::Spin.new 'dom0'
+        p = @spin.require_p Iotas::Particle
+        p.set_data Iotas::LNK_SRC, 'input1'
+        p.set_data Iotas::LNK_DSTS, 'concat1?follow,output1'
+        p.set_data Iotas::LNK_FIELDS, 'f0,f2'
+        p.set_data Iotas::LNK_CONDF, 'f0,f1,f2'
+        p.set_data Iotas::LNK_CONDV, 'v0v1v2'
+        lnk = Iotas::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 = Iotas::Link.new  'input1', 'concat1?follow,output1', 'f0,f2', 'f0,f1,f2', 'v0v1v2'
+        lnk = Iotas::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