flor 0.17.0 → 1.1.1

data/lib/flor/pcore/type_of.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::TypeOf < Flor::Procedure
   #

data/lib/flor/pcore/until.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Until < Flor::Procedure
   #

data/lib/flor/punit/abort.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class Flor::Pro::Abort < Flor::Procedure
+  #
+  # Cancels the current execution.
+  #
+  # Cancels all the root nodes at once. Is usually the equivalent of
+  # `cancel '0'` but sometimes the root nodes are gone...
+  #
+  # "kabort" is like "abort" but the cancel flavour is 'kill', so that
+  # cancel handlers are ignored.
+  #
+  # ```
+  # # ...
+  # cursor
+  #   task 'prepare mandate'
+  #   abort _ if f.outcome == 'reject'
+  #   task 'sign mandate'
+  # # ...
+  # ```
+  #
+  # ## see also
+  #
+  # Cancel, kill
+
+  name 'abort', 'kabort'
+
+  def receive_last
+
+    fla = heap == 'kabort' ? 'kill' : 'cancel'
+
+    nodes = @execution['nodes']
+    nids = nodes.keys.dup
+
+    @execution['nodes'].values.each do |n|
+
+#p n.select { |k, v| %w[ nid can parent cnodes ].include?(k) }
+      nid = n['nid']
+      pa = nodes[n['parent']]
+
+      nids.delete(nid) if pa && pa['cnodes'].include?(nid)
+    end
+#p nids
+
+    wrap_cancel_nodes(nids, { 'flavour' => fla })
+      .each { |m| m['from'] = '9' }
+        # since '9' isn't the parent of any node
+  end
+end
+

data/lib/flor/punit/c_collect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Ccollect < Flor::Macro::Iterator
   #

data/lib/flor/punit/c_each.rb

@@ -1,5 +1,24 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Ceach < Flor::Macro::Iterator
+  #
+  # Concurrent "each".
+  #
+  # ```
+  # ceach [ alice bob charly ]
+  #   task elt "prepare monthly report"
+  # ```
+  # which is equivalent to
+  # ```
+  # concurrence
+  #   task 'alice' "prepare monthly report"
+  #   task 'bob' "prepare monthly report"
+  #   task 'charly' "prepare monthly report"
+  # ```
+  #
+  # ## see also
+  #
+  # For-each, c-map, and c-for-each.
 
   names %w[ ceach c-each ]
 

data/lib/flor/punit/c_for_each.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'flor/punit/c_iterator'
 
@@ -27,7 +28,7 @@ class Flor::Pro::CforEach < Flor::Pro::ConcurrentIterator
   #
   # ## see also
   #
-  # For-each, cmap, and ceach.
+  # For-each, c-map, and c-each.
 
   name 'c-for-each'
 

data/lib/flor/punit/c_iterator.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-require 'flor/punit/m_ram'
+require 'flor/punit/m_receive_and_merge'
 
 
 # Parent class for "c-for-each" and "c-map"

data/lib/flor/punit/c_map.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'flor/punit/c_iterator'
 

data/lib/flor/punit/cancel.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Cancel < Flor::Procedure
   #
@@ -29,7 +30,15 @@ class Flor::Pro::Cancel < Flor::Procedure
   # ```
   # But it's kind of brittle compared to using tags.
   #
-  # # TODO document "kill"
+  # ## kill
+  #
+  # "kill" is equivalent to "cancel", but once called, cancel handlers are
+  # ignored, it cancels through.
+  #
+  #
+  # ## see also
+  #
+  # On_cancel, on
 
   name 'cancel', 'kill'
     # ruote had "undo" as well...

data/lib/flor/punit/concurrence.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 
-require 'flor/punit/m_ram'
+require 'flor/punit/m_receive_and_merge'
 
 
 class Flor::Pro::Concurrence < Flor::Procedure
@@ -386,10 +387,11 @@ class Flor::Pro::Concurrence < Flor::Procedure
 
   REWRITE_AS_ATTS = %w[
     on_receive on_merge
-    child_on_error children_on_error ]
-      #
-      # heads of the child nodes that should get rewritten as attributes
-      # of the concurrence ...
+    child_on_error children_on_error
+      ].freeze
+        #
+        # heads of the child nodes that should get rewritten as attributes
+        # of the concurrence ...
 
   def pre_execute_rewrite
 

data/lib/flor/punit/cron.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'flor/punit/schedule'
 

data/lib/flor/punit/do_trap.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::DoTrap < Flor::Macro
   #

data/lib/flor/punit/every.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'flor/punit/schedule'
 

data/lib/flor/punit/graft.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Graft < Flor::Procedure
   #

data/lib/flor/punit/{m_ram.rb → m_receive_and_merge.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # Module extracted out of "concurrence", deals with receivers and mergers.
 #
@@ -178,15 +179,15 @@ module Flor::Pro::ReceiveAndMerge
   # * ignore
   # * stack
 
-  STACK_REX = /\Astack(?::([-_a-zA-Z0-9]+))?\z/
+  STACK_REX = /\Astack(?::([-_a-zA-Z0-9]+))?\z/.freeze
 
-  TRANSLATORS = { STACK_REX => 'k', /\Atail\z/ => 'a' }
+  TRANSLATORS = { STACK_REX => 'k', /\Atail\z/ => 'a' }.freeze
 
   MORDERS = {
-    'f' => :first, 'l' => :last, /[tnh]/ => :north, /[bsa]/ => :south }
+    'f' => :first, 'l' => :last, /[tnh]/ => :north, /[bsa]/ => :south }.freeze
   MMERGERS = {
     'd' => :deep, /[mp]/ => :mix, 'o' => :override, 'i' => :ignore,
-    'k' => :stack }
+    'k' => :stack }.freeze
 
   def default_merger
 

data/lib/flor/punit/on_timeout.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::OnTimeout < Flor::Procedure
   #

data/lib/flor/punit/part.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Part < Flor::Procedure
 

data/lib/flor/punit/schedule.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Schedule < Flor::Procedure
   #

data/lib/flor/punit/signal.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Signal < Flor::Procedure
   #
@@ -51,6 +52,26 @@ class Flor::Pro::Signal < Flor::Procedure
   # flor_unit.signal('close', exid: execution_id, payload: { 'f0' => 'zero' })
   # ```
   #
+  # ## signalling another execution
+  #
+  # If the exid of execution A is known in execution B, execution B can
+  # send a signal to A.
+  #
+  # ```ruby
+  # exid0 = @unit.launch(
+  #   %q{
+  #     trap signal: 'green' # block until receiving the 'green' signal
+  #     set f.done true
+  #   })
+  # @unit.launch(
+  #   %q{
+  #     set f.a 'a'
+  #     signal exid: f.exid0 'green' # send 'green' signal to exid0
+  #     set f.b 'b'
+  #   },
+  #   payload: { 'exid0' => exid0 })
+  # ```
+  #
   # ## see also
   #
   # On and trap.
@@ -64,14 +85,18 @@ class Flor::Pro::Signal < Flor::Procedure
 
   def receive_last
 
-    name = att('name', nil)
+    na = att('name', nil)
+    ei = att('exid') || exid
+    pl = att('payload') || payload.copy_current
 
-    return super unless name
+    return super unless na
 
     wrap(
-      'point' => 'signal', 'nid' => nid, 'name' => name,
-      'payload' => payload.copy_current
-    ) + super
+      'point' => 'signal',
+      'exid' => ei, 'nid' => nid,
+      'name' => na, 'payload' => pl
+    ) +
+    super
   end
 end
 

data/lib/flor/punit/sleep.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Sleep < Flor::Procedure
   #

data/lib/flor/punit/task.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Task < Flor::Procedure
   #
@@ -68,6 +69,9 @@ class Flor::Pro::Task < Flor::Procedure
     # clean_up assign: 'alan'
     # "clean up" assign: 'alan'
 
+    @node['message'] = message
+      # keep copy for Executor#return integrity enforcement
+
     nis = atts(nil)
     ta = att('by', 'for', 'assign')
     tn = att('with', 'task')
@@ -79,8 +83,7 @@ class Flor::Pro::Task < Flor::Procedure
 
     attl, attd = determine_atts
 
-    @node['task'] =
-      { 'tasker' => tasker, 'name' => taskname }
+    @node['task'] = { 'tasker' => tasker, 'name' => taskname }
 
     wrap(
       'point' => 'task',
@@ -96,6 +99,9 @@ class Flor::Pro::Task < Flor::Procedure
 
     close_node
 
+    @node['message'] = message
+      # keep copy for Executor#return integrity enforcement
+
     attl, attd = determine_atts
 
     wrap(
@@ -103,6 +109,7 @@ class Flor::Pro::Task < Flor::Procedure
       'exid' => exid, 'nid' => nid,
       'tags' => list_tags,
       'tasker' => att(nil),
+      'taskname' => @node['task']['name'],
       'attl' => attl, 'attd' => attd,
       'payload' => determine_payload)
   end

data/lib/flor/punit/trace.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class Flor::Pro::Trace < Flor::Procedure
 

data/lib/flor/punit/trap.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # Would it be worth the pain implementing bind:?
 
@@ -168,6 +169,12 @@ class Flor::Pro::Trap < Flor::Procedure
   # (org.acme.accounting, org.acme.engineering, org.acme.whatever.x.y.z, ...)
   #
   #
+  # ## the bnid: directive
+  #
+  # "bound nid" by default is the nid of the parent expression to the "trap".
+  # With `bnid:`, one can bind a trap to another expression.
+  #
+  #
   # ## the count: limit
   #
   # ```
@@ -178,6 +185,37 @@ class Flor::Pro::Trap < Flor::Procedure
   # twice.
   #
   #
+  # ## the payload: directive
+  #
+  # The `payload:` attribute tells the trap what payload to hand to the
+  # trap handler.
+  #
+  # When `payload: 'event'`, the handler is given a copy of the fields as
+  # seen in the event that triggered the trap.
+  #
+  # When `payload: 'trap'`, the handler is given a copy of the fields as
+  # they were when and where the trap was set.
+  #
+  # When `payload: { a: 'A' }`, the given payload is used (here
+  # `{ 'a' => 'A' }`).
+  #
+  #
+  # ## blocking trap
+  #
+  # One can use a trap without a function. It will block the execution branch
+  # until the expect event, signal, etc occurs
+  # ```
+  # sequence
+  #   technical_writer 'prepare documentation'
+  #   team_manager 'submit documentation to review team'
+  #   trap signal: 'green' # go on after the 'green' signal...
+  #   team_manager 'deploy documentation'
+  # ```
+  # Here the execution will block after the team manager submits the doc
+  # for review. When the 'green' signal comes, the flow resumes to 'deploy
+  # documentation'.
+  #
+  #
   # ## see also
   #
   # On and signal.
@@ -213,6 +251,8 @@ class Flor::Pro::Trap < Flor::Procedure
     points = points.uniq if points
     names = names.uniq if names
 
+    bnid = att('bnid', 'bind') || parent || '0'
+
     msg =
       if fun
         apply(fun, [], tree[2], anid: false).first
@@ -222,7 +262,7 @@ class Flor::Pro::Trap < Flor::Procedure
 
     tra = {}
     tra['nid'] = nid
-    tra['bnid'] = parent || '0'
+    tra['bnid'] = bnid
     tra['points'] = points
     tra['tags'] = tags
     tra['heaps'] = heaps

data/lib/flor/to_string.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 

data/lib/flor/tools/env.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'fileutils'
 

data/lib/flor/tools/firb.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'irb'
+
+#require 'sequel'
+require 'flor'
+require 'flor/unit'
+
+
+p [ RUBY_VERSION, RUBY_PLATFORM ]
+
+puts
+
+ENV.each do |k, v|
+  next unless k.match?(/RUBY|GEM/)
+  puts "* #{k}: #{v}"
+end
+
+ARGV.each do |arg|
+  if arg.match(/:/)
+    DB = Sequel.connect(arg)
+    p DB
+  end
+end
+
+#MODELS = [ :executions, :timers, :traces, :traps, :pointers, :messages ]
+if defined?(DB)
+  Flor::Message.dataset = DB[:flor_messages]
+end
+
+ARGV.clear
+IRB.start
+