bumbleworks 0.0.8 → 0.0.9

data/.gitignore

@@ -7,7 +7,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/doc/QUICKSTART.md

@@ -0,0 +1,67 @@
+# Quick Start for Rails
+
+1. Install [Rails](http://rubyonrails.org) and [redis](http://redis.io).
+
+1. Create a new Rails application.
+
+  ```
+  $ rails new bumbleworks_quickstart_rails
+  $ cd bumbleworks_quickstart_rails
+  ```
+
+1. Add Bumbleworks and the Redis storage adapter to your Gemfile.
+
+  ```ruby
+  gem 'bumbleworks'
+  gem 'bumbleworks-redis'
+  ```
+
+1. Install the gems in your Gemfile.
+  ```
+  $ bundle install
+  ```
+
+1. Create an initializer at `config/initializers/bumbleworks.rb`:
+
+  ```ruby
+    Bumbleworks.configure do |c|
+        c.storage = Redis.new
+    end
+
+    Bumbleworks.load_definitions!
+  ```
+
+1. Add your first process definition at `lib/process_definitions/`:
+
+  ```ruby
+  Bumbleworks.define_process do
+      # write your process definition here
+  end
+  ```
+
+  Process definitions follow the same syntax as [ruote](http://ruote.rubyforge.org/definitions.html), but are defined using `Bumbleworks.define_process` instead of `Ruote.define`.
+
+1. (*optional*) Put any [custom participants](http://ruote.rubyforge.org/implementing_participants.html) in `app/participants` or `participants`.
+
+1. Create an initializer file (e.g. `config/initializers/bumbleworks.rb` for Rails) with the following:
+
+  ```ruby
+    Bumbleworks.configure do |c|
+        c.storage = Hash.new
+    end
+
+    # this next block is optional - it's only needed
+    # if you want to load custom participants
+    Bumbleworks.register_participants do
+        # foo FooParticipant
+        # bar BarParticipant
+        # ...
+    end
+
+    Bumbleworks.load_definitions!
+    Bumbleworks.start_worker!
+  ```
+
+1. You can now launch processes using `Bumbleworks.launch!('process_definition_name')`.
+
+1. Any expressions of the form `[role] :task => [task_name]` will be turned into tasks retrievable at `Bumbleworks::Task.all`; you can get tasks specific to a role or roles using `Bumbleworks::Task.for_roles([role1, role2, ...])`.

data/lib/bumbleworks/task.rb

@@ -76,21 +76,16 @@ module Bumbleworks
       storage_participant.proceed(@workitem)
     end
 
-    # Claim task and assign token to claim
-    def claim(token)
-      if token && claimant && token != claimant
-        raise AlreadyClaimed, "Already claimed by #{claimant}"
-      end
-
-      params['claimant'] = token
-      save
-    end
-
     # Token used to claim task, nil if not claimed
     def claimant
       params['claimant']
     end
 
+    # Claim task and assign token to claimant
+    def claim(token)
+      set_claimant(token)
+    end
+
     # true if task is claimed
     def claimed?
       !claimant.nil?
@@ -98,12 +93,21 @@ module Bumbleworks
 
     # release claim on task.
     def release
-      claim(nil)
+      set_claimant(nil)
     end
 
     private
     def storage_participant
       self.class.storage_participant
     end
+
+    def set_claimant(token)
+      if token && claimant && token != claimant
+        raise AlreadyClaimed, "Already claimed by #{claimant}"
+      end
+
+      params['claimant'] = token
+      save
+    end
   end
 end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -163,6 +163,7 @@ files:
 - Rakefile
 - bumbleworks.gemspec
 - doc/GUIDE.md
+- doc/QUICKSTART.md
 - doc/TERMS.md
 - lib/bumbleworks.rb
 - lib/bumbleworks/configuration.rb
@@ -216,12 +217,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2621503672602724538
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2621503672602724538
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -255,4 +262,3 @@ test_files:
 - spec/lib/bumbleworks_spec.rb
 - spec/spec_helper.rb
 - spec/support/path_helpers.rb
-has_rdoc: