state_manager 0.2.3

data/test/adapters/active_record_test.rb

@@ -0,0 +1,112 @@
+require 'helper'
+
+class ActiveRecordTest < Test::Unit::TestCase
+
+  class PostStates < StateManager::Base
+    state :unsubmitted do
+      event :submit, :transitions_to => 'submitted.awaiting_review'
+    end
+    state :submitted do
+      state :awaiting_review do
+        event :review, :transitions_to => 'submitted.reviewing'
+      end
+      state :reviewing do
+        event :accept, :transitions_to => 'active'
+        event :clarify, :transitions_to => 'submitted.clarifying'
+      end
+      state :clarifying do
+        event :review, :transitions_to => 'submitted.reviewing'
+      end
+    end
+    state :active
+    state :rejected
+  end
+
+  class Post < ActiveRecord::Base
+    extend StateManager::Resource
+    state_manager
+  end
+
+  def exec(sql)
+    ActiveRecord::Base.connection.execute sql
+  end
+
+  def setup
+    ActiveRecord::Base.establish_connection(
+      :adapter => "sqlite3",
+      :database  => ":memory:" #"tmp/test"
+    )
+
+    ActiveRecord::Schema.define do
+      create_table :posts do |t|
+        t.integer :id
+        t.string :title
+        t.string :body
+        t.string :state
+      end
+    end
+
+    exec "INSERT INTO posts VALUES(1, NULL, NULL, NULL)"
+    exec "INSERT INTO posts VALUES(2, NULL, NULL, 'unsubmitted')"
+    exec "INSERT INTO posts VALUES(3, NULL, NULL, 'submitted.reviewing')"
+    exec "INSERT INTO posts VALUES(4, NULL, NULL, 'submitted.bad_state')"
+
+    @resource = nil
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.disconnect!
+  end
+
+  def test_adapter_included
+    @resource = Post.find(1)
+    assert @resource.is_a?(StateManager::Adapters::ActiveRecord::ResourceMethods)
+    assert @resource.state_manager.is_a?(StateManager::Adapters::ActiveRecord::ManagerMethods)
+  end
+
+  def test_persist_initial_state
+    @resource = Post.find(1)
+    assert_state 'unsubmitted'
+    assert !@resource.changed?, "state should have been persisted"
+  end
+
+  def test_initial_state_value
+    @resource = Post.find(3)
+    assert_state 'submitted.reviewing'
+  end
+
+  def test_validate_nil_state
+    @resource = Post.find(1)
+    assert !@resource.state
+    @resource.save
+    assert_state 'unsubmitted'
+  end
+
+  def test_validate_invalid_state
+    @resource = Post.find(4)
+    assert_equal 'submitted.bad_state', @resource.state
+    @resource.save
+    assert_state 'unsubmitted'
+  end
+
+  def test_scopes
+    exec "INSERT INTO posts VALUES(5, NULL, NULL, 'submitted.reviewing')"
+    exec "INSERT INTO posts VALUES(6, NULL, NULL, 'submitted.reviewing')"
+    exec "INSERT INTO posts VALUES(7, NULL, NULL, 'submitted.reviewing')"
+    exec "INSERT INTO posts VALUES(8, NULL, NULL, 'submitted.reviewing')"
+    exec "INSERT INTO posts VALUES(9, NULL, NULL, 'submitted.clarifying')"
+    exec "INSERT INTO posts VALUES(10, NULL, NULL, 'submitted.clarifying')"
+
+    exec "INSERT INTO posts VALUES(11, NULL, NULL, 'active')"
+    exec "INSERT INTO posts VALUES(12, NULL, NULL, 'active')"
+    exec "INSERT INTO posts VALUES(13, NULL, NULL, 'active')"
+    exec "INSERT INTO posts VALUES(14, NULL, NULL, 'active')"
+
+    # +1 from setup
+    assert_equal 1, Post.unsubmitted.count
+    # +2 from setup
+    assert_equal 8, Post.submitted.count
+    assert_equal 4, Post.active.count
+    assert_equal 0, Post.rejected.count
+  end
+end

data/test/basic_test.rb

@@ -0,0 +1,132 @@
+require 'helper'
+
+class BasicTest < Test::Unit::TestCase
+
+  class PostStates < StateManager::Base
+    state :unsubmitted do
+      event :submit, :transitions_to => 'submitted.awaiting_review'
+    end
+    state :submitted do
+      state :awaiting_review do
+        event :review, :transitions_to => 'submitted.reviewing'
+      end
+      state :reviewing do
+        event :accept, :transitions_to => 'active'
+        event :clarify, :transitions_to => 'submitted.clarifying'
+      end
+      state :clarifying do
+        event :review, :transitions_to => 'submitted.reviewing'
+      end
+    end
+    state :active
+    state :rejected
+  end
+
+  class Post
+    attr_accessor :state
+    extend StateManager::Resource
+    state_manager :state
+  end
+
+  class PostWithInitialState
+    attr_accessor :state
+    extend StateManager::Resource
+    state_manager :state, PostStates do
+      initial_state 'submitted.awaiting_review'
+    end
+  end
+
+  class PostWithCustomProperty
+    attr_accessor :workflow_state
+    extend StateManager::Resource
+    state_manager :workflow_state, PostStates
+  end
+
+  def setup
+    @resource = Post.new
+  end
+
+  def test_state_manager_class_initialized
+    assert @resource.state_manager.is_a?(PostStates), "state manager should have been initialized"
+  end
+  
+  def test_initial_states
+    assert_state 'unsubmitted', "initial state should be set to the default"
+
+    @resource = PostWithInitialState.new
+
+    assert_state 'submitted.awaiting_review', "initial state should be set to specified initial state"
+
+    @resource = Post.new
+    @resource.state = 'active'
+
+    assert_state 'active', "initial state should be read from resource"
+
+    @resource = PostWithInitialState.new
+    @resource.state = ''
+
+    assert_state 'submitted.awaiting_review', "initial state should be set to specified initial state"
+  end
+
+  def test_context
+    @resource.state_manager.context[:user] = 'brogrammer'
+    assert_equal 'brogrammer', @resource.state_manager.context[:user]
+  end
+
+  def test_state_changes
+    @resource.state_manager.transition_to 'submitted.clarifying'
+
+    assert_state 'submitted.clarifying', 'state should have transitioned'
+    assert_equal @resource.state, 'submitted.clarifying', 'state should have been written'
+
+    @resource.state_manager.transition_to 'reviewing'
+
+    assert_state 'submitted.reviewing', 'state should transition with shorthand sibling name'
+
+    @resource.state_manager.transition_to 'rejected'
+
+    assert_state 'rejected', 'state should have transitioned'
+  
+    assert_raise StateManager::StateNotFound do
+      @resource.state_manager.transition_to 'reviewing'
+    end
+  end
+
+  def test_events
+    @resource.state_manager.send_event! :submit
+
+    assert_equal @resource.state_manager.current_state.path, 'submitted.awaiting_review', 'state should have transitioned'
+    assert_equal @resource.state, 'submitted.awaiting_review', 'state should have been written'
+
+    assert_raise StateManager::InvalidEvent do
+      @resource.state_manager.send_event! :submit
+    end
+    assert_equal @resource.state, 'submitted.awaiting_review', 'state should not have changed'
+
+    @resource.state_manager.send_event! :review
+  end
+
+  def test_alternate_property
+    @resource = PostWithCustomProperty.new
+    assert_state 'unsubmitted', @resource.workflow_state_manager
+
+    @resource.workflow_state_manager.send_event! :submit
+
+    assert_equal @resource.workflow_state_manager.current_state.path, 'submitted.awaiting_review', 'state should have transitioned'
+    assert_equal @resource.workflow_state, 'submitted.awaiting_review', 'state should have been written'
+
+    assert_raise StateManager::InvalidEvent do
+      @resource.workflow_state_manager.send_event! :submit
+    end
+    assert_equal @resource.workflow_state, 'submitted.awaiting_review', 'state should not have changed'
+
+    @resource.workflow_state_manager.send_event! :review
+  end
+
+  def test_can_only_transition_to_leaf
+    assert_raise StateManager::InvalidTransition do
+      @resource.state_manager.transition_to('submitted')
+    end
+  end
+
+end

data/test/definition_test.rb

@@ -0,0 +1,132 @@
+require 'helper'
+
+class DefinitionTest < Test::Unit::TestCase
+
+  class CommentStates < StateManager::Base
+    attr_accessor :accept_reason, :reject_reason
+
+    class Submitted < StateManager::State
+
+      state :awaiting_review do
+        event :review, :transitions_to => 'submitted.reviewing'
+      end
+      state :reviewing do
+        event :accept, :transitions_to => 'active'
+        event :clarify, :transitions_to => 'submitted.clarifying'
+      end
+      state :clarifying do
+        event :review, :transitions_to => 'submitted.reviewing'
+      end
+
+      class Reviewing
+
+        def accept(reason)
+          state_manager.accept_reason = reason
+        end
+
+      end
+    end
+
+    state :unsubmitted do
+    end
+    state :submitted do
+    end
+    state :active
+    state :rejected
+
+    event :reject
+
+    def accept(reason)
+      state_manager.accept_reason = 'bad value'
+    end
+
+    def reject(reason)
+      self.reject_reason = reason
+      transition_to :rejected
+    end
+
+    class Unsubmitted
+
+      event :submit, :transitions_to => 'submitted.awaiting_review'
+
+    end
+
+    class_attribute :_resource_class
+    def self.added_to_resource(klass, property, options)
+      self._resource_class = klass
+    end
+
+  end
+
+  class Comment
+    attr_accessor :state
+    extend StateManager::Resource
+    state_manager
+  end
+
+  class ItemStates < StateManager::Base
+    state :default
+  end
+
+  class Item
+    attr_accessor :state
+    extend StateManager::Resource
+    state_manager
+  end
+
+  class BaseStateManager < StateManager::Base
+  end
+
+  class ArticleListingStates < BaseStateManager
+    state :default
+  end
+
+  class ArticleListing
+    attr_accessor :state
+    extend StateManager::Resource
+    state_manager
+  end
+
+  def setup
+    @resource = Comment.new
+  end
+
+  def test_event_in_separate_class_definition
+    @resource.submit!
+    assert_state 'submitted.awaiting_review'
+  end
+
+  def test_states_in_separate_class_definition
+    @resource.submit!
+
+    assert_state 'submitted.awaiting_review'
+
+    @resource.review!
+
+    assert_state 'submitted.reviewing'
+
+    @resource.accept!('hipster')
+
+    assert_equal 'hipster', @resource.state_manager.accept_reason
+    assert_state 'active'
+
+    @resource.reject!('not a hipster')
+
+    assert_equal 'not a hipster', @resource.state_manager.reject_reason
+
+    assert_state 'rejected'
+  end
+
+  def test_added_to_resource_callback
+    assert_equal Comment, @resource.state_manager.class._resource_class
+  end
+
+  def test_resource_accessor
+    assert @resource.state_manager.class.method_defined?(:comment)
+    assert @resource.state_manager.class.specification.states.values.first.method_defined?(:comment)
+    assert !@resource.state_manager.class.method_defined?(:item), 'accessor for other resource should not be defined'
+    assert !@resource.state_manager.class.method_defined?(:article_listing), 'accessor for other resource should not be defined'
+    assert ArticleListing.new.state_manager.class.method_defined?(:article_listing)
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pry'
+require 'delayed_job_active_record'
+require 'state_manager'
+
+class Test::Unit::TestCase
+
+  def assert_state(path, state_manager=nil, message=nil)
+    if state_manager.is_a? String
+      message = state_manager
+      state_manager = nil
+    end
+    state_manager ||= @resource.state_manager
+    assert_equal path, state_manager.current_state.path
+  end
+
+end

data/test/helpers_test.rb

@@ -0,0 +1,61 @@
+require 'helper'
+
+class HelpersTest < Test::Unit::TestCase
+
+  class ItemStates < StateManager::Base
+    state :default do
+      event :do_inner, :transitions_to => 'root.outer1.inner'
+    end
+    state :root do
+      state :outer1 do
+        event :next, :transitions_to => 'outer2.inner'
+        state :inner do
+          event :next, :transitions_to => 'inner2'
+        end
+        state :inner2
+      end
+      state :outer2 do
+        state :inner do
+        end
+      end
+    end
+  end
+
+  class Item
+    attr_accessor :state
+    extend StateManager::Resource
+    state_manager
+  end
+
+  def setup
+    @resource = Item.new
+  end
+
+  def test_helpers
+    assert @resource.default?
+    assert !@resource.root?
+    assert !@resource.root_outer1?
+    assert !@resource.root_outer1_inner?
+    assert @resource.can_do_inner?
+    assert !@resource.can_next?
+
+    @resource.do_inner!
+
+    assert @resource.root?
+    assert @resource.root_outer1?
+    assert @resource.root_outer1_inner?
+    assert !@resource.root_outer2_inner?
+    assert @resource.can_next?
+    
+    @resource.next!
+
+    assert @resource.root_outer1_inner2?
+    assert @resource.can_next?
+
+    @resource.next!
+
+    assert @resource.root_outer2_inner?
+    assert !@resource.can_next?
+  end
+
+end

data/test/plugins/delayed_job_test.rb

@@ -0,0 +1,131 @@
+require 'helper'
+require 'timecop'
+
+class DelayedJobTest < Test::Unit::TestCase
+
+  class ProjectStates < StateManager::Base
+    initial_state 'unsubmitted.initial'
+    state :unsubmitted do
+      event :submit, :transitions_to => 'submitted'
+      state :initial do
+        event :remind, :transitions_to => 'reminded', :delay => 2.hours
+      end
+      state :reminded
+    end
+    state :submitted do
+      event :accept, :transitions_to => 'accepted'
+      event :auto_accept, :transitions_to => 'accepted', :delay => 1.day
+      event :reject, :transitions_to => 'rejected'
+    end
+    state :accepted do
+      event :remind, :transitions_to => 'rejected'
+    end
+    state :rejected
+  end
+
+  def exec(sql)
+    ActiveRecord::Base.connection.execute sql
+  end
+
+  def setup
+    ActiveRecord::Base.establish_connection(
+      :adapter => "sqlite3",
+      :database  => ":memory:" #"tmp/test"
+    )
+
+    ActiveRecord::Schema.define do
+      create_table :projects do |t|
+        t.integer :id
+        t.string :title
+        t.string :state
+      end
+
+      create_table :delayed_jobs, :force => true do |table|
+        table.integer  :priority, :default => 0      # Allows some jobs to jump to the front of the queue
+        table.integer  :attempts, :default => 0      # Provides for retries, but still fail eventually.
+        table.text     :handler                      # YAML-encoded string of the object that will do work
+        table.text     :last_error                   # reason for last failure (See Note below)
+        table.datetime :run_at                       # When to run. Could be Time.zone.now for immediately, or sometime in the future.
+        table.datetime :locked_at                    # Set when a client is working on this object
+        table.datetime :failed_at                    # Set when all retries have failed (actually, by default, the record is deleted instead)
+        table.string   :locked_by                    # Who is working on this object (if locked)
+        table.string   :queue                        # The name of the queue this job is in
+        table.timestamps
+      end
+    end
+
+    exec "INSERT INTO projects VALUES(1, 'Project 1', NULL)"
+
+  end
+
+  class Project < ActiveRecord::Base
+    extend StateManager::Resource
+    state_manager
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.disconnect!
+    Timecop.return
+  end
+
+
+  # Convince delayed job that the duration has passed and perform any jobs that
+  # need doing
+  def time_warp(duration)
+    Timecop.travel(duration.from_now)
+    Delayed::Worker.new.work_off
+  end
+
+  def test_delayed_event
+    @resource = Project.find(1)
+    
+    assert_state 'unsubmitted.initial'
+    assert_equal 1, Delayed::Job.count
+
+    time_warp(4.hours)
+
+    assert_equal 0, Delayed::Job.count
+    @resource.reload
+    assert_state 'unsubmitted.reminded'
+
+    @resource.submit!
+
+    assert_state 'submitted'
+
+    time_warp(1.hour)
+
+    assert_state 'submitted', 'should not have transitioned yet'
+  end
+
+  def test_expired_event
+    @resource = Project.find(1)
+
+    assert_state 'unsubmitted.initial'
+    assert_equal 1, Delayed::Job.count
+
+    @resource.submit!
+
+    assert_state 'submitted'
+
+    time_warp(4.hours)
+
+    assert_state 'submitted', 'should not have transitioned'
+  end
+
+  def test_event_name_clashes
+    @resource = Project.find(1)
+
+    assert_state 'unsubmitted.initial'
+    assert_equal 1, Delayed::Job.count
+
+    @resource.submit!
+    @resource.accept!
+
+    assert_equal 2, Delayed::Job.count
+
+    time_warp(1.month)
+
+    assert_state 'accepted', 'remind event should not have been triggered'
+  end
+
+end