state_machine-audit_trail 0.1.5 → 0.1.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWM5NDNmMjY4ZDAyZjkxNzhjNWVmZGMxM2ZlNDNkN2ViZTJmZjY1Zg==
+  data.tar.gz: !binary |-
+    Y2JlMTdiOWExODEyNTM5ZGY4MzFhMGRjMGY0OTNjZDNhYzQyNjMzZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    M2U0MzBiN2MxNDc3Y2E3YTczZDg0Mjc4NjkxOWQwNDcwZjlmODU1Yjg5ZmVk
+    OTc1YjI0OTc1YzZkMjJhZWZiNzE5Njg2YzdhNjhmM2IzYTIzZjIwMDg3NWYz
+    NzljOTk3NWZkZThlODVlZDQyMWMxZjRjZGNmZjg2Zjg2MWU5NWE=
+  data.tar.gz: !binary |-
+    NzM5ODc4ZGIwNGY5YmE5NzU0YjZiOTNhZTM2MjA2NzQzZmM1ZWUyNWNmMWJl
+    ODU1OTU1Yzk3ZjIyN2ZjZGYwMDI2YTdkNDU1Y2U1MjJlYWNjMmNkZDMxMWI0
+    MTI3MDdjOTM2YmY1OTNjNzg3MjNkNDViZjBiNTg4NzUyNDhlZjA=

data/README.rdoc

@@ -1,4 +1,4 @@
-= StateMachine audit trail
+= StateMachine audit trail {<img src="https://travis-ci.org/wvanbergen/state_machine-audit_trail.png" />}[https://travis-ci.org/wvanbergen/state_machine-audit_trail]
 
 This plugin for the state machine gem (see https://github.com/pluginaweek/state_machine) adds support for keeping an audit trail for any state machine. Having an audit trail gives you a complete history of the state changes in your model. This history allows you to investigate incidents or perform analytics, like: "How long does it take on average to go from state a to state b?", or "What percentage of cases goes from state a to b via state c?"
 

data/lib/state_machine/audit_trail/backend/active_record.rb

@@ -3,9 +3,9 @@ class StateMachine::AuditTrail::Backend::ActiveRecord < StateMachine::AuditTrail
 
   def initialize(transition_class, owner_class, context_to_log = nil)
     self.context_to_log = context_to_log
-    @association = transition_class.to_s.tableize.to_sym
+    @association = transition_class.to_s.tableize.split('/').last.to_sym
     super transition_class
-    owner_class.has_many @association
+    owner_class.has_many(@association, :class_name => transition_class.to_s) unless owner_class.reflect_on_association(@association)
   end
 
   def log(object, event, from, to, timestamp = Time.now)
@@ -13,6 +13,13 @@ class StateMachine::AuditTrail::Backend::ActiveRecord < StateMachine::AuditTrail
     # right thing with regards to timezones.
     params = {:event => event, :from => from, :to => to}
     params[self.context_to_log] = object.send(self.context_to_log) unless self.context_to_log.nil?
-    object.send(@association).create(params)
+
+    if object.new_record?
+      object.send(@association).build(params)
+    else
+      object.send(@association).create(params)
+    end
+
+    nil
   end
 end

data/lib/state_machine/audit_trail/backend/mongoid.rb

@@ -12,7 +12,7 @@ class StateMachine::AuditTrail::Backend::Mongoid < StateMachine::AuditTrail::Bac
   def log(object, event, from, to, timestamp = Time.now)
     tc = transition_class
     foreign_key_field = tc.relations.keys.first
-    transition_class.create(foreign_key_field => object, :event => event, :from => from, :to => to, :create_at => timestamp)
+    transition_class.create(foreign_key_field => object, :event => event, :from => from, :to => to, :created_at => timestamp)
   end
 
 

data/lib/state_machine/audit_trail/transition_auditing.rb

@@ -16,9 +16,11 @@ module StateMachine::AuditTrail::TransitionAuditing
       state_machine.audit_trail(options[:context_to_log]).log(object, transition.event, transition.from, transition.to)
     end
 
-    state_machine.owner_class.after_create do |object|
-      if !object.send(state_machine.attribute).nil?
-        state_machine.audit_trail(options[:context_to_log]).log(object, nil, nil, object.send(state_machine.attribute))
+    unless state_machine.action == nil
+      state_machine.owner_class.after_create do |object|
+        if !object.send(state_machine.attribute).nil?
+          state_machine.audit_trail(options[:context_to_log]).log(object, nil, nil, object.send(state_machine.attribute))
+        end
       end
     end
   end

data/lib/state_machine/audit_trail/version.rb

@@ -1,5 +1,5 @@
 module StateMachine
   module AuditTrail
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/spec/helpers/active_record.rb

@@ -39,6 +39,10 @@ class ActiveRecordTestModelWithMultipleStateMachinesSecondTransition < ActiveRec
   belongs_to :test_model
 end
 
+class ActiveRecordTestModelWithMultipleStateMachinesThirdTransition < ActiveRecord::Base
+  belongs_to :test_model
+end
+
 class ActiveRecordTestModel < ActiveRecord::Base
 
   state_machine :state, :initial => :waiting do # log initial state?
@@ -102,8 +106,38 @@ class ActiveRecordTestModelWithMultipleStateMachines < ActiveRecord::Base
       transition nil => :beginning_second
     end
   end
+
+  state_machine :third, :action => nil do
+    store_audit_trail
+
+    event :begin_third do
+      transition nil => :beginning_third
+    end
+
+    event :end_third do
+      transition :beginning_third => :done_third
+    end
+  end
 end
 
+module SomeNamespace
+  class ActiveRecordTestModel < ActiveRecord::Base
+
+    state_machine :state, :initial => :waiting do # log initial state?
+      store_audit_trail
+
+      event :start do
+        transition [:waiting, :stopped] => :started
+      end
+
+      event :stop do
+        transition :started => :stopped
+      end
+    end
+  end
+end
+
+
 def create_transition_table(owner_class, state, add_context = false)
   class_name = "#{owner_class.name}#{state.to_s.camelize}Transition"
   ActiveRecord::Base.connection.create_table(class_name.tableize) do |t|
@@ -119,4 +153,5 @@ end
 create_transition_table(ActiveRecordTestModel, :state)
 create_transition_table(ActiveRecordTestModelWithContext, :state, true)
 create_transition_table(ActiveRecordTestModelWithMultipleStateMachines, :first)
-create_transition_table(ActiveRecordTestModelWithMultipleStateMachines, :second)  
+create_transition_table(ActiveRecordTestModelWithMultipleStateMachines, :second)
+create_transition_table(ActiveRecordTestModelWithMultipleStateMachines, :third)

data/spec/state_machine/active_record_spec.rb

@@ -13,9 +13,12 @@ describe StateMachine::AuditTrail::Backend::ActiveRecord do
     ActiveRecordTestModel.reflect_on_association(:active_record_test_model_state_transitions).collection?.should be_true
   end
 
-  context 'on an object with a single state machine' do
-    let!(:state_machine) { ActiveRecordTestModel.create! }
+  it "should handle namespaced models" do
+    backend = StateMachine::AuditTrail::Backend.create_for_transition_class(ActiveRecordTestModelStateTransition, SomeNamespace::ActiveRecordTestModel)
+    SomeNamespace::ActiveRecordTestModel.reflect_on_association(:active_record_test_model_state_transitions).collection?.should be_true
+  end
 
+  shared_examples "a state machine audit trail" do
     it "should log an event with all fields set correctly" do
       state_machine.start!
       last_transition = ActiveRecordTestModelStateTransition.where(:active_record_test_model_id => state_machine.id).last
@@ -27,12 +30,26 @@ describe StateMachine::AuditTrail::Backend::ActiveRecord do
       last_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
     end
 
+    it "should do nothing when the transition is not executed successfully" do
+      lambda { state_machine.stop }.should_not change(ActiveRecordTestModelStateTransition, :count)
+    end
+  end
+
+  context 'on an existing object with a single state machine' do
+    let!(:state_machine) { ActiveRecordTestModel.create! }
+    include_examples "a state machine audit trail"
+
     it "should log multiple events" do
       lambda { state_machine.start && state_machine.stop && state_machine.start }.should change(ActiveRecordTestModelStateTransition, :count).by(3)
     end
+  end
 
-    it "should do nothing when the transition is not executed successfully" do
-      lambda { state_machine.stop }.should_not change(ActiveRecordTestModelStateTransition, :count)
+  context 'on a new object with a single state machine' do
+    let!(:state_machine) { ActiveRecordTestModel.new }
+    include_examples "a state machine audit trail"
+
+    it "should log multiple events including the first event from save" do
+      lambda { state_machine.start && state_machine.stop && state_machine.start }.should change(ActiveRecordTestModelStateTransition, :count).by(4)
     end
   end
 
@@ -100,6 +117,23 @@ describe StateMachine::AuditTrail::Backend::ActiveRecord do
       first_transition.to.should == 'beginning_second'
       first_transition.created_at.should be_within(10.seconds).of(Time.now.utc)
     end
+
+    it "should be fine transitioning before saved on an :action => nil state machine" do
+      lambda do
+        machine = state_machine_class.new
+        machine.begin_third
+        machine.save!
+      end.should change(ActiveRecordTestModelWithMultipleStateMachinesThirdTransition, :count).by(1)
+    end
+
+    it "should queue up transitions to be saved before being saved on an :action => nil state machine" do
+      lambda do
+        machine = state_machine_class.new
+        machine.begin_third
+        machine.end_third
+        machine.save!
+      end.should change(ActiveRecordTestModelWithMultipleStateMachinesThirdTransition, :count).by(2)
+    end
   end
 
   context 'on a class using STI' do

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machine-audit_trail
 version: !ruby/object:Gem::Version
-  version: 0.1.5
-  prerelease: 
+  version: 0.1.6
 platform: ruby
 authors:
 - Willem van Bergen
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -39,7 +35,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -47,7 +42,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,7 +49,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -63,7 +56,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -71,7 +63,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -79,7 +70,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -87,7 +77,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -95,7 +84,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -103,7 +91,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -111,7 +98,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -119,7 +105,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -158,27 +143,26 @@ files:
 homepage: https://github.com/wvanbergen/state_machine-audit_trail
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: state_machine
-rubygems_version: 1.8.23
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Log transitions on a state machine to support auditing and business process
   analytics.
 test_files:
@@ -188,3 +172,4 @@ test_files:
 - spec/state_machine/active_record_spec.rb
 - spec/state_machine/audit_trail_spec.rb
 - spec/state_machine/mongoid_spec.rb
+has_rdoc: