edoors-ruby 0.0.6 → 0.0.7

data/Changelog

@@ -1,4 +1,16 @@
-2012-XX-YY Jérémy Zurcher <jeremy@asynk.ch>
+2012-06-28 Jérémy Zurcher <jeremy@asynk.ch>
+	* release : 0.0.7
+	* yard documentation completed
+	* add link and board JSON ready examples
+	* link_value is an Hash -> fix possible bugs
+	* use ruby Array instead of comma separated Strings (destinations,keys)
+	* implement SYS_ACT_ADD_ROOM system action
+	* implement ACT_PASS_THROUGH application action
+	* add Particle #merged_length, #each_merged
+	* add Board #keep!, flush!
+
+2012-06-13 Jérémy Zurcher <jeremy@asynk.ch>
+	* release : 0.0.6 (edoors)
 	* add bin
 	* add examples
 	* project rename, iotas -> edoors-ruby
@@ -7,6 +19,10 @@
 	* enhance direct routing through Door#send_p destination parameter
 	* enhance Particle#init! and Particle#reset! action and usage
 
+2012-06-13 Jérémy Zurcher <jeremy@asynk.ch>
+	* release : 0.0.5 (iotas)
+	* for project name change notification
+
 2012-06-02 Jérémy Zurcher <jeremy@asynk.ch>
 	* release : 0.0.4
 	* simplify routing algorithm

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    edoors-ruby (0.0.6)
+    edoors-ruby (0.0.7)
       json
 
 GEM

data/examples/board.json

@@ -0,0 +1,52 @@
+{
+  "kls": "Edoors::Spin",
+  "timestamp": "2012-06-28 14:37:21 +0200",
+  "name": "dom0",
+  "hibernation": false,
+  "inner_room": {
+    "iotas": {
+      "input": {
+        "kls": "FileReader",
+        "name": "input",
+        "filepath": "./examples/data.json"
+      },
+      "filter": {
+        "kls": "Filter",
+        "name": "filter"
+      },
+      "stats": {
+        "kls": "Stats",
+        "name": "stats",
+        "postponed": {
+        }
+      },
+      "output": {
+        "kls": "OutputDoor",
+        "name": "output"
+      }
+    },
+    "links": {
+      "input": [
+        {
+          "kls": "Edoors::Link",
+          "src": "input",
+          "dsts": [
+            "filter",
+            "stats?follow",
+            "output"
+          ],
+          "keys": "filter_value",
+          "value": null
+        }
+      ]
+    }
+  },
+  "sys_fifo": [
+
+  ],
+  "app_fifo": [
+
+  ],
+  "debug_garbage": false,
+  "debug_routing": false
+}

data/examples/board.rb

@@ -0,0 +1,133 @@
+#! /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/links.rb
+#
+# or load the system from a JSON specification ( created with dom0.hibernate! )
+#   $ ruby -Ilib bin/edoors.rb -r examples/board.rb examples/board.json
+#
+#
+require 'edoors'
+#
+class FileReader < Edoors::Door
+    #
+    def initialize n, p, path=nil
+        super n, p
+        @filepath = path unless path.nil?
+    end
+    #
+    def hibernate!
+        {'filepath'=>@filepath}
+    end
+    #
+    def resume! o
+        @filepath = o['filepath']
+    end
+    #
+    def start!
+        @file = File.open(@filepath,'r')
+        # stimulate myself on system boot up
+        send_p require_p(Edoors::Particle), Edoors::ACT_GET
+    end
+    #
+    def receive_p p
+        if p.action==Edoors::ACT_GET
+            # stop everything if EOF reached
+            if @file.eof?
+                p.reset!
+                send_p p, Edoors::ACT_PASS_THROUGH, 'stats'
+            else
+                p.set_data 'person', JSON.load(@file.readline)
+                # will follow the non conditional link.
+                # see Room#_send and Room#_try_links
+                send_p p
+                # stimulate myself
+                send_p require_p(Edoors::Particle), Edoors::ACT_GET
+            end
+        end
+    end
+    #
+end
+#
+class Filter < Edoors::Door
+    #
+    def receive_p p
+        if p.action!=Edoors::ACT_ERROR
+            # apply the filter
+            h = {
+                :old => (p['person']['age']>=18),
+                :female => (p['person']['sex']=='f')
+            }
+            # puts "input : "+h.inspect
+            # store the result into one single attribute
+            p['filter_value']= h
+            # will follow the conditional link.
+            # see Room#_send and Room#_try_links
+            send_p p
+        end
+    end
+    #
+end
+#
+class Stats < Edoors::Board
+    #
+    def receive_p p
+        return if p.action==Edoors::ACT_ERROR
+        if p.action==Edoors::ACT_PASS_THROUGH
+            # use this signal to flush all stored data
+            flush!
+        else
+            # restore the Particle into myself
+            # send_p p, self.path
+            keep! p
+        end
+    end
+    #
+end
+#
+class OutputDoor < Edoors::Door
+    #
+    #
+    def receive_p p
+        return if p.action==Edoors::ACT_ERROR
+        f = p['filter_value']
+        puts "Team #{f[:old] ? 'mature' : 'tean'} #{f[:female] ? 'women' : 'men'} #{} (#{p.merged_length+1})"
+        d = p.get_data('person')
+        puts " #{d['name']} is #{d['age']} years old"
+        p.each_merged do |o|
+            d = o.get_data('person')
+            puts " #{d['name']} is #{d['age']} years old"
+        end
+        puts
+    end
+    #
+end
+#
+if $0 == __FILE__
+    # basic setup, see hello_world.rb
+    dom0 = Edoors::Spin.new 'dom0'
+    #
+    FileReader.new 'input', dom0, './examples/data.json'
+    # the filter to be applied to each particle
+    Filter.new 'filter', dom0
+    # the statistics board
+    Stats.new 'stats', dom0
+    # different outptu doors
+    OutputDoor.new 'output', dom0
+    # default link directing everything from input into age_filter
+    dom0.add_link Edoors::Link.new('input', ['filter','stats?follow','output'], 'filter_value')
+    #
+    # 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! 'board.json'
+    #
+end
+#
+# EOF

data/examples/data.json

@@ -0,0 +1,8 @@
+{"name":"Jérémy","age":34,"sex":"m"}
+{"name":"Corina","age":30,"sex":"f"}
+{"name":"Róisín","age":3,"sex":"f"}
+{"name":"Shaunagh","age":1,"sex":"f"}
+{"name":"Alain","age":60,"sex":"m"}
+{"name":"Ghislaine","age":57,"sex":"f"}
+{"name":"Elise","age":33,"sex":"f"}
+{"name":"Tifaine","age":27,"sex":"f"}

data/examples/hello_world.json

@@ -1,6 +1,6 @@
 {
   "kls": "Edoors::Spin",
-  "timestamp": "2012-06-10 23:17:15 +0200",
+  "timestamp": "2012-06-24 22:50:00 +0200",
   "name": "dom0",
   "hibernation": false,
   "inner_room": {
@@ -20,9 +20,8 @@
           "kls": "Edoors::Link",
           "src": "input",
           "dsts": "output",
-          "fields": null,
-          "cond_fields": null,
-          "cond_value": null
+          "keys": null,
+          "value": null
         }
       ]
     }
@@ -33,6 +32,6 @@
   "app_fifo": [
 
   ],
-  "debug_errors": false,
+  "debug_garbage": false,
   "debug_routing": false
 }

data/examples/hello_world.rb

@@ -7,7 +7,7 @@
 #   $ 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
+#   $ ruby -Ilib -r ./examples/hello_world.rb bin/edoors.rb examples/hello_world.json
 #
 require 'edoors'
 #
@@ -62,7 +62,7 @@ if $0 == __FILE__
     # 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)
+    dom0.add_link Edoors::Link.new('input', 'output', nil, nil)
     #
     # schedule the spinning particles untill the system cools down
     dom0.spin!

data/examples/links.json

@@ -0,0 +1,96 @@
+{
+  "kls": "Edoors::Spin",
+  "timestamp": "2012-06-28 14:43:36 +0200",
+  "name": "dom0",
+  "hibernation": false,
+  "inner_room": {
+    "iotas": {
+      "input": {
+        "kls": "FileReader",
+        "name": "input",
+        "filepath": "./examples/data.json"
+      },
+      "age_filter": {
+        "kls": "Filter",
+        "name": "age_filter"
+      },
+      "output_f": {
+        "kls": "OutputDoor",
+        "name": "output_f",
+        "title": "woman"
+      },
+      "output_m": {
+        "kls": "OutputDoor",
+        "name": "output_m",
+        "title": "man"
+      },
+      "output_child": {
+        "kls": "OutputDoor",
+        "name": "output_child",
+        "title": "child"
+      },
+      "output_parent": {
+        "kls": "OutputDoor",
+        "name": "output_parent",
+        "title": "parent"
+      }
+    },
+    "links": {
+      "input": [
+        {
+          "kls": "Edoors::Link",
+          "src": "input",
+          "dsts": "age_filter",
+          "keys": null,
+          "value": null
+        }
+      ],
+      "age_filter": [
+        {
+          "kls": "Edoors::Link",
+          "src": "age_filter",
+          "dsts": "output_f",
+          "keys": null,
+          "value": {
+            "sex": "f"
+          }
+        },
+        {
+          "kls": "Edoors::Link",
+          "src": "age_filter",
+          "dsts": "output_m",
+          "keys": null,
+          "value": {
+            "sex": "m"
+          }
+        },
+        {
+          "kls": "Edoors::Link",
+          "src": "age_filter",
+          "dsts": "output_child",
+          "keys": null,
+          "value": {
+            "old": false
+          }
+        },
+        {
+          "kls": "Edoors::Link",
+          "src": "age_filter",
+          "dsts": "output_parent",
+          "keys": null,
+          "value": {
+            "old": true
+          }
+        }
+      ]
+    }
+  },
+  "sys_fifo": [
+
+  ],
+  "app_fifo": [
+
+  ],
+  "debug_garbage": false,
+  "debug_routing": false
+}

data/examples/links.rb

@@ -0,0 +1,121 @@
+#! /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/links.rb
+#
+# or load the system from a JSON specification ( created with dom0.hibernate! )
+#   $ ruby -Ilib -r ./examples/links.rb bin/edoors.rb examples/links.json
+#
+#
+require 'edoors'
+#
+class FileReader < Edoors::Door
+    #
+    def initialize n, p, path=nil
+        super n, p
+        @filepath = path
+    end
+    #
+    def hibernate!
+        {'filepath'=>@filepath}
+    end
+    #
+    def resume! o
+        @filepath = o['filepath']
+    end
+    #
+    def start!
+        @file = File.open(@filepath,'r')
+        # stimulate myself on system boot up
+        send_p require_p(Edoors::Particle), Edoors::ACT_GET
+    end
+    #
+    def receive_p p
+        if p.action==Edoors::ACT_GET
+            # stop everything if EOF reached
+            return if @file.eof?
+            p.set_data 'person', JSON.load(@file.readline)
+            # will follow the non conditional link.
+            # see Room#_send and Room#_try_links
+            send_p p
+            # stimulate myself
+            send_p require_p(Edoors::Particle), Edoors::ACT_GET
+        end
+    end
+    #
+end
+#
+class Filter < Edoors::Door
+    #
+    def receive_p p
+        if p.action!=Edoors::ACT_ERROR
+            # apply the filter
+            p['old'] = (p['person']['age']>=18)
+            p['sex'] = p['person']['sex']
+            # will follow the conditional link.
+            # see Room#_send and Room#_try_links
+            send_p p
+        end
+    end
+    #
+end
+#
+class OutputDoor < Edoors::Door
+    #
+    def initialize n, p, t=nil
+        super n, p
+        @title = t
+    end
+    #
+    def hibernate!
+        {'title'=>@title}
+    end
+    #
+    def resume! o
+        @title = o['title']
+    end
+    #
+    def receive_p p
+        if p.action!=Edoors::ACT_ERROR
+            p = p.get_data('person')
+            puts "#{p['name']} is a #{p['age']} year(s) old #{@title}"
+        end
+    end
+    #
+end
+#
+if $0 == __FILE__
+    # basic setup, see hello_world.rb
+    dom0 = Edoors::Spin.new 'dom0'
+    #
+    FileReader.new 'input', dom0, './examples/data.json'
+    # the filter to be applied to each particle
+    Filter.new 'age_filter', dom0
+    # different output doors
+    OutputDoor.new 'output_f', dom0, 'woman'
+    OutputDoor.new 'output_m', dom0, 'man'
+    OutputDoor.new 'output_child', dom0, 'child'
+    OutputDoor.new 'output_parent', dom0, 'parent'
+    # default link directing everything from input into age_filter
+    dom0.add_link Edoors::Link.new('input', 'age_filter')
+    # different links directing to different outputs depending on 'sex' key
+    dom0.add_link Edoors::Link.new('age_filter', 'output_f', nil, {'sex'=>'f'})
+    dom0.add_link Edoors::Link.new('age_filter', 'output_m', nil, {'sex'=>'m'})
+    # different links directing to different outputs depending on 'old' key
+    dom0.add_link Edoors::Link.new('age_filter', 'output_child', nil, {'old'=>false})
+    dom0.add_link Edoors::Link.new('age_filter', 'output_parent', nil, {'old'=>true})
+    #
+    # 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! 'links.json'
+    #
+end
+#
+# EOF