railsware-workflow 0.8.1

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/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,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "railsware-workflow"
+  s.version     = "0.8.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Vladimir Dobriakov"]
+  s.email       = ["vladimir@geekq.net"]
+  s.homepage    = "https://github.com/railsware/workflow"
+  s.summary     = "A replacement for acts_as_state_machine."
+  s.description = <<-EOS
+  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
+  EOS
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/workflow.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/lib/*.rb"].each { |rb| require rb }

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: railsware-workflow
+version: !ruby/object:Gem::Version 
+  hash: 61
+  prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 1
+  version: 0.8.1
+platform: ruby
+authors: 
+- Vladimir Dobriakov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-15 00:00:00 Z
+dependencies: []
+
+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"
+email: 
+- vladimir@geekq.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/workflow.rb
+- test/advanced_hooks_and_validation_test.rb
+- test/before_transition_test.rb
+- test/couchtiny_example.rb
+- test/main_test.rb
+- test/multiple_workflows_test.rb
+- test/readme_example.rb
+- test/test_helper.rb
+- test/without_active_record_test.rb
+- workflow.gemspec
+- workflow.rb
+homepage: https://github.com/railsware/workflow
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: A replacement for acts_as_state_machine.
+test_files: 
+- test/advanced_hooks_and_validation_test.rb
+- test/before_transition_test.rb
+- test/couchtiny_example.rb
+- test/main_test.rb
+- test/multiple_workflows_test.rb
+- test/readme_example.rb
+- test/test_helper.rb
+- test/without_active_record_test.rb
+has_rdoc: