bumbleworks 0.0.25 → 0.0.26

data/lib/bumbleworks/task.rb

@@ -1,5 +1,6 @@
 require "bumbleworks/tasks/base"
 require "bumbleworks/workitem_entity_storage"
+require "bumbleworks/task/finder"
 
 module Bumbleworks
   class Task
@@ -8,6 +9,7 @@ module Bumbleworks
     class AlreadyClaimed < StandardError; end
     class MissingWorkitem < StandardError; end
     class NotCompletable < StandardError; end
+    class AvailabilityTimeout < StandardError; end
 
     extend Forwardable
     delegate [:sid, :fei, :fields, :params, :participant_name, :wfid, :wf_name] => :@workitem
@@ -29,24 +31,11 @@ module Bumbleworks
         end
       end
 
-      def for_role(identifier)
-        for_roles([identifier])
-      end
-
-      def for_roles(identifiers)
-        return [] unless identifiers.is_a?(Array)
-        workitems = identifiers.collect { |identifier|
-          storage_participant.by_participant(identifier)
-        }.flatten.uniq
-        from_workitems(workitems)
-      end
-
-      def for_claimant(token)
-        all.select { |t| t.claimant == token }
-      end
-
-      def all
-        from_workitems(storage_participant.all)
+      def method_missing(method, *args)
+        if Finder.new.respond_to?(method)
+          return Finder.new.send(method, *args)
+        end
+        super
       end
 
       def find_by_id(sid)
@@ -60,12 +49,6 @@ module Bumbleworks
       def storage_participant
         Bumbleworks.dashboard.storage_participant
       end
-
-      def from_workitems(workitems)
-        workitems.map { |wi|
-          new(wi) if wi.params['task']
-        }.compact
-      end
     end
 
     def initialize(workitem)

data/lib/bumbleworks/task/finder.rb

@@ -0,0 +1,75 @@
+module Bumbleworks
+  class Task
+    class Finder
+      include Enumerable
+
+      def initialize(queries = [])
+        @queries = queries
+      end
+
+      def by_nickname(nickname)
+        @queries << proc { |wi| wi['fields']['params']['task'] == nickname }
+        self
+      end
+
+      def for_roles(identifiers)
+        identifiers ||= []
+        @queries << proc { |wi| identifiers.include?(wi['participant_name']) }
+        self
+      end
+
+      def for_role(identifier)
+        for_roles([identifier])
+      end
+
+      def for_claimant(token)
+        @queries << proc { |wi| wi['fields']['params']['claimant'] == token }
+        self
+      end
+
+      def for_entity(entity)
+        @queries << proc { |wi|
+          (wi['fields'][:entity_type] || wi['fields']['entity_type']) == entity.class.name &&
+            (wi['fields'][:entity_id] || wi['fields']['entity_id']) == entity.identifier
+        }
+        self
+      end
+
+      def all
+        workitems = Bumbleworks.dashboard.storage_participant.send(:do_select, {}) { |wi|
+          @queries.all? { |q| q.call(wi) }
+        }
+        from_workitems(workitems)
+      end
+
+      def each(&block)
+        all.each(&block)
+      end
+
+      def empty?
+        all.empty?
+      end
+
+      def next_available(options = {})
+        options[:timeout] ||= 5
+
+        start_time = Time.now
+        while first.nil?
+          if (Time.now - start_time) > options[:timeout]
+            raise Bumbleworks::Task::AvailabilityTimeout, "No tasks found matching criteria in time"
+          end
+          sleep 0.1
+        end
+        first
+      end
+
+    private
+
+      def from_workitems(workitems)
+        workitems.map { |wi|
+          Task.new(wi) if wi.params['task']
+        }.compact
+      end
+    end
+  end
+end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.25"
+  VERSION = "0.0.26"
 end

data/lib/bumbleworks/workitem_entity_storage.rb

@@ -5,8 +5,8 @@ module Bumbleworks
     def entity(options = {})
       @entity = nil if options[:reload] == true
       @entity ||= if has_entity_fields?
-        klass = Bumbleworks::Support.constantize(workitem.fields['entity_type'])
-        entity = klass.first_by_identifier(workitem.fields['entity_id'])
+        klass = Bumbleworks::Support.constantize(entity_type)
+        entity = klass.first_by_identifier(entity_id)
       end
       raise EntityNotFound unless @entity
       @entity
@@ -19,7 +19,17 @@ module Bumbleworks
     end
 
     def has_entity_fields?
-      workitem.fields['entity_id'] && workitem.fields['entity_type']
+      entity_id && entity_type
+    end
+
+  private
+
+    def entity_id
+      workitem.fields[:entity_id] || workitem.fields['entity_id']
+    end
+
+    def entity_type
+      workitem.fields[:entity_type] || workitem.fields['entity_type']
     end
   end
 end

data/spec/lib/bumbleworks/task_spec.rb

@@ -91,7 +91,7 @@ describe Bumbleworks::Task do
     it 'logs dispatch' do
       Bumbleworks.launch!('planting_a_noodle')
       Bumbleworks.dashboard.wait_for(:horse_feeder)
-      task = described_class.for_role('horse_feeder').last
+      task = described_class.for_role('horse_feeder').first
       log_entry = Bumbleworks.logger.entries.last[:entry]
       log_entry[:action].should == :dispatch
       log_entry[:target_type].should == 'Task'
@@ -230,9 +230,22 @@ describe Bumbleworks::Task do
   end
 
   describe '.for_role' do
-    it 'delegates to #for_roles with single-item array' do
-      described_class.should_receive(:for_roles).with(['mister_mystery'])
-      described_class.for_role('mister_mystery')
+    it 'returns all tasks for given role' do
+      Bumbleworks.define_process 'chalking' do
+        concurrence do
+          chalker :task => 'make_chalk_drawings'
+          hagrid :task => 'moan_endearingly'
+          chalker :task => 'chalk_it_good_baby'
+        end
+      end
+      Bumbleworks.launch!('chalking')
+      Bumbleworks.dashboard.wait_for(:chalker)
+
+      tasks = described_class.for_role('chalker')
+      tasks.map(&:nickname).should == [
+        'make_chalk_drawings',
+        'chalk_it_good_baby'
+      ]
     end
   end
 
@@ -325,6 +338,39 @@ describe Bumbleworks::Task do
     end
   end
 
+  context '.for_entity' do
+    it 'returns all tasks associated with given entity' do
+      fake_sandwich = OpenStruct.new(:identifier => 'rubies')
+      Bumbleworks.define_process 'existential_pb_and_j' do
+        concurrence do
+          sandwich :task => 'be_made'
+          sandwich :task => 'contemplate_being'
+        end
+      end
+      Bumbleworks.launch!('existential_pb_and_j', :entity => fake_sandwich)
+      Bumbleworks.dashboard.wait_for(:sandwich)
+      tasks = described_class.for_entity(fake_sandwich)
+      tasks.should have(2).items
+    end
+  end
+
+  context '.by_nickname' do
+    it 'returns all tasks with given nickname' do
+      Bumbleworks.define_process 'animal_disagreements' do
+        concurrence do
+          turtle :task => 'be_a_big_jerk'
+          goose :task => 'punch_turtle'
+          rabbit :task => 'punch_turtle'
+        end
+      end
+      Bumbleworks.launch!('animal_disagreements')
+      Bumbleworks.dashboard.wait_for(:rabbit)
+      tasks = described_class.by_nickname('punch_turtle')
+      tasks.should have(2).items
+      tasks.map(&:role).should =~ ['goose', 'rabbit']
+    end
+  end
+
   context 'claiming things' do
     before :each do
       Bumbleworks.define_process 'planting_a_noodle' do
@@ -337,7 +383,7 @@ describe Bumbleworks::Task do
     end
 
     describe '#claim' do
-      it 'sets token on  "claimant" param' do
+      it 'sets token on "claimant" param' do
         @task.params['claimant'].should == 'boss'
       end
 
@@ -515,4 +561,92 @@ describe Bumbleworks::Task do
       end
     end
   end
+
+  describe 'chained queries' do
+    it 'allows for AND-ed chained finders' do
+      Bumbleworks.define_process 'the_big_kachunko' do
+        concurrence do
+          red :task => 'be_really_mad'
+          blue :task => 'be_a_bit_sad'
+          yellow :task => 'be_scared'
+          green :task => 'be_envious'
+          green :task => 'be_proud'
+          pink :task => 'be_proud'
+        end
+      end
+      Bumbleworks.launch!('the_big_kachunko')
+      Bumbleworks.dashboard.wait_for(:pink)
+      described_class.by_nickname('be_really_mad').first.claim('crayon_box')
+      described_class.by_nickname('be_a_bit_sad').first.claim('crayon_box')
+      described_class.by_nickname('be_scared').first.claim('crayon_box')
+
+      tasks = described_class.
+        for_roles(['green', 'pink']).
+        by_nickname('be_proud')
+      tasks.should have(2).items
+      tasks.map(&:nickname).should =~ ['be_proud', 'be_proud']
+
+      tasks = described_class.
+        for_claimant('crayon_box').
+        for_roles(['red', 'yellow', 'green'])
+      tasks.should have(2).items
+      tasks.map(&:nickname).should =~ ['be_really_mad', 'be_scared']
+
+      tasks = described_class.
+        for_claimant('crayon_box').
+        by_nickname('be_a_bit_sad').
+        for_role('blue')
+      tasks.should have(1).item
+      tasks.first.nickname.should == 'be_a_bit_sad'
+    end
+  end
+
+  describe 'method missing' do
+    it 'calls method on new Finder object' do
+      described_class::Finder.any_instance.stub(:shabam!).with(:yay).and_return(:its_a_me)
+      described_class.shabam!(:yay).should == :its_a_me
+    end
+
+    it 'falls back to method missing if no finder method' do
+      expect {
+        described_class.kerplunk!(:oh_no)
+      }.to raise_error
+    end
+  end
+
+  describe '.next_available' do
+    it 'waits for one task to show up and returns it' do
+      Bumbleworks.define_process "lazy_bum_and_cool_guy" do
+        concurrence do
+          cool_guy :task => 'get_it_going_man'
+          sequence do
+            wait '2s'
+            bum :task => 'finally_get_a_round_tuit'
+          end
+        end
+      end
+      start_time = Time.now
+      Bumbleworks.launch!('lazy_bum_and_cool_guy')
+      task = described_class.for_role('bum').next_available
+      end_time = Time.now
+      task.nickname.should == 'finally_get_a_round_tuit'
+      (end_time - start_time).should >= 2
+    end
+
+    it 'times out if task does not appear in time' do
+      Bumbleworks.define_process "really_lazy_bum_and_cool_guy" do
+        concurrence do
+          cool_guy :task => 'good_golly_never_mind_you'
+          sequence do
+            wait '2s'
+            bum :task => 'whatever_these_socks_are_tasty'
+          end
+        end
+      end
+      Bumbleworks.launch!('really_lazy_bum_and_cool_guy')
+      expect {
+        described_class.for_role('bum').next_available(:timeout => 0.5)
+      }.to raise_error(Bumbleworks::Task::AvailabilityTimeout)
+    end
+  end
 end

data/spec/lib/bumbleworks/workitem_entity_storage_spec.rb

@@ -18,6 +18,11 @@ describe Bumbleworks::WorkitemEntityStorage do
       feh.should have_entity_fields
     end
 
+    it 'returns true if workitem fields include symbolized version of 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
@@ -62,6 +67,11 @@ describe Bumbleworks::WorkitemEntityStorage do
       feh.entity.identifier.should == '15'
     end
 
+    it 'works with symbolized _id and _type fields' do
+      feh = FakeEntityHolder.new(:entity_id => '15', :entity_type => 'LovelyEntity')
+      feh.entity.identifier.should == '15'
+    end
+
     it 'throw exception if entity fields not present' do
       feh = FakeEntityHolder.new
       expect {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
   prerelease: 
 platform: ruby
 authors:
@@ -178,6 +178,7 @@ files:
 - lib/bumbleworks/storage_participant.rb
 - lib/bumbleworks/support.rb
 - lib/bumbleworks/task.rb
+- lib/bumbleworks/task/finder.rb
 - lib/bumbleworks/tasks/base.rb
 - lib/bumbleworks/tree_builder.rb
 - lib/bumbleworks/version.rb
@@ -227,18 +228,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2155630126504321546
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2155630126504321546
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -277,3 +272,4 @@ test_files:
 - spec/lib/bumbleworks_spec.rb
 - spec/spec_helper.rb
 - spec/support/path_helpers.rb
+has_rdoc: