state_machine-audit_trail 0.0.2 → 0.0.3

data/lib/state_machine/audit_trail.rb

@@ -2,7 +2,7 @@ require 'state_machine'
 
 module StateMachine::AuditTrail
     
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
     
   def self.setup
     StateMachine::Machine.send(:include, StateMachine::AuditTrail::TransitionAuditing)

data/lib/state_machine/audit_trail_generator.rb

@@ -5,8 +5,8 @@ class StateMachine::AuditTrailGenerator < ::Rails::Generators::Base
   source_root File.join(File.dirname(__FILE__), 'templates')
   
   argument :source_model
-  argument :state_attribute, :default => 'state'
-  argument :transition_model, :default => nil
+  argument :state_attribute,  :default => 'state'
+  argument :transition_model, :default => ''
 
 
   def create_model
@@ -16,6 +16,6 @@ class StateMachine::AuditTrailGenerator < ::Rails::Generators::Base
   protected
   
   def transition_class_name
-    transition_model || "#{source_model.camelize}#{state_attribute.camelize}Transition"
+    transition_model.blank? ? "#{source_model.camelize}#{state_attribute.camelize}Transition" : transition_model
   end
 end

data/spec/state_machine/audit_trail_spec.rb

@@ -1,75 +1,82 @@
 require 'spec_helper'
 
 describe StateMachine::AuditTrail do
+  
   it "should have a VERSION constant" do
     StateMachine::AuditTrail.const_defined?('VERSION').should be_true
   end
   
-  it "should log an event with all fields set correctly" do
-    m = TestModel.create!
-    m.start!
-    last_transition = TestModelStateTransition.where(:test_model_id => m.id).last
+  context 'on an object with a single state machine' do
+    let!(:state_machine) { TestModel.create! }
+    
+    it "should log an event with all fields set correctly" do
+      state_machine.start!
+      last_transition = TestModelStateTransition.where(:test_model_id => state_machine.id).last
 
-    last_transition.event.should == 'start'
-    last_transition.from.should == 'waiting'
-    last_transition.to.should == 'started'
-    last_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
+      last_transition.event.should == 'start'
+      last_transition.from.should == 'waiting'
+      last_transition.to.should == 'started'
+      last_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
+    end
+    
+    it "should log multiple events" do
+      lambda { state_machine.start && state_machine.stop && state_machine.start }.should change(TestModelStateTransition, :count).by(3)
+    end
+    
+    it "should do nothing when the transition is not exectuted successfully" do
+      lambda { state_machine.stop }.should_not change(TestModelStateTransition, :count)
+    end
   end
   
-  it "should log multiple events" do
-    m = TestModel.create!
+  context 'on an object with multiple state machines' do
+    let!(:state_machine) { TestModelWithMultipleStateMachines.create! }
+    
+    it "should log a state transition for the affected state machine" do
+      lambda { state_machine.begin_first! }.should change(TestModelWithMultipleStateMachinesFirstTransition, :count).by(1)
+    end
 
-    lambda do
-      m.start
-      m.stop
-      m.start
-    end.should change(TestModelStateTransition, :count).by(3)
+    it "should not log a state transition for the unaffected state machine" do
+      lambda { state_machine.begin_first! }.should_not change(TestModelWithMultipleStateMachinesSecondTransition, :count)
+    end
   end
   
-  it "should do nothing when the transition is not exectuted successfully" do
-    m = TestModel.create!
-    lambda { m.stop }.should_not change(TestModelStateTransition, :count)
+  context 'on an object with a state machine having an initial state' do
+    let(:state_machine_class) { TestModelWithMultipleStateMachines }
+    let(:state_transition_class) { TestModelWithMultipleStateMachinesFirstTransition }
+    
+    it "should log a state transition for the inital state" do
+      lambda { state_machine_class.create! }.should change(state_transition_class, :count).by(1)
+    end
+    
+    it "should only set the :to state for the initial transition" do
+      state_machine_class.create!
+      initial_transition = state_transition_class.last
+      initial_transition.event.should be_nil
+      initial_transition.from.should be_nil
+      initial_transition.to.should == 'beginning'
+      initial_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
+    end
   end
   
-  it "should log a state_machine specific event for the affected state machine" do
-    m = TestModelWithMultipleStateMachines.create!
-    lambda { m.begin_first! }.should change(TestModelWithMultipleStateMachinesFirstTransition, :count).by(1)
-  end
+  context 'on an object with a state machine not having an initial state' do
+    let(:state_machine_class) { TestModelWithMultipleStateMachines }
+    let(:state_transition_class) { TestModelWithMultipleStateMachinesSecondTransition }
+    
+    it "should not log a transition when the object is created" do
+      lambda { state_machine_class.create! }.should_not change(state_transition_class, :count)
+    end
 
-  it "should not log a state_machine specific event for the unaffected state machine" do
-    m = TestModelWithMultipleStateMachines.create!
-    lambda { m.begin_first! }.should_not change(TestModelWithMultipleStateMachinesSecondTransition, :count)
-  end
-  
-  it "should log a transition for the inital state" do
-    lambda { TestModelWithMultipleStateMachines.create! }.should change(TestModelWithMultipleStateMachinesFirstTransition, :count).by(1)
-  end
-  
-  it "should only log the :to state for an initial state" do
-    TestModelWithMultipleStateMachines.create!
-    initial_transition = TestModelWithMultipleStateMachinesFirstTransition.last
-    initial_transition.event.should be_nil
-    initial_transition.from.should be_nil
-    initial_transition.to.should == 'beginning'
-    initial_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
-  end
-  
-  it "should not log a transition when the state machine does not have an initial state" do
-    lambda { TestModelWithMultipleStateMachines.create! }.should_not change(TestModelWithMultipleStateMachinesSecondTransition, :count)
-  end
-  
-  it "should create a transiction for the first record when the state machine does not have an initial state" do
-    m = TestModelWithMultipleStateMachines.create!
-    lambda { m.begin_second! }.should change(TestModelWithMultipleStateMachinesSecondTransition, :count).by(1)
-  end
-  
-  it "should not have a value for the from state when the state machine does not have an initial state" do
-    m = TestModelWithMultipleStateMachines.create!
-    m.begin_second!
-    first_transition = TestModelWithMultipleStateMachinesSecondTransition.last
-    first_transition.event.should == 'begin_second'
-    first_transition.from.should be_nil
-    first_transition.to.should == 'beginning'
-    first_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
+    it "should log a transition for the first event" do
+      lambda { state_machine_class.create.begin_second! }.should change(state_transition_class, :count).by(1)
+    end
+
+    it "should not set a value for the :from state on the first transition" do
+      state_machine_class.create.begin_second!
+      first_transition = state_transition_class.last
+      first_transition.event.should == 'begin_second'
+      first_transition.from.should be_nil
+      first_transition.to.should == 'beginning'
+      first_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
+    end
   end
 end

data/state_machine-audit_trail.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "state_machine-audit_trail"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Willem van Bergen", "Jesse Storimer"]
   s.email       = ["willem@shopify.com", "jesse@shopify.com"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 -04:00
+date: 2011-04-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency