flor 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 298a6b2c9d3752b561ee8933ae00ed7a3f63682fb758dbe899097c6f7f56c00d
-  data.tar.gz: 3e2602737b9de7a452549d0f8ed34752618b1322a5508d178abe6559d549c045
+  metadata.gz: 352d4347077550a9e577689e8b1f11ad90b7efb0d6fa14e99a228b634852c55f
+  data.tar.gz: 81015d54353ff68b48108e09fdfc8933cae2b20ed48ccba1679bebc1b67258da
 SHA512:
-  metadata.gz: 28ae10c78676391537dde7cd7e0082338650c6aeba60fbcffa2ca5a4cb2dd2f168d7ff61019472c5f6f3d2216cabfe6e9bccb7cdae4856b513e0663f4d4ec362
-  data.tar.gz: 6379738cddfc5b74d37a30fa23260924649866b49dc670f37a0540a47a5079062288851ce07306350e227d73d0fd873f2199c3ea01b3399bce61572b8cebe497
+  metadata.gz: c322beec0f868fbf72c79678227cbf2a2fea34611fe340b1fdd680a7d6b1f5a09246af1a78f6923977a061772ef22fc8d20d2d13a0bad2145991f296b4cfd143
+  data.tar.gz: 3c3e2ce6a88acbaeeab0bb9d89f8c22e5dfd8fb1a81491f0d54983d21d692e3cd93262c842ed8dbc00e021b2fee1d5f3e3e791d8af72bfc6667c472d712d3541

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 # CHANGELOG.md
 
 
+## flor 1.5.0  released 2021-11-24
+
+* Add storage callbacks `on(:pointers, :any) { do_that }`
+* Add `on_receive` (and `on receive`)
+
+
 ## flor 1.4.0  released 2021-11-10
 
 * Add :tree to Execution#to_h

data/lib/flor/core/node.rb

@@ -88,7 +88,7 @@ class Flor::Node
   def domain; Flor.domain(@execution['exid']); end
 
   def point; @message['point']; end
-  def from; @message['from']; end
+  def from; @from || @message['from']; end
 
   def cnodes; @node['cnodes']; end
   def cnodes_any?; cnodes && cnodes.any?; end

data/lib/flor/core/procedure.rb

@@ -381,8 +381,17 @@ class Flor::Procedure < Flor::Node
 
       receive_when_ended
 
+    elsif should_apply_on_receive?
+
+      apply_on_receive
+
     else
 
+      orn = @node['on_receive_nid']
+      @from = orn[1] if orn && orn[0] == from
+        #
+        # in order to move on to the next child...
+
       receive
     end
   end
@@ -982,6 +991,36 @@ class Flor::Procedure < Flor::Node
 
     []
   end
+
+  def should_apply_on_receive?
+
+    return false if @message['from_on'] == 'receive'
+      #
+      # no, since the message comes from an on_receive...
+      # how about nested on_receives?
+
+    orc = @node['on_receive']
+    return false if orc.nil? || orc.empty?
+
+    orn = @node['on_receive_nid']
+    return false if orn && orn[0] == from
+
+    true
+  end
+
+  def apply_on_receive
+
+    determine_fcid_and_ncid
+
+    args = [
+      [ 'msg', @message ],
+      [ 'fcid', @fcid ] ]
+
+    ms = apply(@node['on_receive'][0][1], args, tree[2])
+    @node['on_receive_nid'] = [ ms[0]['nid'], from ]
+
+    ms
+  end
 end
 
 

data/lib/flor/pcore/_apply.rb

@@ -99,7 +99,7 @@ class Flor::Pro::UnderscoreApply < Flor::Procedure
 
     params.each do |param_key, param_tree|
       next if param_tree[0] == '_ref'
-      arg_i = args.index { |arg_key, arg_val| arg_key == param_key }
+      arg_i = args.index { |arg_key, _| arg_key == param_key }
       next unless arg_i
       arg_key, arg_val = args.delete_at(arg_i)
       seen << arg_key

data/lib/flor/pcore/on.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+
 class Flor::Pro::On < Flor::Macro
   #
   # Catches signals or errors.
@@ -132,7 +133,7 @@ class Flor::Pro::On < Flor::Macro
 
   protected
 
-  CATCHES = %w[ error cancel timeout ].freeze
+  CATCHES = %w[ error cancel timeout receive ].freeze
 
   def find_catch
 

data/lib/flor/pcore/on_receive.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+
+class Flor::Pro::OnReceive < Flor::Procedure
+  #
+  # Binds a function to the parent node, the function will be called each time
+  # the parent node "receives".
+  #
+  # ```
+  # set l []
+  # sequence
+  #   on_receive (def msg \ push l 'a')
+  #   push l 0
+  #   push l 1
+  #   push l 2
+  # ```
+  # will result in the variable `l` holding `[ 0, 'a', 1, 'a', 2, 'a' ]`.
+  #
+  # ```
+  # set l []
+  # sequence
+  #   push l 0
+  #   on_receive (def msg \ push l 'a')
+  #   push l 1
+  #   push l 2
+  # ```
+  # will result in the variable `l` holding `[ 0, 1, 'a', 2, 'a' ]`.
+  #
+  # It's meant to play well with a cursor:
+  # ```
+  # set l []
+  # cursor
+  #   on_receive (def \ break _ if l[-1] == 1)
+  #   push l 0
+  #   push l 1
+  #   push l 2
+  # push l 'z'
+  # ```
+  # will result in the variable `l` holding `[ 0, 1, 'z' ]`.
+  #
+  #
+  # ## arguments to the on_receive function
+  #
+  # `msg` and `fcid` (from child id) are passed to the function
+  # ```
+  # set l []
+  # cursor
+  #   on_receive (def msg, fcid \ push l [ msg.from, fcid ])
+  #   push l 0
+  #   push l 1
+  #   push l 2
+  # ```
+  # will result in the variable `l` holding
+  # `[ 0, [ '0_1_1', 1 ], 1, [ '0_1_2', 2 ], 2, [ '0_1_3', 3 ] ]`.
+  #
+  #
+  # ## on_receive and on receive
+  #
+  # A "lighter" notation is available (it's translated automatically to a
+  # `on_receive`):
+  # ```
+  # set l []
+  # cursor
+  #   on receive
+  #     push l $msg.from
+  #     break _ if l.-1 == 1
+  #   push l 0
+  #   push l 1
+  #   push l 2
+  # ```
+  #
+  # Please note the `$msg` variable made available to the `on receive` block.
+  #
+  #
+  # ## concurrence and on_receive
+  #
+  # Please not that `concurrence` has its own `on_receive` with a slightly
+  # different behaviour.
+
+  name 'on_receive'
+
+  def pre_execute
+
+    unatt_unkeyed_children
+
+    @node['rets'] = []
+  end
+
+  def receive_last
+
+    prc = @node['rets'].find { |r| Flor.is_func_tree?(r) }
+
+    store_on(:receive, prc)
+
+    ms = super
+
+    ms.first['from_on'] = 'receive'
+
+    ms
+  end
+end
+

data/lib/flor/punit/concurrence.rb

@@ -139,7 +139,7 @@ class Flor::Pro::Concurrence < Flor::Procedure
   #   + 12 34
   #   + 56 78
   # ```
-  # One can even express the function has a 'block':
+  # One can even express the function as a 'block':
   # ```
   # concurrence tag: 'x'
   #   on_receive

data/lib/flor/tools/flotojson.rb

@@ -16,7 +16,16 @@ if (ARGV & [ '-h', '--help']).any?
   puts "  turns a flor .flo process definition to its tree representation"
   puts
   puts "  flags:"
-  puts "    --pp   pretty prints instead of dumping as JSON"
+  puts "    --pp    pretty prints instead of dumping as JSON"
+  puts
+  puts "    --pj"
+  puts "    --jp    pretty prints the JSON output"
+  puts
+  puts "    -y"
+  puts "    -yaml   dumps as YAML"
+  puts
+  puts "    -h"
+  puts "    --help  prints this help message"
   puts
   exit 0
 end
@@ -53,11 +62,28 @@ end
 #    end
 
 fname = files.first
-content = File.read(fname)
+
+content =
+  if fname
+    abort("File #{fname.inspect} not found") unless File.exist?(fname)
+    File.read(fname)
+  else
+    STDIN.read
+  end
+
 tree = Flor.parse(content, fname, {})
 
 if flags['--pp']
   pp tree
+elsif flags['--jp'] || flags['--pj']
+  puts(
+    JSON.pretty_generate(tree)
+      .gsub(/\[\s+/, '[ ')
+      .gsub(/\]\s+/, ']')
+      .gsub(/,\s+(\d+)\s+\]/, ', \1]')
+        )
+elsif flags['-y'] || flags['--yaml']
+  puts YAML.dump(tree)
 else
   puts JSON.dump(tree)
 end

data/lib/flor/unit/logger.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+
 module Flor
 
   # TODO ::Logger has a formatting callback
@@ -11,7 +12,7 @@ module Flor
 
     # NB: logger configuration entries start with "log_"
 
-    LEVELS_I = %w[ DEBUG INFO WARN ERROR FATAL UNKNOWN ]
+    LEVELS_I = %w[ DEBUG INFO WARN ERROR FATAL UNKNOWN ].freeze
 
     def initialize(unit)
 

data/lib/flor/unit/scheduler.rb

@@ -113,27 +113,6 @@ module Flor
       @ganger.shutdown
     end
 
-    def on_start_exc(e)
-
-      io = StringIO.new
-
-      head, kind =
-        e.is_a?(StandardError) ? [ '=sch', 'error' ] : [ '!sch', 'exception' ]
-      thr = Thread.current
-
-      t = head[0, 2] + Time.now.to_f.to_s.split('.').last
-      io.puts ' /' + t + ' ' + head * 17
-      io.puts " |#{t} + in #{self.class}#start"
-      io.puts " |#{t} db: #{@storage.db.class} #{@storage.db.object_id}"
-      io.puts " |#{t} thread: t#{thr.object_id} #{thr.inspect}"
-      io.puts " |#{t} #{kind}: #{e.inspect}"
-      io.puts " |#{t} backtrace:"
-      e.backtrace.each { |l| io.puts "|#{t} #{l}" }
-      io.puts ' \\' + t + ' ' + (head * 17) + ' .'
-
-      io.string
-    end
-
     def start
 
       # TODO heartbeat, every x minutes, when idle, log something
@@ -557,6 +536,27 @@ module Flor
 
     protected
 
+    def on_start_exc(e)
+
+      io = StringIO.new
+
+      head, kind =
+        e.is_a?(StandardError) ? [ '=sch', 'error' ] : [ '!sch', 'exception' ]
+      thr = Thread.current
+
+      t = head[0, 2] + Time.now.to_f.to_s.split('.').last
+      io.puts ' /' + t + ' ' + head * 17
+      io.puts " |#{t} + in #{self.class}#start"
+      io.puts " |#{t} db: #{@storage.db.class} #{@storage.db.object_id}"
+      io.puts " |#{t} thread: t#{thr.object_id} #{thr.inspect}"
+      io.puts " |#{t} #{kind}: #{e.inspect}"
+      io.puts " |#{t} backtrace:"
+      e.backtrace.each { |l| io.puts "|#{t} #{l}" }
+      io.puts ' \\' + t + ' ' + (head * 17) + ' .'
+
+      io.string
+    end
+
     def extract_dump_and_load_filters(opts)
 
       o = lambda { |k| v = opts[k] || opts["#{k}s".to_sym]; v ? Array(v) : nil }

data/lib/flor/unit/storage.rb

@@ -16,7 +16,7 @@ module Flor
         :content
           ].freeze
 
-    attr_reader :unit, :db, :models
+    attr_reader :unit, :db, :models, :callbacks
 
     attr_reader :mutex
       # might be useful for some implementations
@@ -31,6 +31,8 @@ module Flor
       @archive = @unit.conf['sto_archive']
       @mutex = @unit.conf['sto_sync'] ? Mutex.new : nil
 
+      @callbacks = {}
+
       connect
     end
 
@@ -191,6 +193,8 @@ module Flor
               mtime: now,
               munit: u)
 
+          callback(:executions, :update, id)
+
         else
 
           exe['id'] =
@@ -205,6 +209,8 @@ module Flor
                 cunit: u,
                 munit: u)
               .to_i
+
+          callback(:executions, :insert, exe['id'])
         end
 
         remove_nodes(exe, status, now)
@@ -418,26 +424,29 @@ module Flor
       now = Flor.tstamp
       u = @unit.identifier
 
-      synchronize do
+      id =
+        synchronize do
 
-        @db[:flor_timers]
-          .insert(
-            domain: Flor.domain(message['exid']),
-            exid: message['exid'],
-            nid: message['nid'],
-            onid: message['onid'] || message['nid'],
-            bnid: message['nid'],
-            type: type,
-            schedule: string,
-            ntime: next_time,
-            content: to_blob(message),
-            count: 0,
-            status: 'active',
-            ctime: now,
-            mtime: now,
-            cunit: u,
-            munit: u)
-      end
+          @db[:flor_timers]
+            .insert(
+              domain: Flor.domain(message['exid']),
+              exid: message['exid'],
+              nid: message['nid'],
+              onid: message['onid'] || message['nid'],
+              bnid: message['nid'],
+              type: type,
+              schedule: string,
+              ntime: next_time,
+              content: to_blob(message),
+              count: 0,
+              status: 'active',
+              ctime: now,
+              mtime: now,
+              cunit: u,
+              munit: u)
+        end
+
+      callback(:timers, :insert, id)
 
       @unit.wake_up
 
@@ -502,6 +511,8 @@ module Flor
               munit: u)
         end
 
+      callback(:traps, :insert, id)
+
       traps[id]
 
     rescue => err
@@ -548,6 +559,21 @@ module Flor
       nil
     end
 
+    def on(key, actions=[], &block)
+
+      as =
+        case actions
+        when :any, 'any' then []
+        when Array then actions
+        when Symbol then [ actions ]
+        when String then actions.split(/\s*[;,]\s*/)
+        else []
+        end
+          .collect(&:to_sym)
+
+      (@callbacks[key] ||= []) << [ as, block ]
+    end
+
     protected
 
     def migration_table_and_column(opts={})
@@ -640,10 +666,11 @@ module Flor
     def reschedule_timer(t)
 
       w = { id: t.id.to_i, status: 'active', mtime: t.mtime, munit: t.munit }
+      r = nil
 
       if t.type != 'at' && t.type != 'in'
 
-        @db[:flor_timers]
+        r = @db[:flor_timers]
           .where(w)
           .update(
             count: t.count.to_i + 1,
@@ -652,9 +679,11 @@ module Flor
             mtime: Flor.tstamp,
             munit: @unit.identifier)
 
+        callback(:timers, :update, w, t)
+
       elsif @archive
 
-        @db[:flor_timers]
+        r = @db[:flor_timers]
           .where(w)
           .update(
             count: t.count.to_i + 1,
@@ -662,12 +691,18 @@ module Flor
             mtime: Flor.tstamp,
             munit: @unit.identifier)
 
+        callback(:timers, :update, w, t)
+
       else
 
-        @db[:flor_timers]
+        r = @db[:flor_timers]
           .where(w)
           .delete
+
+        callback(:timers, :delete, w, t)
       end
+
+      r
     end
 
     def remove_nodes(exe, status, now)
@@ -787,6 +822,8 @@ module Flor
         .import(
           POINTER_COLUMNS,
           pointers)
+
+      callback(:pointers, :update, exid)
     end
 
     #def pointer_columns
@@ -835,6 +872,23 @@ module Flor
         .inject([]) { |a, elt| a << [ a.last, elt ].compact.join('.'); a }
     end
 
+    def callback(table, action, *rest)
+
+      (@callbacks[table] || [])
+        .each { |as, block|
+          call_back(block, table, action, *rest) \
+            if as.empty? || as.include?(action) }
+    end
+
+    def call_back(block, table, action, *rest)
+
+      block.call(
+        *(
+          block.arity < 0 ?
+          [ table, action, *rest ] :
+          [ table, action, *rest ][0, block.arity]))
+    end
+
     class DbLogger
 
       def initialize(unit); @unit = unit; end

data/lib/flor.rb

@@ -16,7 +16,7 @@ require 'dense'
 
 module Flor
 
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end
 
 require 'flor/colours'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flor
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: munemo
@@ -204,6 +204,7 @@ files:
 - lib/flor/pcore/on.rb
 - lib/flor/pcore/on_cancel.rb
 - lib/flor/pcore/on_error.rb
+- lib/flor/pcore/on_receive.rb
 - lib/flor/pcore/push.rb
 - lib/flor/pcore/rand.rb
 - lib/flor/pcore/range.rb