super_state 0.1.0 → 0.2.1

data/README

@@ -44,6 +44,12 @@ a simple multi-state model
   
   end
 
+this is actually already shipped as a magic mixin
+
+  class MyClass < ActiveRecord::Base
+    include SuperState::CommonStates
+  end
+  
 we can also take arguments in our transitions
 
   class Loan < ActiveRecord::Base

data/Rakefile

@@ -45,7 +45,7 @@ spec = Gem::Specification.new do |s|
 
   # Change these as appropriate
   s.name              = "super_state"
-  s.version           = "0.1.0"
+  s.version           = "0.2.1"
   s.summary           = "Super Simple State Machine"
   s.author            = "Matthew Rudy Jacobs"
   s.email             = "MatthewRudyJacobs@gmail.com"

data/lib/super_state/common_states.rb

@@ -0,0 +1,42 @@
+module SuperState
+  
+  module CommonStates
+  
+    def self.included(klass)
+      klass.class_eval do
+        include SuperState
+  
+        super_state :pending, :initial => true
+        super_state :processing
+        super_state :completed
+        super_state :failed
+      
+        super_state_group :outstanding, ["pending", "processing"]
+      
+        # first part of a two stage transition
+        # eg.
+        #   def process
+        #     start_processing!
+        #       do_the_stuff
+        #     complete_processing!
+        #   end
+        #
+        state_transition :start_processing, :pending => :processing
+      
+        # second part of a two stage transition
+        state_transition :complete_processing, :processing => :completed
+      
+        # transition direct from pending to complete
+        state_transition :complete, :pending => :completed
+      
+        # failed to process
+        state_transition :fail, :processing => :failed
+      
+        # back to processing
+        state_transition :restart, :failed => :processing
+      end
+    end
+    
+  end
+  
+end

data/lib/super_state.rb

@@ -1,3 +1,5 @@
+require 'super_state/common_states'
+
 module SuperState
   
   def self.included(klass)

data/test/common_states_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+
+class CommonStatesTest < Test::Unit::TestCase
+  
+  class MyClass < ActiveRecord::Base
+    include SuperState::CommonStates
+  end
+  
+  # a DD::Batch is a simple example
+  def setup
+    @object = MyClass.create!()
+    assert @object.pending?
+    assert @object.class.ancestors.include?(CommonStates), "mate, it's not a CommonState thing"
+  end
+  
+  test "a new record is pending?" do
+    @object = MyClass.new
+    assert @object.pending?
+  end
+  
+  test "start_processing! - raises" do
+    assert @object.pending?
+    @object.expects(:valid?).returns(false)
+    
+    assert_raise(ActiveRecord::RecordInvalid) do
+      @object.start_processing!
+    end
+    assert !@object.pending? # doesnt roll back
+  end
+  
+  test "start_processing - returns false" do
+    assert @object.pending?
+    @object.expects(:valid?).returns(false)
+    
+    assert_equal false, @object.start_processing
+    assert @object.pending? # rolls back
+  end
+  
+  test "start_processing!" do
+    assert @object.pending?
+    
+    assert @object.start_processing!
+    
+    before_and_after_reload @object do
+      assert @object.processing?
+    end
+  end
+  
+  test "complete_processing!" do
+    @object.start_processing!
+    assert @object.processing?
+    
+    assert @object.complete_processing!
+    
+    before_and_after_reload @object do
+      assert @object.completed?
+    end
+  end
+  
+  test "fail!" do
+    @object.start_processing!
+    assert @object.processing?
+    
+    assert @object.fail!
+    
+    before_and_after_reload @object do
+      assert @object.failed?
+    end
+  end
+  
+  test "complete!" do
+    assert @object.pending?
+    
+    assert @object.complete!
+    
+    before_and_after_reload @object do
+      assert @object.completed?
+    end
+  end
+  
+  test "outstanding?" do
+    assert @object.pending?
+    assert @object.outstanding?
+    
+    @object.start_processing!
+    assert @object.outstanding?
+    
+    @object.complete_processing!
+    assert !@object.outstanding?
+  end
+  
+end

data/test/super_state_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class SuperStateTest < ActiveSupport::TestCase
+class SuperStateTest < Test::Unit::TestCase
   
   test "abstract the tests" do
     puts "this has been abstracted from a live project"

data/test/test_helper.rb

@@ -1,3 +1,8 @@
 require 'rubygems'
 require 'test/unit'
-require 'active_support'
+require 'active_support/testing/declarative'
+$: << File.expand_path(File.dirname(__FILE__)+"/../lib")
+
+class Test::Unit::TestCase
+  extend ActiveSupport::Testing::Declarative
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: super_state
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 21
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 0
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Matthew Rudy Jacobs
@@ -31,8 +31,10 @@ files:
 - MIT-LICENSE
 - Rakefile
 - README
+- test/common_states_test.rb
 - test/super_state_test.rb
 - test/test_helper.rb
+- lib/super_state/common_states.rb
 - lib/super_state.rb
 has_rdoc: true
 homepage: http://github.com/matthewrudy/super_state