opee 0.1.0 → 1.0.0

data/README.md

@@ -10,9 +10,13 @@ portions of the Actors. They can be used to modify the control of the Actor.
 Once a reasonable API has been established a high performance C extension will
 be written to improve performance.
 
-This is no where close to being ready for prime time.
+Give it a try. Any comments, thoughts, or suggestions are welcome.
 
-Any comments, thoughts, or suggestions are welcome.
+## <a name="source">Source</a>
+
+*GitHub* *repo*: https://github.com/ohler55/opee
+
+*RubyGems* *repo*: https://rubygems.org/gems/opee
 
 ## <a name="links">Links of Interest</a>
 
@@ -20,37 +24,17 @@ Any comments, thoughts, or suggestions are welcome.
 
 ## <a name="release">Release Notes</a>
 
-### Release 0.1.0
+### Release 1.0.0
 
- - Documented classes.
+ - Added names to Actors
 
- - Added a rescuer attribute to the Env for global error handling.
+ - Use Actor name in log messages if set
 
- - Added Collector and Job classes along with unit tests.
+ - Added Actor lookup by name
 
 # Plans and Notes
 
-- add name or label to Actors so they can be discovered by name or symbol
-
-- pick a problem to test against
- - drop file path into dir_wq
- - pick up and decompose
-  - if dir then drop into queue again
-  - if file then send to filter actor
-   - may need to read start to determine text if no extention
-    - check for #! something and assume text/script
-    - if not one of know extension then search low chars that are not \n\r\t or other well knows in text
-    - cache text if file is read in
-  - if text send to through work queue density checker then to summary
-
- - file density distribution
-  - find all files under a directory
-  - detemine if the file is a text or bin file and only keep text files
-  - read in the text file and on work queue
-  - worker determines density of file (non-white/total)
-  - pass on to summary actor
-  - wait_finish
-  - ask to print or write report
+- implement in C if there is enough interest
 
 ### License:
 

data/lib/opee/actor.rb

@@ -16,6 +16,8 @@ module Opee
 
     # The current processing state of the Actor
     attr_reader :state
+    # name of the actor
+    attr_reader :name
 
     # Initializes the Actor with the options specified. A new thread is
     # created during intialization after calling the set_options() method.
@@ -37,9 +39,11 @@ module Opee
       @ask_thread = nil
       @state = RUNNING
       @busy = false
+      @name = nil
       Env.add_actor(self)
       set_options(options)
       @loop = Thread.start(self) do |me|
+        Thread.current[:name] = me.name
         while CLOSING != @state
           begin
             if RUNNING == @state || STEP == @state
@@ -87,13 +91,21 @@ module Opee
     def set_options(options)
       @max_queue_count = options.fetch(:max_queue_count, @max_queue_count)
       @ask_timeout = options.fetch(:ask_timeout, @ask_timeout).to_f
+      @name = options[:name]
+    end
+
+    # Sets the name of the Actor.
+    # @param [String] name new name
+    def name=(name)
+      @name = name
+      @loop[:name] = name
     end
 
     # Calls {#ask}() but uses the specified timeout instead of the default
     # {#ask_timeout} to determine how long to wait if the Actor's queue is full.
     # @param [Fixnum|Float] timeout maximum time to wait trying to add a request to the Actor's queue
     # @param [Symbol] op method to queue for the Actor
-    # @param [Array] *args arguments to the op method
+    # @param [Array] args arguments to the op method
     # @raise [BusyError] if the request queue does not become available in the timeout specified
     def timeout_ask(timeout, op, *args)
       unless @max_queue_count.nil? || 0 == @max_queue_count || @queue.size() < @max_queue_count
@@ -110,7 +122,7 @@ module Opee
 
     # Queues an operation and arguments to be called when the Actor is ready.
     # @param [Symbol] op method to queue for the Actor
-    # @param [Array] *args arguments to the op method
+    # @param [Array] args arguments to the op method
     # @raise [BusyError] if the request queue does not become available in the {#ask_timeout} seconds
     def ask(op, *args)
       timeout_ask(@ask_timeout, op, *args)
@@ -119,7 +131,7 @@ module Opee
     # Queues an operation and arguments to be called when the Actor is has no
     # other requests to process.
     # @param [Symbol] op method to queue for the Actor
-    # @param [Array] *args arguments to the op method
+    # @param [Array] args arguments to the op method
     def on_idle(op, *args)
       @idle_mutex.synchronize {
         @idle.insert(0, Act.new(op, args))
@@ -130,7 +142,7 @@ module Opee
     # Queues an operation and arguments to be called as soon as possible by
     # the Actor. These requests take precedence over other ordinary requests.
     # @param [Symbol] op method to queue for the Actor
-    # @param [Array] *args arguments to the op method
+    # @param [Array] args arguments to the op method
     def priority_ask(op, *args)
       @priority_mutex.synchronize {
         @priority.insert(0, Act.new(op, args))
@@ -142,7 +154,7 @@ module Opee
     # places on the processing queue. Other methods cause a NoMethodError to
     # be raised as it normally would.
     # @param [Symbol] m method to queue for the Actor
-    # @param [Array] *args arguments to the op method
+    # @param [Array] args arguments to the op method
     # @param [Proc] blk ignored
     def method_missing(m, *args, &blk)
       raise NoMethodError.new("undefine method '#{m}' for #{self.class}", m, args) unless respond_to?(m, true)

data/lib/opee/env.rb

@@ -43,6 +43,16 @@ module Opee
       @@actors.each { |a| blk.yield(a) }
     end
 
+    # Locates and return an Actor with the specified name. If there is more
+    # than one Actor with the name specified then the first one encountered is
+    # returned.
+    # @param [String] name name of the Actor
+    # @return [Actor|NilClass] the Actor with the name specified or nil
+    def self.find_actor(name)
+      @@actors.each { |a| return a if name == a.name }
+      nil
+    end
+
     # Returns the number of active Actors.
     def self.actor_count()
       @@actors.size
@@ -62,7 +72,13 @@ module Opee
     # @param [String] message string to log
     def self.log(severity, message)
       @@log = Log.new() if @@log.nil?
-      @@log.ask(:log, severity, message)
+      t = Thread.current
+      if (name = t[:name]).nil?
+        tid = "%d/0x%014x" % [Process.pid, Thread.current.object_id * 2]
+      else
+        tid = "#{Process.pid}/#{name}"
+      end
+      @@log.ask(:log, severity, message, tid)
     end
 
     # Asks the logger to log a message if the current severity level is less

data/lib/opee/log.rb

@@ -9,19 +9,21 @@ module Opee
     def initialize(options={})
       @logger = nil
       @forward = nil
+      @formatter = nil
       super(options)
     end
 
     # Returns the current severity level.
     # @return [Fixnum] Logger severity level
-    def level()
+    def severity()
       @logger.level
     end
+    alias :level :severity
 
     # Returns the current formatter.
     # @return [Logger::Formatter] current formatter
     def formatter()
-      @logger.formatter
+      @formatter
     end
 
     # Returns the forward Log Actor if one has been set.
@@ -53,17 +55,27 @@ module Opee
       else
         @logger = Logger.new(STDOUT)
       end
-      severity = options[:severity] if options.has_key?(:severity)
-      formatter = options[:formatter] if options.has_key?(:formatter)
+      @logger.severity = options[:severity] if options.has_key?(:severity)
+      @formatter = options.fetch(:formatter, nil)
+      @logger.formatter = proc { |s,t,p,m| m }
     end
 
     # Writes a message if the severity is high enough. This method is
     # executed asynchronously.
     # @param [Fixnum] severity one of the Logger levels
     # @param [String] message string to log
-    def log(severity, message)
-      @logger.add(severity, message)
-      @forward.log(severity, message) unless @forward.nil?
+    # @param [Fixnum|String] tid thread id of the thread generating the message
+    def log(severity, message, tid)
+      now = Time.now
+      ss = ['DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'][severity]
+      ss = '' if ss.nil?
+      if @formatter.nil?
+        msg = "#{ss[0]}, [#{now.strftime('%Y-%m-%dT%H:%M:%S.%6N')} ##{tid}]  #{ss} -- : #{message}\n"
+      else
+        msg = @formatter.call(ss, now, tid, message)
+      end
+      @logger.add(severity, msg)
+      @forward.log(severity, message, tid) unless @forward.nil?
     end
 
     # Sets the logger to use the stream specified. This method is executed
@@ -126,7 +138,7 @@ module Opee
     # asynchronously.
     # @param [Proc] proc value to set the formatter to
     def formatter=(proc)
-      @logger.formatter = proc
+      @formatter = proc
     end
 
   end # Log

data/lib/opee/version.rb

@@ -1,5 +1,5 @@
 
 module Opee
   # Current version of the module. 
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opee
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-05-15 00:00:00.000000000 Z
 dependencies: []
 description: ! 'An experimental Object-base Parallel Evaluation Environment. '
 email: peter@ohler.com