acts_as_audited_rails3 1.1.1.4

data/lib/acts_as_audited.rb

@@ -0,0 +1,9 @@
+require 'acts_as_audited/base'
+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/lib/generators/audited_migration/USAGE

@@ -0,0 +1,7 @@
+Description:
+	The audited migration generator creates a migration to add the audits table.
+
+Example:
+    ./script/generate audited_migration add_audits_table
+
+    This will create a migration in db/migrate/.  Run "rake db:migrate" to update your database.

data/lib/generators/audited_migration/audited_migration_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class AuditedMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname) #:nodoc:
+    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_acts_as_audited_migration
+    migration_template 'migration.rb', 'db/migrate/acts_as_audited_migration.rb'
+  end
+end

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

@@ -0,0 +1,29 @@
+class ActsAsAuditedMigration < ActiveRecord::Migration
+  def self.up
+    create_table :audits, :force => true do |t|
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+      t.column :auditable_id, :integer
+      t.column :auditable_type, :string
+      t.column :user_id, :integer
+      t.column :user_type, :string
+      t.column :username, :string
+      t.column :action, :string
+      t.column :audit_changes, :text
+      t.column :version, :integer, :default => 0
+      t.column :comment, :string
+    end
+    if connection.adapter_name =~ /mysql/i
+      execute 'ALTER TABLE audits ADD COLUMN full_model longtext collate utf8_unicode_ci' 
+    else
+      add_column :audits, :full_model, :text
+    end
+    add_index :audits, [:auditable_id, :auditable_type], :name => 'auditable_index'
+    add_index :audits, [:user_id, :user_type], :name => 'user_index'
+    add_index :audits, :created_at  
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/lib/generators/audited_migration_update/USAGE

@@ -0,0 +1,7 @@
+Description:
+	The audited migration generator creates a migration to update the audits table to allow for audit comments. It should only be used if upgrading acts_as_audited from a versino which does not permit audit comments
+
+Example:
+    ./script/generate audited_migration_upgrade update_audits_table
+
+    This will create a migration in db/migrate/.  Run "rake db:migrate" to update your database.

data/lib/generators/audited_migration_update/audited_migration_update_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class AuditedMigrationUpdateGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname) #:nodoc:
+    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_acts_as_audited_update_migration
+    migration_template 'migration.rb', 'db/migrate/acts_as_audited_update_migration.rb'
+  end
+end

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

@@ -0,0 +1,9 @@
+class ActsAsAuditedUpdateMigration < ActiveRecord::Migration
+  def self.up
+    add_column :audits, :comment, :string
+  end
+
+  def self.down
+    remove_column :audits, :comment
+  end
+end

data/test/acts_as_audited_test.rb

@@ -0,0 +1,437 @@
+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.audit_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.audit_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.audit_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.audit_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.audit_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 :audit_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.version.should == 3
+          revision.name.should == 'Foobar 3'
+        end
+
+        should "find the previous revision with :previous" do
+          revision = @user.revision(:previous)
+          revision.version.should == 4
+          revision.should == @user.revision(4)
+        end
+
+        should "be able to get the previous revision repeatedly" do
+          previous = @user.revision(:previous)
+          previous.version.should == 4
+          previous.revision(:previous).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).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
+          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

data/test/audit_sweeper_test.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class AuditsController < ActionController::Base
+  def audit
+    @company = Company.create
+    render :nothing => true
+  end
+  
+  def update_user
+    current_user.update_attributes({:password => 'foo'})
+    render :nothing => true
+  end
+  
+private
+  attr_accessor :current_user
+end
+AuditsController.view_paths = [File.dirname(__FILE__)]
+ActionController::Routing::Routes.draw {|m| m.connect ':controller/:action/:id' }
+
+class AuditsControllerTest < ActionController::TestCase
+  should "audit user" do
+    user = @controller.send(:current_user=, create_user)
+    lambda { post :audit }.should change { Audit.count }
+    assigns(:company).audits.last.user.should == user
+  end
+  
+  should "not save blank audits" do
+    user = @controller.send(:current_user=, create_user)
+    lambda { post :update_user }.should_not change { Audit.count }
+  end
+end