dm-is-persistent_state_machine 0.0.2 → 0.1.0

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/dm-is-persistent_state_machine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-is-persistent_state_machine}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["michael"]
-  s.date = %q{2010-01-04}
+  s.date = %q{2010-01-14}
   s.description = %q{A persistent State Machine for DataMapper}
   s.email = %q{ma@zive.at}
   s.extra_rdoc_files = [
@@ -26,8 +26,10 @@ Gem::Specification.new do |s|
      "dm-is-persistent_state_machine.gemspec",
      "lib/dm-is-persistent_state_machine.rb",
      "lib/dm-is-persistent_state_machine/is/persistent_state_machine.rb",
-     "test/helper.rb",
-     "test/test_dm-is-persistent_state_machine.rb"
+     "spec/dm-is-persistent_state_machine_spec.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/michael/dm-is-persistent_state_machine}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -35,8 +37,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A persistent State Machine for DataMapper}
   s.test_files = [
-    "test/helper.rb",
-     "test/test_dm-is-persistent_state_machine.rb"
+    "spec/dm-is-persistent_state_machine_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/dm-is-persistent_state_machine/is/persistent_state_machine.rb

@@ -15,12 +15,12 @@ end
 class State
   include DataMapper::Resource
 
-  property :id,          Serial
-  property :code,        String, :required => true, :unique => true, :unique_index => true
-  property :name,        String, :required => true, :unique => true, :unique_index => true
-  property :editable,    Boolean
-  property :sorter,      Integer
-  property :type,        Discriminator
+  property :id,             Serial
+  property :code,           String, :required => true, :unique => true, :unique_index => true
+  property :name,           String, :required => true, :unique => true, :unique_index => true
+  property :editable,       Boolean, :default => true
+  property :sorter,         Integer
+  property :type,           Discriminator
 
   # outgoing transitions
   has n, :state_transitions, 'StateTransition', :child_key => [:state_id]
@@ -51,12 +51,26 @@ end
 class StateEvent
   include DataMapper::Resource
   
-  property :id, Serial
+  property :id,   Serial
   property :code, String, :required => true, :unique => true, :unique_index => true
   property :name, String, :required => true, :unique => true, :unique_index => true
   property :type, Discriminator
 end
 
+class StateChange
+  include DataMapper::Resource
+  
+  property :id, Serial
+  
+  property :from_id, Integer,   :required => true, :min => 1, :unique_index => :type
+  property :to_id, Integer,     :required => true, :min => 1, :unique_index => :type
+  
+  property :created_at, DateTime
+  
+  # associations
+  belongs_to :from, "State"
+  belongs_to :to,   "State"
+end
 
 module DataMapper
   module Is
@@ -79,7 +93,8 @@ module DataMapper
       ##
     
       def is_persistent_state_machine
- 
+        DataMapper.logger.info "registering persistent state machine..."
+        
         # Add class-methods
         extend DataMapper::Is::PersistentStateMachine::ClassMethods
         extend Forwardable
@@ -90,32 +105,41 @@ module DataMapper
         property :state_id, Integer, :required => true, :min => 1
         belongs_to :state
         
-        DataMapper.logger.info "registering persistent state machine..."
-        
-        # define delegators
-        def_delegators :@state, :events
-        
         # generate a FooState class that is derived from State        
         state_model = Object.full_const_set(self.to_s+"State", Class.new(State))
         # generate a FooStateEvent class that is derived from StateEvent
         event_model = Object.full_const_set(self.to_s+"StateEvent", Class.new(StateEvent))
+        
+        after :save do
+          if (@prev_state && @prev_state != state)
+            StateChange.create(:from => @prev_state, :to => state, :created_at => DateTime.now)
+          end
+        end
+
+        # define delegators
+        def_delegators :@state, :events        
       end
       
       ##
       # fired after trigger_event! is called on resource
       #
-      def after_trigger_event(event)
-      end
-  
       module ClassMethods
         
       end # ClassMethods
  
       module InstanceMethods
-        def trigger_event!(event_code)
+        def trigger_event!(event_code)          
+          # cache the old value
+          @prev_state = self.state
+
           # delegate to State#trigger!
           self.state.trigger_event!(self, event_code)
         end
+        
+        # hookable
+        def after_trigger_event(event)
+
+        end
       end # InstanceMethods
     end # PersistentStateMachine
   end # Is

data/spec/dm-is-persistent_state_machine_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe DataMapper::Is::PersistentStateMachine do
+  
+  before(:all) do
+    DataMapper.auto_migrate!
+    
+    # add some states
+    open = ProjectState.create(:name => "Open", :code => "open")
+    reviewed = ProjectState.create(:name => "Reviewed", :code => "reviewed")
+    confirmed = ProjectState.create(:name => "Confirmed", :code => "confirmed")
+    
+    # add some events
+    review_evt = ProjectStateEvent.create(:code => "review", :name => "Review")
+    confirm_evt = ProjectStateEvent.create(:code => "confirm", :name => "Confirm")
+    
+    # add some transitions    
+    open_reviewed = StateTransition.create(:state => open, :target => reviewed, :state_event => review_evt)
+    reviewed_confirmed = StateTransition.create(:state => reviewed, :target => confirmed, :state_event => confirm_evt)
+  end
+  
+  describe "with active DM Identity Map" do
+    
+    before :each do
+      Project.auto_migrate!
+      StateChange.auto_migrate!
+    end
+    
+    it "should log state changes" do
+      @project = Project.create(:name => "Operation X", :state => ProjectState.first(:code => "open"))
+      @project.state.code.should == "open"
+      @project.trigger_event!('review')
+      Project.first(:name => "Operation X").state.code.should == "open" # not persistent yet
+      
+      StateChange.count.should == 0
+      @project.state.code.should == "reviewed"
+      @project.save
+      StateChange.count.should == 1
+    end   
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,6 @@
+--exclude "spec"
+--sort coverage
+--callsites
+--xrefs
+--profile
+--text-summary

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--loadby random
+--format specdoc
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+ 
+require 'dm-core'
+require 'dm-adjust'
+require 'dm-aggregates'
+require 'dm-types'
+require 'dm-validations'
+ 
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'dm-is-persistent_state_machine'
+
+DataMapper.setup(:default, 'sqlite3::memory:')
+ 
+# classes/vars for tests
+
+class Project
+  include DataMapper::Resource
+ 
+  property :id,       Serial
+  property :name,     String
+  
+  is :persistent_state_machine
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-is-persistent_state_machine
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - michael
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-04 00:00:00 +01:00
+date: 2010-01-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,8 +41,10 @@ files:
 - dm-is-persistent_state_machine.gemspec
 - lib/dm-is-persistent_state_machine.rb
 - lib/dm-is-persistent_state_machine/is/persistent_state_machine.rb
-- test/helper.rb
-- test/test_dm-is-persistent_state_machine.rb
+- spec/dm-is-persistent_state_machine_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/michael/dm-is-persistent_state_machine
 licenses: []
@@ -72,5 +74,5 @@ signing_key:
 specification_version: 3
 summary: A persistent State Machine for DataMapper
 test_files: 
-- test/helper.rb
-- test/test_dm-is-persistent_state_machine.rb
+- spec/dm-is-persistent_state_machine_spec.rb
+- spec/spec_helper.rb

data/test/helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'dm-is-persistent_state_machine'
-
-class Test::Unit::TestCase
-end

data/test/test_dm-is-persistent_state_machine.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestDmIsPersistentStateMachine < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end