workflow 0.8.7 → 1.0.0

data/.travis.yml

@@ -0,0 +1,14 @@
+before_install:
+  - sudo apt-get install -qq graphviz
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+matrix:
+  include:
+    # legacy build: Ruby 1.8.7, Rails 2.3, less features, smaller test set
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.rails-2.3.x
+      # running a smaller test set for old Rails and Ruby
+      script: rake test_without_new_versions

data/README.markdown

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/geekq/workflow.png?branch=master)](https://travis-ci.org/geekq/workflow)
+
 What is workflow?
 -----------------
 
@@ -501,6 +503,24 @@ when using both a block and a callback method for an event, the block executes p
 Changelog
 ---------
 
+### New in the version 1.0.0
+
+* **Support to private/protected callback methods.**
+  See also issues [#53](https://github.com/geekq/workflow/pull/53)
+  and [#58](https://github.com/geekq/workflow/pull/58). With the new
+  implementation:
+
+  * callback methods can be hidden (non public): both private methods
+    in the immediate class and protected methods somewhere in the class
+    hierarchy are supported
+  * no unintentional calls on `fail!` and other Kernel methods
+  * inheritance hierarchy with workflow is supported
+
+* using Rails' 3.1 `update_column` whenever available so only the
+  workflow state column and not other pending attribute changes are
+  saved on state transition. Fallback to `update_attribute` for older
+  Rails and other ORMs. [commit](https://github.com/geekq/workflow/commit/7e091d8ded1aeeb0a86647bbf7d78ab3c9d0c458)
+
 ### New in the version 0.8.7
 
 * switch from [jeweler][] to pure bundler for building gems

data/Rakefile

@@ -15,6 +15,15 @@ end
 
 require 'rake'
 Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.verbose = true
+  t.warning = true
+  t.test_files = FileList['test/*_test.rb'] + FileList['test/new_versions/*_test.rb']
+end
+
+Rake::TestTask.new do |t|
+  t.name = 'test_without_new_versions'
+  t.libs << 'test'
   t.verbose = true
   t.warning = true
   t.pattern = 'test/*_test.rb'

data/gemfiles/Gemfile.rails-2.3.x

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "activerecord", "~>2.3.15"
+  gem "sqlite3"
+  gem "mocha"
+  gem "rake"
+end

data/lib/workflow.rb

@@ -284,9 +284,14 @@ module Workflow
     def run_action(action, *args)
       instance_exec(*args, &action) if action
     end
-    
+
     def has_callback?(action)
-      self.respond_to?(action) or self.class.private_method_defined?(action)
+      # 1. public callback method or
+      # 2. protected method somewhere in the class hierarchy or
+      # 3. private in the immediate class (parent classes ignored)
+      self.respond_to?(action) or
+        self.class.protected_method_defined?(action) or
+        self.private_methods(false).map(&:to_sym).include?(action)
     end
 
     def run_action_callback(action_name, *args)
@@ -338,7 +343,13 @@ module Workflow
     # On transition the new workflow state is immediately saved in the
     # database.
     def persist_workflow_state(new_value)
-      update_attributes self.class.workflow_column => new_value
+      if self.respond_to? :update_column
+        # Rails 3.1 or newer
+        update_column self.class.workflow_column, new_value
+      else
+        # older Rails; beware of side effect: other (pending) attribute changes will be persisted too
+        update_attribute self.class.workflow_column, new_value
+      end
     end
 
     private

data/lib/workflow/version.rb

@@ -1,3 +1,3 @@
 module Workflow
-  VERSION = "0.8.7"
+  VERSION = "1.0.0"
 end

data/test/advanced_examples_test.rb

@@ -0,0 +1,61 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'workflow'
+class AdvanceExamplesTest < ActiveRecordTestCase
+
+  class Article
+    include Workflow
+    workflow do
+      state :new do
+        event :submit, :transitions_to => :awaiting_review
+      end
+      state :awaiting_review do
+        event :review, :transitions_to => :being_reviewed
+      end
+      state :being_reviewed do
+        event :accept, :transitions_to => :accepted
+        event :reject, :transitions_to => :rejected
+      end
+      state :accepted do
+      end
+      state :rejected do
+      end
+    end
+  end
+
+  test '#63 undoing event - automatically add revert events for every defined event' do
+    # also see https://github.com/geekq/workflow/issues/63
+    spec = Article.workflow_spec
+    spec.state_names.each do |state_name|
+      state = spec.states[state_name]
+
+        (state.events.values.reject {|e| e.name.to_s =~ /^revert_/ }).each do |event|
+          event_name = event.name
+          revert_event_name = "revert_" + event_name.to_s
+
+          # Add revert events
+          spec.states[event.transitions_to.to_sym].events[revert_event_name.to_sym] =
+            Workflow::Event.new(revert_event_name, state, {})
+
+          # Add methods for revert events
+          Article.module_eval do
+            define_method "#{revert_event_name}!".to_sym do |*args|
+              process_event!(revert_event_name, *args)
+            end
+            define_method "can_#{revert_event_name}?" do
+              return self.current_state.events.include?(revert_event_name)
+            end
+          end
+
+        end
+    end
+
+    a = Article.new
+    assert(a.new?, "should start with the 'new' state")
+    a.submit!
+    assert(a.awaiting_review?, "should now be in 'awaiting_review' state")
+    assert_equal(['revert_submit', 'review'], a.current_state.events.keys.map(&:to_s).sort)
+    a.revert_submit! # this method is added by our meta programming magic above
+    assert(a.new?, "should now be back in the 'new' state")
+  end
+
+end

data/test/attr_protected_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+
+$VERBOSE = false
+require 'active_record'
+require 'logger'
+require 'sqlite3'
+require 'workflow'
+require 'mocha/setup'
+require 'stringio'
+
+ActiveRecord::Migration.verbose = false
+
+class AttrProtectedTestOrder < ActiveRecord::Base
+  include Workflow
+
+  workflow do
+    state :submitted do
+      event :accept, :transitions_to => :accepted, :meta => {:doc_weight => 8} do |reviewer, args|
+      end
+    end
+    state :accepted do
+      event :ship, :transitions_to => :shipped
+    end
+    state :shipped
+  end
+
+  attr_accessible :title # protecting all the other attributes
+
+end
+
+AttrProtectedTestOrder.logger = Logger.new(STDOUT) # active_record 2.3 expects a logger instance
+AttrProtectedTestOrder.logger.level = Logger::WARN # switch to Logger::DEBUG to see the SQL statements
+
+class AttrProtectedTest < ActiveRecordTestCase
+
+  def setup
+    super
+
+    ActiveRecord::Schema.define do
+      create_table :attr_protected_test_orders do |t|
+        t.string :title, :null => false
+        t.string :workflow_state
+      end
+    end
+
+    exec "INSERT INTO attr_protected_test_orders(title, workflow_state) VALUES('order1', 'submitted')"
+    exec "INSERT INTO attr_protected_test_orders(title, workflow_state) VALUES('order2', 'accepted')"
+    exec "INSERT INTO attr_protected_test_orders(title, workflow_state) VALUES('order3', 'accepted')"
+    exec "INSERT INTO attr_protected_test_orders(title, workflow_state) VALUES('order4', 'accepted')"
+    exec "INSERT INTO attr_protected_test_orders(title, workflow_state) VALUES('order5', 'accepted')"
+    exec "INSERT INTO attr_protected_test_orders(title, workflow_state) VALUES('protected order', 'submitted')"
+  end
+
+  def assert_state(title, expected_state, klass = AttrProtectedTestOrder)
+    o = klass.find_by_title(title)
+    assert_equal expected_state, o.read_attribute(klass.workflow_column)
+    o
+  end
+
+  test 'cannot mass-assign workflow_state if attr_protected' do
+     o = AttrProtectedTestOrder.find_by_title('order1')
+     assert_equal 'submitted', o.read_attribute(:workflow_state)
+     o.update_attributes :workflow_state => 'some_bad_value'
+     assert_equal 'submitted', o.read_attribute(:workflow_state)
+     o.update_attribute :workflow_state, 'some_overridden_value'
+     assert_equal 'some_overridden_value', o.read_attribute(:workflow_state)
+   end
+
+  test 'immediately save the new workflow_state on state machine transition' do
+    o = assert_state 'order2', 'accepted'
+    assert o.ship!
+    assert_state 'order2', 'shipped'
+  end
+
+  test 'persist workflow_state in the db and reload' do
+    o = assert_state 'order3', 'accepted'
+    assert_equal :accepted, o.current_state.name
+    o.ship! # should save in the database, no `o.save!` needed
+
+    assert_state 'order3', 'shipped'
+
+    o.reload
+    assert_equal 'shipped', o.read_attribute(:workflow_state)
+  end
+
+  test 'default workflow column should be workflow_state' do
+    o = assert_state 'order4', 'accepted'
+    assert_equal :workflow_state, o.class.workflow_column
+  end
+
+  test 'access workflow specification' do
+    assert_equal 3, AttrProtectedTestOrder.workflow_spec.states.length
+    assert_equal ['submitted', 'accepted', 'shipped'].sort,
+      AttrProtectedTestOrder.workflow_spec.state_names.map{|n| n.to_s}.sort
+  end
+
+  test 'current state object' do
+    o = assert_state 'order5', 'accepted'
+    assert_equal 'accepted', o.current_state.to_s
+    assert_equal 1, o.current_state.events.length
+  end
+
+end
+

data/test/main_test.rb

@@ -4,7 +4,7 @@ $VERBOSE = false
 require 'active_record'
 require 'sqlite3'
 require 'workflow'
-require 'mocha'
+require 'mocha/setup'
 require 'stringio'
 #require 'ruby-debug'
 
@@ -244,17 +244,6 @@ class MainTest < ActiveRecordTestCase
     assert !o.shipped?
   end
 
-  unless RUBY_VERSION < '1.9'
-    test 'compare states' do
-      o = assert_state 'some order', 'accepted'
-      assert o.current_state < :shipped
-      assert o.current_state > :submitted
-      assert_raise ArgumentError do
-        o.current_state > :unknown
-      end
-    end
-  end
-
   test 'correct exception for event, that is not allowed in current state' do
     o = assert_state 'some order', 'accepted'
     assert_raise Workflow::NoTransitionAllowed do
@@ -289,26 +278,58 @@ class MainTest < ActiveRecordTestCase
     a.my_transition!(args)
   end
 
-  test '#53 Support for private transition callbacks' do
+  test '#53 Support for non public transition callbacks' do
     args = mock()
-    args.expects(:log).once
-    c = Class.new
+    args.expects(:log).with('in private callback').once
+    args.expects(:log).with('in protected callback in the base class').once
+
+    b = Class.new # the base class with a protected callback
+    b.class_eval do
+      protected
+      def assign_old(args)
+        args.log('in protected callback in the base class')
+      end
+    end
+
+    c = Class.new(b) # inheriting class with an additional protected callback
     c.class_eval do
       include Workflow
       workflow do
         state :new do
           event :assign, :transitions_to => :assigned
+          event :assign_old, :transitions_to => :assigned_old
         end
         state :assigned
+        state :assigned_old
       end
 
       private
       def assign(args)
-        args.log('Assigned')
+        args.log('in private callback')
       end
     end
+
     a = c.new
     a.assign!(args)
+
+    a2 = c.new
+    a2.assign_old!(args)
+  end
+
+  test '#58 Limited private transition callback lookup' do
+    args = mock()
+    c = Class.new
+    c.class_eval do
+      include Workflow
+      workflow do
+        state :new do
+          event :fail, :transitions_to => :failed
+        end
+        state :failed
+      end
+    end
+    a = c.new
+    a.fail!(args)
   end
 
   test 'Single table inheritance (STI)' do
@@ -417,7 +438,7 @@ class MainTest < ActiveRecordTestCase
   test 'diagram generation' do
     begin
       $stdout = StringIO.new('', 'w')
-      Workflow::create_workflow_diagram(Order, 'doc')
+      Workflow::create_workflow_diagram(Order, '/tmp')
       assert_match(/open.+\.pdf/, $stdout.string,
         'PDF should be generate and a hint be given to the user.')
     ensure
@@ -496,14 +517,14 @@ class MainTest < ActiveRecordTestCase
   end
 
   test 'workflow graph generation' do
-    Dir.chdir('tmp') do
+    Dir.chdir('/tmp') do
       capture_streams do
-        Workflow::create_workflow_diagram(Order)
+        Workflow::create_workflow_diagram(Order, '/tmp')
       end
     end
   end
 
-  test 'workflow graph generation in path with spaces' do
+  test 'workflow graph generation in a path with spaces' do
     `mkdir -p '/tmp/Workflow test'`
     capture_streams do
       Workflow::create_workflow_diagram(Order,  '/tmp/Workflow test')

data/test/new_versions/compare_states_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+require 'workflow'
+
+class ComparableStatesOrder
+  include Workflow
+  workflow do
+    state :submitted do
+      event :accept, :transitions_to => :accepted, :meta => {:doc_weight => 8} do |reviewer, args|
+      end
+    end
+    state :accepted do
+      event :ship, :transitions_to => :shipped
+    end
+    state :shipped
+  end
+end
+
+class CompareStatesTest < Test::Unit::TestCase
+
+  test 'compare states' do
+    o = ComparableStatesOrder.new
+    o.accept!
+    assert_equal :accepted, o.current_state.name
+    assert o.current_state < :shipped
+    assert o.current_state > :submitted
+    assert_raise ArgumentError do
+      o.current_state > :unknown
+    end
+  end
+
+end

data/test/new_versions/persistence_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+require 'active_record'
+require 'logger'
+require 'sqlite3'
+require 'workflow'
+require 'mocha/setup'
+require 'stringio'
+
+ActiveRecord::Migration.verbose = false
+
+class PersistenceTestOrder < ActiveRecord::Base
+  include Workflow
+
+  workflow do
+    state :submitted do
+      event :accept, :transitions_to => :accepted, :meta => {:doc_weight => 8} do |reviewer, args|
+      end
+    end
+    state :accepted do
+      event :ship, :transitions_to => :shipped
+    end
+    state :shipped
+  end
+
+  attr_accessible :title # protecting all the other attributes
+
+end
+
+PersistenceTestOrder.logger = Logger.new(STDOUT) # active_record 2.3 expects a logger instance
+PersistenceTestOrder.logger.level = Logger::WARN # switch to Logger::DEBUG to see the SQL statements
+
+class PersistenceTest < ActiveRecordTestCase
+
+  def setup
+    super
+
+    ActiveRecord::Schema.define do
+      create_table :persistence_test_orders do |t|
+        t.string :title, :null => false
+        t.string :workflow_state
+      end
+    end
+
+    exec "INSERT INTO persistence_test_orders(title, workflow_state) VALUES('order6', 'accepted')"
+  end
+
+  def assert_state(title, expected_state, klass = PersistenceTestOrder)
+    o = klass.find_by_title(title)
+    assert_equal expected_state, o.read_attribute(klass.workflow_column)
+    o
+  end
+
+  test 'ensure other dirty attributes are not saved on state change' do
+    o = assert_state 'order6', 'accepted'
+    o.title = 'going to change the title'
+    assert o.changed?
+    o.ship!
+    assert o.changed?, 'title should not be saved and the change still stay pending'
+  end
+
+end
+

data/workflow.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'activerecord'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rake'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workflow
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &9601480 !ruby/object:Gem::Requirement
+  requirement: &7744380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *9601480
+  version_requirements: *7744380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &9600720 !ruby/object:Gem::Requirement
+  requirement: &7771320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *9600720
+  version_requirements: *7771320
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &9599800 !ruby/object:Gem::Requirement
+  requirement: &7767500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9599800
+  version_requirements: *7767500
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &9598500 !ruby/object:Gem::Requirement
+  requirement: &7789480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9598500
+  version_requirements: *7789480
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &9597840 !ruby/object:Gem::Requirement
+  requirement: &7788080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9597840
+  version_requirements: *7788080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &7784180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7784180
 description: ! "    Workflow is a finite-state-machine-inspired API for modeling and
   interacting\n    with what we tend to refer to as 'workflow'.\n\n    * nice DSL
   to describe your states, events and transitions\n    * robust integration with ActiveRecord
@@ -80,18 +91,23 @@ extra_rdoc_files:
 - README.markdown
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.markdown
 - Rakefile
-- VERSION
+- gemfiles/Gemfile.rails-2.3.x
 - lib/workflow.rb
 - lib/workflow/version.rb
+- test/advanced_examples_test.rb
 - test/advanced_hooks_and_validation_test.rb
+- test/attr_protected_test.rb
 - test/before_transition_test.rb
 - test/couchtiny_example.rb
 - test/main_test.rb
 - test/multiple_workflows_test.rb
+- test/new_versions/compare_states_test.rb
+- test/new_versions/persistence_test.rb
 - test/on_error_test.rb
 - test/readme_example.rb
 - test/test_helper.rb
@@ -112,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2208733943504161358
+      hash: 666989584691565007
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2208733943504161358
+      hash: 666989584691565007
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -129,11 +145,15 @@ signing_key:
 specification_version: 3
 summary: A replacement for acts_as_state_machine.
 test_files:
+- test/advanced_examples_test.rb
 - test/advanced_hooks_and_validation_test.rb
+- test/attr_protected_test.rb
 - test/before_transition_test.rb
 - test/couchtiny_example.rb
 - test/main_test.rb
 - test/multiple_workflows_test.rb
+- test/new_versions/compare_states_test.rb
+- test/new_versions/persistence_test.rb
 - test/on_error_test.rb
 - test/readme_example.rb
 - test/test_helper.rb

data/VERSION

@@ -1 +0,0 @@
-0.8.6