bumbleworks 0.0.21 → 0.0.22

data/lib/bumbleworks.rb

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

data/lib/bumbleworks/local_participant.rb

@@ -0,0 +1,9 @@
+require "ruote/part/local_participant"
+require "bumbleworks/workitem_entity_storage"
+
+module Bumbleworks
+  module LocalParticipant
+    include ::Ruote::LocalParticipant
+    include WorkitemEntityStorage
+  end
+end

data/lib/bumbleworks/task.rb

@@ -1,10 +1,12 @@
 require "bumbleworks/tasks/base"
+require "bumbleworks/workitem_entity_storage"
 
 module Bumbleworks
   class Task
+    include WorkitemEntityStorage
+
     class AlreadyClaimed < StandardError; end
     class MissingWorkitem < StandardError; end
-    class EntityNotFound < StandardError; end
     class NotCompletable < StandardError; end
 
     extend Forwardable
@@ -80,25 +82,6 @@ module Bumbleworks
       self
     end
 
-    def entity
-      if has_entity_fields?
-        klass = Bumbleworks::Support.constantize(fields['entity_type'])
-        entity = klass.first_by_identifier(fields['entity_id'])
-      end
-      raise EntityNotFound unless entity
-      entity
-    end
-
-    def has_entity?
-      !entity.nil?
-    rescue EntityNotFound
-      false
-    end
-
-    def has_entity_fields?
-      fields['entity_id'] && fields['entity_type']
-    end
-
     # alias for fields[] (fields delegated to workitem)
     def [](key)
       fields[key]
@@ -135,7 +118,7 @@ module Bumbleworks
 
     # proceed workitem (saving changes to fields)
     def complete(metadata = {})
-      raise NotCompletable unless completable?
+      raise NotCompletable.new(not_completable_error_message) unless completable?
       before_update(metadata)
       before_complete(metadata)
       proceed_workitem
@@ -188,6 +171,10 @@ module Bumbleworks
 
   private
 
+    def workitem
+      @workitem
+    end
+
     def storage_participant
       self.class.storage_participant
     end

data/lib/bumbleworks/tasks/base.rb

@@ -19,6 +19,10 @@ module Bumbleworks
       def completable?
         true
       end
+
+      def not_completable_error_message
+        "This task is not currently completable."
+      end
     end
   end
 end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.21"
+  VERSION = "0.0.22"
 end

data/lib/bumbleworks/workitem_entity_storage.rb

@@ -0,0 +1,24 @@
+module Bumbleworks
+  module WorkitemEntityStorage
+    class EntityNotFound < StandardError; end
+
+    def entity
+      if has_entity_fields?
+        klass = Bumbleworks::Support.constantize(workitem.fields['entity_type'])
+        entity = klass.first_by_identifier(workitem.fields['entity_id'])
+      end
+      raise EntityNotFound unless entity
+      entity
+    end
+
+    def has_entity?
+      !entity.nil?
+    rescue EntityNotFound
+      false
+    end
+
+    def has_entity_fields?
+      workitem.fields['entity_id'] && workitem.fields['entity_type']
+    end
+  end
+end

data/spec/lib/bumbleworks/local_participant_spec.rb

@@ -0,0 +1,9 @@
+describe Bumbleworks::LocalParticipant do
+  it 'includes Ruote::LocalParticipant' do
+    described_class.included_modules.should include(Ruote::LocalParticipant)
+  end
+
+  it 'includes WorkitemEntityStorage' do
+    described_class.included_modules.should include(Bumbleworks::WorkitemEntityStorage)
+  end
+end

data/spec/lib/bumbleworks/task_spec.rb

@@ -8,6 +8,18 @@ describe Bumbleworks::Task do
     Bumbleworks.start_worker!
   end
 
+  it 'includes WorkitemEntityStorage' do
+    described_class.included_modules.should include(Bumbleworks::WorkitemEntityStorage)
+  end
+
+  describe '#not_completable_error_message' do
+    it 'defaults to generic message' do
+      task = described_class.new(workflow_item)
+      task.not_completable_error_message.should ==
+        "This task is not currently completable."
+    end
+  end
+
   describe '.autoload_all' do
     it 'autoloads all task modules in directory' do
       Bumbleworks.root = File.join(fixtures_path, 'apps', 'with_default_directories')
@@ -460,6 +472,7 @@ describe Bumbleworks::Task do
         event = Bumbleworks.dashboard.wait_for :dog_mouth
         task = described_class.for_role('dog_mouth').first
         task.stub(:completable?).and_return(false)
+        task.stub(:not_completable_error_message).and_return('hogwash!')
         task.should_receive(:before_update).never
         task.should_receive(:before_complete).never
         task.should_receive(:proceed_workitem).never
@@ -467,7 +480,7 @@ describe Bumbleworks::Task do
         task.should_receive(:after_update).never
         expect {
           task.complete
-        }.to raise_error(Bumbleworks::Task::NotCompletable)
+        }.to raise_error(Bumbleworks::Task::NotCompletable, "hogwash!")
         described_class.for_role('dog_mouth').should_not be_empty
       end
 
@@ -501,70 +514,5 @@ describe Bumbleworks::Task do
         }
       end
     end
-
-    describe '#has_entity_fields?' do
-      it 'returns true if workitem fields include entity fields' do
-        task = described_class.new(workflow_item)
-        task['entity_id'] = '1'
-        task['entity_type'] = 'SomeEntity'
-        task.should have_entity_fields
-      end
-
-      it 'returns false if workitem fields do not include entity fields' do
-        task = described_class.new(workflow_item)
-        task.should_not have_entity_fields
-      end
-    end
-
-    describe '#has_entity?' do
-      it 'returns true if entity is not nil' do
-        task = described_class.new(workflow_item)
-        task.stub(:entity).and_return(:a_real_boy_not_a_puppet)
-        task.has_entity?.should be_true
-      end
-
-      it 'returns false if EntityNotFound' do
-        task = described_class.new(workflow_item)
-        task.stub(:entity).and_raise(Bumbleworks::Task::EntityNotFound)
-        task.has_entity?.should be_false
-      end
-    end
-
-    describe '#entity' do
-      class LovelyEntity
-        def self.first_by_identifier(identifier)
-          return nil unless identifier
-          "Object #{identifier}"
-        end
-      end
-
-      let(:entitied_workflow_item) {
-        Ruote::Workitem.new('fields' => {
-          'entity_id' => '15',
-          'entity_type' => 'LovelyEntity',
-          'params' => {'task' => 'go_to_work'}
-        })
-      }
-
-      it 'attempts to instantiate business entity from _id and _type fields' do
-        task = described_class.new(entitied_workflow_item)
-        task.entity.should == 'Object 15'
-      end
-
-      it 'throw exception if entity fields not present' do
-        task = described_class.new(workflow_item)
-        expect {
-          task.entity
-        }.to raise_error Bumbleworks::Task::EntityNotFound
-      end
-
-      it 'throw exception if entity returns nil' do
-        task = described_class.new(entitied_workflow_item)
-        task['entity_id'] = nil
-        expect {
-          task.entity
-        }.to raise_error Bumbleworks::Task::EntityNotFound
-      end
-    end
   end
 end

data/spec/lib/bumbleworks/workitem_entity_storage_spec.rb

@@ -0,0 +1,76 @@
+require "bumbleworks/workitem_entity_storage"
+
+describe Bumbleworks::WorkitemEntityStorage do
+  class FakeEntityHolder
+    include Bumbleworks::WorkitemEntityStorage
+    def initialize(fields = {})
+      @fields = fields
+    end
+
+    def workitem
+      OpenStruct.new(:fields => @fields)
+    end
+  end
+
+  describe '#has_entity_fields?' do
+    it 'returns true if workitem fields include entity fields' do
+      feh = FakeEntityHolder.new('entity_id' => '1', 'entity_type' => 'SomeEntity')
+      feh.should have_entity_fields
+    end
+
+    it 'returns false if workitem fields do not include entity fields' do
+      feh = FakeEntityHolder.new
+      feh.should_not have_entity_fields
+    end
+  end
+
+  describe '#has_entity?' do
+    it 'returns true if entity is not nil' do
+      feh = FakeEntityHolder.new
+      feh.stub(:entity).and_return(:a_real_boy_not_a_puppet)
+      feh.has_entity?.should be_true
+    end
+
+    it 'returns false if EntityNotFound' do
+      feh = FakeEntityHolder.new
+      feh.stub(:entity).and_raise(Bumbleworks::WorkitemEntityStorage::EntityNotFound)
+      feh.has_entity?.should be_false
+    end
+  end
+
+  describe '#entity' do
+    class LovelyEntity
+      def self.first_by_identifier(identifier)
+        return nil unless identifier
+        "Object #{identifier}"
+      end
+    end
+
+    let(:entitied_workflow_item) {
+      Ruote::Workitem.new('fields' => {
+        'entity_id' => '15',
+        'entity_type' => 'LovelyEntity',
+        'params' => {'task' => 'go_to_work'}
+      })
+    }
+
+    it 'attempts to instantiate business entity from _id and _type fields' do
+      feh = FakeEntityHolder.new('entity_id' => '15', 'entity_type' => 'LovelyEntity')
+      feh.entity.should == 'Object 15'
+    end
+
+    it 'throw exception if entity fields not present' do
+      feh = FakeEntityHolder.new
+      expect {
+        feh.entity
+      }.to raise_error Bumbleworks::WorkitemEntityStorage::EntityNotFound
+    end
+
+    it 'throw exception if entity returns nil' do
+      feh = FakeEntityHolder.new('entity_id' => nil, 'entity_type' => 'LovelyEntity')
+      expect {
+        feh.entity
+      }.to raise_error Bumbleworks::WorkitemEntityStorage::EntityNotFound
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
   prerelease: 
 platform: ruby
 authors:
@@ -168,6 +168,7 @@ files:
 - lib/bumbleworks.rb
 - lib/bumbleworks/configuration.rb
 - lib/bumbleworks/hash_storage.rb
+- lib/bumbleworks/local_participant.rb
 - lib/bumbleworks/participant_registration.rb
 - lib/bumbleworks/process_definition.rb
 - lib/bumbleworks/rake_tasks.rb
@@ -180,6 +181,7 @@ files:
 - lib/bumbleworks/tasks/base.rb
 - lib/bumbleworks/tree_builder.rb
 - lib/bumbleworks/version.rb
+- lib/bumbleworks/workitem_entity_storage.rb
 - lib/tasks/bumbleworks.rake
 - spec/fixtures/apps/with_default_directories/config_initializer.rb
 - spec/fixtures/apps/with_default_directories/full_initializer.rb
@@ -199,6 +201,7 @@ files:
 - spec/integration/configuration_spec.rb
 - spec/integration/sample_application_spec.rb
 - spec/lib/bumbleworks/configuration_spec.rb
+- spec/lib/bumbleworks/local_participant_spec.rb
 - spec/lib/bumbleworks/participant_registration_spec.rb
 - spec/lib/bumbleworks/process_definition_spec.rb
 - spec/lib/bumbleworks/ruote_spec.rb
@@ -207,6 +210,7 @@ files:
 - spec/lib/bumbleworks/support_spec.rb
 - spec/lib/bumbleworks/task_spec.rb
 - spec/lib/bumbleworks/tree_builder_spec.rb
+- spec/lib/bumbleworks/workitem_entity_storage_spec.rb
 - spec/lib/bumbleworks_spec.rb
 - spec/spec_helper.rb
 - spec/support/path_helpers.rb
@@ -254,6 +258,7 @@ test_files:
 - spec/integration/configuration_spec.rb
 - spec/integration/sample_application_spec.rb
 - spec/lib/bumbleworks/configuration_spec.rb
+- spec/lib/bumbleworks/local_participant_spec.rb
 - spec/lib/bumbleworks/participant_registration_spec.rb
 - spec/lib/bumbleworks/process_definition_spec.rb
 - spec/lib/bumbleworks/ruote_spec.rb
@@ -262,6 +267,7 @@ test_files:
 - spec/lib/bumbleworks/support_spec.rb
 - spec/lib/bumbleworks/task_spec.rb
 - spec/lib/bumbleworks/tree_builder_spec.rb
+- spec/lib/bumbleworks/workitem_entity_storage_spec.rb
 - spec/lib/bumbleworks_spec.rb
 - spec/spec_helper.rb
 - spec/support/path_helpers.rb