sequencerrb 0.1.1 → 0.2.0

data/README.rdoc

@@ -3,19 +3,25 @@
 Simple library for sequencing procs/lambdas. Mainly useful for managing
 sequential asynchronous operations.
 
+== Install
+
+    ~$ gem install sequencerrb
+
 == Usage
     
     acc = 0
 
-    f = proc { |sq|
+    f = proc { |cb|
       acc+=1
-      sq.next
+      cb.call
     }
 
     Sequencer.new([f,f,f]).start
 
     acc == 3 # true
 
+Read the spec files for all the use cases.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/collector.rb

@@ -0,0 +1,29 @@
+class Collector
+
+  attr_accessor :collect
+
+  def initialize(procs, fin)
+    @procs    = procs
+    @finalize = fin
+    @counter  = 0
+    @collect  = nil
+  end
+
+  def add(f)
+    @procs.push(f)
+  end
+
+  def start
+    @procs.each do |f|
+      f.call(self)
+    end
+  end
+
+  def proc_finished
+    @counter += 1
+    if @procs.size == @counter
+      @finalize.call(self)
+    end
+  end
+
+end

data/lib/sequencer.rb

@@ -1,8 +1,11 @@
 # A class for running arbitrary actions in sequence.
 class Sequencer
 
+  attr_reader :running
+
   def initialize(procs=[])
-    @procs = procs
+    @procs   = procs
+    @running = false
   end
 
   # Add a function to the sequence
@@ -17,13 +20,23 @@ class Sequencer
 
   # Start running
   def start
+    @running = true
     self.next
   end
 
+  # Return a proc to trigger the start
+  def start_callback
+    proc {
+      self.start
+    }
+  end
+
   # Run the next function (if any)
   def next
     if @procs.size > 0
-      @procs.shift.call(self)
+      @procs.shift.call(proc { self.next })
+    else
+      @running = false
     end
   end
 

data/sequencerrb.gemspec

@@ -0,0 +1,58 @@
+# 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{sequencerrb}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michiel Kalkman"]
+  s.date = %q{2010-08-06}
+  s.description = %q{Simple library for sequencing procs/lambdas. Mainly useful for managing sequential asynchronous operations.}
+  s.email = %q{michielkalkman@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/collector.rb",
+     "lib/sequencer.rb",
+     "sequencerrb.gemspec",
+     "spec/collector_spec.rb",
+     "spec/sequencer_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/michiel/sequencer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple library for sequencing procs/lambdas.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/collector_spec.rb",
+     "spec/sequencer_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= 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/spec/collector_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Collector" do
+
+  it "should do something" do
+    f = proc {|st|
+      st.collect += 1
+      st.proc_finished
+    }
+
+    col = Collector.new(
+      [f,f,f], 
+      proc {|st|
+      }
+    )
+    col.collect = 0
+    col.start
+    col.collect.should == 3
+  end
+
+end

data/spec/sequencer_spec.rb

@@ -4,9 +4,9 @@ describe "Sequencer" do
   it "should run three actions" do
 
     acc = 0
-    f = proc { |sq|
+    f = proc { |cb|
       acc+=1
-      sq.next
+      cb.call
     }
     Sequencer.new([f,f,f]).start
 
@@ -17,9 +17,9 @@ describe "Sequencer" do
   it "should add two actions" do
 
     acc = 0
-    f = proc { |sq|
+    f = proc { |cb|
       acc+=1
-      sq.next
+      cb.call
     }
 
     seq = Sequencer.new
@@ -36,13 +36,13 @@ describe "Sequencer" do
     acc = 0
 
     seq = Sequencer.new([
-      proc { |sq|
+      proc { |cb|
         acc = 1
-        sq.next
+        cb.call
       },
-      proc { |sq|
+      proc { |cb|
         acc = 2
-        sq.next
+        cb.call
       }
     ])
     seq.reverse!
@@ -55,10 +55,10 @@ describe "Sequencer" do
   it "should work with nested lexical scope" do
 
     acc = 0
-    f = proc { |sq|
+    f = proc { |cb|
       callback = proc {
         acc+=1
-        sq.next
+        cb.call
       }
       callback.call
     }
@@ -69,4 +69,70 @@ describe "Sequencer" do
 
   end
 
+  it "should work with threads" do
+
+    acc = 0
+    f = proc { |cb|
+      Thread.new do
+        acc+=1
+        cb.call
+      end
+    }
+
+    Sequencer.new([f,f,f]).start
+
+    acc.should == 3
+
+  end
+
+  it "should fail threads with sleep because rspec doesn't do async" do
+
+    acc = 0
+    f = proc { |cb|
+      Thread.new do
+        sleep 5
+        acc+=1
+        cb.call
+      end
+    }
+
+    Sequencer.new([f,f,f]).start
+
+    acc.should == 0
+
+  end
+
+  it "should allow nested usage" do
+
+    acc = 0
+
+    f = proc { |cb|
+        acc+=1
+        cb.call
+    }
+
+    Sequencer.new([ f, f, f,
+                  Sequencer.new([f,f]).start_callback
+    ]).start
+
+    acc.should == 5
+
+  end
+
+  it "should have a working state accessor" do
+
+    acc = 0
+
+    f = proc { |cb|
+      acc+=1
+      cb.call
+    }
+
+    seq = Sequencer.new([ f, f, f ])
+
+    seq.start
+    seq.running.should == false
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'sequencer'
+require 'collector'
 require 'spec'
 require 'spec/autorun'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sequencerrb
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michiel Kalkman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-02 00:00:00 +02:00
+date: 2010-08-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,10 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- lib/collector.rb
 - lib/sequencer.rb
+- sequencerrb.gemspec
+- spec/collector_spec.rb
 - spec/sequencer_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -90,4 +93,5 @@ specification_version: 3
 summary: Simple library for sequencing procs/lambdas.
 test_files: 
 - spec/spec_helper.rb
+- spec/collector_spec.rb
 - spec/sequencer_spec.rb