tribe 0.0.6 → 0.0.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tribe (0.0.6)
+    tribe (0.0.7)
       workers (= 0.0.6)
 
 GEM

data/README.md

@@ -1,7 +1,10 @@
 # Tribe
 
-Tribe is a Ruby gem that implements event driven actors.
-Actors are light weight concurrent objects that use asynchronous message passing for communication.
+Tribe is a Ruby gem that implements event driven [actors] (http://en.wikipedia.org/wiki/Actor_model "actors").
+Actors are lightweight concurrent objects that use asynchronous message passing for communication.
+Tribe focuses on high performance, low latency, an easy to use API, and flexibility.
+It is built on top of the [Workers] (https://github.com/chadrem/workers "Workers") gem, which allows it to support many actors (millions should be possible).
+Actors can use a shared thread pool (default) or dedicted threads.
 
 ## Installation
 
@@ -51,7 +54,7 @@ Or install it yourself as:
       MyActor.new(:name => "my_actor_#{i}")
     end
     
-    # Send an event to each actors.  Find each actor using the registry.
+    # Send an event to each actors.  Find each actor using the global registry.
     100.times do |i|
       actor = Tribe.registry["my_actor_#{i}"]
       actor.enqueue(:my_custom, 'hello world')
@@ -64,7 +67,7 @@ Or install it yourself as:
     end
 
 ### Implementation notes
-Because actors use a shared thread pool, it is important that they don't block for long periods of time.
+Because actors use a shared thread pool, it is important that they don't block for long periods of time (short periods are fine).
 Actors that block for long periods of time should use a dedicated thread (:dedicated => true or subclass from Tribe::DedicatedActor).
 
 ## Registries
@@ -104,7 +107,3 @@ In general you shouldn't have to create your own since there is a global one (Tr
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-## Copyright
-
-Copyright (c) 2012 Chad Remesch. See LICENSE.txt for further details.

data/lib/tribe/actable.rb

@@ -0,0 +1,80 @@
+module Tribe
+  module Actable
+    include Workers::Helpers
+
+    def init_actable(options = {})
+      @logger = Workers::LogProxy.new(options[:logger])
+      @dedicated = options[:dedicated] || false
+      @mailbox = options[:mailbox] || Tribe::Mailbox.new
+      @registry = options[:registry] || Tribe.registry
+      @name = options[:name]
+      @pool = @dedicated ? Workers::Pool.new(:size => 1) : (options[:pool] || Workers.pool)
+      @alive = true
+
+      @registry.register(self)
+    end
+
+    def enqueue(command, data = nil)
+      return false unless alive?
+
+      @mailbox.push(Workers::Event.new(command, data)) do
+        @pool.perform { process_events }
+      end
+
+      return true
+    end
+
+    def alive?
+      @mailbox.synchronize { return @alive }
+    end
+
+    def name
+      return @name
+    end
+
+    def identifier
+      return @name ? "#{object_id}:#{@name}" : object_id
+    end
+
+    private
+
+    def process_events
+      while (event = @mailbox.shift)
+        case event.command
+        when :shutdown
+          shutdown_handler(event)
+          @pool.shutdown if @dedicated
+          @mailbox.synchronize { @alive = false }
+        else
+          process_event(event)
+        end
+      end
+
+    rescue Exception => e
+      @alive = false
+      exception_handler(e)
+    ensure
+      @mailbox.release do
+        @pool.perform { process_events }
+      end
+
+      return nil
+    end
+
+    #
+    # Subclass and override the below methods.
+    #
+
+    def process_event(event)
+      puts "Actor (#{identifier}) processing event (#{event.inspect}) using thread (#{Thread.current.object_id})."
+    end
+
+    def exception_handler(e)
+      puts concat_e("Actor (#{identifier}) died.", e)
+    end
+
+    def shutdown_handler(event)
+      puts "Actor (#{identifier}) is shutting down."
+    end
+  end
+end

data/lib/tribe/actor.rb

@@ -1,88 +1,9 @@
 module Tribe
   class Actor
-    include Workers::Helpers
+    include Tribe::Actable
 
     def initialize(options = {})
-      @logger = Workers::LogProxy.new(options[:logger])
-      @dedicated = options[:dedicated] || false
-      @mailbox = options[:mailbox] || Tribe::Mailbox.new
-      @registry = options[:registry] || Tribe.registry
-      @name = options[:name]
-      @pool = @dedicated ? Workers::Pool.new(:size => 1) : (options[:pool] || Workers.pool)
-      @alive = true
-
-      @registry.register(self)
-    end
-
-    def enqueue(command, data = nil)
-      return false unless alive?
-
-      @mailbox.push(Workers::Event.new(command, data))
-
-      @pool.perform do
-        process_events
-      end
-
-      return true
-    end
-
-    def alive?
-      @mailbox.synchronize do
-        return @alive
-      end
-    end
-
-    def name
-      return @name
-    end
-
-    def identifier
-      return @name ? "#{object_id}:#{@name}" : object_id
-    end
-
-    private
-
-    def process_events
-      while (event = @mailbox.shift)
-        case event.command
-        when :shutdown
-          shutdown_handler(event)
-          @pool.shutdown if @dedicated
-          @mailbox.synchronize do
-            @alive = false
-          end
-        else
-          process_event(event)
-        end
-      end
-
-    rescue Exception => e
-      @alive = false
-      exception_handler(e)
-    ensure
-      @mailbox.release do
-        @pool.perform do
-          process_events
-        end
-      end
-
-      return nil
-    end
-
-    #
-    # Subclass and override the below methods.
-    #
-
-    def process_event(event)
-      puts "Actor (#{identifier}) processing event (#{event.inspect}) using thread (#{Thread.current.object_id})."
-    end
-
-    def exception_handler(e)
-      puts concat_e("Actor (#{identifier}) died.", e)
-    end
-
-    def shutdown_handler(event)
-      puts "Actor (#{identifier}) is shutting down."
+      init_actable(options)
     end
   end
 end

data/lib/tribe/mailbox.rb

@@ -5,10 +5,13 @@ module Tribe
       @mutex = Mutex.new
     end
 
-    def push(event)
+    def push(event, &block)
       @mutex.synchronize do
         @messages.push(event)
+        block.call unless @current_thread
       end
+
+      return nil
     end
 
     def shift
@@ -17,44 +20,25 @@ module Tribe
 
         @current_thread = Thread.current unless @current_thread
 
-        @messages.shift
+        return @messages.shift
       end
     end
 
-    def release(&requeue_block)
+    def release(&block)
       @mutex.synchronize do
         @current_thread = nil
-
-        if requeue_block && @messages.length > 0
-          requeue_block.call
-        end
+        block.call if block && @messages.length > 0
       end
+
+      return nil
     end
 
     def synchronize(&block)
       @mutex.synchronize do
         block.call
       end
-    end
-
-    # def obtain
-    #   @mutex.synchronize do
-    #     return false if @current_thread && @current_thread != Thread.current
 
-    #     @current_thread = Thread.current
-
-    #     return true
-    #   end
-    # end
-
-    # def release
-    #   @mutex.synchronize do
-    #     return false unless @current_thread && @current_thread == Thread.current
-
-    #     @current_thread = nil
-
-    #     return true
-    #   end
-    # end
+      return nil
+    end
   end
 end

data/lib/tribe/version.rb

@@ -1,3 +1,3 @@
 module Tribe
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/tribe.rb

@@ -1,6 +1,7 @@
 require 'workers'
 
 require 'tribe/mailbox'
+require 'tribe/actable'
 require 'tribe/actor'
 require 'tribe/dedicated_actor'
 require 'tribe/registry'
@@ -8,12 +9,12 @@ require 'tribe/registry'
 module Tribe
   def self.registry
     return @registry ||= Tribe::Registry.new
-  end 
+  end
 
   def self.registry=(val)
     @registry.dispose if @registry
-    @registry = val 
-  end 
+    @registry = val
+  end
 end
 
 # Force initialization of defaults.

data/tribe.gemspec

@@ -4,9 +4,9 @@ require File.expand_path('../lib/tribe/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Chad Remesch"]
   gem.email         = ["chad@remesch.com"]
-  gem.description   = %q{Event driven actors for Ruby}
-  gem.summary       = %q{Event driven actors for Ruby}
-  gem.homepage      = ""
+  gem.description   = %q{Tribe is a Ruby gem that implements event driven actors.}
+  gem.summary       = %q{Actors are lightweight concurrent objects that use asynchronous message passing for communication. Tribe focuses on high performance, low latency, an easy to use API, and flexibility.}
+  gem.homepage      = "https://github.com/chadrem/tribe"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tribe
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-20 00:00:00.000000000 Z
+date: 2013-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workers
@@ -27,7 +27,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.6
-description: Event driven actors for Ruby
+description: Tribe is a Ruby gem that implements event driven actors.
 email:
 - chad@remesch.com
 executables: []
@@ -41,13 +41,14 @@ files:
 - README.md
 - Rakefile
 - lib/tribe.rb
+- lib/tribe/actable.rb
 - lib/tribe/actor.rb
 - lib/tribe/dedicated_actor.rb
 - lib/tribe/mailbox.rb
 - lib/tribe/registry.rb
 - lib/tribe/version.rb
 - tribe.gemspec
-homepage: ''
+homepage: https://github.com/chadrem/tribe
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -70,5 +71,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Event driven actors for Ruby
+summary: Actors are lightweight concurrent objects that use asynchronous message passing
+  for communication. Tribe focuses on high performance, low latency, an easy to use
+  API, and flexibility.
 test_files: []