workflow 0.5.0 → 0.6.0

data/README.markdown

@@ -331,6 +331,63 @@ The whole event sequence is as follows:
     * on_entry
 
 
+Multiple Workflows
+------------------
+
+I am frequently asked if it's possible to represent multiple "workflows"
+in an ActiveRecord class. 
+
+The solution depends on your business logic and how you want to
+structure your implementation.
+
+### Use Single Table Inheritance
+
+One solution can be to do it on the class level and use a class
+hierarchy. You can use [single table inheritance][STI] so there is only
+single `orders` table in the database. Read more in the chapter "Single
+Table Inheritance" of the [ActiveRecord documentation][ActiveRecord].
+Then you define your different classes:
+
+    class Order < ActiveRecord::Base
+      include Workflow
+    end
+
+    class SmallOrder < Order
+      workflow do
+        # workflow definition for small orders goes here
+      end
+    end
+
+    class BigOrder < Order
+      workflow do
+        # workflow for big orders, probably with a longer approval chain
+      end
+    end
+
+
+### Individual workflows for objects
+
+Another solution would be to connect different workflows to object
+instances via metaclass, e.g.
+
+    booking = Booking.find(1234)
+    if # some condition
+      class << booking
+        include Workflow
+        workflow do
+          state :state1
+          state :state2
+        end
+      end
+    # if some other condition, use a different workflow
+
+Please also have a look at [the full working example][multiple_workflow_test]!
+
+[STI]: http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
+[ActiveRecord]: http://api.rubyonrails.org/classes/ActiveRecord/Base.html
+[multiple_workflow_test]: http://github.com/geekq/workflow/blob/master/test/multiple_workflows_test.rb
+
+
 Documenting with diagrams
 -------------------------
 
@@ -375,6 +432,12 @@ when using both a block and a callback method for an event, the block executes p
 Changelog
 ---------
 
+### New in the version 0.6.0
+
+* enable multiple workflows by connecting workflow to object instances
+  (using metaclass) instead of connecting to a class, s. "Multiple
+  Workflows" section
+
 ### New in the version 0.5.0
 
 * change the behaviour of halt! to immediately raise an exception. See

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/workflow.rb

@@ -177,6 +177,11 @@ module Workflow
     end
 
     def spec
+      # check the singleton class first
+      class << self
+        return workflow_spec if workflow_spec
+      end
+
       c = self.class
       # using a simple loop instead of class_inheritable_accessor to avoid
       # dependency on Rails' ActiveSupport

data/test/main_test.rb

@@ -43,18 +43,10 @@ class LegacyOrder < ActiveRecord::Base
 end
 
 
-class MainTest < Test::Unit::TestCase
-
-  def exec(sql)
-    ActiveRecord::Base.connection.execute sql
-  end
+class MainTest < ActiveRecordTestCase
 
   def setup
-    ActiveRecord::Base.establish_connection(
-      :adapter => "sqlite3",
-      :database  => ":memory:" #"tmp/test"
-    )
-    ActiveRecord::Base.connection.reconnect! # eliminate ActiveRecord warning. TODO: delete as soon as ActiveRecord is fixed
+    super
 
     ActiveRecord::Schema.define do
       create_table :orders do |t|
@@ -76,10 +68,6 @@ class MainTest < Test::Unit::TestCase
 
   end
 
-  def teardown
-    ActiveRecord::Base.connection.disconnect!
-  end
-
   def assert_state(title, expected_state, klass = Order)
     o = klass.find_by_title(title)
     assert_equal expected_state, o.read_attribute(klass.workflow_column)

data/test/multiple_workflows_test.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+class MultipleWorkflowsTest < ActiveRecordTestCase
+
+  test 'multiple workflows' do
+
+    ActiveRecord::Schema.define do
+      create_table :bookings do |t|
+        t.string :title, :null => false
+        t.string :workflow_state
+        t.string :workflow_type
+      end
+    end
+
+    exec "INSERT INTO bookings(title, workflow_state, workflow_type) VALUES('booking1', 'initial', 'workflow_1')"
+    exec "INSERT INTO bookings(title, workflow_state, workflow_type) VALUES('booking2', 'initial', 'workflow_2')"
+
+    class Booking < ActiveRecord::Base
+      def initialize_workflow
+        # define workflow per object instead of per class
+        case workflow_type
+        when 'workflow_1'
+          class << self
+            include Workflow
+            workflow do
+              state :initial do
+                event :progress, :transitions_to => :last
+              end
+              state :last
+            end
+          end
+        when 'workflow_2'
+          class << self
+            include Workflow
+            workflow do
+              state :initial do
+                event :progress, :transitions_to => :intermediate
+              end
+              state :intermediate
+              state :last
+            end
+          end
+        end
+      end
+    end
+
+    booking1 = Booking.find_by_title('booking1')
+    booking1.initialize_workflow
+
+    booking2 = Booking.find_by_title('booking2')
+    booking2.initialize_workflow
+
+    assert booking1.initial?
+    booking1.progress!
+    assert booking1.last?, 'booking1 should transition to the "last" state'
+
+    assert booking2.initial?
+    booking2.progress!
+    assert booking2.intermediate?, 'booking2 should transition to the "intermediate" state'
+  end
+
+end

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'test/unit'
+require 'active_record'
 
 class << Test::Unit::TestCase
   def test(name, &block)
@@ -7,10 +8,32 @@ class << Test::Unit::TestCase
     raise ArgumentError, "#{test_name} is already defined" if self.instance_methods.include? test_name.to_s
     if block
       define_method test_name, &block
-    else  
+    else
       puts "PENDING: #{name}"
-    end   
-  end   
+    end
+  end
 end
 
+class ActiveRecordTestCase < Test::Unit::TestCase
+  def exec(sql)
+    ActiveRecord::Base.connection.execute sql
+  end
+
+  def setup
+    ActiveRecord::Base.establish_connection(
+      :adapter => "sqlite3",
+      :database  => ":memory:" #"tmp/test"
+    )
+
+    # eliminate ActiveRecord warning. TODO: delete as soon as ActiveRecord is fixed
+    ActiveRecord::Base.connection.reconnect!
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.disconnect!
+  end
+
+  def default_test
+  end
+end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Vladimir Dobriakov
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-01 00:00:00 +02:00
+date: 2010-07-08 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,7 @@ files:
 - lib/workflow.rb
 - test/couchtiny_example.rb
 - test/main_test.rb
+- test/multiple_workflows_test.rb
 - test/readme_example.rb
 - test/test_helper.rb
 - test/without_active_record_test.rb
@@ -74,4 +75,5 @@ test_files:
 - test/main_test.rb
 - test/test_helper.rb
 - test/without_active_record_test.rb
+- test/multiple_workflows_test.rb
 - test/readme_example.rb