workflow-rails4 1.1.0

data/test/multiple_workflows_test.rb

@@ -0,0 +1,84 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'workflow'
+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
+
+      include Workflow
+
+      def initialize_workflow
+        # define workflow per object instead of per class
+        case workflow_type
+        when 'workflow_1'
+          class << self
+            workflow do
+              state :initial do
+                event :progress, :transitions_to => :last
+              end
+              state :last
+            end
+          end
+        when 'workflow_2'
+          class << self
+            workflow do
+              state :initial do
+                event :progress, :transitions_to => :intermediate
+              end
+              state :intermediate
+              state :last
+            end
+          end
+        end
+      end
+
+      def metaclass; class << self; self; end; end
+
+      def workflow_spec
+        metaclass.workflow_spec
+      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'
+
+    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
+
+    # check persistence
+    booking2reloaded = Booking.find_by_title('booking2')
+    booking2reloaded.initialize_workflow
+    assert booking2reloaded.intermediate?, 'persistence of workflow state does not work'
+  end
+
+  class Object
+    # The hidden singleton lurks behind everyone
+    def metaclass; class << self; self; end; end
+  end
+
+end

data/test/new_versions/compare_states_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+require 'workflow'
+
+class ComparableStatesOrder
+  include Workflow
+  workflow do
+    state :submitted do
+      event :accept, :transitions_to => :accepted, :meta => {: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 == :accepted
+    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/test/on_error_test.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'workflow'
+
+class OnErrorTest < Test::Unit::TestCase
+  # A class that does not handle errors in an error block
+  class NoErrorBlock
+    include Workflow
+    workflow do
+      state :first do
+        event :forward, :transitions_to => :second do
+          raise "This is some random runtime error"
+        end
+      end
+      state :second
+    end
+  end
+
+  # A class that handles errors in an error block
+  class ErrorBlock
+    attr_reader :errors
+
+    def initialize
+      @errors = {}
+    end
+
+    include Workflow
+    workflow do
+      state :first do
+        event :forward, :transitions_to => :second do
+          raise "This is some random runtime error"
+        end
+      end
+      state :second
+      on_error { |error, from, to, event, *args| @errors.merge!({:error => error.class, :from => from, :to => to, :event => event, :args => args}) }
+    end
+  end
+
+
+  test 'that an exception is raised if there is no associated on_error block' do
+    flow = NoErrorBlock.new
+    assert_raise( RuntimeError, "This is some random runtime error" ) { flow.forward! }
+    assert_equal(true, flow.first?)
+  end
+  
+  test 'that on_error block is called when an exception is raised and the transition is halted' do
+    flow = ErrorBlock.new
+    assert_nothing_raised { flow.forward! }
+    assert_equal({:error => RuntimeError, :from=>:first, :to=>:second, :event=>:forward, :args=>[]}, flow.errors)
+    # transition should not happen
+    assert_equal(true, flow.first?)
+  end
+end

data/test/readme_example.rb

@@ -0,0 +1,37 @@
+require 'workflow'
+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
+    state :rejected
+  end
+end
+
+article = Article.new
+article.accepted? # => false
+article.new? # => true
+article.submit!
+article.review!
+
+puts article.current_state # => being_reviewed
+
+
+class Article
+  def reject
+    puts "send email to the author here explaining the reason for the rejection"
+  end
+end
+
+article.reject! # will cause a state transition, would persist the new
+  # state (if inherited from ActiveRecord), and invoke the callback -
+  # send email to the author.

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+
+class << Test::Unit::TestCase
+  def test(name, &block)
+    test_name = :"test_#{name.gsub(' ','_')}"
+    raise ArgumentError, "#{test_name} is already defined" if self.instance_methods.include? test_name.to_s
+    if block
+      define_method test_name, &block
+    else
+      puts "PENDING: #{name}"
+    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
+

data/test/without_active_record_test.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'workflow'
+
+class WithoutWorkflowTest < Test::Unit::TestCase
+  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
+      state :rejected
+    end
+  end
+
+  def test_readme_example_article
+    article = Article.new
+    assert article.new?
+  end
+
+  test 'better error message on transitions_to typo' do
+    assert_raise Workflow::WorkflowDefinitionError do
+      Class.new do
+        include Workflow
+        workflow do
+          state :new do
+            event :event1, :transitionnn => :next # missing transitions_to target
+          end
+          state :next
+        end
+      end
+    end
+  end
+
+  test 'check transition_to alias' do
+    Class.new do
+      include Workflow
+      workflow do
+        state :new do
+          event :event1, :transition_to => :next
+        end
+        state :next
+      end
+    end
+  end
+end
+

data/workflow.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workflow/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "workflow-rails4"
+  gem.version       = Workflow::VERSION
+  gem.authors       = ["Vladimir Dobriakov", "Timon Vonk"]
+  gem.email         = ["vladimir@geekq.net"]
+  gem.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 and non relational data stores\n    * various hooks for single transitions, entering state etc.\n    * convenient access to the workflow specification: list states, possible events\n      for particular state\n Temporary version to address possible rails4 issues"
+  gem.summary       = %q{A replacement for acts_as_state_machine.}
+  gem.homepage = "http://www.geekq.net/workflow/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.extra_rdoc_files = [
+    "README.markdown"
+  ]
+
+  gem.add_development_dependency 'rdoc',    [">= 3.12"]
+  gem.add_development_dependency 'bundler', [">= 1.0.0"]
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'ruby-graphviz', ['>= 1.0']
+end
+

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: workflow-rails4
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Vladimir Dobriakov
+- Timon Vonk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |2-
+      Workflow is a finite-state-machine-inspired API for modeling and interacting
+      with what we tend to refer to as 'workflow'.
+
+      * nice DSL to describe your states, events and transitions
+      * robust integration with ActiveRecord and non relational data stores
+      * various hooks for single transitions, entering state etc.
+      * convenient access to the workflow specification: list states, possible events
+        for particular state
+   Temporary version to address possible rails4 issues
+email:
+- vladimir@geekq.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- gemfiles/Gemfile.rails-2.3.x
+- gemfiles/Gemfile.rails-3.x
+- gemfiles/Gemfile.rails-edge
+- lib/workflow.rb
+- lib/workflow/adapters/active_record.rb
+- lib/workflow/adapters/remodel.rb
+- lib/workflow/draw.rb
+- lib/workflow/errors.rb
+- lib/workflow/event.rb
+- lib/workflow/specification.rb
+- lib/workflow/state.rb
+- lib/workflow/version.rb
+- orders_workflow.png
+- test/active_record_scopes_test.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/inheritance_test.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
+- test/without_active_record_test.rb
+- workflow.gemspec
+homepage: http://www.geekq.net/workflow/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A replacement for acts_as_state_machine.
+test_files:
+- test/active_record_scopes_test.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/inheritance_test.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
+- test/without_active_record_test.rb