state_machines-audit_trail 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f76b02dab1bbb82a2ba360cbc86137642fc3874
-  data.tar.gz: a40d8ce4c4f7166f9660669d8a603eb8da9d9e40
+  metadata.gz: b2be69a3ef20ae821d26c9cc330e19fe8d94d5a2
+  data.tar.gz: a4b55d4b850acf875c7489c1505c3c99152111a1
 SHA512:
-  metadata.gz: 9818ab2f5f3146c6444645cc6a92c331c069d842b00ff309bc8c4e8ff61fd09a396e0b5240ef43d6686fcdc8e42cc4dd23e6c8f1814ccd47efa3c2fb20aa3915
-  data.tar.gz: e85f0fee66e5323f67e1ffb4d8bb9cd42313d3e5e33ab846fc43a9b0b8bbcf79205c8cc6f2738d633ae450a4e11bf750de24a9a78d11cbc27ce0bc331f5640f3
+  metadata.gz: 0d89506285ebdd527499b689a4bc9d08e7996ceaed99f4cb707941e8134a086f998b73d50f414702afbbd15abfa669dca1b24446da2fef56e647792bb971b9a1
+  data.tar.gz: f7e486a00886044b9763ad293d27c4fce800c52e968e0b689b431b23b3b3d321050a1c229921f8ab55ac17531c48db356734c0ee010719d9a42bdbc15f3f8754

data/README.md

@@ -97,7 +97,7 @@ In order to utilize this feature, you need to:
 #### Example 1 - Store a single attribute value
 Store `Subscription` `field1` in `Transition` field `field1`:
 ```ruby
-audit_trail :context: :field1
+audit_trail context: :field1
 ```
 
 #### Example 2 - Store multiple attribute values
@@ -106,7 +106,25 @@ Store `Subscription` `field1` and `field2` in `Transition` fields `field1` and `
 audit_trail context: [:field1, :field2]
 ```
 
-#### Example 3 - Store simple method results
+#### Example 3 - Store multiple values from a single context object
+Store `Subscription` `user` in `Transition` fields `user_id` and `user_name`:
+```ruby
+class Subscription < ActiveRecord::Base
+  state_machines :state, initial: :start do
+    audit_trail context: :user
+    ...
+  end
+end
+
+class SubscriptionStateTransition < ActiveRecord::Base
+  def user=(u)
+    self.user_id = u.id
+    self.user_name = u.name
+  end
+end
+```
+
+#### Example 4 - Store simple method results
 Store simple method results.
 
 Sometimes it can be useful to store dynamically computed information, such as those from a `Subscription`  method `#plan_time_remaining`
@@ -123,7 +141,7 @@ class Subscription < ActiveRecord::Base
     ...
 ```
 
-#### Example 4 - Store advanced method results
+#### Example 5 - Store advanced method results
 Store method results that interrogate the transition for information such as `event` arguments:
 
 ```ruby

data/lib/state_machines/audit_trail/backend.rb

@@ -48,6 +48,11 @@ class StateMachines::AuditTrail::Backend < Struct.new(:transition_class, :owner_
     end
   end
 
+  # Exists in case ORM layer has a different way of answering this question, but works for most.
+  def new_record?(object)
+    object.new_record?
+  end
+
   protected
 
   def persist(object, fields)

data/lib/state_machines/audit_trail/transition_auditing.rb

@@ -30,9 +30,11 @@ module StateMachines::AuditTrail::TransitionAuditing
       unless state_machine.action == nil
         # Log the initial transition from null => initial (upon object instantiation)
         state_machine.owner_class.after_initialize do |object|
-          current_state = object.send(state_machine.attribute)
-          if !current_state.nil?
-            state_machine.backend.log(object, OpenStruct.new(namespace: state_machine.namespace, to: current_state))
+          if state_machine.backend.new_record? object
+            current_state = object.send(state_machine.attribute)
+            if !current_state.nil?
+              state_machine.backend.log(object, OpenStruct.new(namespace: state_machine.namespace, to: current_state))
+            end
           end
         end
       end

data/lib/state_machines/audit_trail/version.rb

@@ -1,5 +1,5 @@
 module StateMachines
   module AuditTrail
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end
 end

data/spec/lib/state_machines/audit_trail/backend/active_record_spec.rb

@@ -21,9 +21,7 @@ describe StateMachines::AuditTrail::Backend::ActiveRecord do
         expect(target.new_record?).to be_falsey
         expect(target.ar_model_state_transitions.count).to eq 1
         state_transition = target.ar_model_state_transitions.first
-        expect(state_transition.from).to be_nil
-        expect(state_transition.to).to eq 'waiting'
-        expect(state_transition.event).to be_nil
+        assert_transition state_transition, nil, nil, 'waiting'
       end
 
       it 'create object' do
@@ -32,9 +30,13 @@ describe StateMachines::AuditTrail::Backend::ActiveRecord do
         expect(target.new_record?).to be_falsey
         expect(target.ar_model_state_transitions.count).to eq 1
         state_transition = target.ar_model_state_transitions.first
-        expect(state_transition.from).to be_nil
-        expect(state_transition.to).to eq 'waiting'
-        expect(state_transition.event).to be_nil
+        assert_transition state_transition, nil, nil, 'waiting'
+
+        # ensure we don't have a second initial state transition logged (issue #4)
+        target = target.reload()
+        expect(target.ar_model_state_transitions.count).to eq 1
+        state_transition = target.ar_model_state_transitions.first
+        assert_transition state_transition, nil, nil, 'waiting'
       end
     end
 
@@ -261,4 +263,13 @@ describe StateMachines::AuditTrail::Backend::ActiveRecord do
       expect { m.complete! }.not_to raise_error
     end
   end
+
+  private
+
+  def assert_transition(state_transition, event, from, to)
+    # expect(state_transition.namespace).to eq namespace
+    expect(state_transition.event).to eq event
+    expect(state_transition.from).to eq from
+    expect(state_transition.to).to eq to
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-audit_trail
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Kevin Ross
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machines