state_machines-audit_trail 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8a0bfd2dd9a83185bc24c1c55d3804b2fba5a8e
-  data.tar.gz: 03e55491819582dbf56a32b494756564d0da7ffd
+  metadata.gz: 0f76b02dab1bbb82a2ba360cbc86137642fc3874
+  data.tar.gz: a40d8ce4c4f7166f9660669d8a603eb8da9d9e40
 SHA512:
-  metadata.gz: d1c764d8ed988ecb2a766939127e76ce902241320bd53fdce5641830bb3eb52c666179dae873d23fc2f989a5fd65013722af497716a59d65e06c5d5d5a659e6b
-  data.tar.gz: 60d5d11f419b337f253141fb36a17a51dcb2852cb549e89b64a59f4c8f06ed8a30fe7785038138a7a11884212ca1cd0b52cbac094cd9133699eb3165a5dd39f4
+  metadata.gz: 9818ab2f5f3146c6444645cc6a92c331c069d842b00ff309bc8c4e8ff61fd09a396e0b5240ef43d6686fcdc8e42cc4dd23e6c8f1814ccd47efa3c2fb20aa3915
+  data.tar.gz: e85f0fee66e5323f67e1ffb4d8bb9cd42313d3e5e33ab846fc43a9b0b8bbcf79205c8cc6f2738d633ae450a4e11bf750de24a9a78d11cbc27ce0bc331f5640f3

data/lib/state_machines/audit_trail/backend.rb

@@ -9,7 +9,15 @@ class StateMachines::AuditTrail::Backend < Struct.new(:transition_class, :owner_
   #   - transition: state machine transition object that state machine passes to after/before transition callbacks
   #
   def log(object, transition)
-    fields = {event: transition.event ? transition.event.to_s : nil, from: transition.from, to: transition.to}
+
+    if transition.machine.presence
+      # full transition object
+      namespace = transition.machine.namespace
+    else
+      # initial state open struct
+      namespace = transition.namespace
+    end
+    fields = {namespace: namespace, event: transition.event ? transition.event.to_s : nil, from: transition.from, to: transition.to}
     [context].flatten(1).each { |field|
       fields[field] = resolve_context(object, field, transition)
     } unless self.context.nil?

data/lib/state_machines/audit_trail/transition_auditing.rb

@@ -32,7 +32,7 @@ module StateMachines::AuditTrail::TransitionAuditing
         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(to: current_state))
+            state_machine.backend.log(object, OpenStruct.new(namespace: state_machine.namespace, to: current_state))
           end
         end
       end

data/lib/state_machines/audit_trail/version.rb

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

data/lib/state_machines/audit_trail_generator.rb

@@ -12,6 +12,7 @@ class StateMachines::AuditTrailGenerator < ::Rails::Generators::Base
   def create_model
     args = [transition_class_name,
             "#{source_model.demodulize.tableize.singularize}:references",
+            'namespace:string',
             'event:string',
             'from:string',
             'to:string',

data/spec/helpers/active_record.rb

@@ -6,6 +6,11 @@ ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':me
 class ARModelStateTransition < ActiveRecord::Base
   belongs_to :ar_model
 end
+
+class ARModelWithNamespaceFooStateTransition < ActiveRecord::Base
+  belongs_to :ar_model_with_namespace
+end
+
 class ARModelNoInitialStateTransition < ActiveRecord::Base
   belongs_to :ar_model_no_initial
 end
@@ -32,7 +37,7 @@ end
 
 class ARModel < ActiveRecord::Base
 
-  state_machine :state, initial: :waiting do # log initial state?
+  state_machine :state, initial: :waiting do
     audit_trail
 
     event :start do
@@ -47,7 +52,7 @@ end
 
 class ARModelNoInitial < ActiveRecord::Base
 
-  state_machine :state, initial: :waiting do # log initial state?
+  state_machine :state, initial: :waiting do
     audit_trail initial: false
 
     event :start do
@@ -59,9 +64,25 @@ class ARModelNoInitial < ActiveRecord::Base
     end
   end
 end
+
+class ARModelWithNamespace < ActiveRecord::Base
+
+  state_machine :foo_state, initial: :waiting, namespace: :foo do
+    audit_trail
+
+    event :start do
+      transition [:waiting, :stopped] => :started
+    end
+
+    event :stop do
+      transition :started => :stopped
+    end
+  end
+end
+
 #
 class ARModelWithContext < ActiveRecord::Base
-  state_machine :state, initial: :waiting do # log initial state?
+  state_machine :state, initial: :waiting do
     audit_trail context: :context
 
     event :start do
@@ -79,7 +100,7 @@ class ARModelWithContext < ActiveRecord::Base
 end
 
 class ARModelWithMultipleContext < ActiveRecord::Base
-  state_machine :state, initial: :waiting do # log initial state?
+  state_machine :state, initial: :waiting do
     audit_trail context: [:context, :second_context, :context_with_args]
 
     event :start do
@@ -150,14 +171,14 @@ class ARModelWithMultipleStateMachines < ActiveRecord::Base
   end
 end
 
-module SomeNamespace
+module SomeModule
   class ARModelStateTransition < ActiveRecord::Base
-    belongs_to :test_model
+    belongs_to :ar_model
   end
 
   class ARModel < ActiveRecord::Base
 
-    state_machine :state, initial: :waiting do # log initial state?
+    state_machine :state, initial: :waiting do
       audit_trail
 
       event :start do
@@ -174,9 +195,13 @@ end
 #
 # Generate tables
 #
-def create_model_table(owner_class, multiple_state_machines = false)
+def create_model_table(owner_class, multiple_state_machines = false, state_column = nil)
   ActiveRecord::Base.connection.create_table(owner_class.name.tableize) do |t|
-    t.string :state unless multiple_state_machines
+    if state_column.presence
+      t.string state_column
+    else
+      t.string :state unless multiple_state_machines
+    end
     t.string :type
 
     if multiple_state_machines
@@ -189,10 +214,12 @@ def create_model_table(owner_class, multiple_state_machines = false)
   end
 end
 
-create_model_table(ARModel)
-create_model_table(ARModelNoInitial)
-create_model_table(ARModelWithContext)
-create_model_table(ARModelWithMultipleContext)
+
+%w(ARModel ARModelNoInitial ARModelWithContext ARModelWithMultipleContext).each do |name|
+  create_model_table(name.constantize)
+end
+
+create_model_table(ARModelWithNamespace, false, :foo_state)
 create_model_table(ARModelWithMultipleStateMachines, true)
 
 
@@ -202,6 +229,7 @@ def create_transition_table(owner_class, state, add_context = false)
 
     # t.references :"#{owner_class.name.pluralize.demodulize.tableize}"
     t.integer owner_class.name.foreign_key
+    t.string :namespace
     t.string :event
     t.string :from
     t.string :to
@@ -213,8 +241,11 @@ def create_transition_table(owner_class, state, add_context = false)
   end
 end
 
-create_transition_table(ARModel, :state)
-create_transition_table(ARModelNoInitial, :state)
+%w(ARModel ARModelNoInitial).each do |name|
+  create_transition_table(name.constantize, :state)
+end
+
+create_transition_table(ARModelWithNamespace, :foo_state, false)
 create_transition_table(ARModelWithContext, :state, true)
 create_transition_table(ARModelWithMultipleContext, :state, true)
 create_transition_table(ARModelWithMultipleStateMachines, :first)

data/spec/helpers/mongoid.rb

@@ -9,6 +9,7 @@ class MongoidTestModelStateTransition
   include Mongoid::Timestamps
   belongs_to :mongoid_test_model
 
+  field :namespace, type: String
   field :event, type: String
   field :from,  type: String
   field :to,    type: String
@@ -19,6 +20,7 @@ class MongoidTestModelWithMultipleStateMachinesFirstTransition
   include Mongoid::Timestamps
   belongs_to :mongoid_test_model
 
+  field :namespace, type: String
   field :event, type: String
   field :from,  type: String
   field :to,    type: String
@@ -29,6 +31,7 @@ class MongoidTestModelWithMultipleStateMachinesSecondTransition
   include Mongoid::Timestamps
   belongs_to :mongoid_test_model
 
+  field :namespace, type: String
   field :event, type: String
   field :from,  type: String
   field :to,    type: String

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

@@ -9,20 +9,33 @@ require 'helpers/active_record'
 describe StateMachines::AuditTrail::Backend::ActiveRecord do
 
   context ':initial option' do
-    it 'default logs' do
-      target = ARModel.new
-      # initial transition is built but not saved
-      expect(target.new_record?).to be_truthy
-      expect(target.ar_model_state_transitions.count).to eq 0
-      target.save!
+    context 'default' do
+      it 'new object' do
+        target = ARModel.new
+        # initial transition is built but not saved
+        expect(target.new_record?).to be_truthy
+        expect(target.ar_model_state_transitions.count).to eq 0
+        target.save!
+
+        # initial transition is saved and should be present
+        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
+      end
 
-      # initial transition is saved and should be present
-      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
+      it 'create object' do
+        target = ARModel.create!
+        # initial transition is saved and should be present
+        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
+      end
     end
 
     it 'false skips log' do
@@ -38,6 +51,32 @@ describe StateMachines::AuditTrail::Backend::ActiveRecord do
     end
   end
 
+  context 'namespaced state_machine' do
+    it 'should log namespace' do
+      target = ARModelWithNamespace.create!
+
+      # initial transition is saved and should be present
+      expect(target.new_record?).to be_falsey
+      expect(target.ar_model_with_namespace_foo_state_transitions.count).to eq 1
+      state_transition = target.ar_model_with_namespace_foo_state_transitions.first
+      expect(state_transition.namespace).to eq 'foo'
+      expect(state_transition.from).to be_nil
+      expect(state_transition.to).to eq 'waiting'
+      expect(state_transition.event).to be_nil
+    end
+
+    it 'should not log namespace' do
+      target = ARModel.create!
+      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.namespace).to be_nil
+      expect(state_transition.from).to be_nil
+      expect(state_transition.to).to eq 'waiting'
+      expect(state_transition.event).to be_nil
+    end
+  end
+
   context '#create_for' do
     it 'should be Backend::ActiveRecord' do
       backend = StateMachines::AuditTrail::Backend.create_for(ARModelWithContextStateTransition, ARModel)
@@ -49,13 +88,13 @@ describe StateMachines::AuditTrail::Backend::ActiveRecord do
       expect(ARModel.reflect_on_association(:ar_model_state_transitions).collection?).to be_truthy
     end
 
-    it 'should handle namespaced models' do
-      StateMachines::AuditTrail::Backend.create_for(ARModelWithContextStateTransition, SomeNamespace::ARModel)
-      expect(SomeNamespace::ARModel.reflect_on_association(:ar_model_state_transitions).collection?).to be_truthy
+    it 'should handle models within modules' do
+      StateMachines::AuditTrail::Backend.create_for(ARModelWithContextStateTransition, SomeModule::ARModel)
+      expect(SomeModule::ARModel.reflect_on_association(:ar_model_state_transitions).collection?).to be_truthy
     end
 
-    it 'should handle namespaced state transition model' do
-      StateMachines::AuditTrail::Backend.create_for(SomeNamespace::ARModelStateTransition, ARModel)
+    it 'should handle state transition models within modules' do
+      StateMachines::AuditTrail::Backend.create_for(SomeModule::ARModelStateTransition, ARModel)
       expect(ARModel.reflect_on_association(:ar_model_state_transitions).collection?).to be_truthy
     end
   end

data/spec/lib/state_machines/audit_trail_generator_spec.rb

@@ -10,7 +10,7 @@
 # describe StateMachines::AuditTrailGenerator, type: :generator do
 #
 #   destination File.expand_path('../../../../tmp', __FILE__)
-#   arguments %w(SomeNamespace::Subscription state)
+#   arguments %w(SomeModule::Subscription state)
 #
 #   before(:all) do
 #     prepare_destination
@@ -36,7 +36,7 @@
 #                                       end
 #                                       directory 'some_namespace' do
 #                                         file 'subscription_state_transition.rb' do
-#                                           contains 'class SomeNamespace::SubscriptionStateTransition'
+#                                           contains 'class SomeModule::SubscriptionStateTransition'
 #                                         end
 #                                       end
 #                                     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-audit_trail
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Ross