edoors-ruby 0.0.6

data/README.md

@@ -0,0 +1,18 @@
+# edoors-ruby
+    by Jérémy Zurcher
+    http://asynk.ch
+
+## DESCRIPTION:
+
+* a ruby rewrite of [evenja](http://www.revena.com/evenja) C++ application framework concept
+
+## FEATURES/PROBLEMS:
+[![Build Status](https://secure.travis-ci.org/jeremyz/edoors-ruby.png)](http://travis-ci.org/jeremyz/edoors-ruby)
+
+## SYNOPSIS:
+
+* experimental material, we'll see where it leads
+
+## LICENSE:
+
+[AGPL](http://www.gnu.org/licenses/agpl-3.0.html)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/bin/edoors.rb

@@ -0,0 +1,71 @@
+#! /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/>.
+
+require 'edoors'
+require 'optparse'
+
+@options = { :require=>[] }
+
+@parser ||= OptionParser.new do |opts|
+    opts.banner = "Usage: #{$0.split('/').last} [options] config"
+
+    opts.on_tail("-r", "--require", "Print this message")               { puts opts; exit 0 }
+    opts.on_tail("-h", "--help", "Print this message")                  { puts opts; exit 0 }
+    opts.on_tail("-v", "--version", "Print version info then exit")     { puts "edoors-ruby #{Edoors::VERSION}"; exit 0 }
+    opts.on_tail("-l", "--license", "Print license info then exit")     { puts DATA.read; exit 0 }
+    opts.on_tail("-r", "--require FILE", "require the library")         { |file| @options[:require] << file }
+end
+
+@parser.parse!(ARGV)
+
+config_path = ARGV.shift
+if config_path.nil?
+    puts "no config file provided, what the hell should I do ?"
+    exit 1
+end
+if not File.exists? config_path
+    puts "#{config_path} does not exists."
+    exit 1
+end
+
+@options[:require].each do |file|
+    load file
+end
+
+dom0 = Edoors::Spin.resume! config_path
+dom0.spin!
+
+__END__
+
+Copyright 2012 Jérémy Zurcher <jeremy@asynk.ch>
+
+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/>.
+

data/edoors-ruby.gemspec

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+$:.push File.expand_path("../lib", __FILE__)
+require 'version'
+#
+Gem::Specification.new do |s|
+    s.name = "edoors-ruby"
+    s.version = Edoors::VERSION
+    s.authors = ["Jérémy Zurcher"]
+    s.email = ["jeremy@asynk.ch"]
+    s.homepage = "http://github.com/jeremyz/edoors-ruby"
+    s.summary = %q{ruby rewrite of C++ application framework evenja (http://www.revena.com/evenja)}
+    s.description = %q{Evenja propose a data centric paradigm. A traditional programm composed of many functions
+    is decomposed into small autonomous modifications applied on the data implemented in different instances of Door base class.
+    Routing between these doors is handled through links or user application destinations.}
+
+    s.files = `git ls-files`.split("\n")
+    s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+    s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+    s.require_paths = ["lib"]
+
+    s.add_runtime_dependency "json"
+    s.add_development_dependency "rspec", ["~> 2.6"]
+    s.add_development_dependency "rake"
+end
+#
+# EOF

data/examples/hello_world.json

@@ -0,0 +1,38 @@
+{
+  "kls": "Edoors::Spin",
+  "timestamp": "2012-06-10 23:17:15 +0200",
+  "name": "dom0",
+  "hibernation": false,
+  "inner_room": {
+    "iotas": {
+      "input": {
+        "kls": "InputDoor",
+        "name": "input"
+      },
+      "output": {
+        "kls": "OutputDoor",
+        "name": "output"
+      }
+    },
+    "links": {
+      "input": [
+        {
+          "kls": "Edoors::Link",
+          "src": "input",
+          "dsts": "output",
+          "fields": null,
+          "cond_fields": null,
+          "cond_value": null
+        }
+      ]
+    }
+  },
+  "sys_fifo": [
+
+  ],
+  "app_fifo": [
+
+  ],
+  "debug_errors": false,
+  "debug_routing": false
+}

data/examples/hello_world.rb

@@ -0,0 +1,76 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+#
+# from the project top directory :
+#
+# run this script which builds the example system and spin it untill it's empty:
+#   $ ruby -Ilib examples/hello_world.rb
+#
+# or load the system from a JSON specification ( created with dom0.hibernate! )
+#   $ ruby -Ilib bin/edoors.rb -r examples/hello_world.rb examples/hello_world.json
+#
+require 'edoors'
+#
+class InputDoor < Edoors::Door
+    #
+    # see Iota class for the different methods to override
+    def start!
+        # stimulate myself on system boot up
+        # if an action is set, but no destination is, it will be self.
+        # see Door#_send
+        send_p require_p(Edoors::Particle), Edoors::ACT_GET
+    end
+    #
+    def receive_p p
+        if p.action==Edoors::ACT_GET
+            # if desired (not necessary here), call reset! to clear particle's data,
+            # meaning merge particle, payload, destinations
+            # see Particle#reset!
+            p.reset!
+            # manipulate the particle's payload
+            p.set_data 'txt', "hello world"
+            # will follow the non conditional link.
+            # see Room#_send and Room#_try_links
+            send_p p
+        else
+            # we can release it or let the Door do it.
+            # see Door#process_p
+            release_p p
+        end
+    end
+    #
+end
+#
+class OutputDoor < Edoors::Door
+    #
+    def receive_p p
+        if p.action!=Edoors::ACT_ERROR
+            puts p.get_data('txt')
+        end
+        # let the door release the particle
+        # see Door#process_p
+    end
+    #
+end
+#
+if $0 == __FILE__
+    #
+    # This will schedule the particles and act as the top level Room
+    dom0 = Edoors::Spin.new 'dom0'
+    # This will feed a receive particle with data and send it back
+    input = InputDoor.new 'input', dom0
+    # This will output the receive data and let the system recycle the particle
+    output = OutputDoor.new 'output', dom0
+    # This will be the unconditinal link leading from 'input' to 'output'
+    dom0.add_link Edoors::Link.new('input', 'output', nil, nil, nil)
+    #
+    # schedule the spinning particles untill the system cools down
+    dom0.spin!
+    #
+    # you can save the system state after it's run,
+    # but to be able to use it to bootstrap, the hibernation attribute must be set to false
+    # otherwise start! method is not called
+    # dom0.hibernate! 'hello_world.json'
+end
+#
+# EOF

data/lib/edoors.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 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/>.
+
+require 'version'
+#
+module Edoors
+    #
+    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 'edoors/particle'
+require 'edoors/iota'
+require 'edoors/room'
+require 'edoors/spin'
+require 'edoors/door'
+require 'edoors/board'
+require 'edoors/link'
+#
+# EOF

data/lib/edoors/board.rb

@@ -0,0 +1,69 @@
+#! /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
+    #
+    ACT_FOLLOW = 'follow'.freeze
+    #
+    class Board < Door
+        #
+        def initialize n, p
+            super n, p
+            @postponed = {}
+        end
+        #
+        def to_json *a
+            {
+                'kls'       => self.class.name,
+                'name'      => @name,
+                'postponed' => @postponed
+            }.merge(hibernate!).to_json *a
+        end
+        #
+        def self.json_create o
+            raise Edoors::Exception.new "JSON #{o['kls']} != #{self.name}" if o['kls'] != self.name
+            board = self.new o['name'], o['parent']
+            o['postponed'].each do |link_value,particle|
+                board.process_p Edoors::Particle.json_create(particle.merge!('spin'=>board.spin))
+            end
+            board.resume! o
+            board
+        end
+        #
+        def process_p p
+            @viewer.receive_p p if @viewer
+            if p.action!=Edoors::ACT_ERROR
+                p2 = @postponed[p.link_value] ||= p
+                return if p2==p
+                @postponed.delete p.link_value
+                p,p2 = p2,p if p.action==Edoors::ACT_FOLLOW
+                p.merge! p2
+            end
+            @saved = p
+            receive_p p
+            _garbage if not @saved.nil?
+        end
+        #
+    end
+    #
+end
+#
+# EOF

data/lib/edoors/door.rb

@@ -0,0 +1,95 @@
+#! /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 Door < Iota
+        #
+        def initialize n, p
+            super n, p
+            @saved = nil
+        end
+        #
+        def to_json *a
+            {
+                'kls'   => self.class.name,
+                'name'  => @name
+            }.merge(hibernate!).to_json *a
+        end
+        #
+        def self.json_create o
+            raise Edoors::Exception.new "JSON #{o['kls']} != #{self.name}" if o['kls'] != self.name
+            door = self.new o['name'], o['parent']
+            door.resume! o
+            door
+        end
+        #
+        def require_p p_kls
+            @spin.require_p p_kls
+        end
+        #
+        def release_p p
+            @saved=nil if @saved==p     # particle is released, all is good
+            @spin.release_p p
+        end
+        #
+        def _garbage
+            puts " ! #{path} didn't give back #{@saved}" if @spin.debug_errors
+            puts "\t#{@saved.data Edoors::FIELD_ERROR_MSG}" if @saved.action==Edoors::ACT_ERROR
+            @spin.release_p @saved
+            @saved = nil
+        end
+        private :_garbage
+        #
+        def process_p p
+            @viewer.receive_p p if @viewer
+            @saved = p
+            receive_p p
+            _garbage if not @saved.nil?
+        end
+        #
+        def process_sys_p p
+            # nothing todo with it now
+            @spin.release_p p
+        end
+        #
+        def _send sys, p, a=nil, d=nil
+            p.init! self
+            p.set_dst! a, d||self if a
+            @saved=nil if @saved==p # particle is sent back the data, all is good
+            # daddy will know what to do
+            sys ? @parent.send_sys_p(p) : @parent.send_p(p)
+        end
+        private :_send
+        #
+        def send_p p, a=nil, d=nil
+            _send false, p, a, d
+        end
+        #
+        def send_sys_p p, a=nil, d=nil
+            _send true, p, a, d
+        end
+        #
+    end
+    #
+end
+#
+# EOF