pipeline 0.0.1

data/spec/pipeline/core_ext/symbol_attribute_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+# Reusing stage table to simplify database integration tests
+class FakeForSymbolAttribute < ActiveRecord::Base
+  set_table_name :pipeline_stages
+  
+  symbol_attr :status
+end
+
+module Pipeline
+  describe SymbolAttribute do
+    before(:each) do
+      FakeForSymbolAttribute.delete_all
+    end
+    
+    it "should extend active record to allow symbol attributes to be saved as string" do
+      obj = FakeForSymbolAttribute.new(:status => 'started')
+      obj.save!
+      obj.status.should == :started
+      obj.reload.status.should == :started
+      
+      obj.status = 'finished'
+      obj.save!
+      obj.status.should == :finished
+      obj.reload.status.should == :finished
+    end
+
+    it "should extend Symbol to allow symbol attributes in conditions" do
+      objs = FakeForSymbolAttribute.find(:all, :conditions => ['status = ?', :started])
+      objs.should be_empty
+      
+      FakeForSymbolAttribute.create(:status => :started)
+
+      objs = FakeForSymbolAttribute.find(:all, :conditions => ['status = ?', :started])
+      objs.size.should == 1
+    end
+  end
+end

data/spec/pipeline/core_ext/transactional_attribute_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+# Reusing stage table to simplify database integration tests
+class FakeForTransactionalAttribute < ActiveRecord::Base
+  set_table_name :pipeline_stages
+  
+  transactional_attr :status
+end
+
+module Pipeline
+  describe TransactionalAttribute do
+    it "should extend active record to allow transactional attributes to be saved in a nested transaction" do
+      obj = FakeForTransactionalAttribute.create(:status => "started")
+      obj.status.should == "started"
+      obj.reload.status.should == "started"
+      
+      obj.status = "finished"
+      obj.status.should == "finished"
+      obj.reload.status.should == "finished"
+    end
+  end
+end

data/spec/pipeline/errors_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module Pipeline
+  describe InvalidPipelineError do
+    it "should accept description message when raised" do
+      lambda {raise InvalidPipelineError.new, "message"}.should raise_error(InvalidPipelineError, "message")
+    end
+  end
+
+  describe InvalidStatusError do
+    it "should accept status name as symbol" do
+      lambda {raise InvalidStatusError.new(:started)}.should raise_error(InvalidStatusError, "Status is already started")
+    end
+
+    it "should accept status name as string" do
+      lambda {raise InvalidStatusError.new("in progress")}.should raise_error(InvalidStatusError, "Status is already in progress")
+    end
+
+    it "should replace underscores with spaces" do
+      lambda {raise InvalidStatusError.new(:in_progress)}.should raise_error(InvalidStatusError, "Status is already in progress")
+    end
+  end
+
+  describe IrrecoverableError do
+    it "should accept description message when raised" do
+      lambda {raise IrrecoverableError.new, "message"}.should raise_error(IrrecoverableError, "message")
+    end
+  end
+
+  describe RecoverableError do
+    it "should accept description message when raised" do
+      lambda {raise RecoverableError.new, "message"}.should raise_error(RecoverableError, "message")
+      lambda {raise RecoverableError.new("message")}.should raise_error(RecoverableError, "message")
+    end
+    
+    it "might require user input" do
+      error = RecoverableError.new("message", true)
+      error.should be_input_required
+    end
+
+    it "doesn't require user input by default" do
+      error = RecoverableError.new
+      error.should_not be_input_required
+    end
+  end
+end

data/spec/pipeline/stage/base_spec.rb

@@ -0,0 +1,203 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+class SampleStage < Pipeline::Stage::Base
+  def run
+    @executed = true
+  end
+  
+  def executed?
+    !!@executed
+  end
+end
+
+module Pipeline
+  module Stage
+    describe Base do
+
+      describe "- chaining" do
+        class Step1 < Base; end
+        class Step2 < Base; end
+        class Step3 < Base; end
+        
+        it "should start as itself" do
+          Step1.build_chain.should == [Step1]
+          Step2.build_chain.should == [Step2]
+          Step3.build_chain.should == [Step3]
+        end
+
+        it "should allow chaining" do
+          (Step1 >> Step2).build_chain.should == [Step1, Step2]
+          (Step2 >> Step1).build_chain.should == [Step2, Step1]
+          (Step1 >> Step2 >> Step3).build_chain.should == [Step1, Step2, Step3]
+        end
+      end
+      
+      describe "- setup" do
+        it "should set default name" do
+          Base.new.name.should == "Pipeline::Stage::Base"
+          SampleStage.new.name.should == "SampleStage"
+        end
+
+        it "should allow specifying a name on creation" do
+          Base.new(:name => "My Name").name.should == "My Name"
+          SampleStage.new(:name => "Customized Name").name.should == "Customized Name"
+        end
+
+        it "should start with status not_started" do
+          Base.new.status.should == :not_started
+        end
+        
+        it "should validate status" do
+          lambda {Base.new(:status => :something_else)}.should raise_error
+        end
+      end
+      
+      describe "- persistence" do
+        before(:each) do
+          @stage = SampleStage.new
+        end
+        
+        it "should persist stage" do
+          @stage.id.should be_nil
+          lambda {@stage.save!}.should_not raise_error
+          @stage.id.should_not be_nil
+        end
+        
+        it "should allow retrieval by id" do
+          @stage.save!
+
+          s = SampleStage.find(@stage.id)
+          s.should === @stage
+        end
+
+        it "should persist type as single table inheritance" do
+          @stage.save!
+          stage = Base.find(@stage.id)
+          stage.should be_an_instance_of(SampleStage)
+        end
+        
+      end
+
+      describe "- execution (success)" do
+        before(:each) do
+          @stage = SampleStage.new
+        end
+        
+        it "should update status after finished" do
+          @stage.perform
+          @stage.status.should == :completed
+          @stage.should be_completed
+        end
+        
+        it "should save status" do
+          @stage.save!
+          @stage.perform
+          @stage.reload.status.should == :completed
+          @stage.reload.should be_completed
+        end
+        
+        it "should increment attempts" do
+          @stage.stub!(:run).and_raise(StandardError.new)
+          lambda {@stage.perform}.should raise_error(StandardError)
+          @stage.attempts.should == 1
+
+          lambda {@stage.perform}.should raise_error(StandardError)
+          @stage.attempts.should == 2
+        end
+        
+        it "should call template method #run" do
+          @stage.should_not be_executed
+          @stage.perform
+          @stage.should be_executed
+        end
+      end
+      
+      describe "- execution (failure)" do
+        before(:each) do
+          @stage = SampleStage.new
+          @stage.stub!(:run).and_raise(StandardError.new)
+        end
+
+        it "should re-raise error" do
+          lambda {@stage.perform}.should raise_error
+        end
+        
+        it "should update status on irrecoverable error" do
+          @stage.should_receive(:run).and_raise(IrrecoverableError.new)
+          lambda {@stage.perform}.should raise_error(IrrecoverableError)
+          @stage.status.should == :failed
+          @stage.reload.status.should == :failed
+        end
+
+        it "should update message on irrecoverable error" do
+          @stage.should_receive(:run).and_raise(IrrecoverableError.new("message"))
+          lambda {@stage.perform}.should raise_error(IrrecoverableError)
+          @stage.message.should == "message"
+          @stage.reload.message.should == "message"
+        end
+
+        it "should update status on recoverable error (not requiring input)" do
+          @stage.should_receive(:run).and_raise(RecoverableError.new)
+          lambda {@stage.perform}.should raise_error(RecoverableError)
+          @stage.status.should == :failed
+          @stage.reload.status.should == :failed
+        end
+
+        it "should update status on recoverable error (requiring input)" do
+          @stage.should_receive(:run).and_raise(RecoverableError.new("message", true))
+          lambda {@stage.perform}.should raise_error(RecoverableError)
+          @stage.status.should == :failed
+          @stage.reload.status.should == :failed
+        end
+
+        it "should update message on recoverable error" do
+          @stage.should_receive(:run).and_raise(RecoverableError.new("message"))
+          lambda {@stage.perform}.should raise_error(RecoverableError)
+          @stage.message.should == "message"
+          @stage.reload.message.should == "message"
+        end
+
+      end
+      
+      describe "- execution (in progress)" do
+        it "should set status to in_progress" do
+          stage = SampleStage.new
+          stage.send(:_setup)
+          
+          stage.status.should == :in_progress
+          stage.reload.status.should == :in_progress
+        end
+      end
+      
+      describe "- execution (state transitions)" do
+        it "should execute if status is :not_started" do
+          stage = SampleStage.new
+          
+          lambda {stage.perform}.should_not raise_error(InvalidStatusError)
+        end
+
+        it "should execute if status is :failed (for retrying)" do
+          stage = SampleStage.new
+          stage.send(:status=, :failed)
+          
+          lambda {stage.perform}.should_not raise_error(InvalidStatusError)
+        end
+        
+        it "should not execute if status is :in_progress" do
+          stage = SampleStage.new
+          stage.send(:status=, :in_progress)
+          
+          lambda {stage.perform}.should raise_error(InvalidStatusError, "Status is already in progress")
+        end
+
+        it "should not execute if status is :completed" do
+          stage = SampleStage.new
+          stage.send(:status=, :completed)
+
+          lambda {stage.perform}.should raise_error(InvalidStatusError, "Status is already completed")
+        end
+      end
+
+    end
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude 'spec/*,var/*,gems/*,/Library/*,/usr/*'

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'spec'
+
+require File.join(File.dirname(__FILE__), '..', 'init')
+require File.join(File.dirname(__FILE__), 'database_integration_helper')
+
+ActiveRecord::Base.logger = Logger.new('pipeline.log')
+
+at_exit do
+  File.delete("pipeline.log") if File.exists?("pipeline.log")
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: pipeline
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Danilo Sato
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-30 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: collectiveidea-delayed_job
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Pipeline is a Rails plugin/gem to run asynchronous processes in a configurable pipeline.
+email: danilo@dtsato.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/auto_recoverable_pipeline.rb
+- examples/cancelling_pipeline.rb
+- examples/two_step_pipeline.rb
+- examples/user_recoverable_pipeline.rb
+- generators/pipeline/pipeline_generator.rb
+- generators/pipeline/templates/pipeline_instances_migration.rb
+- generators/pipeline/templates/pipeline_stages_migration.rb
+- init.rb
+- lib/pipeline.rb
+- lib/pipeline/api_methods.rb
+- lib/pipeline/base.rb
+- lib/pipeline/core_ext/symbol_attribute.rb
+- lib/pipeline/core_ext/transactional_attribute.rb
+- lib/pipeline/errors.rb
+- lib/pipeline/stage/base.rb
+- pipeline.gemspec
+- spec/database_integration_helper.rb
+- spec/pipeline/api_methods_spec.rb
+- spec/pipeline/base_spec.rb
+- spec/pipeline/core_ext/symbol_attribute_spec.rb
+- spec/pipeline/core_ext/transactional_attribute_spec.rb
+- spec/pipeline/errors_spec.rb
+- spec/pipeline/stage/base_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dtsato/pipeline
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --line-numbers
+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: pipeline
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: A Rails plugin/gem to run asynchronous processes in a configurable pipeline
+test_files: 
+- spec/database_integration_helper.rb
+- spec/pipeline/api_methods_spec.rb
+- spec/pipeline/base_spec.rb
+- spec/pipeline/core_ext/symbol_attribute_spec.rb
+- spec/pipeline/core_ext/transactional_attribute_spec.rb
+- spec/pipeline/errors_spec.rb
+- spec/pipeline/stage/base_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb