bumbleworks 0.0.61 → 0.0.62

data/lib/bumbleworks/process.rb

@@ -1,7 +1,11 @@
+require "bumbleworks/workitem_entity_storage"
+
 module Bumbleworks
   class Process
     class EntityConflict < StandardError; end
 
+    include WorkitemEntityStorage
+
     attr_reader :id
 
     class << self
@@ -37,18 +41,16 @@ module Bumbleworks
       wfid == other.wfid
     end
 
-    def entity_fields
-      return {} if workitems.empty?
-      if workitems.map(&:entity_fields).uniq.length == 1
-        workitems.first.entity_fields
+    def entity_workitem
+      @entity_workitem ||= if workitems.map(&:entity_fields).uniq.length <= 1
+        workitems.first
       else
         raise EntityConflict
       end
     end
 
-    def entity
-      return nil if entity_fields.empty?
-      workitems.first.entity
+    def entity_storage_workitem
+      super(entity_workitem)
     end
 
     def expressions

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.61"
+  VERSION = "0.0.62"
 end

data/lib/bumbleworks/workitem.rb

@@ -45,6 +45,11 @@ module Bumbleworks
       }
     end
 
+    def entity_name
+      fields = entity_fields(:titleize => true)
+      "#{fields[:type]} #{fields[:identifier]}"
+    end
+
   private
 
     def entity_id

data/lib/bumbleworks/workitem_entity_storage.rb

@@ -2,10 +2,18 @@ module Bumbleworks
   module WorkitemEntityStorage
     extend Forwardable
 
-    delegate [:entity, :has_entity?, :has_entity_fields?, :entity_fields] => :entity_storage_workitem
+    delegate [:entity, :has_entity?, :has_entity_fields?, :entity_fields, :entity_name] => :entity_storage_workitem
 
-    def entity_storage_workitem
-      @entity_storage_workitem ||= Bumbleworks::Workitem.new(workitem)
+    def entity_storage_workitem(the_workitem = workitem)
+      @entity_storage_workitem ||= wrapped_workitem(the_workitem)
+    end
+
+    def wrapped_workitem(the_workitem)
+      if the_workitem.is_a? Bumbleworks::Workitem
+        the_workitem
+      else
+        Bumbleworks::Workitem.new(the_workitem)
+      end
     end
   end
 end

data/spec/lib/bumbleworks/error_handler_spec.rb

@@ -7,6 +7,11 @@ describe Bumbleworks::ErrorHandler do
     end
   end
 
+  it_behaves_like "an entity holder" do
+    let(:holder) { described_class.new(workitem) }
+    let(:storage_workitem) { Bumbleworks::Workitem.new(workitem) }
+  end
+
   describe '#on_error' do
     it 'raises a SubclassResponsiblity exception' do
       expect{subject.on_error}.to raise_error Bumbleworks::ErrorHandler::SubclassResponsibility

data/spec/lib/bumbleworks/error_logger_spec.rb

@@ -1,6 +1,12 @@
 describe Bumbleworks::ErrorLogger do
   subject {described_class.new(workitem)}
   let(:workitem) {double(:wf_name => 'armadillo', :error => 'something is amiss in dillo land', :wfid => 'zabme123', :fields => {})}
+
+  it_behaves_like "an entity holder" do
+    let(:holder) { described_class.new(workitem) }
+    let(:storage_workitem) { Bumbleworks::Workitem.new(workitem) }
+  end
+
   it 'calls registered logger and logs error information' do
     Bumbleworks.logger.should_receive(:error).with({
       :actor => 'armadillo',

data/spec/lib/bumbleworks/participant/local_participant_spec.rb

@@ -1,9 +1,20 @@
 describe Bumbleworks::LocalParticipant do
+  let(:fake_local_participant) {
+    Class.new {
+      include Bumbleworks::LocalParticipant
+      attr_reader :workitem
+      def initialize(workitem)
+        @workitem = workitem
+      end
+    }
+  }
+
   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)
+  it_behaves_like "an entity holder" do
+    let(:holder) { fake_local_participant.new(:a_workitem) }
+    let(:storage_workitem) { Bumbleworks::Workitem.new(:a_workitem) }
   end
 end

data/spec/lib/bumbleworks/process_spec.rb

@@ -67,7 +67,7 @@ describe Bumbleworks::Process do
   end
 
   describe '#workitems' do
-    it 'returns task query filtered for this process' do
+    it 'returns array of applied workitems from each leaf' do
       bp = described_class.new('chumpy')
       l1 = double(:applied_workitem => 'aw1')
       l2 = double(:applied_workitem => 'aw2')
@@ -81,23 +81,36 @@ describe Bumbleworks::Process do
     end
   end
 
-  describe '#entity_fields' do
-    it 'returns empty hash if process not ready yet' do
+  it_behaves_like "an entity holder" do
+    let(:entity_workitem) { Bumbleworks::Workitem.new(:fake_workitem) }
+    let(:holder) {
+      holder = described_class.new('nothing')
+      holder.stub(:entity_workitem => entity_workitem)
+      holder
+    }
+    let(:storage_workitem) { entity_workitem }
+  end
+
+  describe '#entity_workitem' do
+    it 'returns first workitem from workitems array, if no entity fields conflict' do
       bp = described_class.new('nothing')
-      bp.entity_fields.should == {}
+      w1 = double(:entity_fields => :some_fields)
+      w2 = double(:entity_fields => :some_fields)
+      bp.stub(:workitems => [w1, w2])
+      bp.entity_workitem.should == w1
     end
 
-    it 'returns empty hash if no entity' do
-      bp = Bumbleworks.launch!('going_to_the_dance')
-      wait_until { bp.reload.trackers.count > 0 }
-      bp.entity_fields.should == {}
+    it 'returns nil if no process' do
+      bp = described_class.new('nothing')
+      bp.entity_workitem.should be_nil
     end
 
-    it 'returns entity_fields provided at launch' do
+    it 'returns workitem with entity reference from process launch' do
       rainbow_loom = RainbowLoom.new('1234')
       bp = Bumbleworks.launch!('going_to_the_dance', :entity => rainbow_loom)
       wait_until { bp.reload.trackers.count > 0 }
-      bp.entity_fields.should == { :type => 'RainbowLoom', :identifier => '1234'}
+      ew = bp.entity_workitem
+      ew.entity.should == rainbow_loom
     end
 
     it 'raises exception if multiple workitems have conflicting entity info' do
@@ -116,7 +129,17 @@ describe Bumbleworks::Process do
       bp = Bumbleworks.launch!('conflict_this', :entity => RainbowLoom.new('1234'))
       Bumbleworks.dashboard.wait_for(:just_wait)
       expect {
-        bp.entity_fields
+        bp.entity_workitem
+      }.to raise_error(Bumbleworks::Process::EntityConflict)
+    end
+  end
+
+  describe '#entity' do
+    it 'bubbles EntityConflict from entity_workitem' do
+      bp = described_class.new('whatever')
+      bp.stub(:entity_workitem).and_raise(Bumbleworks::Process::EntityConflict)
+      expect {
+        bp.entity
       }.to raise_error(Bumbleworks::Process::EntityConflict)
     end
   end
@@ -219,29 +242,6 @@ describe Bumbleworks::Process do
     end
   end
 
-  describe '#entity' do
-    it 'returns nil if entity_fields is empty' do
-      bp = described_class.new('nothing')
-      bp.stub(:entity_fields => {})
-      bp.entity.should be_nil
-    end
-
-    it 'returns entity provided at launch' do
-      rainbow_loom = RainbowLoom.new('1234')
-      bp = Bumbleworks.launch!('going_to_the_dance', :entity => rainbow_loom)
-      wait_until { bp.reload.trackers.count > 0 }
-      bp.entity.should == rainbow_loom
-    end
-
-    it 'bubbles EntityConflict from entity_fields' do
-      bp = described_class.new('whatever')
-      bp.stub(:entity_fields).and_raise(Bumbleworks::Process::EntityConflict)
-      expect {
-        bp.entity
-      }.to raise_error(Bumbleworks::Process::EntityConflict)
-    end
-  end
-
   describe '#process_status' do
     it 'returns a process_status instance for the wfid' do
       bp = described_class.new('frogheads')

data/spec/lib/bumbleworks/task_spec.rb

@@ -8,15 +8,9 @@ describe Bumbleworks::Task do
     Bumbleworks.start_worker!
   end
 
-  describe 'entity storage' do
-    it 'includes WorkitemEntityStorage' do
-      described_class.included_modules.should include(Bumbleworks::WorkitemEntityStorage)
-    end
-
-    it 'has a workitem method that returns workitem' do
-      task = described_class.new(workflow_item)
-      task.workitem.should == workflow_item
-    end
+  it_behaves_like "an entity holder" do
+    let(:holder) { described_class.new(workflow_item) }
+    let(:storage_workitem) { Bumbleworks::Workitem.new(workflow_item) }
   end
 
   describe '#not_completable_error_message' do

data/spec/lib/bumbleworks/workitem_entity_storage_spec.rb

@@ -1,32 +1,34 @@
 require "bumbleworks/workitem_entity_storage"
 
 describe Bumbleworks::WorkitemEntityStorage do
-  class FakeEntityHolder
-    include Bumbleworks::WorkitemEntityStorage
-    attr_reader :workitem
-    def initialize(workitem)
-      @workitem = workitem
-    end
-  end
+  let(:fake_entity_holder) {
+    Class.new {
+      include Bumbleworks::WorkitemEntityStorage
+      attr_reader :workitem
+      def initialize(workitem)
+        @workitem = workitem
+      end
+    }
+  }
 
   describe '#entity_storage_workitem' do
     it 'returns new Bumbleworks::Workitem instance with workitem' do
       Bumbleworks::Workitem.stub(:new).with(:a_workitem).and_return(:the_workitem)
-      feh = FakeEntityHolder.new(:a_workitem)
+      feh = fake_entity_holder.new(:a_workitem)
       feh.entity_storage_workitem.should == :the_workitem
     end
 
     it 'is memoized' do
-      feh = FakeEntityHolder.new(:a_workitem)
+      feh = fake_entity_holder.new(:a_workitem)
       esw = feh.entity_storage_workitem
       feh.entity_storage_workitem.should be esw
     end
   end
 
-  [:has_entity_fields?, :has_entity?, :entity, :entity_fields].each do |method|
+  [:has_entity_fields?, :has_entity?, :entity, :entity_fields, :entity_name].each do |method|
     describe "##{method}" do
       it 'delegates to entity storage workitem' do
-        feh = FakeEntityHolder.new(:a_workitem)
+        feh = fake_entity_holder.new(:a_workitem)
         feh.entity_storage_workitem.stub(method).with(1, 2, 3).and_return(:yay_for_bikes)
         feh.send(method, 1, 2, 3).should == :yay_for_bikes
       end

data/spec/lib/bumbleworks/workitem_spec.rb

@@ -93,4 +93,10 @@ describe Bumbleworks::Workitem do
       workitem.entity_fields(:titleize => true).should == { :type => 'Rainbow Loom', :identifier => '123' }
     end
   end
+
+  describe "#entity_name" do
+    it 'returns entity fields in displayable string' do
+      workitem.entity_name.should == 'Rainbow Loom 123'
+    end
+  end
 end

data/spec/support/shared_examples.rb

@@ -0,0 +1,16 @@
+shared_examples "an entity holder" do
+  [:has_entity_fields?, :has_entity?, :entity, :entity_fields, :entity_name].each do |method|
+    describe "##{method}" do
+      it 'delegates to entity storage workitem' do
+        holder.entity_storage_workitem.stub(method).with(1, 2, 3).and_return(:yay_for_bikes)
+        holder.send(method, 1, 2, 3).should == :yay_for_bikes
+      end
+    end
+  end
+
+  describe "#entity_storage_workitem" do
+    it 'returns the expected workitem' do
+      holder.entity_storage_workitem.should == storage_workitem
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.61
+  version: 0.0.62
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -246,6 +246,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/path_helpers.rb
 - spec/support/process_testing_helpers.rb
+- spec/support/shared_examples.rb
 - spec/support/tracer.rb
 homepage: ''
 licenses:
@@ -262,7 +263,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1220168955592203945
+      hash: -1400629937644699968
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -271,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1220168955592203945
+      hash: -1400629937644699968
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -329,4 +330,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/path_helpers.rb
 - spec/support/process_testing_helpers.rb
+- spec/support/shared_examples.rb
 - spec/support/tracer.rb