async-proxy 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Angel Faus
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,83 @@
+= async-proxy
+
+An Async proxy is a wrapper around a real object that intercepts method calls and runs them
+in an asynchronous way. 
+
+=Construction
+
+Async proxies will be generally constructed calling .async on any object. 
+
+=Behaviour
+
+Calling any method in async proxy creates a new thread in charge of running the actual computation 
+and control is immediately returned to the callee. 
+
+When the actual result of the method call is needed, call +sync+ on the returned value
+and this will wait (if necessary) for the thread to finish and provide the real value.
+
+Example:
+
+   async_recommendations = user.async.recommendations # computing the recommendations is really slow!
+
+   #do other stuff
+
+   print async_recommendations.sync
+
+=Chaining
+
+The result of a method call in an async proxy will itself be an async proxy. This allows for
+chained computations:
+
+ my_async_result = object.async.some_slow_method.and_another_one(with_an_argument).and_a_third_one
+
+ currency = user.async.country.currency
+
+Each chained method is run as soon as the previous level result is available.
+Calling sync in any dependent value will automatically wait for all dependencies.
+
+=Dependent computations
+
+Sometimes you want to run some code on the returned value as soon as it is available. With
+async proxy you do that with:
+
+- register_callback: run the code but do not care about the return value 
+ 
+   async_proxy.slow_method.register_callback{|return_value| puts return_value}
+
+- when_ready: returns yet another async proxy that lets you recover the block's returned value
+
+   squared = async_proxy.slow_method.when_ready{|return_value| return_value * return_value }
+   ..
+   squared.sync
+   
+=Automatic synchronization
+
+Some method calls automatically trigger synchronization:
+
+- to_s
+- inspect
+- each
+
+This means that in most cases you can treat an async object exactly in the same way that the
+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")
+
+= Locking and thread safety
+
+Async Proxy makes no attempt to guarantee thread safety. It can be considered as just syntactic
+sugar to automate the creations of threads, so if your code is not thread-safe or uses libraries
+that are not thread-safe mischief will happen. 
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Angel Faus. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "async-proxy"
+    gem.summary = %Q{run any method call asynchronously without caring about threads}
+    gem.description = %Q{turn any object into an async version of itself, so that all method calls will run asynchronously, including dependent computations}
+    gem.email = "angel@vlex.com"
+    gem.homepage = "http://github.com/angelf/async-proxy"
+    gem.authors = ["Angel Faus"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "async-proxy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/async-proxy.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{async-proxy}
+  s.version = "0.0.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.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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "async-proxy.gemspec",
+     "lib/async-proxy.rb",
+     "lib/computed_proxy.rb",
+     "lib/init.rb",
+     "lib/object_extensions.rb",
+     "lib/object_proxy.rb",
+     "spec/async-proxy_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/angelf/async-proxy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{run any method call asynchronously without caring about threads}
+  s.test_files = [
+    "spec/async-proxy_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/async-proxy.rb

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,52 @@
+module AsyncProxy
+  
+  # a specialization of ObjectProxy to be used when the wraped value is dependent on another
+  # async proxy and a computation (a block)
+  #
+  # will be automatically created by calling a method or +when_ready+ in any async object 
+  #
+  # the user should not directly create objects of this class
+  
+  class ComputedProxy < ObjectProxy
+    
+    attr_reader :callable
+    attr_reader :proc
+    
+    def initialize(callable, proc)
+      @callable  = callable
+      @proc      = proc
+      @callbacks = []
+    end
+    
+    def ready?
+      @ready
+    end
+    
+    def async
+      self
+    end
+    
+    def sync
+      wait_for_computation
+      @result
+    end
+
+    def launch_computation
+      @thread = Thread.new do
+        @result = @proc.call(@callable.sync)
+        @ready = true
+        run_callbacks
+      end
+    end
+
+    def wait_for_computation
+      callable.sync # ensures the callable has finished and run its callbacks
+      @thread.join if !@done
+    end
+    
+    private
+      def run_callbacks
+        @callbacks.each { |block| block.call @result }
+      end
+  end
+end

data/lib/init.rb

@@ -0,0 +1 @@
+

data/lib/object_extensions.rb

@@ -0,0 +1,11 @@
+class Object
+  # returns an async wrapper around this object
+  def async
+    AsyncProxy::ObjectProxy.new(self)
+  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
+  end
+end

data/lib/object_proxy.rb

@@ -0,0 +1,73 @@
+module AsyncProxy
+  
+  # a wrapper around an object that will intercept all method calls and run them asynchronously  
+  class ObjectProxy
+    def initialize(object)
+      @object    = object
+      @callbacks = []
+    end
+    
+    def sync
+      @object
+    end
+    
+    def async
+      self
+    end
+    
+    def to_s
+      sync.to_s
+    end
+    
+    def each
+      sync.each{yield}
+    end
+    
+    # calling +map+ on a proxy will run the block in parallel for each element
+    # of the Enumerable
+    #
+    # async_array.map(&block).each {
+    #   # starts processing the first element even if the other ones are not ready yet
+    # }
+    def map(&block)
+      when_ready do |enum|
+        enum.map do |item|
+          AsyncProxy::ResultProxy.new(item, block)
+        end
+      end
+    end
+    
+    def ready?
+      true
+    end
+    
+    # runs the block with the computation's result as the first argument
+    # as soon as the value is available
+    #
+    # returns an async proxy object, that can be used exactly to recover the block's return
+    # value or chain more computations    
+    def when_ready(&block)
+      result_proxy = AsyncProxy::ComputedProxy.new(self, block)
+      register_callback {result_proxy.launch_computation}
+      result_proxy
+    end
+
+    # called with a block, runs it as soon the computation's result is available.
+    # The return value of the block is discarded: use +when_ready+ if you are interested in the
+    # block's return value
+    def register_callback(&proc)
+      if ready?
+        proc.call(sync)
+      else
+        @callbacks << proc
+      end
+    end
+
+    private  
+      def method_missing(symbol, *args)
+        when_ready do |obj|
+          obj.send(symbol, *args)
+        end
+      end
+  end
+end

data/spec/async-proxy_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Integer
+  def slow_inc
+    Kernel.sleep(1)
+    self + 1
+  end
+end
+
+describe "AsyncProxy" do
+
+  it "sync is idempotent" do
+    1.sync.should == 1
+  end
+
+  it "async is idempotent" do
+    x = 1.async
+    x.async == x
+  end
+  
+  it "simple call" do
+    1.async.slow_inc.sync.should == 2
+  end
+  
+  it "chained call" do
+    1.async.slow_inc.div(2).sync.should == 1
+  end
+
+  it "chained call with intermediate object already synchronized" do
+    intermediate = 1.async.slow_inc
+    divided = intermediate.div(2)
+    
+    intermediate.sync
+    divided.sync.should == 1
+  end
+
+  it "chained call + when ready" do
+    1.async.slow_inc.div(2).when_ready{|one| one + 2}.sync.should == 3
+  end
+  
+  it "shared intermediate object" do
+    intermediate = 0.async.slow_inc
+    intermediate_plus_1 = intermediate.when_ready{|x| x + 1}
+    intermediate_plus_2 = intermediate.when_ready{|x| x + 2}
+
+    intermediate.sync.should == 1
+    intermediate_plus_1.sync.should == 2
+    intermediate_plus_2.sync.should == 3
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'async-proxy'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: async-proxy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Angel Faus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- async-proxy.gemspec
+- lib/async-proxy.rb
+- lib/computed_proxy.rb
+- lib/init.rb
+- lib/object_extensions.rb
+- lib/object_proxy.rb
+- spec/async-proxy_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/angelf/async-proxy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: run any method call asynchronously without caring about threads
+test_files: 
+- spec/async-proxy_spec.rb
+- spec/spec_helper.rb