auditor 2.0.3 → 2.1.0

data/README.rdoc

@@ -19,6 +19,13 @@ Generate the migration and create the audits table
   rails generate auditor:migration
   rake db:migrate
 
+= Upgrading
+
+You will need to run the upgrade migration if coming from a version earlier than 2.1.0
+
+  rails generate auditor:upgrade
+  rake db:migrate
+
 = Setup
 
 Auditor needs to know who the current user is, but with no standard for doing so you'll have to do a little work to set things up. You simply need to set your current user model object as the Auditor current user before any CRUD operations are performed. For example, in a Rails application you could add the following to your application_controller.rb
@@ -46,6 +53,8 @@ All audit data is stored in a table named Audits, which is automatically created
 
 * auditable_id - the primary key of the table belonging to the audited model object
 * auditable_type - the class type of the audited model object
+* owner_id - the primary key of the of the model that owns this audit record
+* owner_type - the class type of the owner model object
 * user_id - the primary key of the table belonging to the user being audited
 * user_type - the class type of the model object representing users in your application
 * action - a string indicating the action that was audited (create, update, destroy, or find)
@@ -62,6 +71,9 @@ The audited_changes column automatically serializes the changes of any model att
   # Only audit edits to the title column when destroying/deleting
   audit(:destroy, :only => :title)
 
+  # Associate the audit records with a related model, which becomes the owner
+  audit(:update, :on => :book)
+
 = Make Auditing Important
 
 There's an alternate form of specifying your audit requirements that will cause the create, find, update, or destroy to fail if for some reason the audit record cannot be saved to the database. Instead of calling audit, call audit! instead.

data/auditor.gemspec

@@ -12,12 +12,13 @@ Gem::Specification.new do |s|
   s.description = %q{Auditor allows you to declaratively specify what CRUD operations should be audited and save the audit data to the database.}
   s.license     = "MIT"
 
-  s.files         = `git ls-files`.split("\n")
+  s.files         = `git ls-files`.split("\n").reject { |path| path =~ /^(Gemfile|.gitignore|Rakefile)/ }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency('activerecord', '> 3.0.0')
+
   s.add_development_dependency('rspec', '2.5.0')
   s.add_development_dependency('sqlite3-ruby', '1.3.3')
-  s.add_development_dependency('activerecord', '> 3.0.0')
 end

data/lib/auditor/audit.rb

@@ -3,6 +3,7 @@ require 'auditor/config'
 
 class Audit < ActiveRecord::Base
   belongs_to :auditable, :polymorphic => true
+  belongs_to :owner, :polymorphic => true
   belongs_to :user, :polymorphic => true
 
   before_create :set_version_number

data/lib/auditor/recorder.rb

@@ -26,7 +26,13 @@ module Auditor
       audit.auditable_type = model.class.name
       audit.audited_changes = prepare_changes(model.changes) if changes_available?(action)
       audit.action = action
-      audit.comment = @blk.call(model, user) if @blk
+      audit.comment = @blk.call(model, user, action) if @blk
+
+      without_auditing do
+        owner = @options[:on] ? model.send(@options[:on].to_sym) : model
+        audit.owner_id = owner.id
+        audit.owner_type = owner.class.name
+      end
 
       @options[:fail_on_error] ? audit.save! : audit.save
     end

data/lib/auditor/status.rb

@@ -1,3 +1,5 @@
+require 'auditor/user'
+
 module Auditor
   module Status
 

data/lib/auditor/version.rb

@@ -1,3 +1,3 @@
 module Auditor
-  VERSION = "2.0.3"
+  VERSION = "2.1.0"
 end

data/lib/generators/auditor/migration/templates/migration.rb

@@ -3,6 +3,8 @@ class CreateAuditsTable < ActiveRecord::Migration
     create_table :audits, :force => true do |t|
       t.column :auditable_id, :integer, :null => false
       t.column :auditable_type, :string, :null => false
+      t.column :owner_id, :integer, :null => false
+      t.column :owner_type, :string, :null => false
       t.column :user_id, :integer, :null => false
       t.column :user_type, :string, :null => false
       t.column :action, :string, :null => false

data/lib/generators/auditor/upgrade/templates/upgrade.rb

@@ -0,0 +1,13 @@
+class UpgradeAuditsTable < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :owner_id, :integer
+    add_column :audits, :owner_type, :string
+
+    add_index :audits, [:owner_id, :owner_type], :name => 'owner_index'
+  end
+
+  def self.down
+    remove_column :audits, :owner_type
+    remove_column :audits, :owner_id
+  end
+end

data/lib/generators/auditor/upgrade/upgrade_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Auditor
+  module Generators
+    class UpgradeGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Create upgrade migration for Auditor audits table"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'upgrade.rb', 'db/migrate/upgrade_audits_table.rb'
+      end
+    end
+  end
+end

data/spec/audit_spec.rb

@@ -8,24 +8,24 @@ describe Audit do
   end
 
   it 'should set the version number on save' do
-    audit = Audit.create(:auditable => @auditable, :audited_changes => { :name => [nil, 'new']}, :user => @user, :action => :create)
+    audit = Audit.create(:auditable => @auditable, :owner => @auditable, :audited_changes => { :name => [nil, 'new']}, :user => @user, :action => :create)
     audit.version.should == 1
   end
 
   it 'should provide access to the audited model object' do
-    audit = Audit.create(:auditable => @auditable, :user => @user, :action => :create)
+    audit = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :create)
     audit.auditable.should == @auditable
   end
   it 'should provide access to the user associated with the audit' do
-    audit = Audit.create(:auditable => @auditable, :user => @user, :action => :create)
+    audit = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :create)
     audit.user.should == @user
   end
 
   it 'should create a snapshot of the audited objects attributes at the time of the audit' do
-    audit1 = Audit.create(:auditable => @auditable, :user => @user, :action => :create)
-    audit2 = Audit.create(:auditable => @auditable, :user => @user, :action => :update, :audited_changes => {'name' => [nil, 'n1'], 'value' => [nil, 'v1']})
-    audit3 = Audit.create(:auditable => @auditable, :user => @user, :action => :find)
-    audit4 = Audit.create(:auditable => @auditable, :user => @user, :action => :update, :audited_changes => {'value' => [nil, 'v2']})
+    audit1 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :create)
+    audit2 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :update, :audited_changes => {'name' => [nil, 'n1'], 'value' => [nil, 'v1']})
+    audit3 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :find)
+    audit4 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :update, :audited_changes => {'value' => [nil, 'v2']})
 
     audit1.attribute_snapshot.should == {}
     audit2.attribute_snapshot.should == {'name' => 'n1', 'value' => 'v1'}
@@ -35,10 +35,10 @@ describe Audit do
 
   describe 'modifying scope' do
     it 'should return all audit records that were a result of modifying the audited object attributes' do
-      audit1 = Audit.create(:auditable => @auditable, :user => @user, :action => :create, :audited_changes  => {'name' => [nil, 'n0']})
-      audit2 = Audit.create(:auditable => @auditable, :user => @user, :action => :update, :audited_changes => {'name' => ['n0', 'n1'], 'value' => [nil, 'v1']})
-      audit3 = Audit.create(:auditable => @auditable, :user => @user, :action => :find)
-      audit4 = Audit.create(:auditable => @auditable, :user => @user, :action => :update, :audited_changes => {'value' => [nil, 'v2']})
+      audit1 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :create, :audited_changes  => {'name' => [nil, 'n0']})
+      audit2 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :update, :audited_changes => {'name' => ['n0', 'n1'], 'value' => [nil, 'v1']})
+      audit3 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :find)
+      audit4 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :update, :audited_changes => {'value' => [nil, 'v2']})
 
       Audit.modifying.should include(audit1, audit2, audit4)
       Audit.modifying.should_not include(audit3)
@@ -48,10 +48,10 @@ describe Audit do
   describe 'predecessors scope' do
     it 'should return all previous audit records for the same auditable' do
       auditable2 = Model.create
-      audit1 = Audit.create(:auditable => @auditable, :user => @user, :action => :create)
-      audit2 = Audit.create(:auditable => @auditable, :user => @user, :action => :update, :audited_changes => {'name' => [nil, 'n1'], 'value' => [nil, 'v1']})
-      audit3 = Audit.create(:auditable => auditable2, :user => @user, :action => :find)
-      audit4 = Audit.create(:auditable => @auditable, :user => @user, :action => :update, :audited_changes => {'value' => [nil, 'v2']})
+      audit1 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :create)
+      audit2 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :update, :audited_changes => {'name' => [nil, 'n1'], 'value' => [nil, 'v1']})
+      audit3 = Audit.create(:auditable => auditable2, :owner => auditable2, :user => @user, :action => :find)
+      audit4 = Audit.create(:auditable => @auditable, :owner => @auditable, :user => @user, :action => :update, :audited_changes => {'value' => [nil, 'v2']})
 
       Audit.trail(audit4).should include(audit1, audit2, audit4)
       Audit.trail(audit4).should_not include(audit3)
@@ -59,5 +59,3 @@ describe Audit do
   end
 end
 
-class Model < ActiveRecord::Base; end
-class User < ActiveRecord::Base; end

data/spec/auditable_spec.rb

@@ -7,9 +7,14 @@ describe Auditor::Auditable do
 
   before(:each) do
     @user = User.create
+    @original_model = Model
     Auditor::User.current_user = @user
   end
 
+  after(:each) do
+    reset_model
+  end
+
   it 'should audit find' do
     redefine_model { audit!(:find) }
     m = without_auditing { Model.create }
@@ -105,7 +110,9 @@ describe Auditor::Auditable do
     Object.send :const_set, 'Model', clazz
   end
 
-  class ::User < ActiveRecord::Base; end
-  class ::Model < ActiveRecord::Base; end
+  def reset_model
+    Object.send :remove_const, 'Model'
+    Object.send :const_set, 'Model', @original_model
+  end
 
 end

data/spec/recorder_spec.rb

@@ -35,6 +35,8 @@ describe Auditor::Recorder do
     audit.action.should == action.to_s
     audit.auditable_id.should == model.id
     audit.auditable_type.should == model.class.to_s
+    audit.owner_id.should == model.id
+    audit.owner_type.should == model.class.to_s
     audit.user_id.should == @user.id
     audit.user_type.should == @user.class.to_s
     audit.comment.should == 'comment'
@@ -42,6 +44,7 @@ describe Auditor::Recorder do
 
     audit.user.should == @user
     audit.auditable.should == model
+    audit.owner.should == model
   end
 
   it 'should set comment details to nil if they are not given' do
@@ -81,6 +84,32 @@ describe Auditor::Recorder do
     audit.audited_changes.should == {'name' => [nil, 'changed'] }
   end
 
-  class Model < ActiveRecord::Base; end
-  class User < ActiveRecord::Base; end
+  it 'should associate audit records with an owner' do
+    model = Model.create
+    config = Auditor::Config.new(:create)
+    recorder = Auditor::Recorder.new(config.options)
+    recorder.after_create(model)
+    audit = Audit.last
+    audit.owner.should == model
+
+    owner = User.create
+    model.user = owner
+    config = Auditor::Config.new(:create, :on => :user)
+    recorder = Auditor::Recorder.new(config.options)
+    recorder.after_create(model)
+    audit = Audit.last
+    audit.owner.should == owner
+  end
+
+  it 'should pass the model, user, and action to any supplied block' do
+    model = Model.create
+    config = Auditor::Config.new(:create)
+    recorder = Auditor::Recorder.new(config.options) do |model, user, action|
+      model.should == model
+      user.should == @user
+      action.should == :create
+    end
+    recorder.after_create(model)
+  end
+
 end

data/spec/support/db_setup.rb

@@ -1,6 +1,7 @@
 require 'active_support/core_ext'
 require 'active_record'
 require 'generators/auditor/migration/templates/migration'
+require 'fileutils'
 
 tmpdir = File.join(File.dirname(__FILE__), '..', '..', 'tmp')
 FileUtils.mkdir(tmpdir) unless File.exist?(tmpdir)
@@ -36,6 +37,7 @@ class CreateModel < ActiveRecord::Migration
     create_table :models, :force => true do |t|
       t.column :name, :string
       t.column :value, :string
+      t.column :user_id, :integer
     end
   end
 

data/spec/support/model_setup.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base; end
+class Model < ActiveRecord::Base
+  belongs_to :user
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: auditor
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 11
   prerelease: 
   segments: 
   - 2
+  - 1
   - 0
-  - 3
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors: 
 - Jeff Kunkle
@@ -15,55 +15,55 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-23 00:00:00 -04:00
+date: 2011-06-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activerecord
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">"
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 7
         segments: 
-        - 2
-        - 5
+        - 3
         - 0
-        version: 2.5.0
-  type: :development
+        - 0
+        version: 3.0.0
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
+  name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 29
+        hash: 27
         segments: 
-        - 1
-        - 3
-        - 3
-        version: 1.3.3
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: sqlite3-ruby
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">"
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 29
         segments: 
+        - 1
         - 3
-        - 0
-        - 0
-        version: 3.0.0
+        - 3
+        version: 1.3.3
   type: :development
   version_requirements: *id003
 description: Auditor allows you to declaratively specify what CRUD operations should be audited and save the audit data to the database.
@@ -75,11 +75,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .gitignore
-- Gemfile
 - LICENSE
 - README.rdoc
-- Rakefile
 - auditor.gemspec
 - init.rb
 - lib/auditor.rb
@@ -94,6 +91,8 @@ files:
 - lib/generators/auditor.rb
 - lib/generators/auditor/migration/migration_generator.rb
 - lib/generators/auditor/migration/templates/migration.rb
+- lib/generators/auditor/upgrade/templates/upgrade.rb
+- lib/generators/auditor/upgrade/upgrade_generator.rb
 - spec/audit_spec.rb
 - spec/auditable_spec.rb
 - spec/config_spec.rb
@@ -101,6 +100,7 @@ files:
 - spec/spec_helper.rb
 - spec/status_spec.rb
 - spec/support/db_setup.rb
+- spec/support/model_setup.rb
 - spec/support/transactional_specs.rb
 - spec/user_spec.rb
 has_rdoc: true
@@ -145,5 +145,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/status_spec.rb
 - spec/support/db_setup.rb
+- spec/support/model_setup.rb
 - spec/support/transactional_specs.rb
 - spec/user_spec.rb

data/.gitignore

@@ -1,8 +0,0 @@
-coverage
-rdoc
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-tmp/*
-.DS_Store

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in auditor.gemspec
-gemspec

data/Rakefile

@@ -1,33 +0,0 @@
-$:.unshift File.expand_path("../lib", __FILE__)
-
-require 'rake'
-require 'rake/rdoctask'
-require 'rspec/core/rake_task'
-require 'bundler'
-
-Bundler::GemHelper.install_tasks
-
-desc 'Default: run specs'
-task :default => :spec
-
-desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = %w(-fs --color)
-end
-
-desc "Run specs with RCov"
-RSpec::Core::RakeTask.new(:rcov) do |t|
-  t.rspec_opts = %w(-fs --color)
-  t.rcov = true
-  t.rcov_opts = %w(--exclude "spec/*,gems/*")
-end
-
-desc 'Generate documentation for the gem.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Auditor'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-