em-scenario 0.0.2 → 0.0.3

data/README.md

@@ -10,16 +10,123 @@ Ruby 1.9.2 is used, it may work with ruby 1.8.x
 Tools
 -----
 
-The specs provide nice example of usage.
-
 ### Quorum
 
 Do something when n actions are done.
 
+```ruby
+EM.run do
+  quorum(5) do |nextStep|
+      5.times do |i|
+          EM.add_timer(Random.rand(0.1)) do
+              nextStep.call
+          end
+      end
+  end.finally do
+      assert true
+      EM.stop
+  end
+end
+
+```
+
+### AdNauseum
+
+```ruby
+EM.run do
+    cpt = 0
+    adnauseum do |nextStep|
+        EM.add_timer(Random.rand(0.1)) do
+            cpt += 1
+            nextStep.call
+        end
+    end.until do
+        cpt > 5
+    end.finally do
+        assert true
+        EM.stop
+    end
+end
+```
+
 ### AbInitio
 
 Act sequentialy, from the start.
 
+```ruby
+EM.run do
+    txt = ""
+    abinitio do |sequence|
+        sequence.then do |nextStep|
+            EM.add_timer(Random.rand(0.1)) do
+                txt = "Hello "
+                nextStep.call
+            end
+        end.then do |nextStep|
+            EM.add_timer(Random.rand(0.1)) do
+                txt += "World"
+                nextStep.call
+            end
+        end.then do |nextStep|
+            EM.add_timer(Random.rand(0.1)) do
+                txt.upcase!
+                nextStep.call
+            end
+        end
+    end.finally do
+        assert "HELLO WORLD" == txt
+        EM.stop
+    end
+end
+```
+
 ### AdLib
 
 Repeat an action, seqentillay.
+
+```ruby
+EM.run do
+    stack = []
+    adlib(5) do |nextStep, i|
+        stack << i
+        EM.add_timer(Random.rand(0.1)) do
+            nextStep.call
+        end
+   end.finally do
+        assert true
+        assert [0,1,2,3,4] == stack
+        EM.stop
+   end
+end
+```
+
+### QuantumSatis
+
+Not so many parallel actions
+
+```ruby
+EM.run do
+    stack = []
+    quantumsatis(5, 2) do |nextStep, i, workers|
+        assert workers <= 2
+        EM.add_timer(Random.rand(0.1)) do
+            stack << i
+            nextStep.call
+        end
+    end.finally do
+        assert (0..4).to_a == stack.sort
+        EM.stop
+    end
+end
+```
+
+Todo
+----
+
+ * Chain all commands
+ * Alias in plain old english
+
+Licence
+-------
+
+Released under the LGPL license.

data/lib/scenario.rb

@@ -4,6 +4,10 @@ module EventMachine
     # @see http://en.wikipedia.org/wiki/List_of_Latin_phrases
     module Scenario
 
+        class Scenario
+
+        end
+
         # from the start
         class AbInitio
             include EM::Deferrable
@@ -45,7 +49,7 @@ module EventMachine
        end
 
         #Trigger when a quota of actions is done
-        class Quorum
+        class Quorum < Scenario
             include EM::Deferrable
 
             def initialize times, &block
@@ -61,13 +65,56 @@ module EventMachine
 
             protected
             def nextStep
-                if @times == 0
-                    self.succeed
+                @times -= 1
+                self.succeed(self) if @times == 0
+            end
+        end
+
+        # As much as enough.
+        # You wont lots of parralel workers, but not too much.
+        class QuantumSatis
+            include EM::Deferrable
+
+            def initialize times, throttle=nil, &block
+                @opened = 0
+                @finished = 0
+                @worker = 0
+                @times = times
+                @throttle = throttle
+                @loop = block
+                @debug = false
+            end
+
+            def finally &block
+                self.callback &block
+                if @throttle
+                    @throttle.times{ call }
                 else
-                    @times -= 1
-                    @loop.call( Proc.new {nextStep} )
+                    @times.times{ call }
                 end
             end
+
+            protected
+            def call
+                @worker += 1
+                @loop.call Proc.new{nextStep}, @opened, @worker
+                @opened += 1
+                if @debug
+                    puts "worker: #{@worker} opened: #{@opened} finished: #{@finished}"
+                end
+            end
+
+            def nextStep
+                puts "ending" if @debug
+                @finished += 1
+                @worker -= 1
+                if @finished == @times
+                    self.succeed
+                else
+                    call if @opened < @times
+                end
+           end
+
         end
 
         # Repeat sequentially an action
@@ -96,6 +143,7 @@ module EventMachine
             end
         end
 
+        # Until sick. Act again and again, until criteria
         class AdNauseum
             include EM::Deferrable
 
@@ -141,3 +189,7 @@ end
 def adnauseum(&block)
     EventMachine::Scenario::AdNauseum.new &block
 end
+
+def quantumsatis(times, throttle=nil, &block)
+    EventMachine::Scenario::QuantumSatis.new times, throttle, &block
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-scenario
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000 Z
+date: 2011-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2152000200 !ruby/object:Gem::Requirement
+  requirement: &2152103240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0.beta3
   type: :runtime
   prerelease: false
-  version_requirements: *2152000200
+  version_requirements: *2152103240
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2151999100 !ruby/object:Gem::Requirement
+  requirement: &2152099300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2151999100
+  version_requirements: *2152099300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2151998320 !ruby/object:Gem::Requirement
+  requirement: &2152093220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151998320
+  version_requirements: *2152093220
 description: Handling simpler story with event machine's callback
 email: mathieu@garambrogne.net
 executables: []