mailbox 0.1.0 → 0.1.1

data/Rakefile

@@ -1,27 +1,36 @@
 require "rubygems"
 require "rake/testtask"
+require "rake/rdoctask"
 require "jeweler"
 
 task :default => :test
 
 Rake::TestTask.new do |t|
-	t.libs << "test"
-	t.test_files = FileList['test/**/*_test.rb']
-	t.verbose = true
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
 end
 
 Jeweler::Tasks.new do |gemspec|
-	gemspec.name = "mailbox"
-	gemspec.summary = "Mailbox is a JRuby module that simplifies concurrency and is backed by JVM threads."
-	gemspec.description = gemspec.summary
-	gemspec.email = "asher.friedman@gmail.com"
-	gemspec.homepage = "http://joelash.github.com/mailbox"
-	gemspec.authors = ["Joel Friedman", "Patrick Farley"]
-
-	gemspec.rubyforge_project = "mailbox"
+  gemspec.name = "mailbox"
+  gemspec.summary = "Mailbox is a JRuby module that simplifies concurrency and is backed by JVM threads."
+  gemspec.description = gemspec.summary
+  gemspec.email = "asher.friedman@gmail.com"
+  gemspec.homepage = "http://joelash.github.com/mailbox"
+  gemspec.authors = ["Joel Friedman", "Patrick Farley"]
+
+  gemspec.add_dependency "jretlang"
+
+  gemspec.rubyforge_project = "mailbox"
 end
 
 Jeweler::RubyforgeTasks.new do |rubyforge|
-	rubyforge.doc_task = "rdoc"
+  rubyforge.doc_task = "rdoc"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.main = "README"
+  rdoc.rdoc_files.include("README", "lib/**/*.rb")
+  rdoc.rdoc_dir = "rdoc"
 end
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 1
 :major: 0
-:patch: 0
+:patch: 1

data/lib/mailbox.rb

@@ -1,78 +1,94 @@
 require 'rubygems'
 require 'jretlang'
 
+# Author:: Joel Friedman and Patrick Farley
+
+# This module is used to simplify the using concurrency
+# in your application. Using JVM threads as the backing
+# a function can set to become an asynchronous function
+# to be used in a actor-model method. Or a function
+# can be set to be the backing of a named channel 
+# (jretlang channels are used here). 
 module Mailbox
 
+  # Register your jretlang channel as a named channel
+  def register_channel(channel_name, channel)
+    channel_registry = self.class.__channel_registry__
+    channel_registry.each_pair { |key, value| __subscribe__(channel, key) if value == channel_name }
+  end
+
+  private 
+
   def self.included(base)
-		base.extend(Mailbox::ClassMethods)
-	end
-	
-	def register_channel(channel_name, channel)
-		channel_registry = self.class.__channel_registry__
-		channel_registry.each_pair { |key, value| __subscribe__(channel, key) if value == channel_name }
-	end
-
-	def __subscribe__(channel, method)
-		channel.subscribe_on_fiber(__fiber__) { |*args| self.send(method, *args) }
-	end
+    base.extend(Mailbox::ClassMethods)
+  end
+
+  def __subscribe__(channel, method)
+    channel.subscribe_on_fiber(__fiber__) { |*args| self.send(method, *args) }
+  end
 
   def __started_fiber__
-  	fiber = JRL::Fiber.new
-  	fiber.start
-  	fiber
+    fiber = JRL::Fiber.new
+    fiber.start
+    fiber
   end
 
   def __fiber__
-  	@fiber ||= __started_fiber__
+    @fiber ||= __started_fiber__
   end 
 
-	module ClassMethods
+  module ClassMethods
+
+    attr_accessor :__channel_registry__
 
- 		attr_accessor :__channel_registry__
+    # Notifies Mailbox that the next method added
+    # will be a 'mailslot'. If :channel is provided
+    # then it'll become a subscriber on that channel
+    def mailslot(params={})
+      @next_channel_name = params[:channel]
+      @mailslot = true
+    end
 
-  	def mailslot(params={})
-			@next_channel_name = params[:channel]
-			@mailslot = true
-  	end
+    private
 
-  	def method_added(method_name, &block)
-  		return if @adding_mailbox_to_method == method_name
+    def method_added(method_name, &block)
+      return if @adding_mailbox_to_method == method_name
 
-  		unless @mailslot == true
-  		  private method_name
-  			return
-  		end
+      unless @mailslot == true
+        private method_name
+        return
+      end
 
-  		@mailslot = false
+      @mailslot = false
 
-			if @next_channel_name.nil?
-				__setup_on_fiber__(method_name)
-			else
-				__setup_on_channel__(method_name)
-			end
+      if @next_channel_name.nil?
+        __setup_on_fiber__(method_name)
+      else
+        __setup_on_channel__(method_name)
+      end
 
-  	end
+    end
 
-		def __setup_on_fiber__(method_name)
-  		alias_method :"__#{method_name}__", method_name
+    def __setup_on_fiber__(method_name)
+      alias_method :"__#{method_name}__", method_name
 
-  		@adding_mailbox_to_method = method_name
+      @adding_mailbox_to_method = method_name
 
-			define_method( method_name, lambda do |*args| 
-				__fiber__.execute { self.send(:"__#{method_name}__", *args ) }  
-			end )
+      define_method( method_name, lambda do |*args| 
+        __fiber__.execute { self.send(:"__#{method_name}__", *args ) }  
+      end )
 
-  		@adding_mailbox_to_method = nil
-		end
+      @adding_mailbox_to_method = nil
+    end
 
-		def __setup_on_channel__(method_name)
-			private method_name
-			@__channel_registry__ ||= {}
-			__channel_registry__[method_name] = @next_channel_name
-			@next_channel_name = nil
-		end
+    def __setup_on_channel__(method_name)
+      private method_name
+      @__channel_registry__ ||= {}
+      __channel_registry__[method_name] = @next_channel_name
+      @next_channel_name = nil
+    end
+
+  end 
 
-	end 
-	
 end
 

data/mailbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mailbox}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joel Friedman", "Patrick Farley"]
-  s.date = %q{2009-10-13}
+  s.date = %q{2009-10-18}
   s.description = %q{Mailbox is a JRuby module that simplifies concurrency and is backed by JVM threads.}
   s.email = %q{asher.friedman@gmail.com}
   s.extra_rdoc_files = [
@@ -38,8 +38,11 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jretlang>, [">= 0"])
     else
+      s.add_dependency(%q<jretlang>, [">= 0"])
     end
   else
+    s.add_dependency(%q<jretlang>, [">= 0"])
   end
 end

data/test/mailbox_test.rb

@@ -4,71 +4,70 @@ require 'test/unit'
 require File.dirname(__FILE__) + "/../lib/mailbox"
 
 module Latches
-	include_package 'java.util.concurrent'
+  include_package 'java.util.concurrent'
 end
 
 class MailboxTest < Test::Unit::TestCase
 
-	def test_mailslot_causes_execution_on_separate_thread
-		
-		klass = Class.new do
-			include Mailbox
-
-			mailslot
-			def test_method(latch, thread_ids)
-				thread_ids << Thread.current.object_id
-				latch.count_down
-			end
-		end
-
-		thread_ids = []
-		latch = Latches::CountDownLatch.new( 1 )
-		klass.new.test_method(latch, thread_ids)
-
-		assert( latch.await( 1, Latches::TimeUnit::SECONDS ), "Timed out" )
-		assert_not_equal Thread.current.object_id, thread_ids.first
-
-	end
-
-	def test_non_mailslot_methods_become_private
-
-		klass = Class.new do 
-			include Mailbox
-
-			def bar
-			end
-		end
-
-		exception = assert_raise NoMethodError do
-			klass.new.bar
-		end
-		
- 		assert_match /private method `bar'/, exception.message
-	end
-	
-	def test_should_supports_channels
-
-		klass = Class.new do
-			include Mailbox
-			
-			def initialize(channel)
- 		    register_channel :test_channel, channel
-		  end
-
-			mailslot :channel => :test_channel
-			def test_method(latch)
-				latch.count_down
-			end
-		end
-	  
-		thread_ids = []
-		latch = Latches::CountDownLatch.new 1
-		a_channel = JRL::Channel.new
-	
-		klass.new(a_channel)
+  def test_mailslot_causes_execution_on_separate_thread
+
+    klass = Class.new do
+      include Mailbox
+
+      mailslot
+      def test_method(latch, thread_ids)
+        thread_ids << Thread.current.object_id
+        latch.count_down
+      end
+    end
+
+    thread_ids = []
+    latch = Latches::CountDownLatch.new( 1 )
+    klass.new.test_method(latch, thread_ids)
+
+    assert( latch.await( 1, Latches::TimeUnit::SECONDS ), "Timed out" )
+    assert_not_equal Thread.current.object_id, thread_ids.first
+
+  end
+
+  def test_non_mailslot_methods_become_private
+
+    klass = Class.new do 
+      include Mailbox
+
+      def bar
+      end
+    end
+
+    exception = assert_raise NoMethodError do
+      klass.new.bar
+    end
+
+    assert_match /private method `bar'/, exception.message
+  end
+
+  def test_should_supports_channels
+
+    klass = Class.new do
+      include Mailbox
+
+      def initialize(channel)
+        register_channel :test_channel, channel
+      end
+
+      mailslot :channel => :test_channel
+      def test_method(latch)
+        latch.count_down
+      end
+    end
+
+    latch = Latches::CountDownLatch.new 1
+    a_channel = JRL::Channel.new
+
+    klass.new(a_channel)
     a_channel.publish latch
-	
-		assert latch.await( 1, Latches::TimeUnit::SECONDS ), "Timed out" 
+
+    assert latch.await( 1, Latches::TimeUnit::SECONDS ), "Timed out" 
 
   end
 

metadata

@@ -49,15 +49,24 @@ requirements: []
 authors: 
 - Joel Friedman
 - Patrick Farley
-date: 2009-10-13 05:00:00 +00:00
+date: 2009-10-18 05:00:00 +00:00
 platform: ruby
 test_files: 
 - test/mailbox_test.rb
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 require_paths: 
 - lib
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - '>='
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+  type: :runtime
+  version_requirement: 
+  name: jretlang
 bindir: bin
 has_rdoc: true