tribe 0.0.4 → 0.0.5

data/README.md

@@ -1,6 +1,7 @@
 # Tribe
 
-Actor Model for Ruby.  Currently experimental and not recommend for production.
+Tribe is a Ruby gem that implements event driven actors.
+Actors are light weight concurrent objects that use asynchronous message passing for communication.
 
 ## Installation
 
@@ -16,6 +17,86 @@ Or install it yourself as:
 
     $ gem install tribe
 
+## Actors
+
+    # Create your custom actor class.
+    class MyActor < Tribe::Actor
+      private
+      def initialize(options = {})
+        super
+      end
+      
+      def process_event(event)
+       case event.command
+       when :my_custom
+         my_custom_handler(event)
+       end
+      end
+      
+      def my_custom_handler(event)
+        puts "Received a custom event (#{event.inspect})"
+      end
+      
+      def exception_handler(e)
+        puts concat_e("MyActor (#{identifier}) died.", e)
+      end
+      
+      def shutdown_handler(event)
+        puts "MyActor (#{identifier}) is shutting down.  Put cleanup code here."
+      end
+    end
+    
+    # Create some named actors.
+    100.times do |i|
+      MyActor.new(:name => "my_actor_#{i}")
+    end
+    
+    # Send an event to each actors.  Find each actor using the registry.
+    100.times do |i|
+      actor = Tribe.registry["my_actor_#{i}"]
+      actor.enqueue(:my_custom, 'hello world')
+    end
+    
+    # Shutdown the actors.
+    100.times do |i|
+      actor = Tribe.registry["my_actor_#{i}"]
+      actor.enqueue(:shutdown)
+    end
+
+### Implementation notes
+Because actors use a shared thread pool, it is important that they don't block for long periods of time.
+Actors that block for long periods of time should use a dedicated thread (:dedicated => true or subclass from Tribe::DedicatedActor).
+
+## Registries
+
+Registries hold references to named actors.
+In general you shouldn't have to create your own since there is a global one (Tribe.registry).
+
+## Options (defaults below):
+
+    actor = Tribe::Actor.new(
+      :logger => nil,                   # Ruby logger instance.
+      :dedicated => false,              # If true, the actor runs with a worker pool that has one thread.
+      :pool => Workers.pool,            # The workers pool used to execute events.
+      :mailbox => Tribe::Mailbox.new,   # The mailbox used to receive events.
+      :registry => Tribe.registry,      # The registry used to store a reference to the actor if it has a name.
+      :name => nil                      # The name of the actor (must be unique in the registry).
+    )
+
+    actor = Tribe::DedicatedActor.new(
+      :logger => nil,                   # Ruby logger instance.
+      :mailbox => Tribe::Mailbox.new,   # The mailbox used to receive events.
+      :registry => Tribe.registry,      # The registry used to store a reference to the actor if it has a name.
+      :name => nil                      # The name of the actor (must be unique in the registry).
+    )
+
+## TODO - missing features
+
+- Futures.
+- Workers::Timer integration.
+- Supervisors.
+- Linking.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,106 +1,13 @@
-#!/usr/bin/env rake
-require 'bundler/gem_tasks'
-require 'benchmark'
+require "bundler/gem_tasks"
 
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts(e.message)
-  $stderr.puts("Run `bundle install` to install missing gems")
-  exit e.status_code
-end
-
-task :environment do
+desc 'Start an IRB console with Workers loaded'
+task :console do
   $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
-  require 'tribe'
-end
 
-desc 'Start an IRB console with offier loaded'
-task :console => :environment do
+  require 'tribe'
   require 'irb'
 
   ARGV.clear
 
   IRB.start
 end
-
-desc 'Demo mode (temporary)'
-task :demo => :environment do
-  $demo_queue = Queue.new
-  $demo_mutex = Mutex.new
-
-  def locked_puts(msg)
-    $demo_mutex.synchronize { puts msg }
-  end
-
-  DEMO_ACTOR_COUNT = 100
-  DEMO_MSG_COUNT = 3000
-
-  class MyActor < Tribe::Actor
-
-    def pre_init
-      reset_count
-    end 
-
-    def increment
-      @count += 1
-
-      if @count >= DEMO_MSG_COUNT
-        locked_puts("#{@name} done.")
-        $demo_queue.push(@name)
-      end
-    end
-
-    def reset_count
-      @count = 0
-    end
-
-    def go(friend_name)
-      friend = Tribe.registry[friend_name]
-
-      DEMO_MSG_COUNT.times do
-        friend.increment!
-      end
-    end
-  end
-
-  def tribe_demo
-    actors = []
-
-    locked_puts('Create actors...')
-    (0...DEMO_ACTOR_COUNT).each do |i|
-      name = i.to_s
-      actor = Tribe.registry[name] || MyActor.new(:name => name)
-      actors.push(actor)
-      locked_puts(name)
-    end
-
-    locked_puts('Resetting...')
-    actors.each do |actor|
-      actor.reset_count!
-    end
-
-    locked_puts('Go...')
-    actors.each do |actor|
-      friend = actor.name.to_i
-      friend += 1
-      friend = 0 if friend == DEMO_ACTOR_COUNT
-      friend = friend.to_s
-
-      locked_puts("pair: #{actor.name}, #{friend}")
-      actor.go!(friend)
-    end
-
-    locked_puts('Benchmark...')
-    result = Benchmark.realtime do
-      DEMO_ACTOR_COUNT.times do
-        $demo_queue.pop
-      end
-    end
-
-    nil
-  end
-
-  tribe_demo
-end
-

data/lib/tribe/version.rb

@@ -1,3 +1,3 @@
 module Tribe
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/tribe.gemspec

@@ -5,7 +5,7 @@ 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 designed for high performance.}
+  gem.summary       = %q{Event driven actors for Ruby}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($\)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tribe
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -59,22 +59,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2679671106278227985
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2679671106278227985
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Event driven actors for Ruby designed for high performance.
+summary: Event driven actors for Ruby
 test_files: []