state_machine-audit_trail 0.1.6 → 0.1.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWM5NDNmMjY4ZDAyZjkxNzhjNWVmZGMxM2ZlNDNkN2ViZTJmZjY1Zg==
+    NDliMWUwOGMyMzhhNzgxODQ3YjU0NWNjNDkwNjI5Nzk1NWVkOTc0OA==
   data.tar.gz: !binary |-
-    Y2JlMTdiOWExODEyNTM5ZGY4MzFhMGRjMGY0OTNjZDNhYzQyNjMzZA==
-!binary "U0hBNTEy":
+    YTFiYmZjMjY3YjhhNjJhYzNlMjhlZmQyYWVjZGY0YjZjMGExOTgyZg==
+SHA512:
   metadata.gz: !binary |-
-    M2U0MzBiN2MxNDc3Y2E3YTczZDg0Mjc4NjkxOWQwNDcwZjlmODU1Yjg5ZmVk
-    OTc1YjI0OTc1YzZkMjJhZWZiNzE5Njg2YzdhNjhmM2IzYTIzZjIwMDg3NWYz
-    NzljOTk3NWZkZThlODVlZDQyMWMxZjRjZGNmZjg2Zjg2MWU5NWE=
+    ZjM3MDNlNTFmNWNiNTdmYWU3ZDMwZjc5OTJkZGI4M2Y5MDZmYmNmY2NiMDNj
+    MjQ1YWRhYmViYzk2NzZiNTRkZTQxNzNlNmZiOGI4M2NhMWFjMGFmMmQ2NzRm
+    NTQyMGVjZTBmNDI2MmNhYjhhYTFjMTVmY2UxZjhjZmI3NTNkMDg=
   data.tar.gz: !binary |-
-    NzM5ODc4ZGIwNGY5YmE5NzU0YjZiOTNhZTM2MjA2NzQzZmM1ZWUyNWNmMWJl
-    ODU1OTU1Yzk3ZjIyN2ZjZGYwMDI2YTdkNDU1Y2U1MjJlYWNjMmNkZDMxMWI0
-    MTI3MDdjOTM2YmY1OTNjNzg3MjNkNDViZjBiNTg4NzUyNDhlZjA=
+    MzY2NzM5M2I4ZjBiNTA4NzE5YmFlYWE1MTliOTUyMjc0NTBhNjM4MmI2NDJj
+    YjljN2NhYmEzZjA2NDgzM2NmNWE0MzNiMzgwNjVmMmE2NjJhMDkzNGJhMDcw
+    Y2IxOWJiOTFhMWE2NzFhNWE0MGY4MDU1OTM2Mzg3OTcyMDZkNTI=

data/README.rdoc

@@ -21,6 +21,8 @@ Create a model/table that holds the audit trail. The table needs to have a forei
 
   rails generate state_machine:audit_trail <model> <state_attribute>
 
+  (For Rails 2, use rails generate state_machine_audit_trail <model> <state_attribute>  [note the underscore instead of the colon])
+
 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 store an audit trail:
@@ -41,6 +43,8 @@ That's it! The plugin will register an <tt>after_transition</tt> callback that i
 
 If you would like to store additional messages in the audit trail, you can do so with the following:
     store_audit_trail :context_to_log => :state_message # Will grab the results of the state_message method on the model and store it in a field called state_message on the audit trail model
+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
 
 == About
 

data/generators/state_machine_audit_trail_generator.rb

@@ -0,0 +1,48 @@
+require 'rails_generator'
+
+class StateMachineAuditTrailGenerator < Rails::Generator::NamedBase
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @source_model, @state_attribute, @transition_model = runtime_args
+    @state_attribute ||= 'state'
+    @transition_model ||= ''
+  end
+
+  def manifest
+    record do |m|
+      attributes = [Rails::Generator::GeneratedAttribute.new(@source_model.tableize.singularize, :references),
+                    Rails::Generator::GeneratedAttribute.new(:event, :string),
+                    Rails::Generator::GeneratedAttribute.new(:from, :string),
+                    Rails::Generator::GeneratedAttribute.new(:to, :string),
+                    Rails::Generator::GeneratedAttribute.new(:created_at, :timestamp)]
+
+      #Model file
+      m.directory File.join('app/models', class_path)
+      m.template 'model:model.rb', File.join('app/models', class_path, "#{transition_file_name}.rb"), :assigns => {:class_name => transition_class_name, :attributes => attributes}
+
+      #Migration
+      options[:skip_timestamps] = true
+      migration_file_path = transition_file_name.gsub(/\//, '_')
+      migration_name = transition_class_name
+      if ActiveRecord::Base.pluralize_table_names
+        migration_name = migration_name.pluralize
+        migration_file_path = migration_file_path.pluralize
+      end
+
+      m.migration_template 'model:migration.rb', 'db/migrate', :assigns => {:migration_name => "Create#{migration_name.gsub(/::/, '')}",
+                                                                            :table_name => transition_file_name.pluralize,
+                                                                            :attributes => attributes},
+                                                               :migration_file_name => "create_#{migration_file_path}"
+    end
+  end
+
+  protected
+
+  def transition_class_name
+    @transition_model.blank? ? "#{@source_model.camelize}#{@state_attribute.camelize}Transition" : @transition_model
+  end
+
+  def transition_file_name
+    @transition_model.blank? ? "#{@source_model.downcase}_#{@state_attribute}_transition" : @transition_model.tableize.singularize
+  end
+end

data/lib/state_machine/audit_trail.rb

@@ -10,6 +10,6 @@ end
 require 'state_machine/audit_trail/version'
 require 'state_machine/audit_trail/transition_auditing'
 require 'state_machine/audit_trail/backend'
-require 'state_machine/audit_trail/railtie' if defined?(::Rails)
+require 'state_machine/audit_trail/railtie' if defined?(::Rails) && Rails::VERSION::MAJOR >= 3
 
 StateMachine::AuditTrail.setup

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

@@ -11,8 +11,8 @@ class StateMachine::AuditTrail::Backend::ActiveRecord < StateMachine::AuditTrail
   def log(object, event, from, to, timestamp = Time.now)
     # Let ActiveRecord manage the timestamp for us so it does the 
     # 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?
+    params = {:event => event ? event.to_s : nil, :from => from, :to => to}
+    [context_to_log].flatten(1).each { |context| params[context] = object.send(context) } unless self.context_to_log.nil?
 
     if object.new_record?
       object.send(@association).build(params)

data/lib/state_machine/audit_trail/version.rb

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

data/spec/helpers/active_record.rb

@@ -16,6 +16,12 @@ ActiveRecord::Base.connection.create_table(:active_record_test_model_with_contex
   t.timestamps
 end
 
+ActiveRecord::Base.connection.create_table(:active_record_test_model_with_multiple_contexts) do |t|
+  t.string :state
+  t.string :type
+  t.timestamps
+end
+
 ActiveRecord::Base.connection.create_table(:active_record_test_model_with_multiple_state_machines) do |t|
   t.string :first
   t.string :second
@@ -31,6 +37,10 @@ class ActiveRecordTestModelWithContextStateTransition < ActiveRecord::Base
   belongs_to :test_model
 end
 
+class ActiveRecordTestModelWithMultipleContextStateTransition < ActiveRecord::Base
+  belongs_to :test_model
+end
+
 class ActiveRecordTestModelWithMultipleStateMachinesFirstTransition < ActiveRecord::Base
   belongs_to :test_model
 end
@@ -76,6 +86,28 @@ class ActiveRecordTestModelWithContext < ActiveRecord::Base
   end
 end
 
+class ActiveRecordTestModelWithMultipleContext < ActiveRecord::Base
+  state_machine :state, :initial => :waiting do # log initial state?
+    store_audit_trail :context_to_log => [:context, :second_context]
+
+    event :start do
+      transition [:waiting, :stopped] => :started
+    end
+
+    event :stop do
+      transition :started => :stopped
+    end
+  end
+
+  def context
+    "Some context"
+  end
+
+  def second_context
+    "Extra context"
+  end
+end
+
 class ActiveRecordTestModelDescendant < ActiveRecordTestModel
 end
 
@@ -137,6 +169,12 @@ 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"
@@ -146,12 +184,14 @@ def create_transition_table(owner_class, state, add_context = false)
     t.string :from
     t.string :to
     t.string :context if add_context
+    t.string :second_context if add_context
     t.datetime :created_at
   end
 end
 
 create_transition_table(ActiveRecordTestModel, :state)
 create_transition_table(ActiveRecordTestModelWithContext, :state, true)
+create_transition_table(ActiveRecordTestModelWithMultipleContext, :state, true)
 create_transition_table(ActiveRecordTestModelWithMultipleStateMachines, :first)
 create_transition_table(ActiveRecordTestModelWithMultipleStateMachines, :second)
 create_transition_table(ActiveRecordTestModelWithMultipleStateMachines, :third)

data/spec/state_machine/active_record_spec.rb

@@ -18,6 +18,11 @@ describe StateMachine::AuditTrail::Backend::ActiveRecord do
     SomeNamespace::ActiveRecordTestModel.reflect_on_association(:active_record_test_model_state_transitions).collection?.should be_true
   end
 
+  it "should handle namespaced state transition model" do
+    backend = StateMachine::AuditTrail::Backend.create_for_transition_class(SomeNamespace::ActiveRecordTestModelStateTransition, ActiveRecordTestModel)
+    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!
@@ -67,6 +72,21 @@ describe StateMachine::AuditTrail::Backend::ActiveRecord do
     end
   end
 
+  context 'on an object with a single state machine that wants to log multiple context fields' do
+    before do
+      backend = StateMachine::AuditTrail::Backend.create_for_transition_class(ActiveRecordTestModelWithMultipleContextStateTransition, ActiveRecordTestModelWithMultipleContext, [:context, :second_context])
+    end
+
+    let!(:state_machine) { ActiveRecordTestModelWithMultipleContext.create! }
+
+    it "should log an event with all fields set correctly" do
+      state_machine.start!
+      last_transition = ActiveRecordTestModelWithMultipleContextStateTransition.where(:active_record_test_model_with_multiple_context_id => state_machine.id).last
+      last_transition.context.should == state_machine.context
+      last_transition.second_context.should == state_machine.second_context
+    end
+  end
+
   context 'on an object with multiple state machines' do
     let!(:state_machine) { ActiveRecordTestModelWithMultipleStateMachines.create! }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machine-audit_trail
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machine
@@ -124,6 +124,7 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- generators/state_machine_audit_trail_generator.rb
 - lib/state_machine-audit_trail.rb
 - lib/state_machine/audit_trail.rb
 - lib/state_machine/audit_trail/backend.rb
@@ -160,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: state_machine
-rubygems_version: 2.0.7
+rubygems_version: 2.1.4
 signing_key: 
 specification_version: 4
 summary: Log transitions on a state machine to support auditing and business process