bumbleworks 0.0.4 → 0.0.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bumbleworks (0.0.4)
+    bumbleworks (0.0.6)
       ruote
 
 GEM

data/bumbleworks.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Bumbleworks::VERSION
   spec.authors       = ["Maher Hawash", "Ravi Gadad", "Laurie Kemmerer", "David Miller"]
   spec.email         = ["mhawash@renewfund.com", "ravi@renewfund.com", "laurie@renewfund.com", "dave.miller@renewfund.com"]
-  spec.description   = %q{Bumbleworks adds a workflow engine (via ruote[http://github.com/jmettraux/ruote] to your application.}
+  spec.description   = %q{Bumbleworks adds a workflow engine (via ruote[http://github.com/jmettraux/ruote]) to your application.}
   spec.summary       = %q{Framework around ruote[http://github.com/jmettraux/ruote] workflow engine}
   spec.homepage      = ""
   spec.license       = "MIT"

data/lib/bumbleworks.rb

@@ -25,8 +25,10 @@ module Bumbleworks
     def_delegator Bumbleworks::ProcessDefinition, :define, :define_process
 
     # @public
-    # Returns the global configuration, or initializes a new
-    # configuration object if it doesn't exist yet.
+    # Returns the global configuration, or initializes a new configuration
+    # object if it doesn't exist yet.  If initializing new config, also adds
+    # default storage adapters.
+    #
     def configuration
       @configuration ||= begin
         configuration = Bumbleworks::Configuration.new
@@ -42,7 +44,7 @@ module Bumbleworks
     end
 
     # @public
-    # Yields the global configurtion to a block.
+    # Yields the global configuration to a block.
     # @yield [configuration] global configuration
     #
     # @example
@@ -69,8 +71,8 @@ module Bumbleworks
 
     # @public
     # Accepts a block for registering participants which
-    # is envoked when start! is called. Notice that a
-    # 'catchall' storage participant is always added to
+    # is envoked when start! is called. Note that a
+    # 'catchall Ruote::StorageParticipant' is always added to
     # the end of the list (unless it is defined in the block).
     #
     # @example
@@ -84,8 +86,11 @@ module Bumbleworks
     end
 
     # @public
-    # Starts a Ruote engine, sets up the storage and registers participants
-    # and process_definitions with the Ruote engine.
+    # Registers participants and process_definitions with the Ruote engine.
+    # Also calls Bumbleworks::Ruote.dashboard for the first time, which
+    # implicitly instantiates the storage, and might start a worker (if
+    # configuration.autostart_worker is true)
+    #
     def start!
       autoload_and_register_participants
       load_process_definitions
@@ -93,18 +98,18 @@ module Bumbleworks
 
     # @public
     # Resets Bumbleworks - clears configuration and setup variables, and
-    # shuts down the dashboard.
+    # also resets the dashboard.
+    #
     def reset!
       @configuration = nil
       @participant_block = nil
-      @registered_process_definitions = nil
       Bumbleworks::Ruote.reset!
     end
 
     # @public
-    # Launches the workflow engine with the specified process name.
-    # The process_definiton_name should already be registered with
-    # Bumbleworks.
+    # Launches the process definition with the given process name, as long as
+    # that definition name is already registered with Bumbleworks.
+    #
     def launch!(process_definition_name, options = {})
       Bumbleworks::Ruote.launch(process_definition_name, options)
     end

data/lib/bumbleworks/configuration.rb

@@ -1,7 +1,7 @@
 module Bumbleworks
-  # Stores configruation information
+  # Stores configuration information
   #
-  # Configruation inforamtion is loaded from a configuration block defined within
+  # Configuration information is loaded from a configuration block defined within
   # the client application.
   #
   # @example Standard settings
@@ -33,31 +33,29 @@ module Bumbleworks
     #   /participants
     #   /app/participants
     #
-    # default: non, must be specified
+    # default: none, must be specified
     # Exceptions: raises Bumbleworks::UndefinedSetting if not defined by the client
     #
     define_setting :root
 
     # Path to the folder which holds the ruote definition files. Bumbleworks
-    # will autoload all definition files by recursively traversing the directory
-    # tree under this folder. No specific loading order is guranteed
+    # will load all definition files by recursively traversing the directory
+    # tree under this folder. No specific loading order is guaranteed
     #
     # default: ${Bumbleworks.root}/lib/process_definitions
     define_setting :definitions_directory
 
     # Path to the folder which holds the ruote participant files. Bumbleworks
-    # will autoload all participant files by recursively traversing the directory
-    # tree under this folder. No specific loading order is guranteed
-    #
-    # Bumbleworks will guarantee that these files are autoloaded before registration
-    # of participants.
+    # will recursively traverse the directory tree under this folder and ensure
+    # that all found files are autoloaded before registration of participants.
     #
     # default: ${Bumbleworks.root}/participants then ${Bumbleworks.root}/app/participants
     define_setting :participants_directory
 
-    # Bumbelworks requires a dedicated key-value storage for process information.  Two
-    # storage solutions are currently supported: Redis and Sequel.  You can set the storage
-    # as follows:
+    # Bumbleworks requires a dedicated key-value storage for process information.  Three
+    # storage solutions are currently supported: Hash, Redis and Sequel.  The latter
+    # two require the bumbleworks-redis and bumbleworks-sequel gems, respectively.
+    # You can set the storage as follows:
     #
     # @Exammple: Redis
     #   Bumbleworks.storage = Redis.new(:host => '127.0.0.1', :db => 0, :thread_safe => true)
@@ -96,10 +94,10 @@ module Bumbleworks
       @participants_folder ||= default_participant_directory
     end
 
-    # Root folder where bumbleworks looks for ruote assets (participants,
-    # process_definitions, ..etc.)  The root path must be absolute.
-    # It can be defined throguh a configuration block:
-    #   Bumbleworks.configure {|c| c.root = '/somewhere'}
+    # 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:
+    #   Bumbleworks.configure { |c| c.root = '/somewhere' }
     #
     # Or directly:
     #   Bumbleworks.root = '/somewhere/else/'
@@ -126,15 +124,13 @@ module Bumbleworks
     end
 
     # Add a storage adapter to the set of possible adapters.  Takes an object
-    # that responds to `driver`, `use?(storage)`, and `display_name`.
+    # that responds to `driver`, `use?`, `storage_class`, and `display_name`.
     #
-    def add_storage_adapter(storage_adapter)
-      raise ArgumentError, "#{storage_adapter} is not a Bumbleworks storage adapter" unless
-        storage_adapter.respond_to?(:driver) &&
-        storage_adapter.respond_to?(:use?) &&
-        storage_adapter.respond_to?(:display_name)
+    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) }
 
-      @storage_adapters << storage_adapter
+      @storage_adapters << adapter
       @storage_adapters
     end
 

data/lib/bumbleworks/hash_storage.rb

@@ -2,12 +2,14 @@ require 'bumbleworks/storage_adapter'
 
 module Bumbleworks
   class HashStorage < Bumbleworks::StorageAdapter
-    def self.driver
-      ::Ruote::HashStorage
-    end
+    class << self
+      def driver
+        ::Ruote::HashStorage
+      end
 
-    def self.display_name
-      'Hash'
+      def storage_class
+        Hash
+      end
     end
   end
 end

data/lib/bumbleworks/storage_adapter.rb

@@ -12,12 +12,16 @@ module Bumbleworks
       end
 
       def use?(storage)
-        storage.class.name =~ /^#{display_name}/
+        storage.is_a? storage_class
       end
 
-      def display_name
+      def storage_class
         raise "Subclass responsibility"
       end
+
+      def display_name
+        storage_class.name
+      end
     end
   end
 end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/spec/lib/bumbleworks/configuration_spec.rb

@@ -110,7 +110,7 @@ describe Bumbleworks::Configuration do
   describe '#add_storage_adapter' do
     it 'adds storage adapter to registered list' do
       GoodForNothingStorage = OpenStruct.new(
-        :driver => nil, :display_name => 'Dummy', :use? => true
+        :driver => nil, :storage_class => 'Dummy', :display_name => 'Dummy', :use? => true
       )
       configuration.storage_adapters.should be_empty
       configuration.add_storage_adapter(GoodForNothingStorage)

data/spec/lib/bumbleworks/storage_adapter_spec.rb

@@ -17,8 +17,15 @@ describe Bumbleworks::StorageAdapter do
   end
 
   describe '.display_name' do
+    it 'returns storage class name as a string' do
+      described_class.stub(:storage_class).and_return(String)
+      described_class.display_name.should == 'String'
+    end
+  end
+
+  describe '.storage_class' do
     it 'is a subclass responsibility' do
-      expect { described_class.display_name }.to raise_error
+      expect { described_class.storage_class }.to raise_error
     end
   end
 
@@ -30,10 +37,10 @@ describe Bumbleworks::StorageAdapter do
 
   describe '.use?' do
     before :each do
-      described_class.stub(:display_name).and_return('String')
+      described_class.stub(:storage_class).and_return(String)
     end
 
-    it 'returns true if argument class name matches display name' do
+    it 'returns true if argument class is_a storage class' do
       described_class.use?('a string').should be_true
       described_class.use?(:not_a_string).should be_false
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -142,7 +142,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Bumbleworks adds a workflow engine (via ruote[http://github.com/jmettraux/ruote]
+description: Bumbleworks adds a workflow engine (via ruote[http://github.com/jmettraux/ruote])
   to your application.
 email:
 - mhawash@renewfund.com
@@ -217,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3704003548247520954
+      hash: -3888661442558670334
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -226,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3704003548247520954
+      hash: -3888661442558670334
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23