bumbleworks 0.0.44 → 0.0.45

data/lib/bumbleworks/configuration.rb

@@ -65,7 +65,7 @@ module Bumbleworks
     # two require the bumbleworks-redis and bumbleworks-sequel gems, respectively.
     # You can set the storage as follows:
     #
-    # @Exammple: Redis
+    # @Example: Redis
     #   Bumbleworks.storage = Redis.new(:host => '127.0.0.1', :db => 0, :thread_safe => true)
     #
     # @Example: Sequel with Postgres db
@@ -73,6 +73,17 @@ module Bumbleworks
     #
     define_setting :storage
 
+    # Normally, the first adapter in the storage_adapters list that can #use? the
+    # configured storage will be used automatically.  This may not be what you want;
+    # if you have multiple adapters that can use a Redis database or a Hash, for
+    # example, you may want to specify explicitly which one to use.  Use this setting
+    # to override the automatic adapter selection.
+    #
+    # @Example:
+    #   Bumbleworks.storage_adapter = Bumbleworks::OtherHashStorage
+    #
+    define_setting :storage_adapter
+
     # 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,
@@ -186,12 +197,27 @@ module Bumbleworks
     #
     def add_storage_adapter(adapter)
       raise ArgumentError, "#{adapter} is not a Bumbleworks storage adapter" unless
-        [:driver, :use?, :storage_class, :display_name].all? { |m| adapter.respond_to?(m) }
+        [:driver, :use?, :new_storage, :allow_history_storage?, :storage_class, :display_name].all? { |m| adapter.respond_to?(m) }
 
       @storage_adapters << adapter
       @storage_adapters
     end
 
+    # If storage_adapter is not explicitly set, find first registered adapter that
+    # can use Bumbleworks.storage.
+    #
+    def storage_adapter
+      @storage_adapter ||= begin
+        all_adapters = storage_adapters
+        raise UndefinedSetting, "No storage adapters configured" if all_adapters.empty?
+        adapter = all_adapters.detect do |potential_adapter|
+          potential_adapter.use?(storage)
+        end
+        raise UndefinedSetting, "Storage is missing or not supported.  Supported: #{all_adapters.map(&:display_name).join(', ')}" unless adapter
+        adapter
+      end
+    end
+
     def logger
       @logger ||= Bumbleworks::SimpleLogger
     end

data/lib/bumbleworks/ruote.rb

@@ -114,7 +114,7 @@ module Bumbleworks
       end
 
       def set_up_storage_history
-        if storage_adapter.allow_history_storage?
+        if Bumbleworks.storage_adapter.allow_history_storage?
           dashboard.add_service('history', 'ruote/log/storage_history', 'Ruote::StorageHistory')
         end
       end
@@ -128,19 +128,8 @@ module Bumbleworks
         end
       end
 
-      def storage_adapter
-        @storage_adapter ||= begin
-          all_adapters = Bumbleworks.configuration.storage_adapters
-          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
-        end
-      end
-
       def storage
-        @storage ||= storage_adapter.driver.new(Bumbleworks.storage)
+        @storage ||= Bumbleworks.storage_adapter.new_storage(Bumbleworks.storage)
       end
 
       def reset!
@@ -149,7 +138,6 @@ module Bumbleworks
           @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

@@ -1,5 +1,6 @@
 module Bumbleworks
   class StorageAdapter
+    class UnsupportedStorage < StandardError; end
     class << self
       attr_accessor :auto_register
 
@@ -11,6 +12,11 @@ module Bumbleworks
         raise "Subclass responsibility"
       end
 
+      def new_storage(storage)
+        raise UnsupportedStorage unless use?(storage)
+        driver.new(storage)
+      end
+
       def use?(storage)
         storage.is_a? storage_class
       end

data/lib/bumbleworks/version.rb

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

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

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

data/spec/integration/history_storage_spec.rb

@@ -0,0 +1,52 @@
+describe 'History storage' do
+  let(:app_root) {
+    File.expand_path(File.join(fixtures_path, 'apps', 'with_default_directories'))
+  }
+
+  class HashStorageWithHistory < Bumbleworks::HashStorage
+    def self.allow_history_storage?
+      true
+    end
+  end
+
+  before :each do
+    Bumbleworks.reset!
+  end
+
+  context 'when storage allows storing history' do
+    before :each do
+      Bumbleworks.stub(:storage_adapter => HashStorageWithHistory)
+      load File.join(app_root, 'full_initializer.rb')
+    end
+
+    it 'uses storage for history' do
+      Bumbleworks.dashboard.history.should be_a(::Ruote::StorageHistory)
+    end
+
+    it 'keeps history of messages' do
+      Bumbleworks::Ruote.storage.get_many('history').should be_empty
+      wfid = Bumbleworks.launch!('make_honey')
+      Bumbleworks.dashboard.wait_for(:dave)
+      Bumbleworks::Ruote.storage.get_many('history').should_not be_empty
+      Bumbleworks.dashboard.history.wfids.should include(wfid)
+    end
+  end
+
+  context 'when storage does not allow storing history' do
+    before :each do
+      load File.join(app_root, 'full_initializer.rb')
+    end
+
+    it 'does not use storage for history' do
+      Bumbleworks.dashboard.history.should be_a(::Ruote::DefaultHistory)
+    end
+
+    it 'keeps history of messages' do
+      Bumbleworks.dashboard.history.by_date(Date.today).should be_empty
+      wfid = Bumbleworks.launch!('make_honey')
+      Bumbleworks.dashboard.wait_for(:dave)
+      Bumbleworks.dashboard.history.by_date(Date.today).should_not be_empty
+      Bumbleworks.dashboard.history.wfids.should include(wfid)
+    end
+  end
+end

data/spec/lib/bumbleworks/configuration_spec.rb

@@ -212,11 +212,41 @@ describe Bumbleworks::Configuration do
     end
   end
 
+  describe "#storage_adapter" do
+    it 'defaults to first adapter in registered list that uses storage' do
+      right_adapter = double('right', :use? => true)
+      wrong_adapter_1 = double('wrong1', :use? => false)
+      wrong_adapter_2 = double('wrong2', :use? => false)
+      subject.stub(:storage_adapters => [wrong_adapter_1, right_adapter, wrong_adapter_2])
+      subject.storage_adapter.should == right_adapter
+    end
+
+    it 'can be set storage directly' do
+      storage = double("Storage Adapter")
+      subject.storage_adapter = storage
+      subject.storage_adapter.should == storage
+    end
+
+    it 'raises UndefinedSetting if no matching storage adapter' do
+      wrong_adapter = double('wrong1', :use? => false, :display_name => 'Wrong')
+      subject.stub(:storage_adapters => [wrong_adapter])
+      expect {
+        subject.storage_adapter
+      }.to raise_error(Bumbleworks::UndefinedSetting,
+        "Storage is missing or not supported.  Supported: Wrong")
+    end
+
+    it 'raises UndefinedSetting if no storage adapters' do
+      expect {
+        subject.storage_adapter
+      }.to raise_error(Bumbleworks::UndefinedSetting,
+        "No storage adapters configured")
+    end
+  end
+
   describe '#add_storage_adapter' do
     it 'adds storage adapter to registered list' do
-      GoodForNothingStorage = OpenStruct.new(
-        :driver => nil, :storage_class => 'Dummy', :display_name => 'Dummy', :use? => true
-      )
+      GoodForNothingStorage = double('fake_storage', :respond_to? => true)
       configuration.storage_adapters.should be_empty
       configuration.add_storage_adapter(GoodForNothingStorage)
       configuration.add_storage_adapter(Bumbleworks::HashStorage)

data/spec/lib/bumbleworks/ruote_spec.rb

@@ -243,7 +243,7 @@ describe Bumbleworks::Ruote do
   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)
+      Bumbleworks.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'
@@ -253,7 +253,7 @@ describe Bumbleworks::Ruote do
 
     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)
+      Bumbleworks.storage_adapter = storage_adapter
       described_class.stub(:storage => Ruote::HashStorage.new({}))
       Bumbleworks.dashboard.should_receive(:add_service).never
       described_class.set_up_storage_history
@@ -323,14 +323,17 @@ describe Bumbleworks::Ruote do
   describe '.storage' do
     it 'raise error when storage is not defined' do
       Bumbleworks.storage = nil
-      expect { described_class.send(:storage) }.to raise_error Bumbleworks::UndefinedSetting
+      expect { described_class.storage }.to raise_error Bumbleworks::UndefinedSetting
     end
 
-    it 'handles Hash storage' do
+    it 'returns new storage from configured adapter' do
+      driven_storage = ::Ruote::HashStorage.new({})
       storage = {}
+      adapter = double('Adapter')
+      adapter.stub(:new_storage).with(storage).and_return(driven_storage)
       Bumbleworks.storage = storage
-      Ruote::HashStorage.should_receive(:new).with(storage)
-      described_class.send(:storage)
+      Bumbleworks.storage_adapter = adapter
+      described_class.storage.should == driven_storage
     end
   end
 
@@ -353,12 +356,6 @@ describe Bumbleworks::Ruote do
   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!)

data/spec/lib/bumbleworks/storage_adapter_spec.rb

@@ -51,4 +51,24 @@ describe Bumbleworks::StorageAdapter do
       described_class.use?(:not_a_string).should be_false
     end
   end
+
+  describe '.new_storage' do
+    before :each do
+      storage_driver = double('storage_driver')
+      storage_driver.stub(:new).with(:awesome_stuff).and_return(:new_storage)
+      described_class.stub(:driver => storage_driver)
+    end
+
+    it 'returns driven storage if driver can use storage' do
+      described_class.stub(:use?).with(:awesome_stuff).and_return(true)
+      described_class.new_storage(:awesome_stuff).should == :new_storage
+    end
+
+    it "raises UnsupportedStorage if driver can't use storage" do
+      described_class.stub(:use?).with(:awesome_stuff).and_return(false)
+      expect {
+        described_class.new_storage(:awesome_stuff)
+      }.to raise_error(Bumbleworks::StorageAdapter::UnsupportedStorage)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.44
+  version: 0.0.45
   prerelease: 
 platform: ruby
 authors:
@@ -205,7 +205,8 @@ files:
 - spec/fixtures/definitions/a_list_of_jams.rb
 - spec/fixtures/definitions/nested_folder/test_nested_process.rb
 - spec/fixtures/definitions/test_process.rb
-- spec/integration/configuration_spec.rb
+- spec/integration/example_configurations_spec.rb
+- spec/integration/history_storage_spec.rb
 - spec/integration/sample_application_spec.rb
 - spec/lib/bumbleworks/configuration_spec.rb
 - spec/lib/bumbleworks/error_handler_participant_spec.rb
@@ -245,7 +246,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1016861213985986002
+      hash: 2245939095029135345
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -254,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1016861213985986002
+      hash: 2245939095029135345
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -277,7 +278,8 @@ test_files:
 - spec/fixtures/definitions/a_list_of_jams.rb
 - spec/fixtures/definitions/nested_folder/test_nested_process.rb
 - spec/fixtures/definitions/test_process.rb
-- spec/integration/configuration_spec.rb
+- spec/integration/example_configurations_spec.rb
+- spec/integration/history_storage_spec.rb
 - spec/integration/sample_application_spec.rb
 - spec/lib/bumbleworks/configuration_spec.rb
 - spec/lib/bumbleworks/error_handler_participant_spec.rb