mailbox 0.1.2 → 0.1.3

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+rdoc/*
+**/*.swp
+mailbox.iws
+.rakeTasks

data/README

@@ -1,7 +1,10 @@
 == About Mailbox
 
-Mailbox is a JRuby module that simplifies the creation of Actor-Model functions that are backed by JVM threads.
-"Unobtrusive concurrency for a multicore world" - pgfarley
+"Unobtrusive concurrency for a multicore world"
+
+Mailbox is a JRuby mixin that simplifies JVM thread backed message passing concurrency.
+
+Mailbox is Alpha software under active development.  Future releases may include backward compatibility breaking changes.
 
 * jretlang gem is required to use mailbox
 

data/Rakefile

@@ -11,6 +11,12 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+Rake::TestTask.new("example") do |t|
+  t.libs << "example"
+  t.test_files = FileList['example/**/*_example.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."

data/VERSION.yml

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

data/example/channel_based_log_example.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'test/unit'
+
+require File.dirname(__FILE__) + "/../lib/mailbox"
+
+class ChannelBasedLogger
+  include Mailbox
+
+  def initialize(log_channel)
+    register_channel :log_channel, log_channel
+  end
+
+  mailslot :channel => :log_channel
+  def log(message)
+    p "Logging on Thread #{Thread.current.object_id} - #{message}"
+  end
+end
+
+class ChannelBasedLogExample < Test::Unit::TestCase
+
+  def test_log_example
+    channel = JRL::Channel.new
+    logger = ChannelBasedLogger.new channel
+    p "Current Thread is #{Thread.current.object_id}"
+    channel.publish "some log message"
+  end
+
+end

data/example/i_can_has_cheese_burger_example.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'test/unit'
+
+require File.dirname(__FILE__) + "/../lib/mailbox"
+
+class ICanHasCheeseBurger
+  include Mailbox
+
+  def initialize(channel)
+    register_channel :request_channel, channel
+  end
+
+  mailslot :channel => :request_channel, :replyable => true
+  def can_you_has?
+    return "ya you can has!"
+  end
+
+end
+
+class ICanHasCheeseBurgerExample < Test::Unit::TestCase
+
+  def test_cheeseburgerz
+    i_can_has_channel = org.jetlang.channels.MemoryRequestChannel.new
+    i_can_has_cheeseburger = ICanHasCheeseBurger.new(i_can_has_channel)
+
+    sync_executor = org.jetlang.core.SynchronousDisposingExecutor.new
+    sync_fiber = org.jetlang.fibers.ThreadFiber.new(sync_executor, nil, false)
+    question = "can i has?"
+    puts question
+
+    latch = JRL::Concurrent::Latch.new(1)
+    answer = "no response!"
+    org.jetlang.channels.AsyncRequest.with_one_reply(sync_fiber, i_can_has_channel, question) do |message|
+      answer = message
+      latch.count_down
+    end
+
+    latch.await(1)
+    puts answer
+  end
+
+end

data/example/log_example.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'test/unit'
+
+require File.dirname(__FILE__) + "/../lib/mailbox"
+
+class Logger
+  include Mailbox
+
+  mailslot
+  def log(message)
+    p "Logging on Thread #{Thread.current.object_id} - #{message}"
+  end
+end
+
+class LogExample < Test::Unit::TestCase
+
+  def test_log_example
+    logger = Logger.new
+    p "Current Thread is #{Thread.current.object_id}"
+    logger.log "some log message"
+  end
+
+end

data/example/parallel_each_example.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'test/unit'
+
+require File.dirname(__FILE__) + "/../lib/mailbox"
+
+class DataProcessor
+  include Mailbox
+
+  mailslot
+  def process(data)
+    p "#{data} was processed by Thread# #{Thread.current.object_id}"
+  end
+
+end
+
+class ParallelEachExample < Test::Unit::TestCase
+
+  def test_a_simple_parallel_each
+
+    items = ["item1", "item2", "item3", "item4", "item5"]
+
+    processors = [DataProcessor.new, DataProcessor.new, DataProcessor.new]
+
+    items.each_with_index do |item, index|
+      processors[index % processors.length].process item
+    end
+
+  end
+
+end

data/example/ping_pong_example.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'test/unit'
+
+require File.dirname(__FILE__) + "/../lib/mailbox"
+
+class Player
+  include Mailbox
+
+  def initialize(sound, send_channel, recieve_channel)
+    @sound = sound
+    @send_channel = send_channel
+    register_channel :recieve_channel, recieve_channel
+  end
+
+  mailslot :channel => :recieve_channel
+  def play(last_move)
+    p "Thread [#{Thread.current.object_id}] - #{@sound} for #{last_move}"
+    @send_channel.publish @sound
+  end
+
+end
+
+class PingPongExample < Test::Unit::TestCase
+
+  def test_ping_pong
+    ping_channel = JRL::Channel.new
+    pong_channel = JRL::Channel.new
+
+    pinger = Player.new "ping", ping_channel, pong_channel
+    ponger = Player.new "pong", pong_channel, ping_channel
+
+    ping_channel.publish "ping"
+    sleep 0.001
+  end
+
+end

data/lib/mailbox.rb

@@ -1,23 +1,37 @@
+# Author:: Joel Friedman and Patrick Farley
+#
+# This module is used to simplify concurrency
+# in your application. JVM threads and JRetlang are
+# used to provide Actor model style asynchronous
+# message passing via method calls.  Named channel based
+# message passing is also supported via +register_channel+ and
+# the <tt>:channel</tt> parameter on +mailslot+.
+
 require 'rubygems'
 require 'jretlang'
 
-# Author:: Joel Friedman and Patrick Farley
+require File.dirname(__FILE__) + '/synchronized'
 
-# This module is used to simplify the using concurrency
-# in your application. Using JVM threads as the backing
-# a method can set to become an asynchronous method
-# to be used in a actor-model method. Or a method
-# can be set to be the backing of a named channel 
-# (jretlang channels are used here). 
 module Mailbox
+  include Synchronized
 
   # 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 }
+    channel_registry.select { |k,v| v[:channel] == channel_name }.each do |k,v|
+      v[:replyable] ? __subscribe_with_single_reply__(channel, k) : __subscribe__(channel, k)
+    end
   end
 
-  private 
+  class << self
+    # Used to tell +Mailbox+ that all +mailslot+ 
+    # methods should be run on the calling thread.
+    #
+    # <b>*** Intended for synchronus unit testing of concurrent apps***</b>
+    attr_accessor :synchronous
+  end
+
+  private
 
   def self.included(base)
     base.extend(Mailbox::ClassMethods)
@@ -27,65 +41,82 @@ module Mailbox
     channel.subscribe_on_fiber(__fiber__) { |*args| self.send(method, *args) }
   end
 
+  def __subscribe_with_single_reply__(channel, method)
+    channel.subscribe(__fiber__) do |message|
+      message.reply(self.send(method))
+    end
+  end
+
+  def __synchronous_fiber__
+    executor = JRL::SynchronousDisposingExecutor.new
+    fiber = JRL::Fibers::ThreadFiber.new executor, "synchronous_thread", true
+  end
+
   def __started_fiber__
-    fiber = JRL::Fiber.new
+    fiber = Mailbox.synchronous == true ? __synchronous_fiber__ : JRL::Fibers::ThreadFiber.new
     fiber.start
     fiber
   end
 
   def __fiber__
     @fiber ||= __started_fiber__
-  end 
-
-  module ClassMethods
-
-    attr_accessor :__channel_registry__
+  end
+  
+  module ClassMethods 
+    include Synchronized::ClassMethods
+  
+    # Used within +Mailbox+ module
+    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
+    # will be a +mailslot+. If <tt>:channel</tt> is provided
+    # the next method will become a subscriber on the channel.
+    # Channel based +mailslot+ methods are also made private
+    # to discourage direct invocation
     def mailslot(params={})
       @next_channel_name = params[:channel]
+      @replyable = params[:replyable]
       @mailslot = true
     end
 
     private
 
     def method_added(method_name, &block)
-      return if @adding_mailbox_to_method == method_name
-
-      return unless @mailslot == true
-
+      return super unless @mailslot == true
       @mailslot = false
 
       if @next_channel_name.nil?
         __setup_on_fiber__(method_name)
       else
-        __setup_on_channel__(method_name)
+        __setup_on_channel__(method_name, @replyable)
       end
+      
+      super
 
     end
 
     def __setup_on_fiber__(method_name)
+      return super if @is_adding_mailbox_to_method
+    
       alias_method :"__#{method_name}__", method_name
+      @is_adding_mailbox_to_method = true
 
-      @adding_mailbox_to_method = method_name
-
-      define_method( method_name, lambda do |*args| 
-        __fiber__.execute { self.send(:"__#{method_name}__", *args ) }  
+      define_method( method_name, lambda do |*args|
+        __fiber__.execute { self.send(:"__#{method_name}__", *args ) }
       end )
 
-      @adding_mailbox_to_method = nil
+      @is_adding_mailbox_to_method = false
     end
 
-    def __setup_on_channel__(method_name)
+    def __setup_on_channel__(method_name, replyable)
       private method_name
       @__channel_registry__ ||= {}
-      __channel_registry__[method_name] = @next_channel_name
+      __channel_registry__[method_name] = { :channel => @next_channel_name, :replyable => replyable } 
+      @replyable = nil
       @next_channel_name = nil
     end
 
-  end 
+  end
 
 end
 

data/lib/synchronized.rb

@@ -0,0 +1,57 @@
+# Author:: Joel Friedman and Patrick Farley
+#
+# This module goes hand in hand with +Mailbox+.
+# It simplifies concurrecncy within your 
+# JRuby applications.
+module Synchronized
+  
+  private
+  
+  def __mutex__
+    @mutex ||= Mutex.new
+  end
+  
+  def self.included(base)
+    base.extend(Synchronized::ClassMethods)
+  end
+  
+  module ClassMethods
+    
+    # Notify +Mailbox+ that the next method added
+    # will be +synchronized+. 
+    #
+    # This guarentees:
+    #     1. Two invocations of this method will not interleave and 
+    #     2. a happens-before relationship is established with any subsequent invocation.
+    # http://java.sun.com/docs/books/tutorial/essential/concurrency/syncmeth.html
+    def synchronized
+      @synchronized = true
+    end
+    
+    private
+    
+    def method_added(method_name, &block)
+      return super unless @synchronized == true
+      @synchronized = false
+      __synchronize__(method_name)
+      super
+    end
+    
+    
+    def __synchronize__(method_name)
+      return super if @is_adding_synchronized_to_method 
+      
+      alias_method :"__#{method_name}__", method_name
+      @is_adding_synchronized_to_method = true
+      
+
+      define_method( method_name, lambda do |*args| 
+        __mutex__.synchronize { self.send(:"__#{method_name}__", *args ) }  
+      end )
+      
+      @is_adding_synchronized_to_method = false
+    end
+    
+  end
+  
+end

data/mailbox.gemspec

@@ -5,23 +5,34 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mailbox}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   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-22}
+  s.date = %q{2009-11-04}
   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 = [
     "README"
   ]
   s.files = [
-    "README",
+    ".gitignore",
+     "README",
      "Rakefile",
      "VERSION.yml",
+     "example/channel_based_log_example.rb",
+     "example/i_can_has_cheese_burger_example.rb",
+     "example/log_example.rb",
+     "example/parallel_each_example.rb",
+     "example/ping_pong_example.rb",
      "lib/mailbox.rb",
+     "lib/synchronized.rb",
      "mailbox.gemspec",
-     "test/mailbox_test.rb"
+     "mailbox.iml",
+     "mailbox.ipr",
+     "test/mailbox_test.rb",
+     "test/synchronized_test.rb",
+     "test/test_helper.rb"
   ]
   s.homepage = %q{http://joelash.github.com/mailbox}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -30,7 +41,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.3}
   s.summary = %q{Mailbox is a JRuby module that simplifies concurrency and is backed by JVM threads.}
   s.test_files = [
-    "test/mailbox_test.rb"
+    "test/mailbox_test.rb",
+     "test/synchronized_test.rb",
+     "test/test_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/mailbox.iml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module relativePaths="true" type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="JRuby SDK 1.3.1" jdkType="JRUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="RModuleSettingsStorage">
+    <RMODULE_SETTINGS_STORAGE_ID NAME="NUMBER" VALUE="0" />
+  </component>
+</module>
+

data/mailbox.ipr

@@ -0,0 +1,254 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project relativePaths="false" version="4">
+  <component name="AntConfiguration">
+    <defaultAnt bundledAnt="true" />
+  </component>
+  <component name="BuildJarProjectSettings">
+    <option name="BUILD_JARS_ON_MAKE" value="false" />
+  </component>
+  <component name="CodeStyleSettingsManager">
+    <option name="PER_PROJECT_SETTINGS" />
+    <option name="USE_PER_PROJECT_SETTINGS" value="false" />
+  </component>
+  <component name="CompilerConfiguration">
+    <option name="DEFAULT_COMPILER" value="Javac" />
+    <option name="DEPLOY_AFTER_MAKE" value="0" />
+    <resourceExtensions>
+      <entry name=".+\.(properties|xml|html|dtd|tld)" />
+      <entry name=".+\.(gif|png|jpeg|jpg)" />
+    </resourceExtensions>
+    <wildcardResourcePatterns>
+      <entry name="?*.properties" />
+      <entry name="?*.xml" />
+      <entry name="?*.gif" />
+      <entry name="?*.png" />
+      <entry name="?*.jpeg" />
+      <entry name="?*.jpg" />
+      <entry name="?*.html" />
+      <entry name="?*.dtd" />
+      <entry name="?*.tld" />
+      <entry name="?*.ftl" />
+    </wildcardResourcePatterns>
+  </component>
+  <component name="CopyrightManager" default="">
+    <module2copyright />
+  </component>
+  <component name="DependencyValidationManager">
+    <option name="SKIP_IMPORT_STATEMENTS" value="false" />
+  </component>
+  <component name="EclipseCompilerSettings">
+    <option name="DEBUGGING_INFO" value="true" />
+    <option name="GENERATE_NO_WARNINGS" value="true" />
+    <option name="DEPRECATION" value="false" />
+    <option name="ADDITIONAL_OPTIONS_STRING" value="" />
+    <option name="MAXIMUM_HEAP_SIZE" value="128" />
+  </component>
+  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
+  <component name="IdProvider" IDEtalkID="2A4BC5ABDEB6DBFA33020D902AA1570C" />
+  <component name="InspectionProjectProfileManager">
+    <option name="PROJECT_PROFILE" value="Project Default" />
+    <option name="USE_PROJECT_LEVEL_SETTINGS" value="false" />
+    <scopes />
+    <profiles>
+      <profile version="1.0" is_locked="false">
+        <option name="myName" value="Project Default" />
+        <option name="myLocal" value="false" />
+      </profile>
+    </profiles>
+    <list size="0" />
+  </component>
+  <component name="JavacSettings">
+    <option name="DEBUGGING_INFO" value="true" />
+    <option name="GENERATE_NO_WARNINGS" value="false" />
+    <option name="DEPRECATION" value="true" />
+    <option name="ADDITIONAL_OPTIONS_STRING" value="" />
+    <option name="MAXIMUM_HEAP_SIZE" value="128" />
+  </component>
+  <component name="JavadocGenerationManager">
+    <option name="OUTPUT_DIRECTORY" />
+    <option name="OPTION_SCOPE" value="protected" />
+    <option name="OPTION_HIERARCHY" value="true" />
+    <option name="OPTION_NAVIGATOR" value="true" />
+    <option name="OPTION_INDEX" value="true" />
+    <option name="OPTION_SEPARATE_INDEX" value="true" />
+    <option name="OPTION_DOCUMENT_TAG_USE" value="false" />
+    <option name="OPTION_DOCUMENT_TAG_AUTHOR" value="false" />
+    <option name="OPTION_DOCUMENT_TAG_VERSION" value="false" />
+    <option name="OPTION_DOCUMENT_TAG_DEPRECATED" value="true" />
+    <option name="OPTION_DEPRECATED_LIST" value="true" />
+    <option name="OTHER_OPTIONS" value="" />
+    <option name="HEAP_SIZE" />
+    <option name="LOCALE" />
+    <option name="OPEN_IN_BROWSER" value="true" />
+  </component>
+  <component name="JikesSettings">
+    <option name="JIKES_PATH" value="" />
+    <option name="DEBUGGING_INFO" value="true" />
+    <option name="DEPRECATION" value="true" />
+    <option name="GENERATE_NO_WARNINGS" value="false" />
+    <option name="IS_EMACS_ERRORS_MODE" value="true" />
+    <option name="ADDITIONAL_OPTIONS_STRING" value="" />
+  </component>
+  <component name="Palette2">
+    <group name="Swing">
+      <item class="com.intellij.uiDesigner.HSpacer" tooltip-text="Horizontal Spacer" icon="/com/intellij/uiDesigner/icons/hspacer.png" removable="false" auto-create-binding="false" can-attach-label="false">
+        <default-constraints vsize-policy="1" hsize-policy="6" anchor="0" fill="1" />
+      </item>
+      <item class="com.intellij.uiDesigner.VSpacer" tooltip-text="Vertical Spacer" icon="/com/intellij/uiDesigner/icons/vspacer.png" removable="false" auto-create-binding="false" can-attach-label="false">
+        <default-constraints vsize-policy="6" hsize-policy="1" anchor="0" fill="2" />
+      </item>
+      <item class="javax.swing.JPanel" icon="/com/intellij/uiDesigner/icons/panel.png" removable="false" auto-create-binding="false" can-attach-label="false">
+        <default-constraints vsize-policy="3" hsize-policy="3" anchor="0" fill="3" />
+      </item>
+      <item class="javax.swing.JScrollPane" icon="/com/intellij/uiDesigner/icons/scrollPane.png" removable="false" auto-create-binding="false" can-attach-label="true">
+        <default-constraints vsize-policy="7" hsize-policy="7" anchor="0" fill="3" />
+      </item>
+      <item class="javax.swing.JButton" icon="/com/intellij/uiDesigner/icons/button.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="0" hsize-policy="3" anchor="0" fill="1" />
+        <initial-values>
+          <property name="text" value="Button" />
+        </initial-values>
+      </item>
+      <item class="javax.swing.JRadioButton" icon="/com/intellij/uiDesigner/icons/radioButton.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="0" hsize-policy="3" anchor="8" fill="0" />
+        <initial-values>
+          <property name="text" value="RadioButton" />
+        </initial-values>
+      </item>
+      <item class="javax.swing.JCheckBox" icon="/com/intellij/uiDesigner/icons/checkBox.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="0" hsize-policy="3" anchor="8" fill="0" />
+        <initial-values>
+          <property name="text" value="CheckBox" />
+        </initial-values>
+      </item>
+      <item class="javax.swing.JLabel" icon="/com/intellij/uiDesigner/icons/label.png" removable="false" auto-create-binding="false" can-attach-label="false">
+        <default-constraints vsize-policy="0" hsize-policy="0" anchor="8" fill="0" />
+        <initial-values>
+          <property name="text" value="Label" />
+        </initial-values>
+      </item>
+      <item class="javax.swing.JTextField" icon="/com/intellij/uiDesigner/icons/textField.png" removable="false" auto-create-binding="true" can-attach-label="true">
+        <default-constraints vsize-policy="0" hsize-policy="6" anchor="8" fill="1">
+          <preferred-size width="150" height="-1" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JPasswordField" icon="/com/intellij/uiDesigner/icons/passwordField.png" removable="false" auto-create-binding="true" can-attach-label="true">
+        <default-constraints vsize-policy="0" hsize-policy="6" anchor="8" fill="1">
+          <preferred-size width="150" height="-1" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JFormattedTextField" icon="/com/intellij/uiDesigner/icons/formattedTextField.png" removable="false" auto-create-binding="true" can-attach-label="true">
+        <default-constraints vsize-policy="0" hsize-policy="6" anchor="8" fill="1">
+          <preferred-size width="150" height="-1" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JTextArea" icon="/com/intellij/uiDesigner/icons/textArea.png" removable="false" auto-create-binding="true" can-attach-label="true">
+        <default-constraints vsize-policy="6" hsize-policy="6" anchor="0" fill="3">
+          <preferred-size width="150" height="50" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JTextPane" icon="/com/intellij/uiDesigner/icons/textPane.png" removable="false" auto-create-binding="true" can-attach-label="true">
+        <default-constraints vsize-policy="6" hsize-policy="6" anchor="0" fill="3">
+          <preferred-size width="150" height="50" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JEditorPane" icon="/com/intellij/uiDesigner/icons/editorPane.png" removable="false" auto-create-binding="true" can-attach-label="true">
+        <default-constraints vsize-policy="6" hsize-policy="6" anchor="0" fill="3">
+          <preferred-size width="150" height="50" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JComboBox" icon="/com/intellij/uiDesigner/icons/comboBox.png" removable="false" auto-create-binding="true" can-attach-label="true">
+        <default-constraints vsize-policy="0" hsize-policy="2" anchor="8" fill="1" />
+      </item>
+      <item class="javax.swing.JTable" icon="/com/intellij/uiDesigner/icons/table.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="6" hsize-policy="6" anchor="0" fill="3">
+          <preferred-size width="150" height="50" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JList" icon="/com/intellij/uiDesigner/icons/list.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="6" hsize-policy="2" anchor="0" fill="3">
+          <preferred-size width="150" height="50" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JTree" icon="/com/intellij/uiDesigner/icons/tree.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="6" hsize-policy="6" anchor="0" fill="3">
+          <preferred-size width="150" height="50" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JTabbedPane" icon="/com/intellij/uiDesigner/icons/tabbedPane.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="3" hsize-policy="3" anchor="0" fill="3">
+          <preferred-size width="200" height="200" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JSplitPane" icon="/com/intellij/uiDesigner/icons/splitPane.png" removable="false" auto-create-binding="false" can-attach-label="false">
+        <default-constraints vsize-policy="3" hsize-policy="3" anchor="0" fill="3">
+          <preferred-size width="200" height="200" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JSpinner" icon="/com/intellij/uiDesigner/icons/spinner.png" removable="false" auto-create-binding="true" can-attach-label="true">
+        <default-constraints vsize-policy="0" hsize-policy="6" anchor="8" fill="1" />
+      </item>
+      <item class="javax.swing.JSlider" icon="/com/intellij/uiDesigner/icons/slider.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="0" hsize-policy="6" anchor="8" fill="1" />
+      </item>
+      <item class="javax.swing.JSeparator" icon="/com/intellij/uiDesigner/icons/separator.png" removable="false" auto-create-binding="false" can-attach-label="false">
+        <default-constraints vsize-policy="6" hsize-policy="6" anchor="0" fill="3" />
+      </item>
+      <item class="javax.swing.JProgressBar" icon="/com/intellij/uiDesigner/icons/progressbar.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="0" hsize-policy="6" anchor="0" fill="1" />
+      </item>
+      <item class="javax.swing.JToolBar" icon="/com/intellij/uiDesigner/icons/toolbar.png" removable="false" auto-create-binding="false" can-attach-label="false">
+        <default-constraints vsize-policy="0" hsize-policy="6" anchor="0" fill="1">
+          <preferred-size width="-1" height="20" />
+        </default-constraints>
+      </item>
+      <item class="javax.swing.JToolBar$Separator" icon="/com/intellij/uiDesigner/icons/toolbarSeparator.png" removable="false" auto-create-binding="false" can-attach-label="false">
+        <default-constraints vsize-policy="0" hsize-policy="0" anchor="0" fill="1" />
+      </item>
+      <item class="javax.swing.JScrollBar" icon="/com/intellij/uiDesigner/icons/scrollbar.png" removable="false" auto-create-binding="true" can-attach-label="false">
+        <default-constraints vsize-policy="6" hsize-policy="0" anchor="0" fill="2" />
+      </item>
+    </group>
+  </component>
+  <component name="ProjectDetails">
+    <option name="projectName" value="mailbox" />
+  </component>
+  <component name="ProjectFileVersion" converted="true">
+    <converter id="javaee-modules" />
+    <converter id="ror-modules" />
+    <converter id="SelenaRunConfToDiana" />
+  </component>
+  <component name="ProjectKey">
+    <option name="state" value="project:///Users/garethjones/sandbox/mailbox/mailbox.ipr" />
+  </component>
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/mailbox.iml" filepath="$PROJECT_DIR$/mailbox.iml" />
+    </modules>
+  </component>
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_5" assert-keyword="true" jdk-15="true" project-jdk-name="JRuby SDK 1.3.1" project-jdk-type="JRUBY_SDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+  <component name="ResourceManagerContainer">
+    <option name="myResourceBundles">
+      <value>
+        <list size="0" />
+      </value>
+    </option>
+  </component>
+  <component name="RmicSettings">
+    <option name="IS_EANABLED" value="false" />
+    <option name="DEBUGGING_INFO" value="true" />
+    <option name="GENERATE_NO_WARNINGS" value="false" />
+    <option name="GENERATE_IIOP_STUBS" value="false" />
+    <option name="ADDITIONAL_OPTIONS_STRING" value="" />
+  </component>
+  <component name="SvnBranchConfigurationManager">
+    <option name="mySupportsUserInfoFilter" value="true" />
+  </component>
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+  <component name="WebServicesPlugin" addRequiredLibraries="true" />
+</project>
+

data/test/mailbox_test.rb

@@ -1,11 +1,4 @@
-require 'rubygems'
-require 'test/unit'
-
-require File.dirname(__FILE__) + "/../lib/mailbox"
-
-module Latches
-  include_package 'java.util.concurrent'
-end
+require 'test_helper.rb'
 
 class MailboxTest < Test::Unit::TestCase
 
@@ -15,36 +8,48 @@ class MailboxTest < Test::Unit::TestCase
       include Mailbox
 
       mailslot
-      def test_method(latch, thread_ids)
-        thread_ids << Thread.current.object_id
+      def test_method(latch, thread_info)
+        thread_info[:thread_id] = Thread.current.object_id
         latch.count_down
       end
     end
 
-    thread_ids = []
+    thread_info = {}
     latch = Latches::CountDownLatch.new( 1 )
-    klass.new.test_method(latch, thread_ids)
+    klass.new.test_method(latch, thread_info)
 
     assert( latch.await( 1, Latches::TimeUnit::SECONDS ), "Timed out" )
-    assert_not_equal Thread.current.object_id, thread_ids.first
+    assert_not_equal Thread.current.object_id, thread_info[:thread_id]
 
   end
 
-  def test_non_mailslot_methods_stay_public
+  def test_default_is_run_asynchronously
+    assert Mailbox.synchronous == false, "Mailbox is defaulting to synchronous execution"
+  end
 
-    klass = Class.new do 
-      include Mailbox
+  def test_can_set_mailslot_to_run_synchronously
+    begin
+      Mailbox.synchronous = true
+      klass = Class.new do
+        include Mailbox
+
+        mailslot
+        def test_method(thread_info)
+          thread_info[:thread_id] = Thread.current.object_id
+        end
 
-      def bar
-        "foo"
       end
-    end
 
-    assert "foo", klass.new.bar
+      thread_info = {}
+      klass.new.test_method(thread_info)
+      assert_equal Thread.current.object_id, thread_info[:thread_id]
+    ensure
+      Mailbox.synchronous = false;
+    end
 
   end
 
-  def test_should_supports_channels
+  def test_should_support_channels
 
     klass = Class.new do
       include Mailbox
@@ -54,19 +59,54 @@ class MailboxTest < Test::Unit::TestCase
       end
 
       mailslot :channel => :test_channel
-      def test_method(latch)
-        latch.count_down
+      def test_method(message)
+        message[:thread_info][:thread_id] = Thread.current.object_id
+        message[:latch].count_down
       end
     end
 
+    thread_info = {}
     latch = Latches::CountDownLatch.new 1
     a_channel = JRL::Channel.new
 
     klass.new(a_channel)
-    a_channel.publish latch
+    a_channel.publish :latch => latch, :thread_info => thread_info
 
     assert latch.await( 1, Latches::TimeUnit::SECONDS ), "Timed out" 
+    assert_not_equal Thread.current.object_id, thread_info[:thread_id]
 
   end
 
+  def test_should_support_request_channels
+
+    klass = Class.new do
+      include Mailbox
+
+      def initialize(request_channel)
+        register_channel :test_channel, request_channel
+      end
+
+      mailslot :channel => :test_channel, :replyable => true
+      def test_method
+        return "ya_rly!"
+      end
+    end
+
+    thread_info = {}
+    latch = Latches::CountDownLatch.new 1
+    request_channel = JRL::Channels::MemoryRequestChannel.new
+
+    klass.new(request_channel)
+    fiber = JRL::Fibers::ThreadFiber.new
+    fiber.start
+
+    response = "no response"
+    JRL::Channels::AsyncRequest.with_one_reply(fiber, request_channel, "orly?") do |message|
+      response = message
+      latch.count_down
+    end
+
+    assert latch.await(1, Latches::TimeUnit::SECONDS), "timed out"
+    assert_equal "ya_rly!", response
+  end
 end

data/test/synchronized_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper.rb'
+
+class SynchronizedTest < Test::Unit::TestCase
+  
+  def test_supports_synchronized_access_of_methods_by_including_synchronized
+
+    klass = Class.new do
+      include Synchronized
+
+      attr_accessor :values
+
+      def initialize
+        @values = []
+      end
+
+      synchronized
+      def test_method( value )
+        @value = value
+        @values << @value
+        sleep 1
+        @values << @value
+      end
+    end
+
+    clazz = klass.new
+
+    thread_1 = Thread.new do
+      clazz.test_method "thread 1"
+    end
+
+    sleep 0.3
+
+    thread_2 = Thread.new do
+      clazz.test_method "thread 2"
+    end
+
+    thread_1.join 1
+    thread_2.join 1
+
+    assert_equal "thread 1", clazz.values[0], "1st wrong"
+    assert_equal "thread 1", clazz.values[1], "2nd wrong"
+    assert_equal "thread 2", clazz.values[2], "3rd wrong"
+    assert_equal "thread 2", clazz.values[3], "4th wrong"
+    
+  end
+  
+  def test_supports_synchronized_access_of_methods_by_including_mailbox
+
+    klass = Class.new do
+      include Mailbox
+
+      attr_accessor :values
+
+      def initialize
+        @values = []
+      end
+
+      synchronized
+      def test_method( value )
+        @value = value
+        @values << @value
+        sleep 1
+        @values << @value
+      end
+    end
+
+    clazz = klass.new
+
+    thread_1 = Thread.new do
+      clazz.test_method "thread 1"
+    end
+
+    sleep 0.3
+
+    thread_2 = Thread.new do
+      clazz.test_method "thread 2"
+    end
+
+    thread_1.join 1
+    thread_2.join 1
+
+    assert_equal "thread 1", clazz.values[0], "1st wrong"
+    assert_equal "thread 1", clazz.values[1], "2nd wrong"
+    assert_equal "thread 2", clazz.values[2], "3rd wrong"
+    assert_equal "thread 2", clazz.values[3], "4th wrong"
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+require File.dirname(__FILE__) + "/../lib/mailbox"
+require File.dirname(__FILE__) + "/../lib/synchronized"
+
+module Latches
+  include_package 'java.util.concurrent'
+end

metadata

@@ -29,12 +29,23 @@ description: Mailbox is a JRuby module that simplifies concurrency and is backed
 specification_version: 3
 default_executable: 
 files: 
+- .gitignore
 - README
 - Rakefile
 - VERSION.yml
+- example/channel_based_log_example.rb
+- example/i_can_has_cheese_burger_example.rb
+- example/log_example.rb
+- example/parallel_each_example.rb
+- example/ping_pong_example.rb
 - lib/mailbox.rb
+- lib/synchronized.rb
 - mailbox.gemspec
+- mailbox.iml
+- mailbox.ipr
 - test/mailbox_test.rb
+- test/synchronized_test.rb
+- test/test_helper.rb
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - '>='
@@ -49,12 +60,14 @@ requirements: []
 authors: 
 - Joel Friedman
 - Patrick Farley
-date: 2009-10-22 05:00:00 +00:00
+date: 2009-11-04 06:00:00 +00:00
 platform: ruby
 test_files: 
 - test/mailbox_test.rb
+- test/synchronized_test.rb
+- test/test_helper.rb
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 require_paths: 
 - lib
 dependencies: