oflow 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d36c10496898f7cb6df17b4be3ba103cb8098169
-  data.tar.gz: 563283b71b4e11bd6b207a464b9204722d472f02
+  metadata.gz: 41a62977484dfde369899d13d67f34f41e88d643
+  data.tar.gz: 80f9dc4d7fb42859bfd4b292393b53857ac418b8
 SHA512:
-  metadata.gz: 0d0572af84b50544594563dd86e625c1b86b444702d793ea1585cc870b31f07194903677e1a65a9c6b0d798b7e7a44031c233ca8e3764f36273c20fdb13ce9ff
-  data.tar.gz: 6ca630368b0c25ee789e761043bbca9dcfb8e11fadf590ef8b19017b0d5ea1811c36135d9c9f2e0ab41b97e8f8776a7d969a88678c5c5a223eea4e2adf203c3c
+  metadata.gz: a32921aa1cfae8f6053f571d5b9fad0bf473f2365f46b36f12ff5866ea913e8836d6f5463b46f7fe05cdc839dd93455f985aabaccc2ae1ecf85455f84353beb0
+  data.tar.gz: 04ad4e9db6a86bb6ea02ab1f31f405f8abcb34c7af516e3598c0549414a5fbb704224eb91935a635884daad0837e1e3a8eb99805c0f074a54946fc31b818052e

data/README.md

@@ -25,6 +25,18 @@ Follow [@peterohler on Twitter](http://twitter.com/#!/peterohler) for announceme
 
 ## Release Notes
 
+### Next Release 0.8
+
+ - A somewhat non trivial example. GemChart collects statistics on my gems and
+   stores those statistics. It also provides a web interface to view the
+   statistics as a graph.
+
+### Current Release 0.7
+
+ - Simplified the APIs and structure.
+
+ - Added OmniGraffle support. Diagrams can now be executed.
+
 ### Release 0.6
 
  - Added HTTP Server Actor that acts as a simple HTTP server.
@@ -95,19 +107,23 @@ end
 Next build the flow using Ruby code.
 
 ```ruby
+env = ::OFlow::Env.new('')
+
 def hello_flow(period)
-    ::OFlow::Env.flow('hello_world') { |f|
-      f.task(:repeater, ::OFlow::Actors::Timer, repeat: 3, period: period) { |t|
-        t.link(nil, :hello, nil)
-      }
-      f.task(:hello, HelloWorld)
+  env.flow('hello_world') { |f|
+    f.task(:repeater, ::OFlow::Actors::Timer, repeat: 3, period: period) { |t|
+      t.link(nil, :hello, nil)
     }
+    f.task(:hello, HelloWorld)
+  }
+  env.prepare()
+  env.start()
 end
 
 hello_flow(1.0)
 
 if $0 == __FILE__
-  ::OFlow::Env.flush()
+  env.flush()
 end
 ```
 
@@ -123,10 +139,6 @@ Hello World!
 
 ## Future Features
 
- - HTTP Server Actor
-
- - OmniGraffle file input for configuration.
-
  - .svg file input for configuration.
 
  - Visio file input for configuration.
@@ -141,7 +153,7 @@ Hello World!
    around 10M operations per second where an operation is one task execution per
    thread.
 
- - HTTP based inpector.
+ - HTTP/Websockets based inpector.
 
 # Links
 
@@ -162,33 +174,3 @@ Hello World!
 [Oj Object Mode Performance](http://www.ohler.com/dev/oj_misc/performance_object.html) compares Oj object mode parser performance to other marshallers.
 
 [Oj Callback Performance](http://www.ohler.com/dev/oj_misc/performance_callback.html) compares Oj callback parser performance to other JSON parsers.
-
-### License:
-
-    Copyright (c) 2014, Peter Ohler
-    All rights reserved.
-    
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions are met:
-    
-     - Redistributions of source code must retain the above copyright notice, this
-       list of conditions and the following disclaimer.
-    
-     - Redistributions in binary form must reproduce the above copyright notice,
-       this list of conditions and the following disclaimer in the documentation
-       and/or other materials provided with the distribution.
-    
-     - Neither the name of Peter Ohler nor the names of its contributors may be
-       used to endorse or promote products derived from this software without
-       specific prior written permission.
-    
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/oflow.rb

@@ -4,9 +4,6 @@ end
 
 require 'oflow/errors'
 require 'oflow/stamp'
-require 'oflow/hasname'
-require 'oflow/hastasks'
-require 'oflow/haslinks'
 require 'oflow/haserrorhandler'
 require 'oflow/haslog'
 require 'oflow/pattern'
@@ -19,5 +16,7 @@ require 'oflow/flow'
 
 require 'oflow/actors'
 
+require 'oflow/graffle'
+
 require 'oflow/env'
 require 'oflow/inspector'

data/lib/oflow/actor.rb

@@ -42,6 +42,9 @@ module OFlow
       nil
     end
 
+    def set_option(key, value)
+    end
+
     # Return any options that should be displayed as part of a Task.describe().
     # @return [Hash] Hash of options with String keys.
     def options()

data/lib/oflow/actors/httpserver.rb

@@ -28,7 +28,8 @@ module OFlow
               session = @server.accept_nonblock()
               session.fcntl(Fcntl::F_SETFL, session.fcntl(Fcntl::F_GETFL, 0) | Fcntl::O_NONBLOCK)
               @count += 1
-              req = read_req(session, @count)
+              # if nil is returned the request was empty
+              next if (req = read_req(session, @count)).nil?
               @sessions[@count] = session
               resp = {
                 status: 200,
@@ -106,6 +107,7 @@ module OFlow
           id: id,
         }
         line = session.gets()
+        return if line.nil?
         parts = line.split(' ')
         req[:method] = parts[0]
         req[:protocol] = parts[2]

data/lib/oflow/actors/log.rb

@@ -78,6 +78,7 @@ module OFlow
       # @option options [String|Fixnum] :severity initial setting for severity
       # @option options [Proc] :formatter initial setting for the formatter procedure
       def set_options(options)
+        @formatter = options.fetch(:formatter, nil)
         if !(filename = options[:filename]).nil?
           max_file_size = options.fetch(:max_file_size, options.fetch(:shift_size, 1048576))
           max_file_count = options.fetch(:max_file_count, options.fetch(:shift_age, 7))
@@ -86,9 +87,9 @@ module OFlow
           @logger = Logger.new(stream)
         else
           @logger = Logger.new(STDOUT)
+          @formatter = proc { |s,t,p,m| "#{s[0]} #{p}> #{m}\n" } if @formatter.nil?
         end
         @logger.level = options.fetch(:severity, Env.log_level)
-        @formatter = options.fetch(:formatter, nil)
         @logger.formatter = proc { |s,t,p,m| m }
         @name = 'Logger' if @name.nil?
       end
@@ -103,7 +104,7 @@ module OFlow
         ss = ['DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'][level]
         ss = '' if ss.nil?
         if @formatter.nil?
-          msg = "#{ss[0]}, [#{now.strftime('%Y-%m-%dT%H:%M:%S.%6N')} #{tid}] #{ss} -- #{message}\n"
+          msg = "#{ss[0]} #{now.strftime('%Y-%m-%dT%H:%M:%S.%6N')} #{tid}> #{message}\n"
         else
           msg = @formatter.call(ss, now, tid, message)
         end

data/lib/oflow/actors/persister.rb

@@ -29,6 +29,8 @@ module OFlow
       #  - :key_data [String] path to record data (default: nil (all))
       #  - :key_path [String] path to key for the record (default: 'key')
       #  - :seq_path [String] path to sequence for the record (default: 'seq')
+      #  - :results_path [String] path to where the results should be placed in
+      #                           the request (default: nil or ship only results)
       #  - :cache [Boolean] if true, cache records in memory
       #  - :historic [Boolean] if true, do not delete previous versions
       def initialize(task, options)
@@ -37,21 +39,25 @@ module OFlow
         if @dir.nil?
           @dir = File.join('db', task.full_name.gsub(':', '/'))
         end
-        @key_path = options.fetch(:key_path, 'key')
-        @seq_path = options.fetch(:seq_path, 'seq')
+        @dir = File.expand_path(@dir.strip)
+        
+        @key_path = options.fetch(:key_path, 'key').strip
+        @seq_path = options.fetch(:seq_path, 'seq').strip
         @data_path = options.fetch(:data_path, nil) # nil means all contents
+        @data_path.strip! unless @data_path.nil?
+        @results_path = options[:results_path]
+        @results_path.strip! unless @results_path.nil?
         if options.fetch(:cache, true)
           # key is record key, value is [seq, rec]
           @cache = {}
         else
           @cache = nil
         end
-        @historic = options.fetch(:historic, false)
+        @historic = ('true' == options.fetch(:historic, 'false').to_s)
 
         if Dir.exist?(@dir)
           unless @cache.nil?
-            Dir.glob(File.join('**', '*.json')).each do |path|
-              path = File.join(@dir, path)
+            Dir.glob(File.join(@dir, '**', '*.json')).each do |path|
               if File.symlink?(path)
                 rec = load(path)
                 unless @cache.nil?
@@ -76,6 +82,8 @@ module OFlow
           result = read(box)
         when :update
           result = update(box)
+        when :insert_update
+          result = insert_update(box)
         when :delete, :remove
           result = delete(box)
         when :query
@@ -85,7 +93,14 @@ module OFlow
         else
           raise OpError.new(task.full_name, op)
         end
-        task.ship(dest, Box.new(result, box.tracker))
+        unless dest.nil?
+          if @results_path.nil?
+            box = Box.new(result, box.tracker)
+          else
+            box = box.set(@results_path, result)
+          end
+          task.ship(dest, box)
+        end
       end
 
       def insert(box)
@@ -151,6 +166,14 @@ module OFlow
         rec
       end
 
+      def insert_update(box)
+        begin
+          insert(box)
+        rescue ExistsError
+          update(box)
+        end
+      end
+
       def delete(box)
         key = box.get(@key_path)
         @cache.delete(key) unless @cache.nil?

data/lib/oflow/actors/timer.rb

@@ -1,4 +1,6 @@
 
+require 'date'
+
 require 'logger'
 
 module OFlow
@@ -70,7 +72,6 @@ module OFlow
         end
         while true
           now = Time.now()
-
           # If past stop time then it is done. A future change in options can
           # restart the timer.
           return if !@stop.nil? && @stop < now
@@ -123,7 +124,7 @@ module OFlow
 
       def set_options(options)
         set_start(options[:start]) # if nil let start get set to now
-        set_stop( options[:stop]) if options.has_key?(:stop)
+        set_stop(options[:stop]) if options.has_key?(:stop)
         set_period(options[:period]) if options.has_key?(:period)
         set_repeat(options[:repeat]) if options.has_key?(:repeat)
         set_with_tracker(options[:with_tracker])
@@ -131,9 +132,11 @@ module OFlow
       end
 
       def set_start(v)
-        now = Time.now()
-        if v.is_a?(Numeric)
-          v = now + v
+        if v.is_a?(String)
+          v = DateTime.parse(v).to_time
+          v = v - v.gmtoff
+        elsif v.is_a?(Numeric)
+          v = Time.now() + v
         elsif v.nil?
           v = Time.now()
         elsif !v.kind_of?(Time) && !v.kind_of?(Date)
@@ -143,9 +146,11 @@ module OFlow
       end
 
       def set_stop(v)
-        now = Time.now()
-        if v.is_a?(Numeric)
-          v = now + v
+        if v.is_a?(String)
+          v = DateTime.parse(v).to_time
+          v = v - v.gmtoff
+        elsif v.is_a?(Numeric)
+          v = Time.now() + v
         elsif !v.nil? && !v.kind_of?(Time) && !v.kind_of?(Date)
           raise ConfigError.new("Expected stop to be a Time or Numeric, not a #{v.class}.")
         end
@@ -153,17 +158,29 @@ module OFlow
       end
 
       def set_period(v)
-        unless v.nil? || v.kind_of?(Numeric)
+        p = 0.0
+        if v.kind_of?(Numeric)
+          p = v
+        elsif v.is_a?(String)
+          p = v.strip().to_f
+        else
           raise ConfigError.new("Expected period to be a Numeric, not a #{v.class}.")
         end
-        @period = v
+        raise ConfigError.new("period must be greater than 0.0.") if 0.0 >= p
+        @period = p
       end
 
       def set_repeat(v)
-        unless v.nil? || v.kind_of?(Fixnum)
+        r = nil
+        if v.kind_of?(Fixnum)
+          r = v
+        elsif v.is_a?(String)
+          r = v.strip().to_i
+        elsif !v.nil?
           raise ConfigError.new("Expected repeat to be a Fixnum, not a #{v.class}.")
         end
-        @repeat = v
+        raise ConfigError.new("repeat must be greater than or equal 0.0 or nil") if !r.nil? && 0.0 >= r
+        @repeat = r
       end
 
       def set_label(v)

data/lib/oflow/box.rb

@@ -35,7 +35,7 @@ module OFlow
       Box.new(@contents, @tracker.receive(location, op))
     end
 
-    # Sets or adds a value in inside the Box. The Box is changed with the new
+    # Sets or adds a value inside the Box. The Box is changed with the new
     # contents being thawed where necessary. A path is a set of element names in
     # the case of a Hash or index numbers in the case of an Array joined with
     # the ':' character as a separator.
@@ -46,7 +46,7 @@ module OFlow
       aset(path.split(':'), value)
     end
 
-    # Sets or adds a value in inside the Box where the path is an array of
+    # Sets or adds a value inside the Box where the path is an array of
     # element names or indices. Indices can be Fixnum or Strings.
     # @param path [Array] location of element to change or add. 
     # @param value value for the addition or change

data/lib/oflow/env.rb

@@ -5,17 +5,11 @@ module OFlow
   # OFlow system.
   class Env
 
-    extend HasTasks
-    extend HasLog
-    extend HasName
-    extend HasErrorHandler
+    include HasLog
+    include HasErrorHandler
 
-    # The default logging level.
     @@log_level = Logger::WARN
 
-    init_name(nil, '')
-    init_tasks()
-
     # Returns the default log level.
     # @return [Fixnum] the default log level which is one of the Logger::Severity values.
     def self.log_level()
@@ -26,23 +20,235 @@ module OFlow
     # @param level [Fixnum] Logger::Severity to set the default log level to
     def self.log_level=(level)
       @@log_level = level unless level < Logger::Severity::DEBUG || Logger::Severity::FATAL < level
+      #@log.receive(:severity, Box.new(@log_level)) unless @log.nil?
+    end
+
+    def initialize(name='')
+      # The default logging level.
+      @flows = {}
+      @prepared = false
+      @name = name
+      @log = nil
+      _clear()
+    end
+
+    def full_name()
+      @name
+    end
+
+    # Returns a log Task if one is set on the instance.
+    # @return [Task] log Task.
+    def log()
+      @log
+    end
+
+    # Returns a error_handler Task if one is set on the instance.
+    # @return [Task] error_handler Task.
+    def error_handler()
+      @error_handler
+    end
+
+    # Creates a Flow and yield to a block with the newly create Flow. Used to
+    # contruct Flows.
+    # @param name [Symbol|String] base name for the Flow
+    # @param options [Hash] optional parameters
+    # @param block [Proc] block to yield to with the new Flow instance
+    # @return [Flow] new Flow
+    def flow(name, &block)
+      f = Flow.new(self, name)
+      @flows[f.name] = f
+      yield(f) if block_given?
+      f
+    end
+
+    def prepare()
+      @flows.each_value { |f|
+        f.resolve_all_links()
+      }
+      validate()
+      @prepared = true
+    end
+
+    # Validates the container by verifying all links on a task have been set to
+    # a valid destination and that destination has been resolved.
+    # @raise [ValidateError] if there is an error in validation
+    def validate()
+      # collects errors and raises all errors at once if there are any
+      errors = _validation_errors()
+      raise ValidateError.new(errors) unless errors.empty?
+    end
+
+    # Returns an Array of validation errors.
+    def _validation_errors()
+      errors = []
+      @flows.each_value { |f| errors += f._validation_errors() }
+      errors
+    end
+
+    # Resolves all the Links on all the Flows being managed.
+    def resolve_all_links()
+      @flows.each_value { |f|
+        f.resolve_all_links()
+      }
+    end
+
+    # Iterates over each Flow and yields to the provided block with each Flow.
+    # @param blk [Proc] Proc to call on each iteration
+    def each_flow(&blk)
+      @flows.each { |name,flow| blk.yield(flow) }
+    end
+
+    # Performs a recursive walk over all Flows and yields to the provided block
+    # for each.
+    # @param blk [Proc] Proc to call on each iteration
+    def walk_flows(&blk)
+      @flows.each_value do |f|
+        blk.yield(t)
+      end
+    end
+
+    # Performs a recursive walk over all Tasks in all Flows and yields to the
+    # provided block for each.
+    # @param blk [Proc] Proc to call on each iteration
+    def walk_tasks(&blk)
+      @flows.each_value do |f|
+        f.walk_tasks(&blk)
+      end
+    end
+
+    # Locates and return a Flow with the specified name.
+    # @param name [String] name of the Flow
+    # @return [Flow|nil] the Flow with the name specified or nil
+    def find_flow(name)
+      name = name.to_sym unless name.nil?
+      @flows[name]
+    end
+
+    # Locates and return a Task with the specified full name.
+    # @param name [String] full name of the Task
+    # @return [Flow|Task|nil] the Flow or Task with the name specified or nil
+    def locate(name)
+      name = name[1..-1] if name.start_with?(':')
+      name = name[0..-2] if name.end_with?(':')
+      path = name.split(':')
+      _locate(path)
+    end
+
+    def _locate(path)
+      f = @flows[path[0].to_sym]
+      return f if f.nil? || 1 == path.size
+      f._locate(path[1..-1])
+    end
+
+    # Returns the number of active Tasks.
+    def flow_count()
+      @flows.size
+    end
+
+    # Returns the sum of all the requests in all the Flow's Task's queues.
+    # @return [Fixnum] total number of items waiting to be processed
+    def queue_count()
+      cnt = 0
+      @flows.each_value { |f| cnt += f.queue_count() }
+      cnt
+    end
+
+    # Returns true of one or more Tasks is either processing a request or has a
+    # request waiting to be processed on it's input queue.
+    # @return [true|false] the busy state across all Tasks
+    def busy?
+      @flows.each_value { |f| return true if f.busy? }
+      return true if !@log.nil? && @log.busy?
+      return true if !@error_handler.nil? && @error_handler.busy?
+      false
+    end
+
+    # Calls the stop() method on all Tasks.
+    def stop()
+      @flows.each_value { |f| f.stop() }
+    end
+
+    # Calls the step() method one Task that is stopped and has an item in the
+    # queue. The Tasks with the highest backed_up() value is selected.
+    def step()
+      max = 0.0
+      best = nil
+      walk_tasks() do |t|
+        if Task::STOPPED == t.state
+          bu = t.backed_up()
+          if max < bu
+            best = t
+            max = bu
+          end
+        end
+      end
+      best.step() unless best.nil?
+      best
+    end
+
+    # Calls the start() method on all Tasks.
+    def start()
+      prepare() unless @prepared
+      @flows.each_value { |f| f.start() }
+    end
+
+    # Wakes up all the Tasks in the Flow.
+    def wakeup()
+      @flows.each_value { |f| f.wakeup() }
+    end
+
+    # Wakes up all the Tasks in the Flow and waits for the system to become idle
+    # before returning.
+    def flush()
+      wakeup()
+      @flows.each_value { |f| f.flush() }
+      while busy?
+        sleep(0.2)
+      end
+    end
+
+    # Sets the state of all Tasks recursively. This should not be called
+    # directly.
+    def state=(s)
+      @flows.each_value do |f|
+        f.state = s
+      end
+    end
+
+    # Shuts down all Tasks.
+    # @param flush_first [true|false] flag indicating shutdown should occur after the system becomes idle
+    def shutdown(flush_first=false)
+      # block all tasks first so threads can empty queues
+      @flows.each_value do |f|
+        f.state = Task::BLOCKED
+      end
+      # shutdown and wait for queues to empty if necessary
+      @flows.each_value do |f|
+        f.shutdown(flush_first)
+      end
+      @flows = {}
+    end
+
+    # Clears out all Tasks and Flows and resets the object back to a empty state.
+    def clear()
+      shutdown()
+      @flows = {}
+      _clear()
     end
 
     # Resets the error handler and log. Usually called on init and by the
     # clear() method.
-    def self._clear()
+    def _clear()
       @error_handler = Task.new(self, :error, Actors::ErrorHandler)
       @log = Task.new(self, :log, Actors::Log)
     end
 
-    _clear()
-
     # Describes all the Flows and Tasks in the system.
-    def self.describe(detail=0, indent=0)
+    def describe(detail=0, indent=0)
       i = ' ' * indent
-      lines = ["#{i}#{self} {"]
-      @tasks.each_value { |t|
-        lines << t.describe(detail, indent + 2)
+      lines = ["#{i}#{@name} (#{self.class.name}) {"]
+      @flows.each_value { |f|
+        lines << f.describe(detail, indent + 2)
       }
       lines << i + "}"
       lines.join("\n")