state_machine-audit_trail 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,6 +1,6 @@
 = StateMachine audit trail
 
-The 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?"
+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?"
 
 Note: while the state_machine gem integrates with multiple ORMs, this plugin currently only has an ActiveRecord backend. It should be easy to add support for other ActiveModel-based ORMs though.
 
@@ -16,22 +16,22 @@ Create a model/table that holds the audit trail. The table needs to have a forei
     
 For a model called "Model", and a state attribute "state", this will generate the ModelStateTransition model and an accompanying migration.
 
-Next, tell your state machine you want to keep an audit trail:
+Next, tell your state machine you want to store an audit trail:
 
   class Model < ActiveRecord::Base
     state_machine :state, :initial => :start do
-      log_transitions
+      store_audit_trail
       ...
 
 If your audit trail model does not use the default naming scheme, provide it using the <tt>:to</tt> option:
 
   class Model < ActiveRecord::Base
     state_machine :state, :initial => :start do
-      log_transitions :to => 'ModelAuditTrail'
+      store_audit_trail :to => 'ModelAuditTrail'
       ...
 
 That's it! The plugin will register an <tt>after_transition</tt> callback that is used to log all transitions. It will also log the initial state if there is one.
 
 == About
 
-This plugin is written by Jesse Storimer and Willem van Bergen for Shopify. It is released under the MIT license (see LICENSE)
+This plugin is written by Jesse Storimer and Willem van Bergen for Shopify. It is released under the MIT license (see LICENSE)

data/lib/state_machine/audit_trail.rb

@@ -2,10 +2,10 @@ require 'state_machine'
 
 module StateMachine::AuditTrail
     
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
     
   def self.setup
-    StateMachine::Machine.send(:include, StateMachine::AuditTrail::TransitionLogging)
+    StateMachine::Machine.send(:include, StateMachine::AuditTrail::TransitionAuditing)
   end
   
   def self.create(transition_class)
@@ -14,8 +14,7 @@ module StateMachine::AuditTrail
   end
 end
 
-require 'state_machine/audit_trail/transition_logging'
-require 'state_machine/audit_trail/base'
-require 'state_machine/audit_trail/active_record'
+require 'state_machine/audit_trail/transition_auditing'
+require 'state_machine/audit_trail/backend'
 require 'state_machine/audit_trail/railtie' if defined?(::Rails)
 StateMachine::AuditTrail.setup

data/lib/state_machine/audit_trail/active_record.rb

@@ -1,7 +1,7 @@
-class StateMachine::AuditTrail::ActiveRecord < StateMachine::AuditTrail::Base
+class StateMachine::AuditTrail::ActiveRecord < StateMachine::AuditTrail::Backend
   def log(object, event, from, to, timestamp = Time.now)
     # Let ActiveRecord manage the timestamp for us so it does the 
-    # right thing width regards to timezones.
+    # right thing with regards to timezones.
     transition_class.create(foreign_key_field(object) => object.id, :event => event, :from => from, :to => to)
   end
 

data/lib/state_machine/audit_trail/backend.rb

@@ -0,0 +1,7 @@
+class StateMachine::AuditTrail::Backend < Struct.new(:transition_class)
+  def log(object, event, from, to, timestamp = Time.now)
+    raise NotImplemented, "Implement in a subclass."
+  end
+end
+
+require 'state_machine/audit_trail/active_record'

data/lib/state_machine/audit_trail/{transition_logging.rb → transition_auditing.rb}

@@ -1,7 +1,7 @@
-module StateMachine::AuditTrail::TransitionLogging
+module StateMachine::AuditTrail::TransitionAuditing
   attr_accessor :transition_class_name
 
-  def log_transitions(options = {})
+  def store_audit_trail(options = {})
     state_machine = self
     state_machine.transition_class_name = (options[:to] || default_transition_class_name).to_s
 
@@ -17,7 +17,7 @@ module StateMachine::AuditTrail::TransitionLogging
   end
 
   def audit_trail
-    @transition_logger ||= StateMachine::AuditTrail.create(transition_class)
+    @transition_auditor ||= StateMachine::AuditTrail.create(transition_class)
   end
 
   private

data/spec/spec_helper.rb

@@ -53,7 +53,7 @@ end
 class TestModel < ActiveRecord::Base
 
   state_machine :state, :initial => :waiting do # log initial state?
-    log_transitions 
+    store_audit_trail 
 
     event :start do
       transition [:waiting, :stopped] => :started
@@ -68,7 +68,7 @@ end
 class TestModelWithMultipleStateMachines < ActiveRecord::Base
 
   state_machine :first, :initial => :beginning do
-    log_transitions 
+    store_audit_trail 
 
     event :begin_first do
       transition :beginning => :end
@@ -76,7 +76,7 @@ class TestModelWithMultipleStateMachines < ActiveRecord::Base
   end
   
   state_machine :second do
-    log_transitions 
+    store_audit_trail 
 
     event :begin_second do
       transition nil => :beginning

data/state_machine-audit_trail.gemspec

@@ -1,10 +1,10 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "state_machine-audit_trail"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Willem van Bergen", "Jesse Storimer"]
-  s.email       = ["willem@shopify.com", "jesse.storimer@shopify.com"]
+  s.email       = ["willem@shopify.com", "jesse@shopify.com"]
   s.homepage    = "https://github.com/wvanbergen/state_machine-audit_trail"
   s.summary     = %q{Log transitions on a state machine to support auditing and business process analytics.}
   s.description = %q{Log transitions on a state machine to support auditing and business process analytics.}
@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency('activerecord', '~> 3')
   s.add_development_dependency('sqlite3')
 
-  s.files      = %w(.gitignore Gemfile LICENSE README.rdoc Rakefile lib/state_machine-audit_trail.rb lib/state_machine/audit_trail.rb lib/state_machine/audit_trail/active_record.rb lib/state_machine/audit_trail/base.rb lib/state_machine/audit_trail/railtie.rb lib/state_machine/audit_trail/transition_logging.rb lib/state_machine/audit_trail_generator.rb spec/spec_helper.rb spec/state_machine/audit_trail_spec.rb state_machine-audit_trail.gemspec tasks/github_gem.rb)
+  s.files      = %w(.gitignore Gemfile LICENSE README.rdoc Rakefile lib/state_machine-audit_trail.rb lib/state_machine/audit_trail.rb lib/state_machine/audit_trail/active_record.rb lib/state_machine/audit_trail/backend.rb lib/state_machine/audit_trail/railtie.rb lib/state_machine/audit_trail/transition_auditing.rb lib/state_machine/audit_trail_generator.rb spec/spec_helper.rb spec/state_machine/audit_trail_spec.rb state_machine-audit_trail.gemspec tasks/github_gem.rb)
   s.test_files = %w(spec/state_machine/audit_trail_spec.rb)
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -86,7 +86,7 @@ dependencies:
 description: Log transitions on a state machine to support auditing and business process analytics.
 email: 
 - willem@shopify.com
-- jesse.storimer@shopify.com
+- jesse@shopify.com
 executables: []
 
 extensions: []
@@ -102,9 +102,9 @@ files:
 - lib/state_machine-audit_trail.rb
 - lib/state_machine/audit_trail.rb
 - lib/state_machine/audit_trail/active_record.rb
-- lib/state_machine/audit_trail/base.rb
+- lib/state_machine/audit_trail/backend.rb
 - lib/state_machine/audit_trail/railtie.rb
-- lib/state_machine/audit_trail/transition_logging.rb
+- lib/state_machine/audit_trail/transition_auditing.rb
 - lib/state_machine/audit_trail_generator.rb
 - spec/spec_helper.rb
 - spec/state_machine/audit_trail_spec.rb

data/lib/state_machine/audit_trail/base.rb

@@ -1,5 +0,0 @@
-class StateMachine::AuditTrail::Base < Struct.new(:transition_class)
-  def log(object, event, from, to, timestamp = Time.now)
-    raise NotImplemented, "Implement in a subclass."
-  end
-end