bumbleworks 0.0.53 → 0.0.54

data/README.md

@@ -96,7 +96,7 @@ If you want to use Sequel:
 
 Bumbleworks uses [ruote](http://github.com/jmettraux/ruote), which allows process definitions to be written using a [Ruby DSL](http://ruote.rubyforge.org/definitions.html#ruby).
 
-By default, your process definitions will be loaded from the `lib/process_definitions` directory at `Bumbleworks.root` (see Determining the Root Directory for more info).  This directory can have as many subdirectories as you want, and Bumbleworks will load everything recursively; note, however, that the directory hierarchy doesn't mean anything to Bumbleworks, and is only for your own organization.  The directory is configurable by setting Bumbleworks.definitions_directory:
+By default, your process definitions will be loaded from the `processes` or `process_definitions` directory at `Bumbleworks.root` (see Determining the Root Directory for more info).  This directory can have as many subdirectories as you want, and Bumbleworks will load everything recursively; note, however, that the directory hierarchy doesn't mean anything to Bumbleworks, and is only for your own organization.  The directory is configurable by setting Bumbleworks.definitions_directory:
 
 ```ruby
 Bumbleworks.configure do |c|
@@ -109,7 +109,7 @@ Note that if you override the default path, you can either specify an absolute p
 
 ### Participant Class Directory
 
-If your app has a `participants` or `app/participants` directory at the root (see Determining the Root Directory), Bumbleworks will require all files in that directory by default before running your `register_participants` block (see below).  You can customize this directory by setting Bumbleworks.participants_directory:
+If your app has a `participants` directory at Bumbleworks.root (see Determining the Root Directory), Bumbleworks will require all files in that directory by default before running your `register_participants` block (see below).  You can customize this directory by setting Bumbleworks.participants_directory:
 
 ```ruby
 Bumbleworks.configure do |c|
@@ -118,11 +118,26 @@ Bumbleworks.configure do |c|
 end
 ```
 
+### Task Class Directory
+
+If your app has a `tasks` directory at Bumbleworks.root (see Determining the Root Directory), Bumbleworks will require all files in that directory when you run `Bumbleworks.register_tasks`.  You can customize this directory by setting Bumbleworks.tasks_directory:
+
+```ruby
+Bumbleworks.configure do |c|
+  c.tasks_directory = '/absolute/path/to/your/task/class/files'
+  # ...
+end
+```
+
 ### Determining the Root Directory
 
-By default, Bumbleworks will attempt in several ways to find your root directory.  In the most common cases (Rails, Sinatra, or Rory), it usually won't have trouble guessing the directory.
+By default, Bumbleworks will attempt in several ways to find your root directory.  In the most common cases (Rails, Sinatra, or Rory), it usually won't have trouble guessing the directory.  The default `Bumbleworks.root` directory will be the framework's root with `lib/bumbleworks` appended.
 
-If you're not using Rails, Sinatra, or Rory, Bumbleworks will complain when you call `bootstrap!` or `update!`, **unless** both your definitions directory and your participants directory (see above) are specified as absolute paths.
+If you're not using Rails, Sinatra, or Rory, and you haven't explicitly set `Bumbleworks.root`, Bumbleworks will complain when you call any of the following methods:
+- `Bumbleworks.load_definitions!`
+- `Bumbleworks.register_tasks`
+- `Bumbleworks.register_participants`
+... **unless** your definitions directory, tasks directory, and participants directory (see above) are specified as absolute paths.
 
 ## Usage
 

data/lib/bumbleworks/configuration.rb

@@ -26,15 +26,24 @@ module Bumbleworks
     end
 
 
-    # Path to the root folder where Bumbleworks assets can be found.
-    # This includes the following structure:
-    #   /lib
-    #     /process_definitions
-    #   /participants
-    #   /app/participants
+    # Path to the root folder where Bumbleworks assets can be found.  By default,
+    # this path will be the root returned by the detected framework (see the
+    # #root method below), with "/lib/bumbleworks" appended, but you can override
+    # this by defining root explicitly.
+    # The definitions, tasks, and participants directories should exist here, if
+    # you're using the defaults for these directories, or if they're overridden
+    # with relative paths.  So in a default install, the hierarchy should look
+    # like this:
+    #   [defined root, or framework root]
+    #     /lib
+    #       /bumbleworks
+    #         /participants
+    #         /processes
+    #         /tasks
     #
-    # default: none, must be specified
-    # Exceptions: raises Bumbleworks::UndefinedSetting if not defined by the client
+    # default: ${Framework root}/lib/bumbleworks (or no default if not in framework)
+    # Exceptions: raises Bumbleworks::UndefinedSetting if no framework and not
+    #   defined by the client
     #
     define_setting :root
 
@@ -42,14 +51,14 @@ module Bumbleworks
     # will load all definition files by recursively traversing the directory
     # tree under this folder. No specific loading order is guaranteed
     #
-    # default: ${Bumbleworks.root}/lib/bumbleworks/process_definitions then ${Bumbleworks.root}/lib/bumbleworks/processes
+    # default: ${Bumbleworks.root}/process_definitions then ${Bumbleworks.root}/processes
     define_setting :definitions_directory
 
     # Path to the folder which holds the ruote participant files. Bumbleworks
     # will recursively traverse the directory tree under this folder and ensure
     # that all found files are autoloaded before registration of participants.
     #
-    # default: ${Bumbleworks.root}/lib/bumbleworks/participants
+    # default: ${Bumbleworks.root}/participants
     define_setting :participants_directory
 
     # Path to the folder which holds the optional task module files, which are
@@ -57,7 +66,7 @@ module Bumbleworks
     # callbacks). Bumbleworks will recursively traverse the directory tree under
     # this folder and ensure that all found files are autoloaded.
     #
-    # default: ${Bumbleworks.root}/lib/bumbleworks/tasks
+    # default: ${Bumbleworks.root}/tasks
     define_setting :tasks_directory
 
     # Bumbleworks requires a dedicated key-value storage for process information.  Three
@@ -192,18 +201,14 @@ module Bumbleworks
     #   Bumbleworks.root = '/somewhere/else/'
     #
     # If the root is not defined, Bumbleworks will use the root of known
-    # frameworks (Rails, Sinatra and Rory).  Otherwise, it will raise an
-    # error if not defined.
+    # frameworks (Rails, Sinatra and Rory), appending "lib/bumbleworks".
+    # Otherwise, it will raise an error if not defined.
     #
     def root
-      @root ||= case
-        when defined?(Rails) then Rails.root
-        when defined?(Rory) then Rory.root
-        when defined?(Padrino) then Padrino.root
-        when defined?(Sinatra::Application) then Sinatra::Application.root
+      @root ||= begin
+        raise UndefinedSetting.new("Bumbleworks.root must be set") unless framework_root
+        File.join(framework_root, "lib", "bumbleworks")
       end
-      raise UndefinedSetting.new("Bumbleworks.root must be set") unless @root
-      @root
     end
 
     # Add a storage adapter to the set of possible adapters.  Takes an object
@@ -257,18 +262,27 @@ module Bumbleworks
       self.class.defined_settings
     end
 
+    def framework_root
+      case
+        when defined?(Rails) then Rails.root
+        when defined?(Rory) then Rory.root
+        when defined?(Padrino) then Padrino.root
+        when defined?(Sinatra::Application) then Sinatra::Application.root
+      end
+    end
+
     def default_definition_directory
-      default_folders = ['lib/bumbleworks/process_definitions', 'lib/bumbleworks/processes']
+      default_folders = ['process_definitions', 'processes']
       find_folder(default_folders, @definitions_directory, "Definitions folder not found")
     end
 
     def default_participant_directory
-      default_folders = ['lib/bumbleworks/participants']
+      default_folders = ['participants']
       find_folder(default_folders, @participants_directory, "Participants folder not found")
     end
 
     def default_tasks_directory
-      default_folders = ['lib/bumbleworks/tasks']
+      default_folders = ['tasks']
       find_folder(default_folders, @tasks_directory, "Tasks folder not found")
     end
 

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.53"
+  VERSION = "0.0.54"
 end

data/spec/integration/example_configurations_spec.rb

@@ -19,7 +19,7 @@ describe Bumbleworks::Configuration do
 
     it 'returns default directory when not set in configuration' do
       load default_initializer
-      Bumbleworks.definitions_directory.should == File.join(default_app_path, 'lib', 'bumbleworks', 'process_definitions')
+      Bumbleworks.definitions_directory.should == File.join(default_app_path, 'process_definitions')
     end
   end
 
@@ -31,7 +31,7 @@ describe Bumbleworks::Configuration do
 
     it 'returns default directory when not set in configuration' do
       load default_initializer
-      Bumbleworks.participants_directory.should == File.join(default_app_path, 'lib', 'bumbleworks', 'participants')
+      Bumbleworks.participants_directory.should == File.join(default_app_path, 'participants')
     end
   end
 end

data/spec/lib/bumbleworks/configuration_spec.rb

@@ -21,7 +21,7 @@ describe Bumbleworks::Configuration do
         end
       end
 
-      configuration.root.should == '/Rails/Root'
+      configuration.root.should == '/Rails/Root/lib/bumbleworks'
       Object.send(:remove_const, :Rails)
     end
 
@@ -32,7 +32,7 @@ describe Bumbleworks::Configuration do
         end
       end
 
-      configuration.root.should == '/Padrino/Root'
+      configuration.root.should == '/Padrino/Root/lib/bumbleworks'
       Object.send(:remove_const, :Padrino)
     end
 
@@ -45,7 +45,7 @@ describe Bumbleworks::Configuration do
         end
       end
 
-      configuration.root.should == '/Sinatra/Root'
+      configuration.root.should == '/Sinatra/Root/lib/bumbleworks'
       Object.send(:remove_const, :Sinatra)
     end
 
@@ -56,7 +56,7 @@ describe Bumbleworks::Configuration do
         end
       end
 
-      configuration.root.should == '/Rory/Root'
+      configuration.root.should == '/Rory/Root/lib/bumbleworks'
       Object.send(:remove_const, :Rory)
     end
 
@@ -82,14 +82,14 @@ describe Bumbleworks::Configuration do
     it 'returns the default folder if not set by client app' do
       File.stub(:directory? => true)
       configuration.root = '/Root'
-      configuration.definitions_directory.should == '/Root/lib/bumbleworks/process_definitions'
+      configuration.definitions_directory.should == '/Root/process_definitions'
     end
 
     it 'returns the second default folder if first does not exist' do
-      File.stub(:directory?).with('/Root/lib/bumbleworks/process_definitions').and_return(false)
-      File.stub(:directory?).with('/Root/lib/bumbleworks/processes').and_return(true)
+      File.stub(:directory?).with('/Root/process_definitions').and_return(false)
+      File.stub(:directory?).with('/Root/processes').and_return(true)
       configuration.root = '/Root'
-      configuration.definitions_directory.should == '/Root/lib/bumbleworks/processes'
+      configuration.definitions_directory.should == '/Root/processes'
     end
 
     it 'raises an error if default folder not found' do
@@ -98,7 +98,7 @@ describe Bumbleworks::Configuration do
         configuration.definitions_directory
       }.to raise_error(
         Bumbleworks::InvalidSetting,
-        "Definitions folder not found (looked in lib/bumbleworks/process_definitions, lib/bumbleworks/processes)"
+        "Definitions folder not found (looked in process_definitions, processes)"
       )
     end
 
@@ -121,9 +121,9 @@ describe Bumbleworks::Configuration do
     end
 
     it 'returns the default folder if not set by client app' do
-      File.stub(:directory?).with('/Root/lib/bumbleworks/participants').and_return(true)
+      File.stub(:directory?).with('/Root/participants').and_return(true)
       configuration.root = '/Root'
-      configuration.participants_directory.should == '/Root/lib/bumbleworks/participants'
+      configuration.participants_directory.should == '/Root/participants'
     end
 
     it 'raises an error if default folder not found' do
@@ -132,7 +132,7 @@ describe Bumbleworks::Configuration do
         configuration.participants_directory
       }.to raise_error(
         Bumbleworks::InvalidSetting,
-        "Participants folder not found (looked in lib/bumbleworks/participants)"
+        "Participants folder not found (looked in participants)"
       )
     end
 
@@ -155,9 +155,9 @@ describe Bumbleworks::Configuration do
     end
 
     it 'returns the default folder if not set by client app' do
-      File.stub(:directory?).with('/Root/lib/bumbleworks/tasks').and_return(true)
+      File.stub(:directory?).with('/Root/tasks').and_return(true)
       configuration.root = '/Root'
-      configuration.tasks_directory.should == '/Root/lib/bumbleworks/tasks'
+      configuration.tasks_directory.should == '/Root/tasks'
     end
 
     it 'raises an error if default folder not found' do
@@ -166,7 +166,7 @@ describe Bumbleworks::Configuration do
         configuration.tasks_directory
       }.to raise_error(
         Bumbleworks::InvalidSetting,
-        "Tasks folder not found (looked in lib/bumbleworks/tasks)"
+        "Tasks folder not found (looked in tasks)"
       )
     end
 
@@ -287,7 +287,7 @@ describe Bumbleworks::Configuration do
       configuration.clear!
 
       configuration.root = '/Root'
-      configuration.definitions_directory.should == '/Root/lib/bumbleworks/process_definitions'
+      configuration.definitions_directory.should == '/Root/process_definitions'
     end
   end
 

data/spec/lib/bumbleworks/participant_registration_spec.rb

@@ -4,9 +4,9 @@ describe Bumbleworks::ParticipantRegistration do
       Bumbleworks.reset!
       Bumbleworks.root = File.join(fixtures_path, 'apps', 'with_default_directories')
       Object.should_receive(:autoload).with(:HoneyParticipant,
-        File.join(Bumbleworks.root, 'lib', 'bumbleworks', 'participants', 'honey_participant.rb'))
+        File.join(Bumbleworks.root, 'participants', 'honey_participant.rb'))
       Object.should_receive(:autoload).with(:MolassesParticipant,
-        File.join(Bumbleworks.root, 'lib', 'bumbleworks', 'participants', 'molasses_participant.rb'))
+        File.join(Bumbleworks.root, 'participants', 'molasses_participant.rb'))
       Bumbleworks::ParticipantRegistration.autoload_all
     end
   end

data/spec/lib/bumbleworks/task_spec.rb

@@ -31,9 +31,9 @@ describe Bumbleworks::Task do
     it 'autoloads all task modules in directory' do
       Bumbleworks.root = File.join(fixtures_path, 'apps', 'with_default_directories')
       Object.should_receive(:autoload).with(:MakeSomeHoneyTask,
-        File.join(Bumbleworks.root, 'lib', 'bumbleworks', 'tasks', 'make_some_honey_task.rb'))
+        File.join(Bumbleworks.root, 'tasks', 'make_some_honey_task.rb'))
       Object.should_receive(:autoload).with(:TasteThatMolassesTask,
-        File.join(Bumbleworks.root, 'lib', 'bumbleworks', 'tasks', 'taste_that_molasses_task.rb'))
+        File.join(Bumbleworks.root, 'tasks', 'taste_that_molasses_task.rb'))
       Bumbleworks::Task.autoload_all
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.53
+  version: 0.0.54
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-25 00:00:00.000000000 Z
+date: 2014-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -197,13 +197,13 @@ files:
 - lib/tasks/bumbleworks.rake
 - spec/fixtures/apps/with_default_directories/config_initializer.rb
 - spec/fixtures/apps/with_default_directories/full_initializer.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/participants/honey_participant.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/participants/molasses_participant.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/process_definitions/garbage_collector.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/process_definitions/make_honey.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/process_definitions/make_molasses.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/tasks/make_some_honey_task.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/tasks/taste_that_molasses_task.rb
+- spec/fixtures/apps/with_default_directories/participants/honey_participant.rb
+- spec/fixtures/apps/with_default_directories/participants/molasses_participant.rb
+- spec/fixtures/apps/with_default_directories/process_definitions/garbage_collector.rb
+- spec/fixtures/apps/with_default_directories/process_definitions/make_honey.rb
+- spec/fixtures/apps/with_default_directories/process_definitions/make_molasses.rb
+- spec/fixtures/apps/with_default_directories/tasks/make_some_honey_task.rb
+- spec/fixtures/apps/with_default_directories/tasks/taste_that_molasses_task.rb
 - spec/fixtures/apps/with_specified_directories/config_initializer.rb
 - spec/fixtures/apps/with_specified_directories/specific_directory/definitions/.gitkeep
 - spec/fixtures/apps/with_specified_directories/specific_directory/participants/.gitkeep
@@ -258,7 +258,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1658665991702061077
+      hash: 4188325697829611705
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -267,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1658665991702061077
+      hash: 4188325697829611705
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -277,13 +277,13 @@ summary: Framework around ruote[http://github.com/jmettraux/ruote] workflow engi
 test_files:
 - spec/fixtures/apps/with_default_directories/config_initializer.rb
 - spec/fixtures/apps/with_default_directories/full_initializer.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/participants/honey_participant.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/participants/molasses_participant.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/process_definitions/garbage_collector.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/process_definitions/make_honey.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/process_definitions/make_molasses.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/tasks/make_some_honey_task.rb
-- spec/fixtures/apps/with_default_directories/lib/bumbleworks/tasks/taste_that_molasses_task.rb
+- spec/fixtures/apps/with_default_directories/participants/honey_participant.rb
+- spec/fixtures/apps/with_default_directories/participants/molasses_participant.rb
+- spec/fixtures/apps/with_default_directories/process_definitions/garbage_collector.rb
+- spec/fixtures/apps/with_default_directories/process_definitions/make_honey.rb
+- spec/fixtures/apps/with_default_directories/process_definitions/make_molasses.rb
+- spec/fixtures/apps/with_default_directories/tasks/make_some_honey_task.rb
+- spec/fixtures/apps/with_default_directories/tasks/taste_that_molasses_task.rb
 - spec/fixtures/apps/with_specified_directories/config_initializer.rb
 - spec/fixtures/apps/with_specified_directories/specific_directory/definitions/.gitkeep
 - spec/fixtures/apps/with_specified_directories/specific_directory/participants/.gitkeep