ericperko-acts_as_audited 1.1.2

data/lib/acts_as_audited/audit.rb

@@ -0,0 +1,119 @@
+require 'set'
+
+# Audit saves the changes to ActiveRecord models.  It has the following attributes:
+#
+# * <tt>auditable</tt>: the ActiveRecord model that was changed
+# * <tt>user</tt>: the user that performed the change; a string or an ActiveRecord model
+# * <tt>action</tt>: one of create, update, or delete
+# * <tt>changes</tt>: a serialized hash of all the changes
+# * <tt>created_at</tt>: Time that the change was performed
+#
+class Audit < ActiveRecord::Base
+  belongs_to :auditable, :polymorphic => true
+  belongs_to :user, :polymorphic => true
+
+  before_create :set_audit_version_number, :set_audit_user
+
+  serialize :changes
+
+  cattr_accessor :audited_class_names
+  self.audited_class_names = Set.new
+
+  def self.audited_classes
+    self.audited_class_names.map(&:constantize)
+  end
+
+  # All audits made during the block called will be recorded as made
+  # by +user+. This method is hopefully threadsafe, making it ideal
+  # for background operations that require audit information.
+  def self.as_user(user, &block)
+    Thread.current[:acts_as_audited_user] = user
+
+    yield
+
+    Thread.current[:acts_as_audited_user] = nil
+  end
+
+  # Allows user to be set to either a string or an ActiveRecord object
+  def user_as_string=(user) #:nodoc:
+    # reset both either way
+    self.user_as_model = self.username = nil
+    user.is_a?(ActiveRecord::Base) ?
+      self.user_as_model = user :
+      self.username = user
+  end
+  alias_method :user_as_model=, :user=
+  alias_method :user=, :user_as_string=
+
+  def user_as_string #:nodoc:
+    self.user_as_model || self.username
+  end
+  alias_method :user_as_model, :user
+  alias_method :user, :user_as_string
+
+  def revision
+    clazz = auditable_type.constantize
+    returning clazz.find_by_id(auditable_id) || clazz.new do |m|
+      Audit.assign_revision_attributes(m, self.class.reconstruct_attributes(ancestors).merge({:audit_version => audit_version}))
+    end
+  end
+
+  def ancestors
+    self.class.find(:all, :order => 'audit_version',
+      :conditions => ['auditable_id = ? and auditable_type = ? and audit_version <= ?',
+      auditable_id, auditable_type, audit_version])
+  end
+
+  # Returns a hash of the changed attributes with the new values
+  def new_attributes
+    (changes || {}).inject({}.with_indifferent_access) do |attrs,(attr,values)|
+      attrs[attr] = values.is_a?(Array) ? values.last : values
+      attrs
+    end
+  end
+
+  # Returns a hash of the changed attributes with the old values
+  def old_attributes
+    (changes || {}).inject({}.with_indifferent_access) do |attrs,(attr,values)|
+      attrs[attr] = Array(values).first
+      attrs
+    end
+  end
+
+  def self.reconstruct_attributes(audits)
+    attributes = {}
+    result = audits.collect do |audit|
+      attributes.merge!(audit.new_attributes).merge!(:audit_version => audit.audit_version)
+      yield attributes if block_given?
+    end
+    block_given? ? result : attributes
+  end
+  
+  def self.assign_revision_attributes(record, attributes)
+    attributes.each do |attr, val|
+      if record.respond_to?("#{attr}=")
+        record.attributes.has_key?(attr.to_s) ?
+          record[attr] = val :
+          record.send("#{attr}=", val)
+      end
+    end
+    record
+  end
+
+private
+
+  def set_audit_version_number
+    max = self.class.maximum(:audit_version,
+      :conditions => {
+        :auditable_id => auditable_id,
+        :auditable_type => auditable_type
+      }) || 0
+    self.audit_version = max + 1
+  end
+
+  def set_audit_user
+    self.user = Thread.current[:acts_as_audited_user] if Thread.current[:acts_as_audited_user]
+    nil # prevent stopping callback chains
+  end
+
+end

data/lib/acts_as_audited/audit_sweeper.rb

@@ -0,0 +1,36 @@
+module CollectiveIdea #:nodoc:
+  module ActionController #:nodoc:
+    module Audited #:nodoc:
+      def audit(*models)
+        ActiveSupport::Deprecation.warn("#audit is deprecated. Declare #acts_as_audited in your models.", caller)
+        
+        options = models.extract_options!
+
+        # Parse the options hash looking for classes
+        options.each_key do |key|
+          models << [key, options.delete(key)] if key.is_a?(Class)
+        end
+
+        models.each do |(model, model_options)|
+          model.send :acts_as_audited, model_options || {}
+        end
+      end
+    end
+  end
+end
+
+class AuditSweeper < ActionController::Caching::Sweeper #:nodoc:
+  def before_create(audit)
+    audit.user ||= current_user
+  end
+
+  def current_user
+    controller.send :current_user if controller.respond_to?(:current_user, true)
+  end
+end
+
+ActionController::Base.class_eval do
+  extend CollectiveIdea::ActionController::Audited
+  cache_sweeper :audit_sweeper
+end
+Audit.add_observer(AuditSweeper.instance)

data/rails/init.rb

@@ -0,0 +1,8 @@
+require 'acts_as_audited/audit'
+require 'acts_as_audited'
+
+ActiveRecord::Base.send :include, CollectiveIdea::Acts::Audited
+
+if defined?(ActionController) and defined?(ActionController::Base)
+  require 'acts_as_audited/audit_sweeper'
+end

data/test/acts_as_audited_test.rb

@@ -0,0 +1,438 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+module CollectiveIdea
+  module Acts
+    class AuditedTest < Test::Unit::TestCase
+      should "include instance methods" do
+        User.new.should be_kind_of(CollectiveIdea::Acts::Audited::InstanceMethods)
+      end
+
+      should "extend singleton methods" do
+        User.should be_kind_of(CollectiveIdea::Acts::Audited::SingletonMethods)
+      end
+
+      ['created_at', 'updated_at', 'created_on', 'updated_on', 'lock_version', 'id', 'password'].each do |column|
+        should "not audit #{column}" do
+          User.non_audited_columns.should include(column)
+        end
+      end
+
+      should "not save non-audited columns" do
+        create_user.audits.first.changes.keys.any?{|col| ['created_at', 'updated_at', 'password'].include? col}.should be(false)
+      end
+      
+      context "on create" do
+        setup { @user = create_user :audit_comment => "Create" }
+
+        should_change 'Audit.count', :by => 1
+
+        should 'create associated audit' do
+          @user.audits.count.should == 1
+        end
+        should "set the action to 'create'" do
+          @user.audits.first.action.should == 'create'
+        end
+
+        should "store all the audited attributes" do
+          @user.audits.first.changes.should == @user.audited_attributes
+        end
+
+        
+        should "not audit an attribute which is excepted if specified on create and on destroy" do
+          on_create_destroy_except_name = OnCreateDestroyExceptName.create(:name => 'Bart')
+          on_create_destroy_except_name.audits.first.changes.keys.any?{|col| ['name'].include? col}.should be(false)
+        end
+
+   
+        should "store comment" do
+          @user.audits.first.comment.should == "Create"
+        end      
+
+
+        should "not save an audit if only specified on update and on destroy" do
+          lambda { on_update_destroy = OnUpdateDestroy.create(:name => 'Bart') }.should_not change { Audit.count }
+        end
+      end
+      
+      context "on update" do
+        setup do
+          @user = create_user(:name => 'Brandon', :audit_comment => "Update")
+        end
+
+        should "save an audit" do
+          lambda { @user.update_attribute(:name, "Someone") }.should change { @user.audits.count }.by(1)
+          lambda { @user.update_attribute(:name, "Someone else") }.should change { @user.audits.count }.by(1)
+        end
+
+        should "not save an audit if the record is not changed" do
+          lambda { @user.save! }.should_not change { Audit.count }
+        end
+
+        should "set the action to 'update'" do
+          @user.update_attributes :name => 'Changed'
+          @user.audits.last.action.should == 'update'
+        end
+
+        should "store the changed attributes" do
+          @user.update_attributes :name => 'Changed'
+          @user.audits.last.changes.should == {'name' => ['Brandon', 'Changed']}
+        end
+
+        should "store audit comment" do
+          @user.audits.last.comment.should == "Update"
+        end
+
+        # Dirty tracking in Rails 2.0-2.2 had issues with type casting
+        if ActiveRecord::VERSION::STRING >= '2.3'
+          should "not save an audit if the value doesn't change after type casting" do
+            @user.update_attributes! :logins => 0, :activated => true
+            lambda { @user.update_attribute :logins, '0' }.should_not change { Audit.count }
+            lambda { @user.update_attribute :activated, 1 }.should_not change { Audit.count }
+            lambda { @user.update_attribute :activated, '1' }.should_not change { Audit.count }
+          end
+        end
+
+        should "not save an audit if only specified on create and on destroy" do
+          on_create_destroy = OnCreateDestroy.create(:name => 'Bart')
+          lambda { on_create_destroy.update_attributes :name => 'Changed' }.should_not change { Audit.count }
+        end
+      end
+
+      context "on destroy" do
+        setup do
+          @user = create_user
+        end
+
+        should "save an audit" do
+          lambda { @user.destroy }.should change { Audit.count }.by(1)
+          @user.audits.size.should == 2
+        end
+
+        should "set the action to 'destroy'" do
+          @user.destroy
+          @user.audits.last.action.should == 'destroy'
+        end
+
+        should "store all of the audited attributes" do
+          @user.destroy
+          @user.audits.last.changes.should == @user.audited_attributes
+        end
+
+        should "be able to reconstruct destroyed record without history" do
+          @user.audits.delete_all
+          @user.destroy
+          revision = @user.audits.first.revision
+          revision.name.should == @user.name
+        end
+        
+        should "not save an audit if only specified on create and on update" do
+          on_create_update = OnCreateUpdate.create(:name => 'Bart')
+          lambda { on_create_update.destroy }.should_not change { Audit.count }
+        end
+      end
+
+      context "dirty tracking" do
+        setup do
+          @user = create_user
+        end
+
+        should "not be changed when the record is saved" do
+          u = User.new(:name => 'Brandon')
+          u.changed?.should be(true)
+          u.save
+          u.changed?.should be(false)
+        end
+
+        should "be changed when an attribute has been changed" do
+          @user.name = "Bobby"
+          @user.changed?.should be(true)
+          @user.name_changed?.should be(true)
+          @user.username_changed?.should be(false)
+        end
+
+        # Dirty tracking in Rails 2.0-2.2 had issues with type casting
+        if ActiveRecord::VERSION::STRING >= '2.3'
+          should "not be changed if the value doesn't change after type casting" do
+            @user.update_attributes! :logins => 0, :activated => true
+            @user.logins = '0'
+            @user.changed?.should be(false)
+          end
+        end
+
+      end
+
+      context "revisions" do
+        setup do
+          @user = create_versions
+        end
+
+        should "be an Array of Users" do
+          @user.revisions.should be_kind_of(Array)
+          @user.revisions.each {|version| version.should be_kind_of(User) }
+        end
+
+        should "have one revision for a new record" do
+          create_user.revisions.size.should == 1
+        end
+
+        should "have one revision for each audit" do
+          @user.revisions.size.should == @user.audits.size
+        end
+
+        should "set the attributes for each revision" do
+          u = User.create(:name => 'Brandon', :username => 'brandon')
+          u.update_attributes :name => 'Foobar'
+          u.update_attributes :name => 'Awesome', :username => 'keepers'
+
+          u.revisions.size.should == 3
+
+          u.revisions[0].name.should == 'Brandon'
+          u.revisions[0].username.should == 'brandon'
+
+          u.revisions[1].name.should == 'Foobar'
+          u.revisions[1].username.should == 'brandon'
+
+          u.revisions[2].name.should == 'Awesome'
+          u.revisions[2].username.should == 'keepers'
+        end
+
+        should "access to only recent revisions" do
+          u = User.create(:name => 'Brandon', :username => 'brandon')
+          u.update_attributes :name => 'Foobar'
+          u.update_attributes :name => 'Awesome', :username => 'keepers'
+
+          u.revisions(2).size.should == 2
+
+          u.revisions(2)[0].name.should == 'Foobar'
+          u.revisions(2)[0].username.should == 'brandon'
+
+          u.revisions(2)[1].name.should == 'Awesome'
+          u.revisions(2)[1].username.should == 'keepers'
+        end
+
+        should "be empty if no audits exist" do
+          @user.audits.delete_all
+          @user.revisions.empty?.should be(true)
+        end
+
+        should "ignore attributes that have been deleted" do
+          @user.audits.last.update_attributes :changes => {:old_attribute => 'old value'}
+          lambda { @user.revisions }.should_not raise_error
+        end
+
+      end
+
+      context "revision" do
+        setup do
+          @user = create_versions(5)
+        end
+
+        should "maintain identity" do
+          @user.revision(1).should == @user
+        end
+
+        should "find the given revision" do
+          revision = @user.revision(3)
+          revision.should be_kind_of(User)
+          revision.audit_version.should == 3
+          revision.name.should == 'Foobar 3'
+        end
+
+        should "find the previous revision with :previous" do
+          revision = @user.revision(:previous)
+          revision.audit_version.should == 4
+          revision.should == @user.revision(4)
+        end
+
+        should "be able to get the previous revision repeatedly" do
+          previous = @user.revision(:previous)
+          previous.audit_version.should == 4
+          previous.revision(:previous).audit_version.should == 3
+        end
+        
+        should "be able to set protected attributes" do
+          u = User.create(:name => 'Brandon')
+          u.update_attribute :logins, 1
+          u.update_attribute :logins, 2
+
+          u.revision(3).logins.should == 2
+          u.revision(2).logins.should == 1
+          u.revision(1).logins.should == 0
+        end
+        
+        should "set attributes directly" do
+          u = User.create(:name => '<Joe>')
+          u.revision(1).name.should == '&lt;Joe&gt;'
+        end
+
+        should "set the attributes for each revision" do
+          u = User.create(:name => 'Brandon', :username => 'brandon')
+          u.update_attributes :name => 'Foobar'
+          u.update_attributes :name => 'Awesome', :username => 'keepers'
+
+          u.revision(3).name.should == 'Awesome'
+          u.revision(3).username.should == 'keepers'
+
+          u.revision(2).name.should == 'Foobar'
+          u.revision(2).username.should == 'brandon'
+
+          u.revision(1).name.should == 'Brandon'
+          u.revision(1).username.should == 'brandon'
+        end
+
+        should "be able to get time for first revision" do
+          suspended_at = Time.now
+          u = User.create(:suspended_at => suspended_at)
+          u.revision(1).suspended_at.should == suspended_at
+        end
+
+        should "not raise an error when no previous audits exist" do
+          @user.audits.destroy_all
+          lambda{ @user.revision(:previous) }.should_not raise_error
+        end
+
+        should "mark revision's attributes as changed" do
+          @user.revision(1).name_changed?.should be(true)
+        end
+
+        should "record new audit when saving revision" do
+          lambda { @user.revision(1).save! }.should change { @user.audits.count }.by(1)
+        end
+
+      end
+
+      context "revision_at" do
+        should "find the latest revision before the given time" do
+          u = create_user
+          Audit.update(u.audits.first.id, :created_at => 1.hour.ago)
+          u.update_attributes :name => 'updated'
+          u.revision_at(2.minutes.ago).audit_version.should == 1
+        end
+
+        should "be nil if given a time before audits" do
+          create_user.revision_at(1.week.ago).should be(nil)
+        end
+
+      end
+
+      context "without auditing" do
+
+        should "not save an audit when calling #save_without_auditing" do
+          lambda {
+            u = User.new(:name => 'Brandon')
+            u.save_without_auditing.should be(true)
+          }.should_not change { Audit.count }
+        end
+
+        should "not save an audit inside of the #without_auditing block" do
+          lambda do
+            User.without_auditing { User.create(:name => 'Brandon') }
+          end.should_not change { Audit.count }
+        end
+      end
+
+      context "comment required" do
+        class CommentRequiredUser < ActiveRecord::Base
+          set_table_name :users
+          acts_as_audited :comment_required => true
+        end
+    
+        context "on create" do
+          should "not validate when audit_comment is not supplied" do
+            CommentRequiredUser.new.valid?.should == false
+          end
+         
+          should "validate when audit_comment is supplied" do
+            CommentRequiredUser.new(:audit_comment => "Create").valid?.should == true
+          end
+        end
+        
+        context "on update" do
+          setup do
+            @user = CommentRequiredUser.create(:audit_comment => "Create")
+          end
+          should "not validate when audit_comment is not supplied" do
+            @user.update_attributes(:name => "Test").should == false
+          end
+         
+          should "validate when audit_comment is supplied" do
+            @user.update_attributes(:name => "foo", :audit_comment => "Update").should == true
+            @user.audits.last.comment.should == "Update"
+          end
+          
+        end
+
+        context "on destroy" do
+          setup do
+            @user = CommentRequiredUser.create(:audit_comment => "Create")
+          end
+
+          should "not validate when audit_comment is unset" do
+            @user.destroy.should == false
+          end
+         
+          should "validate when audit_comment is supplied" do
+            @user.audit_comment = "Destroy"
+            @user.destroy.should == @user
+          end
+        end
+
+      end
+
+      context "attr_protected and attr_accessible" do
+        class UnprotectedUser < ActiveRecord::Base
+          set_table_name :users
+          acts_as_audited :protect => false
+          attr_accessible :name, :username, :password
+        end
+        should "not raise error when attr_accessible is set and protected is false" do
+          lambda{
+            UnprotectedUser.new(:name => 'NO FAIL!')
+          }.should_not raise_error(RuntimeError)
+        end
+
+        class AccessibleUser < ActiveRecord::Base
+          set_table_name :users
+          attr_accessible :name, :username, :password # declare attr_accessible before calling aaa
+          acts_as_audited
+        end
+        should "not raise an error when attr_accessible is declared before acts_as_audited" do
+          lambda{
+            AccessibleUser.new(:name => 'NO FAIL!')
+          }.should_not raise_error
+        end
+      end
+
+      context "audit as" do
+        setup do
+          @user = User.create :name => 'Testing'
+        end
+
+        should "record user objects" do
+          Company.audit_as( @user ) do
+            company = Company.create :name => 'The auditors'
+            company.name = 'The Auditors'
+            company.save
+
+            company.audits.each do |audit|
+              audit.user.should == @user
+            end
+          end
+        end
+
+        should "record usernames" do
+          Company.audit_as( @user.name ) do
+            company = Company.create :name => 'The auditors'
+            company.name = 'The Auditors, Inc'
+            company.save
+
+            company.audits.each do |audit|
+              audit.username.should == @user.name
+            end
+          end
+        end
+      end
+
+    end
+  end
+end