bumbleworks 0.0.18 → 0.0.19

data/lib/bumbleworks.rb

@@ -8,6 +8,7 @@ require "bumbleworks/participant_registration"
 require "bumbleworks/ruote"
 require "bumbleworks/hash_storage"
 require "bumbleworks/simple_logger"
+require "bumbleworks/storage_participant"
 
 module Bumbleworks
   class UnsupportedMode < StandardError; end

data/lib/bumbleworks/ruote.rb

@@ -49,8 +49,9 @@ module Bumbleworks
 
       def set_catchall_if_needed
         last_participant = dashboard.participant_list.last
-        unless last_participant && last_participant.regex == "^.+$" && last_participant.classname == "Ruote::StorageParticipant"
-          catchall = ::Ruote::ParticipantEntry.new(["^.+$", ["Ruote::StorageParticipant", {}]])
+        unless last_participant && last_participant.regex == "^.+$" &&
+            ["Ruote::StorageParticipant", "Bumbleworks::StorageParticipant"].include?(last_participant.classname)
+          catchall = ::Ruote::ParticipantEntry.new(["^.+$", ["Bumbleworks::StorageParticipant", {}]])
           dashboard.participant_list = dashboard.participant_list.push(catchall)
         end
       end

data/lib/bumbleworks/storage_participant.rb

@@ -0,0 +1,9 @@
+module Bumbleworks
+  class StorageParticipant < ::Ruote::StorageParticipant
+    def on_workitem
+      return_value = super
+      Bumbleworks::Task.new(self[workitem.sid]).on_dispatch
+      return return_value
+    end
+  end
+end

data/lib/bumbleworks/task.rb

@@ -5,6 +5,7 @@ module Bumbleworks
     class AlreadyClaimed < StandardError; end
     class MissingWorkitem < StandardError; end
     class EntityNotFound < StandardError; end
+    class NotCompletable < StandardError; end
 
     extend Forwardable
     delegate [:sid, :fei, :fields, :params, :participant_name, :wfid, :wf_name] => :@workitem
@@ -129,6 +130,7 @@ module Bumbleworks
 
     # proceed workitem (saving changes to fields)
     def complete(metadata = {})
+      raise NotCompletable unless completable?
       before_update(metadata)
       before_complete(metadata)
       proceed_workitem
@@ -164,6 +166,11 @@ module Bumbleworks
       set_claimant(nil)
     end
 
+    def on_dispatch
+      log(:dispatch)
+      after_dispatch
+    end
+
     def log(action, metadata = {})
       Bumbleworks.logger.info({
         :actor => params['claimant'],

data/lib/bumbleworks/tasks/base.rb

@@ -12,6 +12,13 @@ module Bumbleworks
 
       def after_complete(params)
       end
+
+      def after_dispatch
+      end
+
+      def completable?
+        true
+      end
     end
   end
 end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

data/spec/fixtures/apps/with_default_directories/lib/bumbleworks/tasks/make_some_honey_task.rb

@@ -2,4 +2,9 @@ module MakeSomeHoneyTask
   def before_update(params)
     fields['what_happened'] = params['happening']
   end
+
+  def after_dispatch
+    fields['i_was_dispatched'] = 'yes_i_was'
+    update
+  end
 end

data/spec/integration/sample_application_spec.rb

@@ -11,7 +11,7 @@ describe 'Bumbleworks Sample Application' do
   describe 'initializer' do
     it 'registers participants' do
       Bumbleworks.dashboard.participant_list.should have(3).items
-      Bumbleworks.dashboard.participant_list.map(&:classname).should =~ ['HoneyParticipant', 'MolassesParticipant', 'Ruote::StorageParticipant']
+      Bumbleworks.dashboard.participant_list.map(&:classname).should =~ ['HoneyParticipant', 'MolassesParticipant', 'Bumbleworks::StorageParticipant']
     end
 
     it 'loads process definitions' do
@@ -53,5 +53,14 @@ describe 'Bumbleworks Sample Application' do
       task['what_happened'].should == 'update'
     end
   end
+
+  describe 'dispatching a task' do
+    it 'triggers after_dispatch callback' do
+      Bumbleworks.launch!('make_honey')
+      Bumbleworks.dashboard.wait_for(:dave)
+      task = Bumbleworks::Task.for_role('dave').first
+      task['i_was_dispatched'].should == 'yes_i_was'
+    end
+  end
 end
 

data/spec/lib/bumbleworks/ruote_spec.rb

@@ -70,7 +70,7 @@ describe Bumbleworks::Ruote do
       described_class.dashboard.participant_list.should be_empty
       described_class.register_participants &registration_block
       described_class.dashboard.participant_list.should have(4).items
-      described_class.dashboard.participant_list.map(&:classname).should =~ ['BeesHoney', 'MapleSyrup', 'NewCatchall', 'Ruote::StorageParticipant']
+      described_class.dashboard.participant_list.map(&:classname).should =~ ['BeesHoney', 'MapleSyrup', 'NewCatchall', 'Bumbleworks::StorageParticipant']
     end
 
     it 'does not add storage participant catchall if already exists' do
@@ -91,7 +91,7 @@ describe Bumbleworks::Ruote do
       described_class.dashboard.participant_list.should be_empty
       described_class.register_participants &nil
       described_class.dashboard.participant_list.should have(1).item
-      described_class.dashboard.participant_list.first.classname.should == 'Ruote::StorageParticipant'
+      described_class.dashboard.participant_list.first.classname.should == 'Bumbleworks::StorageParticipant'
     end
   end
 

data/spec/lib/bumbleworks/task_spec.rb

@@ -19,6 +19,12 @@ describe Bumbleworks::Task do
     end
   end
 
+  describe '#completable?' do
+    it 'defaults to true on base task' do
+      described_class.new(workflow_item).should be_completable
+    end
+  end
+
   describe '.new' do
     it 'raises an error if workitem is nil' do
       expect {
@@ -44,6 +50,39 @@ describe Bumbleworks::Task do
     end
   end
 
+  describe '#on_dispatch' do
+    before :each do
+      Bumbleworks.define_process 'planting_a_noodle' do
+        concurrence do
+          horse_feeder :task => 'give_the_horse_a_bon_bon'
+        end
+      end
+    end
+
+    it 'is called when task is dispatched, and triggers callback' do
+      described_class.any_instance.should_receive(:on_dispatch)
+      Bumbleworks.launch!('planting_a_noodle')
+      Bumbleworks.dashboard.wait_for(:horse_feeder)
+    end
+
+    it 'logs dispatch' do
+      Bumbleworks.launch!('planting_a_noodle')
+      Bumbleworks.dashboard.wait_for(:horse_feeder)
+      task = described_class.for_role('horse_feeder').last
+      log_entry = Bumbleworks.logger.entries.last[:entry]
+      log_entry[:action].should == :dispatch
+      log_entry[:target_type].should == 'Task'
+      log_entry[:target_id].should == task.id
+    end
+
+    it 'calls after_dispatch callback' do
+      task = described_class.new(workflow_item)
+      task.stub(:log)
+      task.should_receive(:after_dispatch)
+      task.on_dispatch
+    end
+  end
+
   describe '#extend_module' do
     it 'extends with base module and task module' do
       task = described_class.new(workflow_item)
@@ -406,6 +445,21 @@ describe Bumbleworks::Task do
         task.fields['meal'].should == 'root beer and a kite'
       end
 
+      it 'throws exception if task is not completable' do
+        event = Bumbleworks.dashboard.wait_for :dog_mouth
+        task = described_class.for_role('dog_mouth').first
+        task.stub(:completable?).and_return(false)
+        task.should_receive(:before_update).never
+        task.should_receive(:before_complete).never
+        task.should_receive(:proceed_workitem).never
+        task.should_receive(:after_complete).never
+        task.should_receive(:after_update).never
+        expect {
+          task.complete
+        }.to raise_error(Bumbleworks::Task::NotCompletable)
+        described_class.for_role('dog_mouth').should_not be_empty
+      end
+
       it 'calls update and complete callbacks' do
         task = described_class.new(workflow_item)
         task.stub(:log)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -174,6 +174,7 @@ files:
 - lib/bumbleworks/ruote.rb
 - lib/bumbleworks/simple_logger.rb
 - lib/bumbleworks/storage_adapter.rb
+- lib/bumbleworks/storage_participant.rb
 - lib/bumbleworks/support.rb
 - lib/bumbleworks/task.rb
 - lib/bumbleworks/tasks/base.rb