bumbleworks 0.0.34 → 0.0.35

data/lib/bumbleworks/configuration.rb

@@ -83,6 +83,10 @@ module Bumbleworks
     # default: Bumbleworks::SimpleLogger
     define_setting :logger
 
+    # All before_* and after_* callback methods prototyped in Tasks::Base will
+    # also be called on all registered observers.
+    define_setting :observers
+
     def initialize
       @storage_adapters = []
     end
@@ -149,6 +153,10 @@ module Bumbleworks
       @logger ||= Bumbleworks::SimpleLogger
     end
 
+    def observers
+      @observers ||= []
+    end
+
     # Clears all memoize variables and configuration settings
     #
     def clear!

data/lib/bumbleworks/task.rb

@@ -33,7 +33,7 @@ module Bumbleworks
 
       def method_missing(method, *args)
         if Finder.new.respond_to?(method)
-          return Finder.new.send(method, *args)
+          return Finder.new([], self).send(method, *args)
         end
         super
       end
@@ -91,23 +91,37 @@ module Bumbleworks
       klass = Bumbleworks::Support.constantize("#{klass_name}Task")
     end
 
+    def call_before_hooks(action, *args)
+      call_hooks(:before, action, *args)
+    end
+
+    def call_after_hooks(action, *args)
+      call_hooks(:after, action, *args)
+    end
+
+    def with_hooks(action, *args, &block)
+      call_before_hooks(action, *args)
+      yield
+      call_after_hooks(action, *args)
+    end
+
     # update workitem with changes to fields & params
     def update(metadata = {})
-      before_update(metadata)
-      update_workitem
-      log(:update, metadata)
-      after_update(metadata)
+      with_hooks(:update, metadata) do
+        update_workitem
+        log(:update, metadata)
+      end
     end
 
     # proceed workitem (saving changes to fields)
     def complete(metadata = {})
       raise NotCompletable.new(not_completable_error_message) unless completable?
-      before_update(metadata)
-      before_complete(metadata)
-      proceed_workitem
-      log(:complete, metadata)
-      after_complete(metadata)
-      after_update(metadata)
+      with_hooks(:update, metadata) do
+        with_hooks(:complete, metadata) do
+          proceed_workitem
+          log(:complete, metadata)
+        end
+      end
     end
 
     # Token used to claim task, nil if not claimed
@@ -122,10 +136,10 @@ module Bumbleworks
 
     # Claim task and assign token to claimant
     def claim(token)
-      before_claim(token)
-      set_claimant(token)
-      log(:claim)
-      after_claim(token)
+      with_hooks(:claim, token) do
+        set_claimant(token)
+        log(:claim)
+      end
     end
 
     # true if task is claimed
@@ -136,15 +150,15 @@ module Bumbleworks
     # release claim on task.
     def release
       current_claimant = claimant
-      before_release(current_claimant)
-      log(:release)
-      set_claimant(nil)
-      after_release(current_claimant)
+      with_hooks(:release, current_claimant) do
+        log(:release)
+        set_claimant(nil)
+      end
     end
 
     def on_dispatch
       log(:dispatch)
-      after_dispatch
+      call_after_hooks(:dispatch)
     end
 
     def log(action, metadata = {})
@@ -170,6 +184,11 @@ module Bumbleworks
     end
 
   private
+    def call_hooks(phase, action, *args)
+      (Bumbleworks.observers + [self]).each do |observer|
+        observer.send(:"#{phase}_#{action}", *args)
+      end
+    end
 
     def displayify(modifier, options = {})
       task_name = Bumbleworks::Support.send(modifier, nickname)

data/lib/bumbleworks/task/finder.rb

@@ -3,8 +3,9 @@ module Bumbleworks
     class Finder
       include Enumerable
 
-      def initialize(queries = [])
+      def initialize(queries = [], task_class = Bumbleworks::Task)
         @queries = queries
+        @task_class = task_class
       end
 
       def by_nickname(nickname)
@@ -22,6 +23,15 @@ module Bumbleworks
         for_roles([identifier])
       end
 
+      def unclaimed(check = true)
+        @queries << proc { |wi| wi['fields']['params']['claimant'].nil? == check }
+        self
+      end
+
+      def claimed
+        unclaimed(false)
+      end
+
       def for_claimant(token)
         @queries << proc { |wi| wi['fields']['params']['claimant'] == token }
         self
@@ -57,7 +67,7 @@ module Bumbleworks
         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"
+            raise @task_class::AvailabilityTimeout, "No tasks found matching criteria in time"
           end
           sleep 0.1
         end
@@ -68,7 +78,7 @@ module Bumbleworks
 
       def from_workitems(workitems)
         workitems.map { |wi|
-          Task.new(wi) if wi.params['task']
+          @task_class.new(wi) if wi.params['task']
         }.compact
       end
     end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.34"
+  VERSION = "0.0.35"
 end

data/spec/lib/bumbleworks/configuration_spec.rb

@@ -192,6 +192,18 @@ describe Bumbleworks::Configuration do
     end
   end
 
+  describe '#observers' do
+    it 'is empty by default' do
+      configuration.observers.should be_empty
+    end
+
+    it 'returns the registered observers' do
+      configuration.observers = [:smash, :pumpkin]
+      configuration.observers << :rhubarb
+      configuration.observers.should == [:smash, :pumpkin, :rhubarb]
+    end
+  end
+
   describe "#storage" do
     it 'can set storage directly' do
       storage = double("Storage")

data/spec/lib/bumbleworks/task/finder_spec.rb

@@ -0,0 +1,34 @@
+describe Bumbleworks::Task::Finder do
+  before :each do
+    Bumbleworks.reset!
+    Bumbleworks.storage = {}
+    Bumbleworks::Ruote.register_participants
+    Bumbleworks.start_worker!
+    Bumbleworks.define_process 'dog-lifecycle' do
+      concurrence do
+        dog :task => 'eat'
+        dog :task => 'bark'
+        dog :task => 'pet_dog'
+        cat :task => 'skip_and_jump'
+      end
+    end
+  end
+
+  describe '#all' do
+    it 'uses Bumbleworks::Task class by default for task generation' do
+      Bumbleworks.launch!('dog-lifecycle')
+      Bumbleworks.dashboard.wait_for(:cat)
+      tasks = Bumbleworks::Task::Finder.new.all
+      tasks.should be_all { |t| t.class == Bumbleworks::Task }
+    end
+
+    it 'uses provided class for task generation' do
+      class MyOwnTask < Bumbleworks::Task; end
+      Bumbleworks.launch!('dog-lifecycle')
+      Bumbleworks.dashboard.wait_for(:cat)
+      tasks = Bumbleworks::Task::Finder.new([], MyOwnTask).all
+      tasks.should be_all { |t| t.class == MyOwnTask }
+      Object.send(:remove_const, :MyOwnTask)
+    end
+  end
+end

data/spec/lib/bumbleworks/task_spec.rb

@@ -80,6 +80,20 @@ describe Bumbleworks::Task do
     end
   end
 
+  [:before, :after].each do |phase|
+    describe "#call_#{phase}_hooks" do
+      it "calls #{phase} hooks on task and all observers" do
+        observer1, observer2 = double('observer1'), double('observer2')
+        Bumbleworks.observers = [observer1, observer2]
+        task = described_class.new(workflow_item)
+        task.should_receive(:"#{phase}_snoogle").with(:chachunga, :faloop)
+        observer1.should_receive(:"#{phase}_snoogle").with(:chachunga, :faloop)
+        observer2.should_receive(:"#{phase}_snoogle").with(:chachunga, :faloop)
+        task.send(:"call_#{phase}_hooks", :snoogle, :chachunga, :faloop)
+      end
+    end
+  end
+
   describe '#on_dispatch' do
     before :each do
       Bumbleworks.define_process 'planting_a_noodle' do
@@ -89,7 +103,7 @@ describe Bumbleworks::Task do
       end
     end
 
-    it 'is called when task is dispatched, and triggers callback' do
+    it 'is called when task is dispatched' do
       described_class.any_instance.should_receive(:on_dispatch)
       Bumbleworks.launch!('planting_a_noodle')
       Bumbleworks.dashboard.wait_for(:horse_feeder)
@@ -105,10 +119,10 @@ describe Bumbleworks::Task do
       log_entry[:target_id].should == task.id
     end
 
-    it 'calls after_dispatch callback' do
+    it 'calls after hooks' do
       task = described_class.new(workflow_item)
       task.stub(:log)
-      task.should_receive(:after_dispatch)
+      task.should_receive(:call_after_hooks).with(:dispatch)
       task.on_dispatch
     end
   end
@@ -256,6 +270,51 @@ describe Bumbleworks::Task do
     end
   end
 
+  describe '.unclaimed' do
+    it 'returns all unclaimed tasks' do
+      Bumbleworks.define_process 'dog-lifecycle' do
+        concurrence do
+          dog :task => 'eat'
+          dog :task => 'bark'
+          dog :task => 'pet_dog'
+          cat :task => 'skip_and_jump'
+        end
+        dog :task => 'nap'
+      end
+      Bumbleworks.launch!('dog-lifecycle')
+      Bumbleworks.dashboard.wait_for(:cat)
+      @unclaimed = described_class.unclaimed
+      @unclaimed.map(&:nickname).should =~ ['eat', 'bark', 'pet_dog', 'skip_and_jump']
+      described_class.all.each do |t|
+        t.claim('radish') unless ['pet_dog', 'bark'].include?(t.nickname)
+      end
+      @unclaimed = described_class.unclaimed
+      @unclaimed.map(&:nickname).should =~ ['pet_dog', 'bark']
+    end
+  end
+
+  describe '.claimed' do
+    it 'returns all claimed tasks' do
+      Bumbleworks.define_process 'dog-lifecycle' do
+        concurrence do
+          dog :task => 'eat'
+          dog :task => 'bark'
+          dog :task => 'pet_dog'
+          cat :task => 'skip_and_jump'
+        end
+        dog :task => 'nap'
+      end
+      Bumbleworks.launch!('dog-lifecycle')
+      Bumbleworks.dashboard.wait_for(:cat)
+      described_class.claimed.should be_empty
+      described_class.all.each_with_index do |t, i|
+        t.claim("radish_#{i}") unless ['pet_dog', 'bark'].include?(t.nickname)
+      end
+      @claimed = described_class.claimed
+      @claimed.map(&:nickname).should =~ ['eat', 'skip_and_jump']
+    end
+  end
+
   describe '.all' do
     before :each do
       Bumbleworks.define_process 'dog-lifecycle' do
@@ -282,6 +341,14 @@ describe Bumbleworks::Task do
         ['dog_legs', 'skip_and_jump']
       ]
     end
+
+    it 'uses subclass for generation of tasks' do
+      class MyOwnTask < Bumbleworks::Task; end
+      Bumbleworks.dashboard.wait_for(:dog_legs)
+      tasks = MyOwnTask.all
+      tasks.should be_all { |t| t.class == MyOwnTask }
+      Object.send(:remove_const, :MyOwnTask)
+    end
   end
 
   describe '#[], #[]=' do
@@ -471,10 +538,10 @@ describe Bumbleworks::Task do
         @task.params['claimed_at'].should be_nil
       end
 
-      it 'calls before_release and after_release callbacks' do
-        @task.should_receive(:before_release).with('boss').ordered
+      it 'calls with hooks' do
+        @task.should_receive(:call_before_hooks).with(:release, 'boss').ordered
         @task.should_receive(:set_claimant).ordered
-        @task.should_receive(:after_release).with('boss').ordered
+        @task.should_receive(:call_after_hooks).with(:release, 'boss').ordered
         @task.release
       end
 
@@ -508,12 +575,12 @@ describe Bumbleworks::Task do
         task.fields['meal'].should == 'salted_rhubarb'
       end
 
-      it 'calls before_update and after_update callbacks' do
+      it 'calls with hooks' do
         task = described_class.new(workflow_item)
         task.stub(:log)
-        task.should_receive(:before_update).with(:argue_mints).ordered
+        task.should_receive(:call_before_hooks).with(:update, :argue_mints).ordered
         task.should_receive(:update_workitem).ordered
-        task.should_receive(:after_update).with(:argue_mints).ordered
+        task.should_receive(:call_after_hooks).with(:update, :argue_mints).ordered
         task.update(:argue_mints)
       end
 
@@ -570,11 +637,11 @@ describe Bumbleworks::Task do
       it 'calls update and complete callbacks' do
         task = described_class.new(workflow_item)
         task.stub(:log)
-        task.should_receive(:before_update).with(:argue_mints).ordered
-        task.should_receive(:before_complete).with(:argue_mints).ordered
+        task.should_receive(:call_before_hooks).with(:update, :argue_mints).ordered
+        task.should_receive(:call_before_hooks).with(:complete, :argue_mints).ordered
         task.should_receive(:proceed_workitem).ordered
-        task.should_receive(:after_complete).with(:argue_mints).ordered
-        task.should_receive(:after_update).with(:argue_mints).ordered
+        task.should_receive(:call_after_hooks).with(:complete, :argue_mints).ordered
+        task.should_receive(:call_after_hooks).with(:update, :argue_mints).ordered
         task.complete(:argue_mints)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.35
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -213,6 +213,7 @@ files:
 - spec/lib/bumbleworks/simple_logger_spec.rb
 - spec/lib/bumbleworks/storage_adapter_spec.rb
 - spec/lib/bumbleworks/support_spec.rb
+- spec/lib/bumbleworks/task/finder_spec.rb
 - spec/lib/bumbleworks/task_spec.rb
 - spec/lib/bumbleworks/tree_builder_spec.rb
 - spec/lib/bumbleworks/workitem_entity_storage_spec.rb
@@ -233,12 +234,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -265632514630841988
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -265632514630841988
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -273,6 +280,7 @@ test_files:
 - spec/lib/bumbleworks/simple_logger_spec.rb
 - spec/lib/bumbleworks/storage_adapter_spec.rb
 - spec/lib/bumbleworks/support_spec.rb
+- spec/lib/bumbleworks/task/finder_spec.rb
 - spec/lib/bumbleworks/task_spec.rb
 - spec/lib/bumbleworks/tree_builder_spec.rb
 - spec/lib/bumbleworks/workitem_entity_storage_spec.rb
@@ -280,4 +288,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/path_helpers.rb
 - spec/support/tracer.rb
-has_rdoc: