bumbleworks 0.0.43 → 0.0.44

data/lib/bumbleworks.rb

@@ -54,6 +54,13 @@ module Bumbleworks
       end
     end
 
+    # @public
+    # Return true only if store_history (from configuration) is true.
+    #
+    def store_history?
+      configuration.store_history == true
+    end
+
     # @public
     # Yields the global configuration to a block.
     # @yield [configuration] global configuration
@@ -117,7 +124,6 @@ module Bumbleworks
     #
     def reset!
       @configuration = nil
-      @participant_block = nil
       Bumbleworks::Ruote.reset!
     end
 

data/lib/bumbleworks/configuration.rb

@@ -112,6 +112,18 @@ module Bumbleworks
     #
     define_setting :error_handlers
 
+    # If #store_history is true, all messages will be logged in the storage under a special
+    # "history" key.  These messages will remain in the history even after a process has been
+    # cancelled or completed, so the history can be used for auditing.
+    #
+    # If #store_history is false, history will be stored in-memory, but only the last 1000 messages,
+    # and since this is in memory, it's useless for multiple workers in separate processes.
+    #
+    # Important Note:  This setting is *ignored* if the storage is a HashStorage, since having a
+    # persistent storage in this case wouldn't make sense (the Hash itself being in-memory).
+    #
+    define_setting :store_history
+
     def initialize
       @storage_adapters = []
       @timeout ||= 5
@@ -141,6 +153,11 @@ module Bumbleworks
       @tasks_folder ||= default_tasks_directory
     end
 
+    # Default history storage to true
+    def store_history
+      @store_history.nil? ? true : @store_history
+    end
+
     # Root folder where Bumbleworks looks for ruote assets (participants,
     # process_definitions, etc.)  The root path must be absolute.
     # It can be defined through a configuration block:

data/lib/bumbleworks/hash_storage.rb

@@ -10,6 +10,10 @@ module Bumbleworks
       def storage_class
         Hash
       end
+
+      def allow_history_storage?
+        false
+      end
     end
   end
 end

data/lib/bumbleworks/ruote.rb

@@ -28,6 +28,8 @@ module Bumbleworks
       #   exits.
       #
       def start_worker!(options = {})
+        set_up_storage_history
+        register_error_handler
         dashboard.noisy = options[:verbose] == true
         worker = ::Ruote::Worker.new(dashboard.context)
         if options[:join] == true
@@ -35,7 +37,6 @@ module Bumbleworks
         else
           worker.run_in_thread
         end
-        register_error_handler
         worker
       end
 
@@ -112,6 +113,12 @@ module Bumbleworks
         end
       end
 
+      def set_up_storage_history
+        if storage_adapter.allow_history_storage?
+          dashboard.add_service('history', 'ruote/log/storage_history', 'Ruote::StorageHistory')
+        end
+      end
+
       def set_catchall_if_needed
         last_participant = dashboard.participant_list.last
         unless last_participant && last_participant.regex == "^.+$" &&
@@ -121,23 +128,28 @@ module Bumbleworks
         end
       end
 
-      def storage
-        @storage ||= begin
+      def storage_adapter
+        @storage_adapter ||= begin
           all_adapters = Bumbleworks.configuration.storage_adapters
-          adapter = all_adapters.detect do |adapter|
-            adapter.use?(Bumbleworks.storage)
+          adapter = all_adapters.detect do |potential_adapter|
+            potential_adapter.use?(Bumbleworks.storage)
           end
           raise UndefinedSetting, "Storage is missing or not supported.  Supported: #{all_adapters.map(&:display_name).join(', ')}" unless adapter
-          adapter.driver.new(Bumbleworks.storage)
+          adapter
         end
       end
 
+      def storage
+        @storage ||= storage_adapter.driver.new(Bumbleworks.storage)
+      end
+
       def reset!
         if @storage
           @storage.purge!
           @storage.shutdown
         end
         @dashboard.shutdown if @dashboard && @dashboard.respond_to?(:shutdown)
+        @storage_adapter = nil
         @storage = nil
         @dashboard = nil
       end

data/lib/bumbleworks/storage_adapter.rb

@@ -22,6 +22,10 @@ module Bumbleworks
       def display_name
         storage_class.name
       end
+
+      def allow_history_storage?
+        true
+      end
     end
   end
 end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.43"
+  VERSION = "0.0.44"
 end

data/spec/fixtures/apps/with_default_directories/full_initializer.rb

@@ -10,4 +10,5 @@ end
 
 Bumbleworks.register_tasks
 Bumbleworks.load_definitions!
+Bumbleworks.dashboard.add_service('history', 'ruote/log/storage_history', 'Ruote::StorageHistory')
 Bumbleworks.start_worker!

data/spec/lib/bumbleworks/configuration_spec.rb

@@ -266,4 +266,15 @@ describe Bumbleworks::Configuration do
       configuration.error_handlers.should =~ [Bumbleworks::ErrorLogger, super_handler]
     end
   end
+
+  describe '#store_history' do
+    it 'defaults to true' do
+      subject.store_history.should be_true
+    end
+
+    it 'can be overridden' do
+      subject.store_history = false
+      subject.store_history.should be_false
+    end
+  end
 end

data/spec/lib/bumbleworks/hash_storage_spec.rb

@@ -0,0 +1,11 @@
+describe Bumbleworks::HashStorage do
+  describe '.allow_history_storage?' do
+    it 'returns false' do
+      described_class.allow_history_storage?.should be_false
+    end
+
+    it 'is a Bumbleworks::StorageAdapter' do
+      described_class.is_a? Bumbleworks::StorageAdapter
+    end
+  end
+end

data/spec/lib/bumbleworks/ruote_spec.rb

@@ -226,6 +226,11 @@ describe Bumbleworks::Ruote do
       described_class.start_worker!
     end
 
+    it 'calls set_up_storage_history' do
+      described_class.should_receive(:set_up_storage_history)
+      described_class.start_worker!
+    end
+
     it 'does not add another error_handler_participant if already registered' do
       described_class.register_participants
       described_class.start_worker!
@@ -235,6 +240,26 @@ describe Bumbleworks::Ruote do
     end
   end
 
+  describe '.set_up_storage_history' do
+    it 'adds a storage history service to the dashboard if storage adapter allows it' do
+      storage_adapter = double('adapter', :allow_history_storage? => true)
+      described_class.stub(:storage_adapter => storage_adapter)
+      described_class.stub(:storage => Ruote::HashStorage.new({}))
+      Bumbleworks.dashboard.should_receive(:add_service).with(
+        'history', 'ruote/log/storage_history', 'Ruote::StorageHistory'
+      )
+      described_class.set_up_storage_history
+    end
+
+    it 'does not add a storage history service to the dashboard if not allowed' do
+      storage_adapter = double('adapter', :allow_history_storage? => false)
+      described_class.stub(:storage_adapter => storage_adapter)
+      described_class.stub(:storage => Ruote::HashStorage.new({}))
+      Bumbleworks.dashboard.should_receive(:add_service).never
+      described_class.set_up_storage_history
+    end
+  end
+
   describe '.register_participants' do
     it 'loads participants from given block, adding storage participant catchall' do
       registration_block = Proc.new {
@@ -326,4 +351,49 @@ describe Bumbleworks::Ruote do
       described_class.dashboard.participant_list.first.classname.should == 'Bumbleworks::StorageParticipant'
     end
   end
+
+  describe '.reset!' do
+    it 'clears storage_adapter' do
+      described_class.instance_variable_set(:@storage_adapter, 'the adapter')
+      described_class.reset!
+      described_class.instance_variable_get(:@storage_adapter).should be_nil
+    end
+
+    it 'purges and shuts down storage, then resets storage' do
+      old_storage = described_class.storage
+      old_storage.should_receive(:purge!)
+      old_storage.should_receive(:shutdown)
+      described_class.reset!
+      described_class.storage.should_not == old_storage
+    end
+
+    it 'skips purging and shutting down of storage if no storage' do
+      described_class.instance_variable_set(:@storage, nil)
+      expect {
+        described_class.reset!
+      }.not_to raise_error
+    end
+
+    it 'shuts down dashboard and detaches' do
+      old_dashboard = described_class.dashboard
+      old_dashboard.should_receive(:shutdown)
+      described_class.reset!
+      described_class.dashboard.should_not == old_dashboard
+    end
+
+    it 'skips shutting down dashboard if no dashboard' do
+      described_class.instance_variable_set(:@dashboard, nil)
+      expect {
+        described_class.reset!
+      }.not_to raise_error
+    end
+
+    it 'skips shutting down dashboard if dashboard can not be shutdown' do
+      dashboard = double('dashboard', :respond_to? => false)
+      described_class.instance_variable_set(:@dashboard, dashboard)
+      dashboard.should_receive(:shutdown).never
+      described_class.reset!
+      described_class.dashboard.should_not == dashboard
+    end
+  end
 end

data/spec/lib/bumbleworks/storage_adapter_spec.rb

@@ -35,6 +35,12 @@ describe Bumbleworks::StorageAdapter do
     end
   end
 
+  describe '.allow_history_storage?' do
+    it 'defaults to true' do
+      described_class.allow_history_storage?.should be_true
+    end
+  end
+
   describe '.use?' do
     before :each do
       described_class.stub(:storage_class).and_return(String)

data/spec/lib/bumbleworks_spec.rb

@@ -35,6 +35,15 @@ describe Bumbleworks do
     end
   end
 
+  describe '.reset!' do
+    it 'resets configuration and resets ruote' do
+      old_config = described_class.configuration
+      Bumbleworks::Ruote.should_receive(:reset!)
+      described_class.reset!
+      described_class.configuration.should_not == old_config
+    end
+  end
+
   describe '.storage' do
     it 'can set directly' do
       storage = double("Storage")
@@ -189,4 +198,25 @@ describe Bumbleworks do
       described_class.logger.should == :a_logger
     end
   end
+
+  describe '.store_history' do
+    it 'delegates to configuration.logger' do
+      described_class.configuration.stub(:store_history).and_return(:why_not)
+      described_class.store_history.should == :why_not
+    end
+  end
+
+  describe '#store_history?' do
+    it 'returns true if store_history is true' do
+      subject.store_history = true
+      subject.store_history?.should be_true
+    end
+
+    it 'returns false if store_history is anything but true' do
+      subject.store_history = false
+      subject.store_history?.should be_false
+      subject.store_history = 'penguins'
+      subject.store_history?.should be_false
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.43
+  version: 0.0.44
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -211,6 +211,7 @@ files:
 - spec/lib/bumbleworks/error_handler_participant_spec.rb
 - spec/lib/bumbleworks/error_handler_spec.rb
 - spec/lib/bumbleworks/error_logger_spec.rb
+- spec/lib/bumbleworks/hash_storage_spec.rb
 - spec/lib/bumbleworks/local_participant_spec.rb
 - spec/lib/bumbleworks/participant_registration_spec.rb
 - spec/lib/bumbleworks/participant_spec.rb
@@ -244,7 +245,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1294048902539087769
+      hash: 1016861213985986002
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -253,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1294048902539087769
+      hash: 1016861213985986002
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -282,6 +283,7 @@ test_files:
 - spec/lib/bumbleworks/error_handler_participant_spec.rb
 - spec/lib/bumbleworks/error_handler_spec.rb
 - spec/lib/bumbleworks/error_logger_spec.rb
+- spec/lib/bumbleworks/hash_storage_spec.rb
 - spec/lib/bumbleworks/local_participant_spec.rb
 - spec/lib/bumbleworks/participant_registration_spec.rb
 - spec/lib/bumbleworks/participant_spec.rb