workflow 0.6.0 → 0.7.0

data/README.markdown

@@ -83,6 +83,14 @@ Alternatively you can just download the lib/workflow.rb and put it in
 the lib folder of your Rails or Ruby application.
 
 
+Ruby 1.9
+--------
+
+Workflow gem does not work with some (but very widespread) Ruby 1.9
+builds due to a known bug in Ruby 1.9. Either compile your Ruby 1.9 from
+source or [comment out some lines in workflow](http://github.com/geekq/workflow/issues#issue/6)
+(reduces functionality).
+
 Examples
 --------
 
@@ -370,7 +378,11 @@ Then you define your different classes:
 Another solution would be to connect different workflows to object
 instances via metaclass, e.g.
 
+    # Load an object from the database
     booking = Booking.find(1234)
+
+    # Now define a workflow - exclusively for this object,
+    # probably depending on some condition or database field
     if # some condition
       class << booking
         include Workflow
@@ -381,7 +393,9 @@ instances via metaclass, e.g.
       end
     # if some other condition, use a different workflow
 
-Please also have a look at [the full working example][multiple_workflow_test]!
+You can also encapsulate this in a class method or even put in some
+ActiveRecord callback. 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
@@ -432,6 +446,14 @@ when using both a block and a callback method for an event, the block executes p
 Changelog
 ---------
 
+### New in the version 0.7.0
+
+* fix issue#10 Workflow::create_workflow_diagram documentation and path
+  escaping
+* fix issue#7 workflow_column does not work STI (single table
+  inheritance) ActiveRecord models
+* fix issue#5 Diagram generation fails for models in modules
+
 ### New in the version 0.6.0
 
 * enable multiple workflows by connecting workflow to object instances
@@ -440,8 +462,8 @@ Changelog
 
 ### New in the version 0.5.0
 
-* change the behaviour of halt! to immediately raise an exception. See
-  also http://github.com/geekq/workflow/issues/#issue/3
+* fix issue#3 change the behaviour of halt! to immediately raise an
+  exception. See also http://github.com/geekq/workflow/issues/#issue/3
 
 ### New in the version 0.4.0
 

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/workflow.rb

@@ -100,10 +100,11 @@ module Workflow
     def workflow_column(column_name=nil)
       if column_name
         @workflow_state_column_name = column_name.to_sym
-      else
-        @workflow_state_column_name ||= :workflow_state
       end
-      @workflow_state_column_name
+      if !@workflow_state_column_name && superclass.respond_to?(:workflow_column)
+        @workflow_state_column_name = superclass.workflow_column
+      end
+      @workflow_state_column_name ||= :workflow_state
     end
 
     def workflow(&specification)
@@ -160,8 +161,10 @@ module Workflow
       else
         check_transition(event)
         run_on_transition(current_state, spec.states[event.transitions_to], name, *args)
-        transition(current_state, spec.states[event.transitions_to], name, *args)
-        return_value
+        transition_value = transition(
+          current_state, spec.states[event.transitions_to], name, *args
+        )
+        return_value.nil? ? transition_value : return_value
       end
     end
 
@@ -205,8 +208,9 @@ module Workflow
 
     def transition(from, to, name, *args)
       run_on_exit(from, to, name, *args)
-      persist_workflow_state to.to_s
+      val = persist_workflow_state to.to_s
       run_on_entry(to, from, name, *args)
+      val
     end
 
     def run_on_transition(from, to, event, *args)
@@ -306,13 +310,13 @@ module Workflow
   end
 
   # Generates a `dot` graph of the workflow.
-  # Prerequisite: the `dot` binary.
-  # You can use it in your own Rakefile like this:
+  # Prerequisite: the `dot` binary. (Download from http://www.graphviz.org/)
+  # You can use this method in your own Rakefile like this:
   #
   #     namespace :doc do
   #       desc "Generate a graph of the workflow."
-  #       task :workflow do
-  #         Workflow::create_workflow_diagram(Order.new)
+  #       task :workflow => :environment do # needs access to the Rails environment
+  #         Workflow::create_workflow_diagram(Order)
   #       end
   #     end
   #
@@ -331,8 +335,8 @@ module Workflow
   # @param klass A class with the Workflow mixin, for which you wish the graphical workflow representation
   # @param [String] target_dir Directory, where to save the dot and the pdf files
   # @param [String] graph_options You can change graph orientation, size etc. See graphviz documentation
-  def self.create_workflow_diagram(klass, target_dir, graph_options='rankdir="LR", size="7,11.6", ratio="fill"')
-    workflow_name = "#{klass.name.tableize}_workflow"
+  def self.create_workflow_diagram(klass, target_dir='.', graph_options='rankdir="LR", size="7,11.6", ratio="fill"')
+    workflow_name = "#{klass.name.tableize}_workflow".gsub('/', '_')
     fname = File.join(target_dir, "generated_#{workflow_name}")
     File.open("#{fname}.dot", 'w') do |file|
       file.puts %Q|
@@ -357,11 +361,11 @@ digraph #{workflow_name} {
       file.puts "}"
       file.puts
     end
-    `dot -Tpdf -o#{fname}.pdf #{fname}.dot`
+    `dot -Tpdf -o'#{fname}.pdf' '#{fname}.dot'`
     puts "
 Please run the following to open the generated file:
 
-open #{fname}.pdf
+open '#{fname}.pdf'
 
 "
   end

data/test/main_test.rb

@@ -5,6 +5,7 @@ require 'active_record'
 require 'sqlite3'
 require 'workflow'
 require 'mocha'
+require 'stringio'
 #require 'ruby-debug'
 
 ActiveRecord::Migration.verbose = false
@@ -21,7 +22,6 @@ class Order < ActiveRecord::Base
     end
     state :shipped
   end
-
 end
 
 class LegacyOrder < ActiveRecord::Base
@@ -39,9 +39,26 @@ class LegacyOrder < ActiveRecord::Base
     end
     state :shipped
   end
+end
+
+class Image < ActiveRecord::Base
+  include Workflow
+
+  workflow_column :status
+
+  workflow do
+    state :unconverted do
+      event :convert, :transitions_to => :converted
+    end
+    state :converted
+  end
+end
 
+class SmallImage < Image
 end
 
+class SpecialSmallImage < SmallImage
+end
 
 class MainTest < ActiveRecordTestCase
 
@@ -66,6 +83,13 @@ class MainTest < ActiveRecordTestCase
 
     exec "INSERT INTO legacy_orders(title, foo_bar) VALUES('some order', 'accepted')"
 
+    ActiveRecord::Schema.define do
+      create_table :images do |t|
+        t.string :title, :null => false
+        t.string :state
+        t.string :type
+      end
+    end
   end
 
   def assert_state(title, expected_state, klass = Order)
@@ -76,13 +100,13 @@ class MainTest < ActiveRecordTestCase
 
   test 'immediately save the new workflow_state on state machine transition' do
     o = assert_state 'some order', 'accepted'
-    o.ship!
+    assert o.ship!
     assert_state 'some order', 'shipped'
   end
 
   test 'immediately save the new workflow_state on state machine transition with custom column name' do
     o = assert_state 'some order', 'accepted', LegacyOrder
-    o.ship!
+    assert o.ship!
     assert_state 'some order', 'shipped', LegacyOrder
   end
 
@@ -257,6 +281,12 @@ class MainTest < ActiveRecordTestCase
     assert !bo.accepted?
   end
 
+  test 'STI when parent changed the workflow_state column' do
+    assert_equal 'status', Image.workflow_column.to_s
+    assert_equal 'status', SmallImage.workflow_column.to_s
+    assert_equal 'status', SpecialSmallImage.workflow_column.to_s
+  end
+
   test 'Two-level inheritance' do
     class BigOrder < Order
     end
@@ -407,5 +437,28 @@ class MainTest < ActiveRecordTestCase
     assert article.rejected?, 'Transition should happen now'
   end
 
+  test 'workflow graph generation' do
+    Dir.chdir('tmp') do
+      capture_streams do
+        Workflow::create_workflow_diagram(Order)
+      end
+    end
+  end
+
+  test 'workflow graph generation in path with spaces' do
+    `mkdir -p '/tmp/Workflow test'`
+    capture_streams do
+      Workflow::create_workflow_diagram(Order,  '/tmp/Workflow test')
+    end
+  end
+
+  def capture_streams
+    old_stdout = $stdout
+    $stdout = captured_stdout = StringIO.new
+    yield
+    $stdout = old_stdout
+    captured_stdout
+  end
+
 end
 

data/test/multiple_workflows_test.rb

@@ -41,6 +41,13 @@ class MultipleWorkflowsTest < ActiveRecordTestCase
           end
         end
       end
+
+      def metaclass; class << self; self; end; end
+
+      def workflow_spec
+        metaclass.workflow_spec
+      end
+
     end
 
     booking1 = Booking.find_by_title('booking1')
@@ -56,6 +63,15 @@ class MultipleWorkflowsTest < ActiveRecordTestCase
     assert booking2.initial?
     booking2.progress!
     assert booking2.intermediate?, 'booking2 should transition to the "intermediate" state'
+
+    assert booking1.workflow_spec, 'can access the individual workflow specification'
+    assert_equal 2, booking1.workflow_spec.states.length
+    assert_equal 3, booking2.workflow_spec.states.length
+  end
+
+  class Object
+    # The hidden singleton lurks behind everyone
+    def metaclass; class << self; self; end; end
   end
 
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Vladimir Dobriakov
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-08 00:00:00 +02:00
+date: 2010-09-08 00:00:00 +02:00
 default_executable: 
 dependencies: []