flor 0.14.0 → 0.15.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d8fca99889bde91b7433d98d674f44c810c041421ce61eef1857e80930e8cef
+  data.tar.gz: 7a06654dbe17ac06aa3afeab0a04b9958851bdaf393df0d48f994dae4681c072
+SHA512:
+  metadata.gz: 0a17e80b8bf6207bd3688f2c57172a51ac471c5f3beaf28803ff8ce41587dc6b181b5295b041dbfa586e6556ee045be56553164e6b09183745c0cfd2562d8c0c
+  data.tar.gz: fad82fa8619af8623b6312d6a4f234f5433d71edcbd05964367c8cde547be357f08d77e9c0e99078f2c71cbf74bfbf7691cae62025f53ce7537ad91cb0ef4d74

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 # flor CHANGELOG.md
 
 
+## flor 0.15.0  released 2018-06-15
+
+- Many many improvements
+- Implement "cron" (macro for "schedule cron:")
+- Introduce Flor.point?(s)
+- Archive terminated, failed and ceased messages (Tsunehisa Doi)
+- Let "case" match regular expressions
+
+
 ## flor 0.14.0  released 2017-06-13
 
 - Implement "match"

data/CREDITS.md

@@ -0,0 +1,21 @@
+
+# CREDITS.md
+
+## Contributors
+
+* David Verrier - https://github.com/dverrier
+* Tsunehisa Doi - https://github.com/dmicky0419
+* Jean-François Rioux - https://github.com/jfrioux
+* Danny Fullerton - https://github.com/northox
+* John Mettraux - https://github.com/jmettraux
+
+https://github.com/floraison/flor/graphs/contributors
+
+## Feedback
+
+## ruote legacy
+
+Many thanks to all the ruote contributors.
+
+https://github.com/jmettraux/ruote/blob/30a6bb88a4e48ed2e1b9089754f1c8be8c1a879c/CREDITS.txt
+

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2015-2017, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2015-2018, John Mettraux, jmettraux+flor@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
+
+Made in Japan
+

data/Makefile

@@ -8,6 +8,7 @@ VERSION = \
 
 count_lines:
 	find lib -name "*.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
+	find spec -name "*_spec.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
 cl: count_lines
 
 gemspec_validate:
@@ -68,6 +69,8 @@ mk:
 
 doc:
 	$(RUBY) -Imak -r 'doc' -e "make_procedures_doc()"
+doct:
+	@$(RUBY) mak/ptree.rb
 
 shell:
 	$(RUBY) -Ilib -r 'flor/tools/shell' -e 'Flor::Tools::Shell.new'
@@ -76,6 +79,7 @@ sh: shell
 cleanshell:
 	rm -f envs/shell/var/flor.db
 	rm -fR envs/shell/var/tasks/*
+	rm -f .log.txt
 
 .PHONY: doc shell cleanshell
 

data/README.md

@@ -8,6 +8,7 @@ Flor is a "Ruby workflow engine", if that makes any sense.
 
 * [![Join the chat at https://gitter.im/floraison/flor](https://badges.gitter.im/floraison/flor.svg)](https://gitter.im/floraison/flor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 * [floraison mailing list](https://groups.google.com/forum/#!forum/floraison)
+* [twitter.com/@flor_workflow](https://twitter.com/flor_workflow)
 
 ## Design
 
@@ -29,6 +30,13 @@ See [quickstart/](quickstart/).
 
 See [doc/](doc/).
 
+## blog posts and presentations
+
+* [Flor, hubristic interpreter](http://rubykaigi.org/2017/presentations/jmettraux.html) - RubyKaigi 2017, Hiroshima - presentation
+* [flor design 0](http://jmettraux.skepti.ch/20171021.html?t=flor_design_0) - running a simple execution, what happens - blog post
+* [flor, branch to branch](https://speakerdeck.com/jmettraux/flor-branch-to-branch) - q1 2017 - very dry deck
+* [flor 2017](https://speakerdeck.com/jmettraux/flor-2017) - q1 2017 - very dry deck
+
 
 ## LICENSE
 

data/flor.gemspec

@@ -21,22 +21,22 @@ A Ruby workflow engine (ruote next generation)
 
   #s.files = `git ls-files`.split("\n")
   s.files = Dir[
+    'README.{md,txt}',
+    'CHANGELOG.{md,txt}', 'CREDITS.{md,txt}', 'LICENSE.{md,txt}',
     'Makefile',
     'lib/**/*.rb', #'spec/**/*.rb', 'test/**/*.rb',
-    '*.gemspec', '*.txt', '*.rdoc', '*.md'
+    "#{s.name}.gemspec",
   ]
 
-  s.add_runtime_dependency 'munemo', '>= 1.0.1'
-  s.add_runtime_dependency 'raabro', '>= 1.1.3'
-  #s.add_runtime_dependency 'rufus-lru', '>= 1.1.0'
-  s.add_runtime_dependency 'fugit', '>= 0.9.5'
+  s.add_runtime_dependency 'munemo', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'raabro', '~> 1.1', '>= 1.1.5'
+  #s.add_runtime_dependency 'rufus-lru', '~> 1.1'
+  s.add_runtime_dependency 'fugit', '~> 1.1'
+  s.add_runtime_dependency 'dense', '~> 1.1', '>= 1.1.1'
 
-  s.add_development_dependency 'sequel', '~> 4'
-    #
-    # flor in transient mode doesn't need a storage,
-    # so Sequel is not a runtime dependency
+  s.add_runtime_dependency 'sequel', '~> 4'
 
-  s.add_development_dependency 'rspec', '3.4.0'
+  s.add_development_dependency 'rspec', '~> 3.7'
   s.add_development_dependency 'terminal-table'
 
   s.require_path = 'lib'

data/lib/flor.rb

@@ -8,11 +8,12 @@ require 'socket'
 
 require 'munemo'
 require 'raabro'
+require 'dense'
 
 
 module Flor
 
-  VERSION = '0.14.0'
+  VERSION = '0.15.0'
 end
 
 require 'flor/colours'
@@ -21,7 +22,6 @@ require 'flor/djan'
 require 'flor/id'
 require 'flor/log'
 require 'flor/flor'
-require 'flor/deep'
 require 'flor/dollar'
 require 'flor/errors'
 require 'flor/parser'

data/lib/flor/changes.rb

@@ -17,9 +17,9 @@ module Flor::Changes
   def do_apply(h, c)
 
     case c['op']
-    when 'add' then Flor.deep_insert(h, c['path'], c['value'])
-    when 'replace' then Flor.deep_set(h, c['path'], c['value'])
-    when 'remove' then Flor.deep_unset(h, c['path'])
+    when 'add' then Dense.insert(h, c['path'], c['value'])
+    when 'replace' then Dense.set(h, c['path'], c['value'])
+    when 'remove' then Dense.unset(h, c['path'])
     end
   end
 end

data/lib/flor/colours.rb

@@ -58,23 +58,29 @@ module Flor
 
   def self.colours(opts={})
 
-    c = nil
-      #
-    [ :color, :colour, :colors, :colours ].each do |k|
-      if opts.has_key?(k); c = opts[k]; break; end
-    end
+    #opts =
+    #  case opts
+    #  when Hash then opts
+    #  when Colours, NoColours then { color: opts }
+    #  else { out: opts }
+    #  end
+
+    c = nil;
+      [ :color, :colour, :colors, :colours ].each do |k|
+        if opts.has_key?(k); c = opts[k]; break; end
+      end
 
     return @colours if c == true
     return @no_colours if c == false
 
     o = opts[:out] || $stdout
 
-    col =
+    return @colours if (
       (o.respond_to?(:log_colours?) ? o.log_colours? : o.tty?) ||
       ($0[-6..-1] == '/rspec' &&
-        (ARGV.include?('--tty') || ARGV.include?('--color')))
+        (ARGV.include?('--tty') || ARGV.include?('--color'))))
 
-    col ? @colours : @no_colours
+    @no_colours
   end
 
   def self.decolour(s)

data/lib/flor/conf.rb

@@ -67,78 +67,83 @@ module Flor
     #
     #   For example `debug: 'msg,stdout'`
 
-    def self.prepare(conf, over_conf)
+    class << self
 
-      c = conf
-      c = Flor::ConfExecutor.interpret(c) if c.is_a?(String)
+      def prepare(conf, over_conf)
 
-      fail ArgumentError.new(
-        "cannot extract conf out of #{c.inspect} (#{conf.class})"
-      ) unless c.is_a?(Hash)
+        c = conf
+        c = Flor::ConfExecutor.interpret_path_or_source(c) if c.is_a?(String)
 
-      unless c['conf'] == true
-        #
-        # don't read FLOR_DEBUG if this executor is only meant to read the conf
+        fail ArgumentError.new(
+          "cannot extract conf out of #{c.inspect} (#{conf.class})"
+        ) unless c.is_a?(Hash)
 
-        c.merge!(interpret_flor_debug(c))
-        c.merge!(interpret_env)
-      end
-
-      c.merge!(over_conf)
-    end
+        unless c['conf'] == true
+          #
+          # don't read FLOR_DEBUG if this executor is only meant to read
+          # the conf
 
-    def self.get_class(conf, key)
+          c.merge!(interpret_flor_debug(c))
+          c.merge!(interpret_env)
+        end
 
-      if v = conf[key]
-        Flor.const_lookup(v)
-      else
-        nil
+        c.merge!(over_conf)
       end
-    end
-
-    protected # somehow
-
-    LOG_DBG_KEYS = %w[ dbg msg err src tree tree_rw run ]
-    LOG_ALL_KEYS = %w[ all log sto ] + LOG_DBG_KEYS
 
-    def self.interpret_flor_debug(c)
+      def get_class(conf, key)
 
-      plus, minus = [ c['flor_debug'], c['debug'], ENV['FLOR_DEBUG'] ]
-        .collect { |v| (v || '').split(/\s*,\s*/) }
-        .flatten(1)
-        .partition { |v| v[0, 1] != '-' }
-      plus = plus.collect { |v| v[0, 1] == '+' ? v[1..-1] : v }
-      minus = minus.collect { |v| v[0, 1] == '-' ? v[1..-1] : v }
-      a = plus - minus
-
-      h =
-        a.inject({}) { |h, kv|
-          k, v = kv.split(':')
-          k = 'sto' if k == 'db'
-          k = "log_#{k}" if LOG_ALL_KEYS.include?(k)
-          h[k] = v ? JSON.parse(v) : true
-          h
-        }
-      LOG_ALL_KEYS.each { |k| h["log_#{k}"] = 1 } if h['log_all']
-      LOG_DBG_KEYS.each { |k| h["log_#{k}"] = 1 } if h['log_dbg']
-
-      h['log_colours'] = true \
-        if a.include?('colours') || a.include?('colors')
-          # LOG_DEBUG=colours forces colors
+        if v = conf[key]
+          Flor.const_lookup(v)
+        else
+          nil
+        end
+      end
 
-      h['log_out'] = 'stdout' if h.delete('stdout')
-      h['log_out'] = 'stderr' if h.delete('stderr')
+      LOG_DBG_KEYS = %w[ dbg msg err src tree tree_rw run ]
+      LOG_ALL_KEYS = %w[ all log sto ] + LOG_DBG_KEYS
+
+      def interpret_flor_debug(c)
+
+        plus, minus = [
+          c['flor_debug'], c[:debug], c['debug'], ENV['FLOR_DEBUG'] ]
+            .collect { |v| (v || '').split(/\s*,\s*/) }
+            .flatten(1)
+            .partition { |v| v[0, 1] != '-' }
+        plus = plus.collect { |v| v[0, 1] == '+' ? v[1..-1] : v }
+        minus = minus.collect { |v| v[0, 1] == '-' ? v[1..-1] : v }
+        a = plus - minus
+
+        h =
+          a.inject({}) { |h, kv|
+            k, v = kv.split(':')
+            k = 'sto' if k == 'db'
+            k = "log_#{k}" if LOG_ALL_KEYS.include?(k)
+            h[k] = v ? JSON.parse(v) : true
+            h
+          }
+        LOG_ALL_KEYS.each { |k| h["log_#{k}"] = 1 } if h['log_all']
+        LOG_DBG_KEYS.each { |k| h["log_#{k}"] = 1 } if h['log_dbg']
+
+        h['log_colours'] = true \
+          if a.include?('colours') || a.include?('colors')
+            # LOG_DEBUG=colours forces colors
+
+        h['log_out'] = 'stdout' if h.delete('stdout')
+        h['log_out'] = 'stderr' if h.delete('stderr')
+
+        h
+      end
 
-      h
-    end
+      protected
 
-    def self.interpret_env
+      def interpret_env
 
-      h = {}
-      u = ENV['FLOR_UNIT']
-      h['unit'] = u if u
+        h = {}
+        u = ENV['FLOR_UNIT']
+        h['unit'] = u if u
 
-      h
+        h
+      end
     end
   end
 end

data/lib/flor/core.rb

@@ -28,17 +28,17 @@ module Flor
 
     t =
       tree.is_a?(String) ?
-      Flor::Lang.parse(tree, opts[:fname], opts) :
+      Flor.parse(tree, opts[:fname], opts) :
       tree
 
     unless t
 
       #h = opts.merge(prune: false, rewrite: false, debug: 0)
-      #Raabro.pp(Flor::Lang.parse(tree, h[:fname], h))
+      #Raabro.pp(Flor.parse(tree, h[:fname], h))
         # TODO re-parse and indicate what went wrong...
 
       fail ArgumentError.new(
-        "flor parse failure: " + tree.inspect[0, 35] + '...')
+        "flow parsing failed: " + tree.inspect[0, 35] + '...')
     end
 
     pl = opts[:payload] || opts[:fields] || {}
@@ -74,7 +74,7 @@ module Flor
         File.join(File.dirname(__FILE__), dir, '*.rb')
       end
 
-    Dir[dirpath].each { |path| require(path) }
+    Dir[dirpath].sort.each { |path| require(path) }
   end
 end
 

data/lib/flor/core/executor.rb

@@ -85,7 +85,7 @@ module Flor
         # be lenient with block hooks, help them return an array
     end
 
-    # Given a nid, returns a copy of all the var the node sees
+    # Given a nid, returns a copy of all the var the node sees at that point.
     #
     def vars(nid, vs={})
 
@@ -124,15 +124,15 @@ module Flor
 
       nid = message['nid']
 
-      now = Flor.tstamp
+      n = Flor.tstamp
 
       node = {
         'nid' => nid,
         'parent' => message['from'],
         'payload' => message['payload'],
-        'status' => [ { 'status' => nil, 'point' => 'execute', 'ctime' => now } ],
-        'ctime' => now,
-        'mtime' => now }
+        'status' => [ { 'status' => nil, 'point' => 'execute', 'ctime' => n } ],
+        'ctime' => n,
+        'mtime' => n }
 
       %w[ vars vdomain cnid dbg ].each do |k|
         v = message[k]
@@ -240,7 +240,16 @@ module Flor
 
       return [ head.rewrite ] if head.is_a?(Flor::Macro)
 
-      head.send("do_#{message['point']}")
+      point = message['point']
+      point = 'kill' if message['flavour'] == 'kill'
+
+      messages = head.send("do_#{point}")
+
+      fail StandardError.new(
+        "#{heap}/#{message['point']} did not return an Array"
+      ) unless messages.is_a?(Array)
+
+      messages
     end
 
     def toc_messages(message)
@@ -250,6 +259,7 @@ module Flor
       m = message.select { |k, v| %w[ exid nid from payload ].include?(k) }
       m['sm'] = message['m']
       m['point'] = message['from'] == '0' ? 'terminated' : 'ceased'
+      m['cause'] = message['cause'] if message.has_key?('cause')
 
       [ m ]
     end
@@ -340,13 +350,11 @@ module Flor
 
       ts = node['tags']; return [] unless ts && ts.any?
 
-      [
-        { 'point' => 'left',
+      [ { 'point' => 'left',
           'tags' => ts,
           'exid' => exid,
           'nid' => node['nid'],
-          'payload' => message['payload'] }
-      ]
+          'payload' => message['payload'] } ]
     end
 
     def error_reply(node, message, err)
@@ -359,7 +367,6 @@ module Flor
       m['error'] = Flor.to_error(err)
 
       @unit.logger.log_err(self, m, flag: true)
-      #Flor.print_detail_msg(self, m, flag: true) if @unit.conf['log_err']
 
       #if m['error']['msg'].match(/\AToo many open files in system/)
       #  puts "=" * 80 + ' ...'
@@ -396,22 +403,43 @@ module Flor
         #
         # FIXME is it in use???
 
-      [
-        { 'point' => 'receive',
+      [ { 'point' => 'receive',
           'exid' => message['exid'],
           'nid' => message['nid'],
           'payload' => message['payload'],
-          'tasker' => message['tasker'] }
-      ]
+          'tasker' => message['tasker'] } ]
     end
 
     def cancel(message)
 
-      if n = @execution['nodes'][message['nid']]
-        apply(n, message)
-      else
-        [] # nothing, node gone
-      end
+      n = @execution['nodes'][message['nid']]
+      return [] unless n # node gone
+
+      apply(n, message)
+    end
+
+    def stack_cause(message)
+
+      pt = message['point']
+      fl = message['flavour']
+
+      cause = pt # trigger or cancel
+      cause = fl if %w[ kill timeout ].include?(fl) # only for cancel, hopefully
+
+      last = (message['cause'] ||= [])[0]
+
+      c = {
+        'cause' => cause,
+        'm' => message['m'],
+        'nid' => message['nid'],
+        'type' => message['type'],
+        'at' => last && last['at'] }
+
+      return if c == last
+
+      message['cause'] =
+        [ c.tap { |h| h['at'] = Flor.tstamp } ] +
+        message['cause']
     end
 
     def process(message)
@@ -421,6 +449,9 @@ module Flor
         message['m'] = counter_next('msgs') # number messages
         message['pr'] = counter('runs') # "processing run"
 
+        stack_cause(message) \
+          if %w[ trigger cancel ].include?(message['point'])
+
         determine_heat(message)
 
         ms = []
@@ -477,16 +508,21 @@ module Flor
         "node #{message['nid']} is gone, cannot flag it as failed"
       ) unless n
 
-#begin
       n['failure'] = Flor.dup(message)
-#rescue; pp message; exit 0; end
 
-      oep = lookup_on_error_parent(message)
-      return oep.trigger_on_error if oep
-
-      @unit.logger.log_err(self, message)
-
-      []
+      if oep = lookup_on_error_parent(message)
+        #
+        # There is a parent with an 'on_error', trigger it that parent
+        # with its 'on_error' turned on.
+        #
+        oep.trigger_on_error
+      else
+        #
+        # Simply log and don't add further messages ([]) to execute
+        #
+        @unit.logger.log_err(self, message)
+        []
+      end
     end
 
     def signal(message); []; end
@@ -494,7 +530,7 @@ module Flor
     def lookup_on_error_parent(message)
 
       nd = Flor::Node.new(self, nil, message).on_error_parent
-      nd ? nd.to_procedure : nil
+      nd ? nd.to_procedure_node : nil
     end
   end
 end