async-proxy 0.0.0 → 0.1.0

data/README.rdoc

@@ -62,6 +62,14 @@ This means that in most cases you can treat an async object exactly in the same
 wrapped object. You generally don't need to make explicit +sync+ calls (although you can if
 you want to control the exact moment the object will be "realized")
 
+=Soft timeouts
+Sometimes you are interested in a value only if it can be computed in a certain time.
+
+   async_result = async_proxy.slow_method
+   ..
+   result = async_result.sync(:soft_timeout => 0.30)
+     
+
 = Locking and thread safety
 
 Async Proxy makes no attempt to guarantee thread safety. It can be considered as just syntactic

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/angelf/async-proxy"
     gem.authors = ["Angel Faus"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "system_timer"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/async-proxy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{async-proxy}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Angel Faus"]
-  s.date = %q{2010-07-04}
+  s.date = %q{2010-09-12}
   s.description = %q{turn any object into an async version of itself, so that all method calls will run asynchronously, including dependent computations}
   s.email = %q{angel@vlex.com}
   s.extra_rdoc_files = [
@@ -49,11 +49,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<system_timer>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<system_timer>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<system_timer>, [">= 0"])
   end
 end
 

data/lib/async-proxy.rb

@@ -1,4 +1,4 @@
+require 'system_timer'
 require File.join(File.dirname(__FILE__), 'object_extensions')
 require File.join(File.dirname(__FILE__), 'object_proxy')
 require File.join(File.dirname(__FILE__), 'computed_proxy')
-

data/lib/computed_proxy.rb

@@ -1,3 +1,4 @@
+
 module AsyncProxy
   
   # a specialization of ObjectProxy to be used when the wraped value is dependent on another
@@ -26,8 +27,17 @@ module AsyncProxy
       self
     end
     
-    def sync
-      wait_for_computation
+    # waits for the computation to finish and returns the actual result
+    #
+    # optional arguments:
+    #   - timeout: the maximum number of seconds that the computation can take.
+    
+    def sync(options = {})
+      if options[:timeout]
+        SystemTimer.timeout_after(options[:timeout]){wait_for_computation}
+      else
+        wait_for_computation
+      end
       @result
     end
 
@@ -41,7 +51,7 @@ module AsyncProxy
 
     def wait_for_computation
       callable.sync # ensures the callable has finished and run its callbacks
-      @thread.join if !@done
+      @thread.join unless @done
     end
     
     private

data/lib/object_extensions.rb

@@ -5,7 +5,7 @@ class Object
   end 
 
   # ensures we are dealing with the "real" synchronous object
-  def sync
-    self # a no-op in Object, will be redefine in async proxies classes
+  def sync(options = {})
+    self # a no-op in Object, will be redefined in async proxies classes
   end
 end

data/lib/object_proxy.rb

@@ -7,7 +7,7 @@ module AsyncProxy
       @callbacks = []
     end
     
-    def sync
+    def sync(options = {})
       @object
     end
     

data/spec/async-proxy_spec.rb

@@ -5,6 +5,7 @@ class Integer
     Kernel.sleep(1)
     self + 1
   end
+  
 end
 
 describe "AsyncProxy" do
@@ -48,4 +49,8 @@ describe "AsyncProxy" do
     intermediate_plus_2.sync.should == 3
   end
   
+  it "timeout" do
+    lambda {1.async.slow_inc.sync(:timeout => 0.5)}.should raise_error(Timeout::Error)
+  end
+  
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
 require 'async-proxy'
 require 'spec'
 require 'spec/autorun'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Angel Faus
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-04 00:00:00 +02:00
+date: 2010-09-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,18 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: system_timer
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: turn any object into an async version of itself, so that all method calls will run asynchronously, including dependent computations
 email: angel@vlex.com
 executables: []