workflow-orchestrator 1.3.0

data/test/attr_protected_test.rb

@@ -0,0 +1,107 @@
+require 'test_helper'
+
+$VERBOSE = false
+require 'active_record'
+require 'logger'
+require 'sqlite3'
+require 'workflow'
+require 'mocha/setup'
+require 'stringio'
+require 'protected_attributes' if ActiveRecord::VERSION::MAJOR >= 4
+
+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).to_s
+     AttrProtectedTestOrder.logger.level = Logger::ERROR # ignore warnings
+     o.update_attributes :workflow_state => 'some_bad_value'
+     AttrProtectedTestOrder.logger.level = Logger::WARN
+     assert_equal 'submitted', o.read_attribute(:workflow_state).to_s
+     o.update_attribute :workflow_state, 'some_overridden_value'
+     assert_equal 'some_overridden_value', o.read_attribute(:workflow_state).to_s
+   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/before_transition_test.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'workflow'
+
+class BeforeTransitionTest < Test::Unit::TestCase
+  class MyFlow
+    attr_reader :history
+    def initialize
+      @history = []
+    end
+
+    include Workflow
+    workflow do
+      state :first do
+        event :forward, :transitions_to => :second do
+          @history << 'forward'
+        end
+      end
+      state :second do
+        event :back, :transitions_to => :first do
+          @history << 'back'
+        end
+      end
+
+      before_transition { @history << 'before' }
+      after_transition { @history << 'after' }
+      on_transition { @history << 'on' }
+    end
+  end
+
+  test 'that before_transition is run before the action' do
+    flow = MyFlow.new
+    flow.forward!
+    flow.back!
+    assert flow.history == ['before', 'forward', 'on', 'after', 'before', 'back', 'on', 'after']
+  end
+end

data/test/couchtiny_example.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'couchtiny'
+require 'couchtiny/document'
+require 'workflow'
+
+class User < CouchTiny::Document
+  include Workflow
+  workflow do
+    state :submitted do
+      event :activate_via_link, :transitions_to => :proved_email
+    end
+    state :proved_email
+  end
+
+  def load_workflow_state
+    self[:workflow_state]
+  end
+
+  def persist_workflow_state(new_value)
+    self[:workflow_state] = new_value
+    save!
+  end
+end
+
+
+class CouchtinyExample < Test::Unit::TestCase
+
+  def setup
+    db = CouchTiny::Database.url("http://127.0.0.1:5984/test-workflow")
+    db.delete_database! rescue nil
+    db.create_database!
+    User.use_database db
+  end
+
+  test 'CouchDB persistence' do
+    user = User.new :email => 'manya@example.com'
+    user.save!
+    assert user.submitted?
+    user.activate_via_link!
+    assert user.proved_email?
+
+    reloaded_user = User.get user.id
+    puts reloaded_user.inspect
+    assert reloaded_user.proved_email?, 'Reloaded user should have the desired workflow state'
+  end
+end

data/test/enum_values_in_memory_test.rb

@@ -0,0 +1,23 @@
+class EnumValuesInMemoryTest < ActiveRecordTestCase
+  test 'that the value of the state is persisted instead of the name' do 
+
+    class EnumFlow
+      attr_reader :workflow_state
+      include Workflow
+
+      workflow do
+        state :first, 1 do
+          event :forward, :transitions_to => :second
+        end
+        state :second, 2 do
+          event :back, :transitions_to => :first
+        end
+      end
+    end
+
+    flow = EnumFlow.new
+    flow.forward!
+    assert flow.workflow_state == 2
+    assert flow.second?
+  end
+end

data/test/enum_values_test.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'workflow'
+
+class EnumValuesTest < ActiveRecordTestCase
+  test 'that the value of the state is persisted instead of the name' do
+  
+    ActiveRecord::Schema.define do
+      create_table(:active_enum_flows) { |t| t.integer :state }
+    end
+
+    class ActiveEnumFlow < ActiveRecord::Base
+      include Workflow
+      workflow_column :state
+
+      workflow do
+        state :first, 1 do
+          event :forward, :transitions_to => :second
+        end
+        state :second, 2 do
+          event :back, :transitions_to => :first
+        end
+      end
+    end
+
+    flow = ActiveEnumFlow.create
+    flow.forward!
+    assert flow.state == 2
+    assert flow.second?
+  end
+end

data/test/incline_column_test.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+$VERBOSE = false
+require 'active_record'
+require 'sqlite3'
+require 'workflow'
+
+ActiveRecord::Migration.verbose = false
+
+class EnumArticleHi < ActiveRecord::Base
+  include Workflow
+
+  workflow :inline_column_hi do
+    state :new, 1 do
+      event :accept, transitions_to: :accepted
+    end
+    state :accepted, 3
+  end
+end
+
+class InlineColumnTest < ActiveRecordTestCase
+
+  def setup
+    super
+
+    ActiveRecord::Schema.define do
+      create_table :enum_article_his do |t|
+        t.string :title
+        t.string :body
+        t.string :blame_reason
+        t.string :reject_reason
+        t.integer :inline_column_hi
+      end
+    end
+  end
+
+  test '"with_new_state" selects matching value' do
+    article = EnumArticleHi.create
+    assert_equal(article.inline_column_hi, 1)
+    article.accept!
+    assert_equal(article.inline_column_hi, 3)
+  end
+
+  test 'allows passing in state value on create' do
+    article = EnumArticleHi.create(inline_column_hi: 3)
+    assert_equal(article.inline_column_hi, 3)
+  end
+
+  test 'allows passing in state name on create' do
+    article = EnumArticleHi.create(inline_column_hi: :accepted)
+    assert_equal(article.inline_column_hi, 3)
+  end
+end
+

data/test/inheritance_test.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'workflow'
+class InheritanceTest < ActiveRecordTestCase
+
+  test '#69 inheritance' do
+    class Animal
+      include Workflow
+
+      workflow do
+
+        state :conceived do
+          event :birth, :transition_to => :born
+        end
+
+        state :born do
+
+        end
+      end
+    end
+
+    class Cat < Animal
+      include Workflow
+      workflow do
+
+        state :upset do
+          event :scratch, :transition_to => :hiding
+        end
+
+        state :hiding do
+
+        end
+      end
+    end
+
+    assert_equal [:born, :conceived], Animal.workflow_spec.states.keys.sort
+    assert_equal [:hiding, :upset], Cat.workflow_spec.states.keys.sort, 'Workflow definitions are not inherited'
+
+    animal = Animal.new
+    cat = Cat.new
+
+    animal.birth!
+
+    assert_raise NoMethodError, 'Methods defined by the old workflow spec should have be gone away' do
+      cat.birth!
+    end
+
+    assert_equal [:birth!, :halt!, :process_event!], bang_methods(animal)
+    assert_equal [:halt!, :process_event!, :scratch!], bang_methods(cat)
+  end
+
+  def bang_methods(obj)
+    non_trivial_methods = obj.public_methods - Object.public_methods
+    methods_with_bang = non_trivial_methods.select { |m| m =~ /!$/ }
+    methods_with_bang.map(&:to_sym).sort
+  end
+end