workflow 0.4.2 → 0.5.0

data/README.markdown

@@ -304,7 +304,8 @@ logging then you can use the universal `on_transition` hook:
 ### Guards
 
 If you want to halt the transition conditionally, you can just raise an
-exception. There is a helper called `halt!`, which raises the
+exception in your [transition event handler](#transition_event_handler).
+There is a helper called `halt!`, which raises the
 Workflow::TransitionHalted exception. You can provide an additional
 `halted_because` parameter.
 
@@ -317,6 +318,8 @@ The traditional `halt` (without the exclamation mark) is still supported
 too. This just prevents the state change without raising an
 exception.
 
+You can check `halted?` and `halted_because` values later.
+
 ### Hook order
 
 The whole event sequence is as follows:
@@ -372,6 +375,11 @@ when using both a block and a callback method for an event, the block executes p
 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
+
 ### New in the version 0.4.0
 
 * completely rewritten the documentation to match my branch
@@ -425,7 +433,7 @@ Support
 About
 -----
 
-Author: Vladimir Dobriakov, http://www.innoq.com/blog/vd, http://blog.geekq.net/
+Author: Vladimir Dobriakov, <http://www.innoq.com/blog/vd>, <http://blog.geekq.net/>
 
 Copyright (c) 2008-2009 Vodafone
 

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/lib/workflow.rb

@@ -135,10 +135,14 @@ module Workflow
       res || spec.initial_state
     end
 
+    # See the 'Guards' section in the README
+    # @return true if the last transition was halted by one of the transition callbacks.
     def halted?
       @halted
     end
 
+    # @return the reason of the last transition abort as set by the previous
+    # call of `halt` or `halt!` method.
     def halted_because
       @halted_because
     end
@@ -148,18 +152,11 @@ module Workflow
       raise NoTransitionAllowed.new(
         "There is no event #{name.to_sym} defined for the #{current_state} state") \
         if event.nil?
-      # This three member variables are a relict from the old workflow library
-      # TODO: refactor some day
       @halted_because = nil
       @halted = false
-      @raise_exception_on_halt = false
       return_value = run_action(event.action, *args) || run_action_callback(event.name, *args)
       if @halted
-        if @raise_exception_on_halt
-          raise TransitionHalted.new(@halted_because)
-        else
-          false
-        end
+        return false
       else
         check_transition(event)
         run_on_transition(current_state, spec.states[event.transitions_to], name, *args)
@@ -168,16 +165,15 @@ module Workflow
       end
     end
 
-    private
+    def halt(reason = nil)
+      @halted_because = reason
+      @halted = true
+    end
 
-    def check_transition(event)
-      # Create a meaningful error message instead of
-      # "undefined method `on_entry' for nil:NilClass"
-      # Reported by Kyle Burton
-      if !spec.states[event.transitions_to]
-        raise WorkflowError.new("Event[#{event.name}]'s " +
-            "transitions_to[#{event.transitions_to}] is not a declared state.")
-      end
+    def halt!(reason = nil)
+      @halted_because = reason
+      @halted = true
+      raise TransitionHalted.new(reason)
     end
 
     def spec
@@ -190,16 +186,16 @@ module Workflow
       c.workflow_spec
     end
 
-    def halt(reason = nil)
-      @halted_because = reason
-      @halted = true
-      @raise_exception_on_halt = false
-    end
+    private
 
-    def halt!(reason = nil)
-      @halted_because = reason
-      @halted = true
-      @raise_exception_on_halt = true
+    def check_transition(event)
+      # Create a meaningful error message instead of
+      # "undefined method `on_entry' for nil:NilClass"
+      # Reported by Kyle Burton
+      if !spec.states[event.transitions_to]
+        raise WorkflowError.new("Event[#{event.name}]'s " +
+            "transitions_to[#{event.transitions_to}] is not a declared state.")
+      end
     end
 
     def transition(from, to, name, *args)

data/test/main_test.rb

@@ -390,9 +390,10 @@ class MainTest < Test::Unit::TestCase
     assert_equal 'too fast', joe.halted_because
   end
 
-  test 'halt! raises exception' do
+  test 'halt! raises exception immediately' do
     article_class = Class.new do
       include Workflow
+      attr_accessor :too_far
       workflow do
         state :new do
           event :reject, :transitions_to => :rejected
@@ -403,6 +404,7 @@ class MainTest < Test::Unit::TestCase
       def reject(reason)
         halt! 'We do not reject articles unless the reason is important' \
           unless reason =~ /important/i
+        self.too_far = "This line should not be executed"
       end
     end
 
@@ -411,6 +413,7 @@ class MainTest < Test::Unit::TestCase
     assert_raise Workflow::TransitionHalted do
       article.reject! 'Too funny'
     end
+    assert_nil article.too_far
     assert article.new?, 'Transition should have been halted'
     article.reject! 'Important: too short'
     assert article.rejected?, 'Transition should happen now'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Vladimir Dobriakov
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-27 00:00:00 +02:00
+date: 2010-07-01 00:00:00 +02:00
 default_executable: 
 dependencies: []