bumbleworks 0.0.12 → 0.0.13

data/lib/bumbleworks.rb

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

data/lib/bumbleworks/configuration.rb

@@ -73,6 +73,16 @@ module Bumbleworks
     #
     define_setting :storage
 
+    # Bumbleworks will attempt to log a variety of events (tasks becoming
+    # available, being claimed/released/completed, etc), and to do so it uses
+    # the logger registered in configuration.  If no logger has been registered,
+    # Bumbleworks will use its SimpleLogger, which just adds the entries to an
+    # array.  See the SimpleLogger for hints on implementing your own logger;
+    # notably, you can also use an instance Ruby's built-in Logger class.
+    #
+    # default: Bumbleworks::SimpleLogger
+    define_setting :logger
+
     def initialize
       @storage_adapters = []
     end
@@ -134,6 +144,10 @@ module Bumbleworks
       @storage_adapters
     end
 
+    def logger
+      @logger ||= Bumbleworks::SimpleLogger
+    end
+
     # Clears all memoize variables and configuration settings
     #
     def clear!

data/lib/bumbleworks/simple_logger.rb

@@ -0,0 +1,23 @@
+module Bumbleworks
+  class SimpleLogger
+    class << self
+      def entries
+        @entries ||= []
+      end
+
+      def add(level, entry)
+        entries << { :level => level, :entry => entry }
+      end
+
+      def clear!
+        @entries = []
+      end
+
+      [:debug, :info, :warn, :error, :fatal].each do |level|
+        define_method level.to_sym do |entry|
+          add level, entry
+        end
+      end
+    end
+  end
+end

data/lib/bumbleworks/task.rb

@@ -113,6 +113,7 @@ module Bumbleworks
     def update(metadata = {})
       before_update(metadata)
       update_workitem
+      log(:update, metadata)
       after_update(metadata)
     end
 
@@ -121,6 +122,7 @@ module Bumbleworks
       before_update(metadata)
       before_complete(metadata)
       proceed_workitem
+      log(:complete, metadata)
       after_complete(metadata)
       after_update(metadata)
     end
@@ -133,6 +135,7 @@ module Bumbleworks
     # Claim task and assign token to claimant
     def claim(token)
       set_claimant(token)
+      log(:claim)
     end
 
     # true if task is claimed
@@ -142,9 +145,20 @@ module Bumbleworks
 
     # release claim on task.
     def release
+      log(:release)
       set_claimant(nil)
     end
 
+    def log(action, metadata = {})
+      Bumbleworks.logger.info({
+        :actor => params['claimant'],
+        :action => action,
+        :object_type => 'Task',
+        :object_id => id,
+        :metadata => metadata.merge(fields)
+      })
+    end
+
   private
 
     def storage_participant
@@ -165,7 +179,7 @@ module Bumbleworks
       end
 
       params['claimant'] = token
-      save
+      update_workitem
     end
   end
 end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/spec/lib/bumbleworks/configuration_spec.rb

@@ -129,6 +129,17 @@ describe Bumbleworks::Configuration do
     end
   end
 
+  describe '#logger' do
+    it 'returns the registered logger' do
+      configuration.logger = :a_logger
+      configuration.logger.should == :a_logger
+    end
+
+    it 'returns the default simple logger if no logger registered' do
+      configuration.logger.should == Bumbleworks::SimpleLogger
+    end
+  end
+
   describe "#storage" do
     it 'can set storage directly' do
       storage = double("Storage")

data/spec/lib/bumbleworks/simple_logger_spec.rb

@@ -0,0 +1,51 @@
+describe Bumbleworks::SimpleLogger do
+  before :each do
+    Bumbleworks::SimpleLogger.clear!
+  end
+
+  [:info, :debug, :fatal, :warn, :error].each do |level|
+    describe ".#{level}" do
+      it "adds given object to the log with '#{level}' level" do
+        described_class.should_receive(:add).
+          with(level, :something => :happened)
+        described_class.send(level.to_sym, :something => :happened)
+      end
+    end
+  end
+
+  describe '.add' do
+    it 'adds given object to the log at given level' do
+      described_class.add(:info, :super_serious_occurrence)
+      described_class.add(:debug, :weird_thing)
+      described_class.entries.should == [
+        { :level => :info, :entry => :super_serious_occurrence },
+        { :level => :debug, :entry => :weird_thing }
+      ]
+    end
+  end
+
+  describe '.entries' do
+    it 'returns entries at all levels when given no filter' do
+      described_class.info 'thing'
+      described_class.debug 'other thing'
+      described_class.info 'third thing'
+      described_class.fatal 'final thing'
+      described_class.entries.should == [
+        { :level => :info, :entry => 'thing' },
+        { :level => :debug, :entry => 'other thing' },
+        { :level => :info, :entry => 'third thing' },
+        { :level => :fatal, :entry => 'final thing' }
+      ]
+    end
+  end
+
+  describe '.clear!' do
+    it 'deletes all entries' do
+      described_class.entries.should be_empty
+      described_class.info 'thing'
+      described_class.entries.should_not be_empty
+      described_class.clear!
+      described_class.entries.should be_empty
+    end
+  end
+end

data/spec/lib/bumbleworks/task_spec.rb

@@ -68,11 +68,6 @@ describe Bumbleworks::Task do
   end
 
   describe '#task_module' do
-    # def task_module
-    #   return nil unless nickname
-    #   klass_name = Bumbleworks::Support.camelize(nickname)
-    #   klass = Bumbleworks::Support.constantize("Bumbleworks::Tasks::#{klass_name}")
-    # end
     it 'returns nil if no nickname' do
       task = described_class.new(workflow_item)
       task.stub(:nickname).and_return(nil)
@@ -245,49 +240,65 @@ describe Bumbleworks::Task do
   end
 
   context 'claiming things' do
-    subject{described_class.new(workflow_item)}
     before :each do
-      subject.stub(:save)
-      workflow_item.params['claimant'] = nil
-      subject.claim('boss')
+      Bumbleworks.define_process 'planting_a_noodle' do
+        noodle_gardener :task => 'plant_noodle_seed'
+      end
+      Bumbleworks.launch!('planting_a_noodle')
+      Bumbleworks.dashboard.wait_for(:noodle_gardener)
+      @task = described_class.for_role('noodle_gardener').first
+      @task.claim('boss')
     end
 
     describe '#claim' do
       it 'sets token on  "claimant" param' do
-        workflow_item.params['claimant'].should == 'boss'
+        @task.params['claimant'].should == 'boss'
       end
 
       it 'raises an error if already claimed by someone else' do
-        expect{subject.claim('peon')}.to raise_error described_class::AlreadyClaimed
+        expect{@task.claim('peon')}.to raise_error described_class::AlreadyClaimed
       end
 
       it 'does not raise an error if attempting to claim by same token' do
-        expect{subject.claim('boss')}.not_to raise_error described_class::AlreadyClaimed
+        expect{@task.claim('boss')}.not_to raise_error described_class::AlreadyClaimed
+      end
+
+      it 'logs event' do
+        log_entry = Bumbleworks.logger.entries.last[:entry]
+        log_entry[:action].should == :claim
+        log_entry[:actor].should == 'boss'
       end
     end
 
     describe '#claimant' do
       it 'returns token of who has claim' do
-        subject.claimant.should == 'boss'
+        @task.claimant.should == 'boss'
       end
     end
 
     describe '#claimed?' do
       it 'returns true if claimed' do
-        subject.claimed?.should be_true
+        @task.claimed?.should be_true
       end
 
       it 'false otherwise' do
-        workflow_item.params['claimant'] = nil
-        subject.claimed?.should be_false
+        @task.params['claimant'] = nil
+        @task.claimed?.should be_false
       end
     end
 
     describe '#release' do
       it "release claim on workitem" do
-        subject.should be_claimed
-        subject.release
-        subject.should_not be_claimed
+        @task.should be_claimed
+        @task.release
+        @task.should_not be_claimed
+      end
+
+      it 'logs event' do
+        @task.release
+        log_entry = Bumbleworks.logger.entries.last[:entry]
+        log_entry[:action].should == :release
+        log_entry[:actor].should == 'boss'
       end
     end
   end
@@ -315,11 +326,28 @@ describe Bumbleworks::Task do
 
       it 'calls before_update and after_update callbacks' do
         task = described_class.new(workflow_item)
+        task.stub(:log)
         task.should_receive(:before_update).with(:argue_mints).ordered
         task.should_receive(:update_workitem).ordered
         task.should_receive(:after_update).with(:argue_mints).ordered
         task.update(:argue_mints)
       end
+
+      it 'logs event' do
+        event = Bumbleworks.dashboard.wait_for :dog_mouth
+        task = described_class.for_role('dog_mouth').first
+        task.params['claimant'] = :some_user
+        task.update(:extra_data => :fancy)
+        Bumbleworks.logger.entries.last.should == {
+          :level => :info, :entry => {
+            :actor => :some_user,
+            :action => :update,
+            :object_type => 'Task',
+            :object_id => task.id,
+            :metadata => { :extra_data => :fancy }.merge(task.fields)
+          }
+        }
+      end
     end
 
     describe '#complete' do
@@ -338,6 +366,7 @@ 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(:proceed_workitem).ordered
@@ -345,6 +374,22 @@ describe Bumbleworks::Task do
         task.should_receive(:after_update).with(:argue_mints).ordered
         task.complete(:argue_mints)
       end
+
+      it 'logs event' do
+        event = Bumbleworks.dashboard.wait_for :dog_mouth
+        task = described_class.for_role('dog_mouth').first
+        task.params['claimant'] = :some_user
+        task.complete(:extra_data => :fancy)
+        Bumbleworks.logger.entries.last.should == {
+          :level => :info, :entry => {
+            :actor => :some_user,
+            :action => :complete,
+            :object_type => 'Task',
+            :object_id => task.id,
+            :metadata => { :extra_data => :fancy }.merge(task.fields)
+          }
+        }
+      end
     end
 
     describe '#has_entity_fields?' do

data/spec/lib/bumbleworks_spec.rb

@@ -150,4 +150,11 @@ describe Bumbleworks do
       }.to raise_error(Bumbleworks::InvalidEntity)
     end
   end
+
+  describe '.logger' do
+    it 'delegates to configuration.logger' do
+      described_class.configuration.stub(:logger).and_return(:a_logger)
+      described_class.logger.should == :a_logger
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -172,6 +172,7 @@ files:
 - lib/bumbleworks/process_definition.rb
 - lib/bumbleworks/rake_tasks.rb
 - lib/bumbleworks/ruote.rb
+- lib/bumbleworks/simple_logger.rb
 - lib/bumbleworks/storage_adapter.rb
 - lib/bumbleworks/support.rb
 - lib/bumbleworks/task.rb
@@ -200,6 +201,7 @@ files:
 - spec/lib/bumbleworks/participant_registration_spec.rb
 - spec/lib/bumbleworks/process_definition_spec.rb
 - spec/lib/bumbleworks/ruote_spec.rb
+- spec/lib/bumbleworks/simple_logger_spec.rb
 - spec/lib/bumbleworks/storage_adapter_spec.rb
 - spec/lib/bumbleworks/support_spec.rb
 - spec/lib/bumbleworks/task_spec.rb
@@ -254,6 +256,7 @@ test_files:
 - spec/lib/bumbleworks/participant_registration_spec.rb
 - spec/lib/bumbleworks/process_definition_spec.rb
 - spec/lib/bumbleworks/ruote_spec.rb
+- spec/lib/bumbleworks/simple_logger_spec.rb
 - spec/lib/bumbleworks/storage_adapter_spec.rb
 - spec/lib/bumbleworks/support_spec.rb
 - spec/lib/bumbleworks/task_spec.rb