auditing 0.0.2 → 1.0.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Brad
+Copyright (c) 2010 Brad Cantin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,10 +1,10 @@
-= auditing (currently in development, no gem has been created yet)
+= auditing (currently in development)
 
 Auditing is a simple way to track and rollback changes to a record.
 
 == Installation
 
-  gem install auditing # NOTE: gem has not been created yet.
+  gem install auditing
   
 You will have to supply a model named Audit in your rails application with the following migration
 
@@ -37,18 +37,41 @@ TODO: more to follow about tracking the user
 To add auditing to all attributes on a model, simply add auditing to the model.
 
   class School < ActiveRecord::Base
-    auditing
+    audit_enabled
   end
 
 If you want more control over which attributes are audited, you can define them
 by supplying a fields hash
 
   class School < ActiveRecord::Base
-    auditing :fields => [:name, :established_on]
+    audit_enabled :fields => [:name, :established_on]
   end
   
 Auditing will not track "id", "created_at", or "updated_at" by default
 
+== belongs_to relationships
+
+Auditing a belongs_to relationship works by keeping track of the foreign_id attribute. You do
+not need to add anything to the foreign model.
+
+== has_many relationships
+
+You may have the need to keep track of a has_many relationship.  To accomplish this, we have
+to enable a similar type of auditing on the other model(s)
+
+  class Company < ActiveRecord::Base
+    has_many :phone_numbers
+    audit_enabled
+  end
+  class PhoneNumber < ActiveRecord::Base
+    belongs_to :company
+    audit_relationship_enabled
+  end
+
+As above, you can supply a :fields hash of which attributes will be logged.
+If your relationship is polymorphic, you can supply an array of classes
+that you :only want to log.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.description = %Q{acts_as_versioned is good. This allows an attribute level rollback instead}
     gem.email = "brad.cantin@gmail.com"
     gem.homepage = "http://github.com/bcantin/auditing"
-    gem.authors = ["Brad"]
+    gem.authors = ["Brad Cantin"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.0.2
+1.0.0

data/auditing.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{auditing}
-  s.version = "0.0.2"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Brad"]
-  s.date = %q{2010-08-29}
+  s.authors = ["Brad Cantin"]
+  s.date = %q{2010-10-09}
   s.description = %q{acts_as_versioned is good. This allows an attribute level rollback instead}
   s.email = %q{brad.cantin@gmail.com}
   s.extra_rdoc_files = [
@@ -29,10 +29,12 @@ Gem::Specification.new do |s|
      "VERSION",
      "auditing.gemspec",
      "lib/auditing.rb",
-     "lib/auditing/auditing.rb",
+     "lib/auditing/audit_relationship.rb",
      "lib/auditing/auditor.rb",
-     "spec/auditing/auditing_spec.rb",
+     "lib/auditing/base.rb",
+     "spec/auditing/audit_relationship_spec.rb",
      "spec/auditing/auditor_spec.rb",
+     "spec/auditing/base_spec.rb",
      "spec/schema.rb",
      "spec/spec_helper.rb"
   ]
@@ -42,8 +44,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A gem to keep track of audit hisory of a record}
   s.test_files = [
-    "spec/auditing/auditing_spec.rb",
+    "spec/auditing/audit_relationship_spec.rb",
      "spec/auditing/auditor_spec.rb",
+     "spec/auditing/base_spec.rb",
      "spec/schema.rb",
      "spec/spec_helper.rb"
   ]

data/lib/auditing/audit_relationship.rb

@@ -0,0 +1,127 @@
+module Auditing
+  module AuditRelationship
+
+    # AuditRelationship creates audits for a has_many relationship.
+    #
+    # @examples
+    #   class Company < ActiveRecord::Base
+    #     has_many :phone_numbers
+    #     audit_enabled
+    #   end
+    #   class PhoneNumber < ActiveRecord::Base
+    #     belongs_to :company
+    #     audit_relationship_enabled
+    #   end
+    #
+    #   valid options include:
+    #   :only => [(array of models)]
+    #     an array of models to only send an audit to
+    #   :except => [(array of models)]
+    #     an array of models to not send an audit to
+    #   :fields => [(array of field names)]
+    #     an array of field names.  Each field name will be one audit item
+    def audit_relationship_enabled(opts={})
+      include InstanceMethods
+
+      class_inheritable_accessor :audit_enabled_models
+      class_inheritable_accessor :field_names
+
+      self.audit_enabled_models = gather_models(opts)
+      self.field_names          = gather_fields_for_auditing(opts[:fields])
+
+      after_create   :audit_relationship_create
+      before_update  :audit_relationship_update
+      before_destroy :audit_relationship_destroy
+    end
+  
+    def gather_fields_for_auditing(fields=nil)
+      poly_array = []
+      reflect_on_all_associations(:belongs_to).each do |assoc|
+        poly_array << assoc.name if assoc.options[:polymorphic]
+      end
+
+      unless fields
+        if poly_array.nil?
+          return default_columns
+        else
+          tmp_names = default_columns
+          poly_array.each do |poly|
+            tmp_names = tmp_names.reject {|column| column.match(/#{poly.to_s}*/)}
+          end
+        end
+        return tmp_names
+      else
+        fields.is_a?(Array) ? fields.map {|f| f.to_s} : [fields.to_s]
+      end
+    end
+
+    def default_columns
+      self.column_names - ["id", "created_at", "updated_at"]
+    end
+
+    def gather_models(opts={})
+      if opts[:only]
+        if opts[:only].is_a?(Array)
+          opts[:only].map {|c| c.to_s.underscore.to_sym}
+        else
+          [opts[:only].to_s.underscore.to_sym]
+        end
+      else
+        array,tmp = [], []
+        reflect_on_all_associations(:belongs_to).each do |assoc|
+          array << assoc.name
+        end
+
+        if opts[:except]
+          if opts[:except].is_a?(Array)
+            tmp = opts[:except].map {|c| c.to_s.underscore.to_sym}
+          else
+            tmp = [opts[:except].to_s.underscore.to_sym]
+          end
+        end
+        array - tmp
+      end
+    end
+
+    module InstanceMethods
+      
+      def audit_relationship_create
+        audit_enabled_models.each do |model|
+          return unless send(model).respond_to?('log_association_create')
+          field_names.each do |field|
+            field_value    = send(field)
+            next unless field_value
+            model_instance = send(model)
+            model_instance.log_association_create(self, {:field => field,
+                                                         :value => field_value})
+          end
+        end
+      end
+      
+      def audit_relationship_update
+        if changed?
+          audit_enabled_models.each do |model|
+            return unless send(model).respond_to?('log_association_update')
+            changes.each.select {|k,v| field_names.include?(k)}.each do |field, change|
+              field_value    = send(field)
+              model_instance = send(model)
+              model_instance.log_association_update(self, {:field     => field,
+                                                           :old_value => change[0], 
+                                                           :new_value => change[1]})
+            end
+          end
+        end
+      end
+      
+      def audit_relationship_destroy
+        audit_enabled_models.each do |model|
+          return unless send(model).respond_to?('log_association_destroy')
+          model_instance = send(model)
+          model_instance.log_association_destroy(self)
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/auditing/auditor.rb

@@ -2,21 +2,28 @@ module Auditing
   module Auditor
     
     def reversable?
-      %w[updated].include?(action)
+      undoable?
     end
     
     def show_action
       action
     end
     
+    def old_value
+      Marshal.load(read_attribute(:old_value))
+    end
+    
+    def new_value
+      Marshal.load(read_attribute(:new_value))
+    end
+    
     def rollback
       return unless reversable?
       
       if association.blank?
         auditable.update_attribute(field_name.to_sym, old_value)
       else
-        # TODO
-        # association.class.find(association_id).update_attribute(field_name.to_sym, old_value)
+        association.class.find(association_id).update_attribute(field_name.to_sym, old_value)
       end
 
     end

data/lib/auditing/base.rb

@@ -0,0 +1,74 @@
+module Auditing
+  module Base
+
+    # Auditing creates audit objects for a record.
+    #
+    # @examples
+    #   class School < ActiveRecord::Base
+    #      audit_enabled
+    #   end
+    #   class School < ActiveRecord::Base
+    #     audit_enabled :fields => [:name, :established_on]
+    #   end
+    def audit_enabled(opts={})
+      include InstanceMethods
+      class_inheritable_accessor :auditing_fields
+
+      has_many :audits, :as => :auditable, :order => 'created_at DESC, id DESC'
+
+      self.auditing_fields = gather_fields_for_auditing(opts[:fields])
+
+      after_create :log_creation
+      after_update :log_update
+    end
+
+    def gather_fields_for_auditing(fields=nil)
+      return self.column_names - ["id", "created_at", "updated_at"] unless fields
+      fields.is_a?(Array) ? fields.map {|f| f.to_s} : [fields.to_s]
+    end
+
+    module InstanceMethods
+      def log_creation
+        add_audit(:action => 'created', :undoable => false)
+      end
+
+      def log_update
+        if changed?
+          changes.each.select {|k,v| auditing_fields.include?(k)}.each do |field, change|
+            next if change[0].to_s == change[1].to_s
+            add_audit(:action     => 'updated',
+                      :field_name => field,
+                      :old_value  => Marshal.dump(change[0]),
+                      :new_value  => Marshal.dump(change[1]) )
+          end
+        end
+      end
+
+      def log_association_create(child_object, hash)
+        add_audit(:action      => 'added',
+                  :association => child_object,
+                  :field_name  => hash[:field],
+                  :new_value   => Marshal.dump(hash[:value]) )
+      end
+
+      def log_association_update(child_object, hash)
+        add_audit(:action      => 'updated',
+                  :association => child_object,
+                  :field_name  => hash[:field],
+                  :old_value   => Marshal.dump(hash[:old_value]),
+                  :new_value   => Marshal.dump(hash[:new_value]) ) 
+      end
+
+      def log_association_destroy(item)
+        add_audit(:action => 'removed', :association => item, :undoable => false)
+        # TODO: update all of this items previous audits to be undoable
+      end
+
+      private
+        def add_audit(hash={})
+          Audit.create!({:auditable => self}.merge(hash))
+        end
+    end # Auditing::InstanceMethods
+
+  end
+end

data/lib/auditing.rb

@@ -1,5 +1,7 @@
-require 'auditing/auditing'
+require 'auditing/base'
 require 'auditing/auditor'
+require 'auditing/audit_relationship'
 
-ActiveRecord::Base.send(:extend, Auditing)
+ActiveRecord::Base.send(:extend, Auditing::Base)
 ActiveRecord::Base.send(:extend, Auditing::Auditor)
+ActiveRecord::Base.send(:extend, Auditing::AuditRelationship)

data/spec/auditing/audit_relationship_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe "AuditingRelationship" do
+  
+  describe "adding audit_relationship_enabled on a model" do
+    before do
+      class Company < ActiveRecord::Base
+        has_many :phone_numbers, :as => :phoneable
+        audit_enabled
+      end
+      class PhoneNumber < ActiveRecord::Base
+        belongs_to :phoneable, :polymorphic => true
+        audit_relationship_enabled
+      end
+    end
+    
+    it "should respond to audit_relationship_enabled when we add audit_relationship_enabled" do
+      PhoneNumber.should respond_to(:audit_relationship_enabled)
+    end
+    
+    it "should build an array of audit_enabled_models" do
+      PhoneNumber.audit_enabled_models.should == [:phoneable]
+    end
+    
+    it "should build an array of field_names" do
+      PhoneNumber.field_names.should =~ ['number', 'extension']
+    end
+  
+    describe "creating a new belongs_to object" do
+      before do
+        @company = Company.create(:name => 'Apple')
+      end
+    
+      it "should add an audit to the parent instance object (company) when we create a phone number" do
+        lambda {
+          @company.phone_numbers << PhoneNumber.new(:number => '1-800-orange')
+          }.should change{@company.audits.count}
+      end
+    
+      it "should add an audit for each field" do
+        lambda {
+          @company.phone_numbers << PhoneNumber.new(:number => '1-800-orange', :extension => '1')
+          }.should change{@company.audits.count}.by(2)
+      end
+  
+      describe "updating an existing belongs_to object" do
+        before do
+          @ph = PhoneNumber.new(:number => '1-800-orange', :extension => '1')
+          @company.phone_numbers << @ph
+        end
+    
+        it "should add an audit to the parent instance when we update a phone number" do
+          lambda {@ph.update_attributes(:number => '1-800-apple')}.should change{@company.audits.count}
+        end
+        
+        describe "deleting a child_object" do
+          it "should add an audit to the parent instance when we delete a phone number" do
+            lambda {PhoneNumber.destroy(@ph)}.should change{@company.audits.count}
+          end
+        end
+      end
+    end
+  end
+end

data/spec/auditing/auditor_spec.rb

@@ -1,22 +1,21 @@
 require 'spec_helper'
-# require 'timecop'
 
 describe "Auditor" do
-  it 'adds the Auditable::Auditor module to the Audit class' do
+  it 'adds the Auditing::Auditor module to the Audit class' do
     Audit.new.should respond_to(:show_action)
   end
   
   describe "#rollback" do
     before do
       class School < ActiveRecord::Base
-        auditing
+        audit_enabled
       end
       @school = School.create(:name => 'PS118')
       @school.update_attributes(:name => 'PS99')
       @audit = @school.audits.first
     end
     
-    it "the first audit should be the audit we want to rollback" do
+    it "the latest audit should be the audit we want to rollback" do
       @audit.action.should      == 'updated'
       @audit.new_value.should   == 'PS99'
       @audit.old_value.should   == 'PS118'
@@ -33,11 +32,96 @@ describe "Auditor" do
       lambda { @audit.rollback }.should change { Audit.count }.by(1)
     end
     
-    it "the first audit after a rollback should contain the changed values" do
+    it "the latest audit after a rollback should contain the changed values" do
       @audit.rollback
       @school.reload
       @school.audits.first.old_value.should == 'PS99'
       @school.audits.first.new_value.should == 'PS118'
     end
   end
+  
+  describe "#rollback belongs_to attribute" do
+    before do
+      class Car < ActiveRecord::Base
+        audit_enabled
+        belongs_to :auto_maker
+      end
+      class AutoMaker < ActiveRecord::Base
+        has_many :cars
+      end
+      @automaker     = AutoMaker.create(:name => 'maker of fast cars')
+      @new_automaker = AutoMaker.create(:name => 'maker of safe cars')
+      
+      @car = Car.create(:name => 'fast car', :auto_maker => @automaker)
+      @car.update_attributes(:auto_maker => @new_automaker)
+      @audit = @car.audits.first
+    end
+    
+    it "the latest audit should be the audit we want to rollback" do
+      @audit.action.should      == 'updated'
+      @audit.new_value.should   == @new_automaker.id
+      @audit.old_value.should   == @automaker.id
+      @audit.association.should == nil
+      @car.auto_maker.should    == @new_automaker
+    end
+    
+    it "performs the rollback" do
+      @audit.rollback
+      @car.reload
+      @car.auto_maker.should == @automaker
+    end
+    
+    it "creates an audit when a rollback is performed" do
+      lambda { @audit.rollback }.should change { Audit.count }.by(1)
+    end
+    
+    it "the latest audit after a rollback should contain the changed values" do
+      @audit.rollback
+      @car.reload
+      @car.audits.first.old_value.should == @new_automaker.id
+      @car.audits.first.new_value.should == @automaker.id
+    end
+  end
+  
+  describe "rollback has_many attributes" do
+    before do
+      class Company < ActiveRecord::Base
+        has_many :phone_numbers, :as => :phoneable
+        audit_enabled
+      end
+      class PhoneNumber < ActiveRecord::Base
+        belongs_to :phoneable, :polymorphic => true
+        audit_relationship_enabled
+      end
+      @company = Company.create(:name => 'Apple')
+      @ph      = PhoneNumber.new(:number => '1-800-orange')
+      @company.phone_numbers << @ph
+      @ph.update_attributes(:number => '1-800-call-apple')
+      @audit = @company.audits.first
+    end
+    
+    it "the latest audit should be the audit we want to rollback" do
+      @audit.action.should      == 'updated'
+      @audit.new_value.should   == '1-800-call-apple'
+      @audit.old_value.should   == '1-800-orange'
+      @audit.association.should == @ph
+    end
+    
+    it "performs the rollback" do
+      @audit.rollback
+      @company.reload
+      @company.phone_numbers.first.number.should == '1-800-orange'
+    end
+    
+    it "creates an audit when a rollback is performed" do
+      lambda { @audit.rollback }.should change { Audit.count }.by(1)
+    end
+    
+    it "the latest audit after a rollback should contain the changed values" do
+      @audit.rollback
+      @company.reload
+      @company.audits.first.old_value.should == '1-800-call-apple'
+      @company.audits.first.new_value.should == '1-800-orange'
+    end
+  end
 end

data/spec/auditing/{auditing_spec.rb → base_spec.rb}

@@ -5,12 +5,12 @@ describe "Auditing" do
   describe "auditing default values" do
     before do
       class School < ActiveRecord::Base
-        auditing
+        audit_enabled
       end
     end
     
-    it "responds to auditing when auditing is added to an AR object" do
-      School.should respond_to(:auditing)
+    it "responds to audit_enabled when auditing is added to an AR object" do
+      School.should respond_to(:audit_enabled)
     end
     
     it "responds to @auditing_fields" do
@@ -23,31 +23,31 @@ describe "Auditing" do
     end
   end # auditing default values
 
-  describe "auditing :fields => [:foo,:bar]" do
+  describe "audit_enabled :fields => [:foo,:bar]" do
     it "accepts a single valude as a symbol" do
       class School < ActiveRecord::Base
-        auditing :fields => :name
+        audit_enabled :fields => :name
       end
       School.auditing_fields.should == ['name']
     end
     
     it "accepts a single value as a string" do
       class School < ActiveRecord::Base
-        auditing :fields => 'name'
+        audit_enabled :fields => 'name'
       end
       School.auditing_fields.should == ['name']
     end
     
     it "accepts an array of symbols" do
       class School < ActiveRecord::Base
-        auditing :fields => [:name, :established_on]
+        audit_enabled :fields => [:name, :established_on]
       end
       School.auditing_fields.should == ['name', 'established_on']
     end
     
     it "accepts an array of strings" do
       class School < ActiveRecord::Base
-        auditing :fields => ['name', 'established_on']
+        audit_enabled :fields => ['name', 'established_on']
       end
       School.auditing_fields.should == ['name', 'established_on']
     end
@@ -56,7 +56,7 @@ describe "Auditing" do
   describe "creating a new instance" do
     before do
       class School < ActiveRecord::Base
-        auditing
+        audit_enabled
       end
     end
 
@@ -83,7 +83,7 @@ describe "Auditing" do
   describe "updating an existing record" do
     before do
       class School < ActiveRecord::Base
-        auditing :fields => 'name'
+        audit_enabled :fields => 'name'
       end
       @school = School.create(:name => 'PS118')
     end
@@ -128,4 +128,74 @@ describe "Auditing" do
     end
   end # updating an existing record
   
+  describe "belongs_to relationships" do
+    before do
+      class Car < ActiveRecord::Base
+        audit_enabled
+        belongs_to :auto_maker
+      end
+      class AutoMaker < ActiveRecord::Base
+        has_many :cars
+      end
+      
+      @car       = Car.create(:name => 'fast car')
+      @automaker = AutoMaker.create(:name => 'maker of fast cars')
+    end
+    
+    it "creates an audit when we add a belongs_to relationship" do
+      lambda { @car.update_attributes(:auto_maker => @automaker) }.should change { Audit.count }.by(1)
+    end
+    
+    describe "our latest audit" do
+      before do
+        @car.update_attributes(:auto_maker => @automaker)
+      end
+      
+      it "the action should be 'updated" do
+        @car.audits.first.action.should == 'updated'
+      end
+      
+      it "new_value should be an id" do
+        @car.audits.first.new_value.should == @automaker.id
+      end
+
+      it "should be reversable" do
+        @car.audits.first.reversable?.should == true
+      end
+    end
+    
+    describe "updating a belongs_to" do
+      before do
+        @new_automaker = AutoMaker.create(:name => 'maker of safe car')
+        @car.update_attributes(:auto_maker => @automaker)
+      end
+      
+      it "creates an audit when we change a belongs_to relationship" do
+        lambda { @car.update_attributes(:auto_maker => @new_automaker) }.should change { Audit.count }.by(1)
+      end
+      
+      describe "our latest audit" do
+        before do
+          @car.update_attributes(:auto_maker => @new_automaker)
+        end
+
+        it "the action should be 'updated" do
+          @car.audits.first.action.should == 'updated'
+        end
+
+        it "new_value should be an id" do
+          @car.audits.first.new_value.should == @new_automaker.id
+        end
+        
+        it "old_value should be an id" do
+          @car.audits.first.old_value.should == @automaker.id
+        end
+        
+        it "should be reversable" do
+          @car.audits.first.reversable?.should == true
+        end
+      end
+    end
+  end # belongs_to relationships
+  
 end

data/spec/schema.rb

@@ -1,6 +1,6 @@
 ActiveRecord::Schema.define(:version => 0) do
   
-  create_table :audits, :force => true do |t|
+  create_table :audits do |t|
     t.string  :action
     t.string  :auditable_type
     t.integer :auditable_id
@@ -14,11 +14,41 @@ ActiveRecord::Schema.define(:version => 0) do
     t.timestamps
   end  
   
-  
-  create_table :schools, :force => true do |t|
+  create_table :schools do |t|
     t.string   :name
     t.datetime :established_on
     t.timestamps
   end
   
+  create_table :cars do |t|
+    t.string  :name
+    t.integer :auto_maker_id
+    t.timestamps
+  end
+  
+  create_table :auto_makers do |t|
+    t.string :name
+    t.timestamps
+  end
+  
+  create_table :companies do |t|
+    t.string :name
+    t.timestamps
+  end
+  
+  create_table :people do |t|
+    t.string :first_name
+    t.string :last_name
+    t.timestamps
+  end
+  
+  create_table :phone_numbers do |t|
+    t.string  :number
+    t.string  :extension
+    t.string  :phoneable_type
+    t.integer :phoneable_id
+    t.timestamps
+  end
+ 
+
 end

metadata

@@ -3,18 +3,18 @@ name: auditing
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors: 
-- Brad
+- Brad Cantin
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-08-29 00:00:00 -04:00
+date: 2010-10-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,10 +54,12 @@ files:
 - VERSION
 - auditing.gemspec
 - lib/auditing.rb
-- lib/auditing/auditing.rb
+- lib/auditing/audit_relationship.rb
 - lib/auditing/auditor.rb
-- spec/auditing/auditing_spec.rb
+- lib/auditing/base.rb
+- spec/auditing/audit_relationship_spec.rb
 - spec/auditing/auditor_spec.rb
+- spec/auditing/base_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -93,7 +95,8 @@ signing_key:
 specification_version: 3
 summary: A gem to keep track of audit hisory of a record
 test_files: 
-- spec/auditing/auditing_spec.rb
+- spec/auditing/audit_relationship_spec.rb
 - spec/auditing/auditor_spec.rb
+- spec/auditing/base_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb

data/lib/auditing/auditing.rb

@@ -1,51 +0,0 @@
-module Auditing
-
-  # Auditing creates audit objects for a record.
-  #
-  # @examples
-  #   class School < ActiveRecord::Base
-  #      auditing
-  #   end
-  #   class School < ActiveRecord::Base
-  #     auditing :fields => [:name, :established_on]
-  #   end
-  def auditing(opts={})
-    include InstanceMethods
-    class_inheritable_accessor :auditing_fields
-
-    has_many :audits, :as => :auditable, :order => 'created_at DESC, id DESC'
-
-    self.auditing_fields = gather_fields_for_auditing(opts[:fields])
-    
-    after_create :log_creation
-    after_update :log_update
-    
-  end
-
-  def gather_fields_for_auditing(fields=nil)
-    return self.column_names - ["id", "created_at", "updated_at"] unless fields
-    fields.is_a?(Array) ? fields.map {|f| f.to_s} : [fields.to_s]
-  end
-
-  module InstanceMethods
-    def log_creation
-      add_audit(:action => 'created', :undoable => false)
-    end
-    
-    def log_update
-      if changed?
-        changes.each.select {|k,v| auditing_fields.include?(k)}.each do |field, change|
-          next if change[0].to_s == change[1].to_s
-          add_audit(:action => 'updated', :field_name => field,
-                    :old_value => change[0], :new_value => change[1])
-        end
-      end
-    end
-    
-    private
-      def add_audit(hash={})
-        Audit.create!({:auditable => self}.merge(hash))
-      end
-  end # Auditing::InstanceMethods
-
-end