hungryblank-event_utils 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Paolo Negri
+
+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,34 @@
+= event_utils
+
+EventUtils is meant to provide modules and classes to help building services
+on top of EventMachine without having to cope with some of the mechnics of
+eventmachine itself.
+
+the first implemented facility is EventUtils::DeferredLoop
+
+it makes possible to perform action on groups of deferrable objects in an
+intuitive way, and without having to take care of starting/stopping the
+EventMachine reactor
+
+example:
+
+  d1 and d2 are two deferrables
+  and we want to compare them but the comparaison is only feasible when
+  d1 and d2 have both deferred status set.
+
+  In this case the code will look like
+
+  require 'event_utils'
+  include EventUtils
+
+  in_deferred_loop do
+    waiting_for d1, d2 do
+      d1 > d2
+    end
+  end
+
+Check http://assertbuggy.blogspot.com for further informations and tutorials
+
+== Copyright
+
+Copyright (c) 2009 Paolo Negri. See LICENSE for details.

data/lib/event_utils.rb

@@ -0,0 +1,7 @@
+require 'eventmachine'
+Dir.glob(File.dirname(__FILE__) + '/event_utils/**/*.rb').each do |lib|
+  require lib
+end
+
+module EventUtils
+end

data/lib/event_utils/evented_loop.rb

@@ -0,0 +1,93 @@
+module EventUtils
+
+  class DeferredChildFailure < StandardError
+  end
+
+  class DeferredLoop
+
+      def self.main_loop
+        @main_loop ||= new(:main)
+      end
+
+
+    attr_accessor :success, :failure
+
+    include EM::Deferrable
+
+    def initialize(main=false)
+      self.class.main_loop.wait_for(self) unless main
+      @success, @failure = 0, 0
+      @waiting_for = []
+    end
+
+    #takes a list of deferrables to wait for before executing the callback
+    def waiting_for(*deferrables, &block)
+      deferrables.each { |d| wait_for(d) }.size
+      callback  { block.call } if block_given?
+      errback { raise DeferredChildFailure, "#{failure} deferred entities failed" }
+      self
+    end
+
+    #callback used by deferrables the loop is waiting for, it increases failure or
+    #success depending by the child outcome
+    def child_returned(outcome)
+      send(outcome.to_s + '=', send(outcome) + 1)
+      terminate if complete?
+    end
+
+    #add a deferrable to the list of deferrables to wait for
+    def wait_for(deferrable)
+      @waiting_for << deferrable
+      deferrable.callback { self.child_returned :success }
+      deferrable.errback { self.child_returned :failure }
+    end
+
+    private
+
+    def complete?
+      @waiting_for.size == success + failure
+    end
+
+    #sets the deferred status depending by outcomes of children
+    #it fails if one or more children failed
+    def terminate
+      failure == 0 ? self.succeed : self.fail
+    end
+
+  end
+
+  #Wraps the clode in the provided block in an EM loop if needed
+  #
+  #  in_deferred_loop do
+  #    your code using deferrables here
+  #  end
+  #
+  def in_deferred_loop(&block)
+    drive_reactor = !EM.reactor_running?
+    if drive_reactor
+      EM.run do
+        DeferredLoop.main_loop.callback { EM.stop }
+        DeferredLoop.main_loop.errback { EM.stop }
+        yield
+      end
+    else
+      yield
+    end
+  end
+
+  #waits until all the deferrables have the deferred status set and then
+  #executes the code in the provided block
+  #
+  #  in_deferred_loop do
+  #    waiting_for deferrable_1, deferrable_2, ..., deferrable_n do
+  #      code that needs all the deferrable deferred status set here
+  #    end
+  #  end
+  #
+  def waiting_for(*deferrables, &block)
+    deferred_loop = DeferredLoop.new
+    deferred_loop.waiting_for(*deferrables, &block)
+    deferred_loop
+  end
+
+end

data/test/deferred_loop_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+include EventUtils
+
+class DeferredLoopTest < Test::Unit::TestCase
+
+  should "add callback end errback to deferrables it's waiting for" do
+    deferrable = Mocha::Mock.new
+    deferrable.expects(:callback)
+    deferrable.expects(:errback)
+    deferred_loop = DeferredLoop.new
+    deferred_loop.wait_for deferrable
+  end
+
+  should "evaluate completion on child returned" do
+    deferred_loop = DeferredLoop.new
+    deferred_loop.expects(:complete?)
+    deferred_loop.child_returned(:success)
+  end
+
+  should "complete when number of success + failures equal waiting for" do
+    deferred_loop = DeferredLoop.new
+    deferred_loop.instance_variable_set('@waiting_for', [1, 2, 3])
+    deferred_loop.success = 2
+    assert !deferred_loop.send(:complete?)
+    deferred_loop.failure = 1
+    assert deferred_loop.send(:complete?)
+  end
+
+  should "increase success and failure on child_returned" do
+    deferred_loop = DeferredLoop.new
+    success, failure = deferred_loop.success, deferred_loop.failure
+    deferred_loop.child_returned(:success)
+    assert_equal success + 1, deferred_loop.success
+    assert_equal failure, deferred_loop.failure
+    deferred_loop.child_returned(:failure)
+    assert_equal failure + 1, deferred_loop.failure
+  end
+
+  should "fail if there are failures" do
+    deferred_loop = DeferredLoop.new
+    deferred_loop.instance_variable_set('@waiting_for', [1])
+    deferred_loop.child_returned(:failure)
+    deferred_loop.expects(:fail)
+    deferred_loop.send(:terminate)
+  end
+
+  should "succeed if there aren't failures" do
+    deferred_loop = DeferredLoop.new
+    deferred_loop.instance_variable_set('@waiting_for', [1])
+    deferred_loop.child_returned(:success)
+    deferred_loop.expects(:succeed)
+    deferred_loop.send(:terminate)
+  end
+
+  should "add callback to main loop when EM reactor is not running" do
+    EM.expects(:run)
+    main_loop = Mocha::Mock.new
+    DeferredLoop.stubs(:main_loop).returns(main_loop)
+    main_loop.expects(:callback)
+    in_deferred_loop {}
+  end
+
+  should "wait for all the deferrables passed to waiting for" do
+    EM.stubs(:reactor_running?).returns(true)
+    ev_loop = DeferredLoop.new
+    a = 1
+    b = 2
+    ev_loop.expects(:wait_for).with(a)
+    ev_loop.expects(:wait_for).with(b)
+    ev_loop.waiting_for a, b
+  end
+
+  should "instantiate a new loop on class waiting_for" do
+    a = b = nil
+    l = lambda { 'bla' }
+    deferred_loop = Mocha::Mock.new
+    DeferredLoop.expects(:new).returns(deferred_loop)
+    deferred_loop.expects(:waiting_for).with(a, b, l)
+    EventUtils.waiting_for(a, b, l)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'event_utils'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: hungryblank-event_utils
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Paolo Negri
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: hungryblank@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- lib/event_utils
+- lib/event_utils/evented_loop.rb
+- lib/event_utils.rb
+- test/deferred_loop_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/hungryblank/event_utils
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: provides various facilities to help building tools on top of eventmachine
+test_files: []
+