mailbox 0.2.0 → 0.2.1

data/.gitignore

@@ -4,4 +4,5 @@ rdoc/*
 mailbox.iws
 .rakeTasks
 TAGS
+tags
 run_tags.rb

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 0
+:patch: 1
 :build: 

data/lib/mailbox.rb

@@ -23,6 +23,10 @@ module Mailbox
     end
   end
 
+  def verbose_output_to method_name
+    @verbose_target = method_name
+  end
+
   class << self
     # Used to tell +Mailbox+ that all +mailslot+ 
     # methods should be run on the calling thread.
@@ -37,7 +41,9 @@ module Mailbox
   end
 
   def __subscribe__(channel, method)
-    channel.subscribe_on_fiber(__fiber__) { |*args| self.send(method, *args) }
+    channel.subscribe_on_fiber(__fiber__) do |*args|
+      self.send(method, *args)
+    end
   end
 
   def __subscribe_with_single_reply__(channel, method)
@@ -82,6 +88,7 @@ module Mailbox
     def mailslot(params={})
       @next_channel_name = params[:channel]
       @replyable = params[:replyable]
+      @timeout = params[:timeout].nil? ? -1 : params[:timeout] * 1000
       @exception = params[:exception]
       @mailslot = true
     end
@@ -93,7 +100,7 @@ module Mailbox
       @mailslot = false
 
       if @next_channel_name.nil?
-        __setup_on_fiber__(method_name, @replyable)
+        __setup_on_fiber__(method_name, @replyable, @timeout)
       else
         __setup_on_channel__(method_name, @replyable)
       end
@@ -102,7 +109,7 @@ module Mailbox
 
     end
 
-    def __setup_on_fiber__(method_name, replyable)
+    def __setup_on_fiber__(method_name, replyable, timeout)
       return super if __is_adding_mailbox_to_method__
     
       alias_method :"__#{method_name}__", method_name
@@ -110,13 +117,16 @@ module Mailbox
 
       exception_method, @exception = @exception, nil
       define_method method_name do |*args|
-        
+
+        self.send(@verbose_target, "enqueued #{method_name}") if defined? @verbose_target
+
         result = nil
         latch = JRL::Concurrent::CountDownLatch.new(1) if replyable
-        
-        __fiber__.execute do 
+
+        __fiber__.execute do
           begin
-            result = self.send(:"__#{method_name}__", *args ) 
+            self.send(@verbose_target, "dequeued #{method_name}") if defined? @verbose_target
+            result = self.send(:"__#{method_name}__", *args )
           rescue Exception => ex
             raise if exception_method.nil?
             self.send(:"#{exception_method}", ex)
@@ -124,8 +134,18 @@ module Mailbox
             latch.count_down if replyable
           end
         end
-      
-        latch.await if replyable
+
+        is_timeout = false
+        if replyable
+          if timeout == -1
+            latch.await
+          else
+            is_timeout = !(latch.await timeout, JRL::Concurrent::TimeUnit::MILLISECONDS)
+          end
+        end
+
+        raise Exception.new("#{method_name} message timeout after #{timeout/1000} seconds") if is_timeout
+
         return result
       
       end 

data/mailbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mailbox}
-  s.version = "0.2.0"
+  s.version = "0.2.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{2010-03-09}
+  s.date = %q{2010-04-21}
   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 = [

data/mailbox.iml

@@ -3,11 +3,8 @@
   <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="jdk" jdkName="JRuby SDK 1.4.0" 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

@@ -1,18 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project relativePaths="false" version="4">
+<project 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)" />
@@ -29,6 +24,7 @@
       <entry name="?*.tld" />
       <entry name="?*.ftl" />
     </wildcardResourcePatterns>
+    <annotationProcessing enabled="false" useClasspath="true" />
   </component>
   <component name="CopyrightManager" default="">
     <module2copyright />
@@ -37,33 +33,11 @@
     <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" />
@@ -81,14 +55,6 @@
     <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">
@@ -213,11 +179,6 @@
   <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>
@@ -236,13 +197,6 @@
       </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>

data/test/mailbox_test.rb

@@ -142,12 +142,82 @@ class MailboxTest < Test::Unit::TestCase
 
       mailslot :replyable => true
       def test_method
-        "response"
+        ["response", JThread.current_thread.name]
       end
     end
   
-    assert_equal "response", klass.new.test_method
+    response, name = klass.new.test_method
+    assert_equal "response", response
+    assert_not_equal JThread.current_thread.name, name
 
   end
 
+  def test_replyable_messages_should_respect_timeout
+
+    klass = Class.new do
+      include Mailbox
+
+      mailslot :replyable => true, :timeout => 0.1
+      def test_method
+        sleep 1
+      end
+    end
+  
+    e = assert_raise(Exception) { klass.new.test_method }
+    assert_equal e.message, "test_method message timeout after 0.1 seconds"
+
+  end
+
+  def test_replyable_messages_should_respect_non_timeout
+
+    klass = Class.new do
+      include Mailbox
+
+      mailslot :replyable => true, :timeout => 1
+      def test_method
+        return 'ok'
+      end
+    end
+
+    assert_equal 'ok', klass.new.test_method 
+
+  end
+
+  def test_should_expose_hooks_to_message_enqueue_and_dequeue
+
+
+    klass = Class.new do
+      include Mailbox
+      attr_accessor :msg_info
+
+      def initialize(latch)
+        verbose_output_to :msg_monitor
+
+        @latch = latch
+        @msg_info = []
+      end
+
+      mailslot :replyable => true
+      def test_method
+        @latch.count_down
+      end
+
+      def msg_monitor(info)
+        @msg_info << info
+      end
+
+    end
+
+    latch = JRL::Concurrent::Latch.new 2
+
+    test_agent = klass.new latch
+    test_agent.test_method
+    test_agent.test_method
+
+    assert latch.await(1), "timed out waiting for test_method to trip latch twice"
+
+    expected = ['enqueued test_method', 'dequeued test_method', 'enqueued test_method', 'dequeued test_method']
+    assert_equal expected, test_agent.msg_info
+  end
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 2
-    - 0
-  version: 0.2.0
+    - 1
+  version: 0.2.1
 platform: ruby
 authors: 
   - Joel Friedman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-09 00:00:00 -06:00
+date: 2010-04-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency