workflow-orchestrator 1.3.0

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/on_unavailable_transition_test.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'workflow'
+
+class OnUnavailableTransitionTest < Test::Unit::TestCase
+
+  class NoUnavailableTransitionBlock
+    attr_reader :unavailable_transitions
+
+    def initialize
+      @unavailable_transitions = {}
+    end
+
+    include Workflow
+    workflow do
+      state :first
+      state :second do
+        event :backward, :transitions_to => :first
+      end
+    end
+  end
+
+  class UnavailableTransitionBlock
+    attr_reader :unavailable_transitions
+
+    def initialize
+      @unavailable_transitions = {}
+    end
+
+    include Workflow
+    workflow do
+      state :first
+      state :second do
+        event :backward, :transitions_to => :first
+      end
+      on_unavailable_transition do |from, to_name, *args|
+        @unavailable_transitions.merge!({:from => from, :to_name => to_name, :args => args})
+      end
+    end
+  end
+
+  class UnavailableTransitionBlockThrowsException
+    attr_reader :unavailable_transitions
+
+    def initialize
+      @unavailable_transitions = {}
+    end
+
+    include Workflow
+    workflow do
+      state :first
+      state :second do
+        event :backward, :transitions_to => :first
+      end
+      on_unavailable_transition do |from, to_name, *args|
+        @unavailable_transitions.merge!({:from => from, :to_name => to_name, :args => args})
+        false
+      end
+    end
+  end
+
+  test 'that NoUnavailableTransitionBlock is raised when no on_unavailable_transition block is defined' do
+    flow = NoUnavailableTransitionBlock.new
+    assert_raise( Workflow::NoTransitionAllowed ) { flow.backward! }
+    assert_equal({}, flow.unavailable_transitions)
+    # transition should not happen
+    assert_equal(true, flow.first?)
+  end
+
+  test 'that on_unavailable_transition block is called when an undefined event is called' do
+    flow = UnavailableTransitionBlock.new
+    assert_nothing_raised { flow.backward! }
+    assert_equal({:from => :first, :to_name => :backward, :args=>[]}, flow.unavailable_transitions)
+    # transition should not happen
+    assert_equal(true, flow.first?)
+  end
+
+  test 'that on_unavailable_transition block is called when an undefined event is called and throws NoUnavailableTransitionBlock as false is returned' do
+    flow = UnavailableTransitionBlockThrowsException.new
+    assert_raise( Workflow::NoTransitionAllowed ) { flow.backward! }
+    assert_equal({:from => :first, :to_name => :backward, :args=>[]}, flow.unavailable_transitions)
+    # 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-orchestrator.gemspec

@@ -0,0 +1,42 @@
+# -*- 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-orchestrator"
+  gem.version       = Workflow::VERSION
+  gem.authors       = ["Lorefnon"]
+  gem.email         = ["lorefnon@gmail.com"]
+  gem.description   = <<DOC
+A ruby DSL for modeling business logic as [Finite State Machines](https://en.wikipedia.org/wiki/Finite-state_machine).
+
+The aim of this library is to make the expression of these concepts as clear as possible, utilizing the expressiveness of ruby language, and using similar terminology as found in state machine theory.
+DOC
+  gem.summary       = "A ruby DSL for modeling business logic as Finite State Machines"
+  gem.homepage      = "https://github.com/lorefnon/workflow-orchestrator"
+
+  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.md"
+  ]
+
+  gem.add_development_dependency 'rdoc',    [">= 3.12"]
+  gem.add_development_dependency 'bundler', [">= 1.0.0"]
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'protected_attributes'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'test-unit'
+  gem.add_development_dependency 'pry-rails'
+  gem.add_development_dependency 'pry-byebug'
+  gem.add_development_dependency 'ruby-graphviz', ['~> 1.0.0']
+  
+  gem.required_ruby_version = '>= 1.9.2'
+end
+

metadata

@@ -0,0 +1,267 @@
+--- !ruby/object:Gem::Specification
+name: workflow-orchestrator
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Lorefnon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-21 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: protected_attributes
+  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: test-unit
+  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: pry-rails
+  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: pry-byebug
+  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.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: |
+  A ruby DSL for modeling business logic as [Finite State Machines](https://en.wikipedia.org/wiki/Finite-state_machine).
+
+  The aim of this library is to make the expression of these concepts as clear as possible, utilizing the expressiveness of ruby language, and using similar terminology as found in state machine theory.
+email:
+- lorefnon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- gemfiles/Gemfile.rails-3.x
+- gemfiles/Gemfile.rails-4.0
+- gemfiles/Gemfile.rails-4.1
+- gemfiles/Gemfile.rails-4.2
+- 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/event_collection.rb
+- lib/workflow/specification.rb
+- lib/workflow/state.rb
+- lib/workflow/version.rb
+- orders_workflow.png
+- test/active_record_scopes_test.rb
+- test/active_record_scopes_with_values_test.rb
+- test/adapter_hook_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/enum_values_in_memory_test.rb
+- test/enum_values_test.rb
+- test/incline_column_test.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/on_unavailable_transition_test.rb
+- test/readme_example.rb
+- test/test_helper.rb
+- test/without_active_record_test.rb
+- workflow-orchestrator.gemspec
+homepage: https://github.com/lorefnon/workflow-orchestrator
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby DSL for modeling business logic as Finite State Machines
+test_files:
+- test/active_record_scopes_test.rb
+- test/active_record_scopes_with_values_test.rb
+- test/adapter_hook_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/enum_values_in_memory_test.rb
+- test/enum_values_test.rb
+- test/incline_column_test.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/on_unavailable_transition_test.rb
+- test/readme_example.rb
+- test/test_helper.rb
+- test/without_active_record_test.rb