em-promise 1.0.0 → 1.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.textile

@@ -0,0 +1,32 @@
+h1. EM-Promise
+
+A promise/deferred implementation inspired by "AngularJS":http://docs.angularjs.org/api/ng.$q see this documentation for use cases.
+
+From the perspective of dealing with error handling, deferred and promise apis are to asynchronous programing what try, catch and throw keywords are to synchronous programming.
+
+<pre><code class="ruby">
+def asyncGreet(name)
+	deferred = EM::Defer.new
+	
+	EM::Timer.new(5) do
+		EM.defer do
+			deferred.resolve("Hello #{name}")
+		end
+	end
+	
+	deferred.promise
+end
+
+
+EventMachine.run do
+
+	promise = asyncGreet('Robin Hood')
+	promise.then(proc { |greeting|
+		p "Success: #{greeting}"
+	}, proc { |reason|
+		p "Failed: #{reason}"
+	})
+	
+end
+
+</code></pre>

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => [:spec]

data/lib/em-promise.rb

@@ -0,0 +1,3 @@
+require 'eventmachine'
+
+require 'em-promise/defer.rb'

data/lib/em-promise/defer.rb

@@ -0,0 +1,181 @@
+
+
+module EventMachine
+	#
+	# Creates a 'Deferred' object which represents a task which will finish in the future.
+	#
+	class Defer
+		
+		class Promise
+		end
+		
+		class DeferredPromise < Promise
+			def initialize(defer)
+				@defer = defer
+			end
+			
+			
+			def then(callback = nil, errback = nil, &blk)
+				result = Defer.new
+				
+				callback ||= blk
+				
+				wrappedCallback = proc { |value|
+					begin
+						result.resolve(callback.nil? ? value : callback.call(value))
+					rescue => e
+						#
+						# TODO:: add debugging output here
+						#
+						result.reject(e);
+					end
+				}
+				
+				wrappedErrback = proc { |reason|
+					begin
+						result.resolve(errback.nil? ? Defer.reject(reason) : errback.call(reason))
+					rescue => e
+						#
+						# TODO:: add debugging output here
+						#
+						result.reject(e);
+					end
+				}
+				
+				#
+				# Schedule as we are touching arrays
+				# => Everything else is locally scoped
+				#
+				EM.schedule do
+					pending_array = pending
+					
+					if pending_array.nil?
+						value.then(wrappedCallback, wrappedErrback)
+					else
+						pending_array << [wrappedCallback, wrappedErrback]
+					end
+				end
+				
+				result.promise
+			end
+			
+			
+			protected
+			
+			
+			def pending
+				@defer.instance_eval { @pending }
+			end
+			
+			def value
+				@defer.instance_eval { @value }
+			end
+		end
+		
+		
+		class ResolvedPromise < Promise
+			def initialize(response, error = false)
+				@error = error
+				@response = response
+			end
+			
+			def then(callback = nil, errback = nil, &blk)
+				result = Defer.new
+				
+				callback ||= blk
+				
+				EM.next_tick {
+					if @error
+						result.resolve(errback.nil? ? Defer.reject(@response) : errback.call(@response))
+					else
+						result.resolve(callback.nil? ? @response : callback.call(@response))
+					end
+				}
+				
+				result.promise
+			end
+		end
+		
+		
+		def initialize
+			@pending = []
+			@value = nil
+		end
+		
+		
+		def resolve(val = nil)
+			EM.schedule do
+				if !!@pending
+					callbacks = @pending
+					@pending = nil
+					@value = ref(val)
+					
+					if callbacks.length > 0
+						EM.next_tick {
+							callbacks.each do |callback|
+								@value.then(callback[0], callback[1])
+							end
+						}
+					end
+				end
+			end
+		end
+		
+		
+		def reject(reason = nil)
+			resolve(Defer.reject(reason))
+		end
+		
+		
+		def promise
+			DeferredPromise.new( self )
+		end
+		
+		
+		#
+		# Creates a promise that is resolved as rejected with the specified reason. This api should be
+		# used to forward rejection in a chain of promises. If you are dealing with the last promise in
+		# a promise chain, you don't need to worry about it.
+		#
+		# When comparing deferreds/promises to the familiar behaviour of try/catch/throw, think of
+		# reject as the raise keyword in Ruby. This also means that if you "catch" an error via
+		# a promise error callback and you want to forward the error to the promise derived from the
+		# current promise, you have to "rethrow" the error by returning a rejection constructed via
+		# reject.
+		#
+		# @example handling rejections
+		#
+		#   #!/usr/bin/env ruby
+		#
+		#   require 'rubygems' # or use Bundler.setup
+		#   require 'eventmachine'
+		#
+		#   promiseB = promiseA.then(lambda {|result|
+		#     # success: do something and resolve promiseB with the old or a new result
+		#     return result
+		#   }, lambda {|reason|
+		#     # error: handle the error if possible and resolve promiseB with newPromiseOrValue,
+		#     #        otherwise forward the rejection to promiseB
+		#     if canHandle(reason)
+		#       # handle the error and recover
+		#       return newPromiseOrValue
+		#     end
+		#     return Defer.reject(reason)
+		#   })
+		#
+		# @param [Object] reason constant, message, exception or an object representing the rejection reason.
+		def self.reject(reason = nil)
+			return ResolvedPromise.new( reason, true )	# A resolved failed promise
+		end
+		
+		
+		protected
+		
+		
+		def ref(value)
+			return value if value.is_a?(Promise)
+			return ResolvedPromise.new( value )			# A resolved success promise
+		end
+	end
+
+end

data/lib/em-promise/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+	class Defer
+		VERSION = "1.0.1"
+	end
+end

data/spec/defer.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'em-promise'
+
+
+describe EventMachine::Defer do
+
+	
+	it "should fulfill the promise and execute all success callbacks in the registration order" do
+		EventMachine.run {
+			proc { |name|
+				deferred = EM::Defer.new
+				EM.defer { deferred.resolve("Hello #{name}") }
+				deferred.promise.then(proc {|result|
+					result += "?"
+					result
+				})
+			}.call('Robin Hood').then(proc { |greeting|
+				greeting.should == 'Hello Robin Hood?'
+				EventMachine.stop
+			}, proc { |reason|
+				fail(reason)
+				EventMachine.stop
+			})
+		}
+	end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-promise
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-20 00:00:00.000000000 Z
+date: 2012-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -49,7 +49,14 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/em-promise/defer.rb
+- lib/em-promise/version.rb
+- lib/em-promise.rb
+- MIT-LICENSE
+- Rakefile
+- README.textile
+- spec/defer.rb
 homepage: https://github.com/cotag/em-promise
 licenses: []
 post_install_message: 
@@ -74,4 +81,5 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: EventMachine based, promise/deferred implementation
-test_files: []
+test_files:
+- spec/defer.rb