state_machine-audit_trail 0.1.7 → 0.1.8

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDliMWUwOGMyMzhhNzgxODQ3YjU0NWNjNDkwNjI5Nzk1NWVkOTc0OA==
-  data.tar.gz: !binary |-
-    YTFiYmZjMjY3YjhhNjJhYzNlMjhlZmQyYWVjZGY0YjZjMGExOTgyZg==
+SHA1:
+  metadata.gz: 1d5ee2c13387ab1270a616717c204ceddd3e0cff
+  data.tar.gz: 1134c034ff9a27b4f2954cfd27ec5950fc364c7f
 SHA512:
-  metadata.gz: !binary |-
-    ZjM3MDNlNTFmNWNiNTdmYWU3ZDMwZjc5OTJkZGI4M2Y5MDZmYmNmY2NiMDNj
-    MjQ1YWRhYmViYzk2NzZiNTRkZTQxNzNlNmZiOGI4M2NhMWFjMGFmMmQ2NzRm
-    NTQyMGVjZTBmNDI2MmNhYjhhYTFjMTVmY2UxZjhjZmI3NTNkMDg=
-  data.tar.gz: !binary |-
-    MzY2NzM5M2I4ZjBiNTA4NzE5YmFlYWE1MTliOTUyMjc0NTBhNjM4MmI2NDJj
-    YjljN2NhYmEzZjA2NDgzM2NmNWE0MzNiMzgwNjVmMmE2NjJhMDkzNGJhMDcw
-    Y2IxOWJiOTFhMWE2NzFhNWE0MGY4MDU1OTM2Mzg3OTcyMDZkNTI=
+  metadata.gz: 220617450fd6439a7decddafc0dffc4ca2a1fd3ef0a1cb10d1d60400e710bc318c2153e64cd06049b5e38e39ebbfc5955507c61ce96bfb75875e17025b43bd74
+  data.tar.gz: 2e8c5702276277406e7031be5df9e538fd502fec261dd7941ff10145cfdf2179ccb04756a55c645043a27c541ad7e5b11f8f5a2a9dccd962830759b9f42a6cae

data/README.rdoc

@@ -46,6 +46,29 @@ If you would like to store additional messages in the audit trail, you can do so
 or
     store_audit_trail :context_to_log => [:field1, :field2] # Will grab the results of the field1 and field2 methods on the model and store them in fields called field1 and field2 on the audit trail model
 
+=== Store virtual attributes
+
+Sometimes it can be useful to store dynamically computed information.
+
+In these situations it's just a matter of defining a new column on table <tt>DeploymentStateTransitions</tt> and configure <tt>context_to_log</tt>.
+
+i.e.
+
+  class Model < ActiveRecord::Base
+    state_machine :state, :initial => :start do
+      store_audit_trail :context_to_log => :version
+      ...
+
+    def version
+      # Dynamically computed field e.g., based on other models
+      ...
+
+  class AddVersionToDeploymentStateTransitions < ActiveRecord::Migration
+    def change
+      add_column :deployment_state_transitions, :version, :string
+      ...
+
+
 == About
 
 This plugin is written by Jesse Storimer and Willem van Bergen for Shopify. Mongoid support was contributed by Siddharth (https://github.com/svs). It is released under the MIT license (see LICENSE).

data/lib/state_machine/audit_trail/transition_auditing.rb

@@ -12,22 +12,28 @@ module StateMachine::AuditTrail::TransitionAuditing
   def store_audit_trail(options = {})
     state_machine = self
     state_machine.transition_class_name = (options[:to] || default_transition_class_name).to_s
+    state_machine.setup_backend(options[:context_to_log])
+
     state_machine.after_transition do |object, transition|
-      state_machine.audit_trail(options[:context_to_log]).log(object, transition.event, transition.from, transition.to)
+      state_machine.backend.log(object, transition.event, transition.from, transition.to)
     end
 
     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))
+          state_machine.backend.log(object, nil, nil, object.send(state_machine.attribute))
         end
       end
     end
   end
 
+  def setup_backend(context_to_log = nil)
+    @backend = StateMachine::AuditTrail::Backend.create_for_transition_class(transition_class, self.owner_class, context_to_log)
+  end
+
   # Public returns an instance of the class which does the actual audit trail logging
-  def audit_trail(context_to_log = nil)
-    @transition_auditor ||= StateMachine::AuditTrail::Backend.create_for_transition_class(transition_class, self.owner_class, context_to_log)
+  def backend
+    @backend
   end
 
   private

data/lib/state_machine/audit_trail/version.rb

@@ -1,5 +1,5 @@
 module StateMachine
   module AuditTrail
-    VERSION = "0.1.7"
+    VERSION = "0.1.8"
   end
 end

data/spec/helpers/active_record.rb

@@ -153,6 +153,10 @@ class ActiveRecordTestModelWithMultipleStateMachines < ActiveRecord::Base
 end
 
 module SomeNamespace
+  class ActiveRecordTestModelStateTransition < ActiveRecord::Base
+    belongs_to :test_model
+  end
+
   class ActiveRecordTestModel < ActiveRecord::Base
 
     state_machine :state, :initial => :waiting do # log initial state?
@@ -169,13 +173,6 @@ module SomeNamespace
   end
 end
 
-module SomeNamespace
-  class ActiveRecordTestModelStateTransition < ActiveRecord::Base
-    belongs_to :test_model
-  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|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machine-audit_trail
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -71,14 +71,14 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -99,14 +99,14 @@ dependencies:
   name: bson_ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Log transitions on a state machine to support auditing and business process
@@ -151,17 +151,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: state_machine
-rubygems_version: 2.1.4
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Log transitions on a state machine to support auditing and business process