acts_as_audited 1.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+acts_as_audited_plugin.sqlite3.db
+test/debug.log
+coverage/
+pkg

data/CHANGELOG

@@ -0,0 +1,25 @@
+ acts_as_audited ChangeLog
+-------------------------------------------------------------------------------
+* 2009-01-27 - Store old and new values for updates, and store all attributes on destroy.
+               Refactored revisioning methods to work as expected
+* 2008-10-10 - changed to make it work in development mode
+* 2008-04-19 - refactored to make compatible with dirty tracking in edge rails
+               and to stop storing both old and new values in a single audit
+* 2008-04-18 - Fix NoMethodError when trying to access the :previous revision
+               on a model that doesn't have previous revisions [Alex Soto]
+* 2008-03-21 - added #changed_attributes to get access to the changes before a
+               save [Chris Parker]
+* 2007-12-16 - Added #revision_at for retrieving a revision from a specific
+               time [Jacob Atzen]
+* 2007-12-16 - Fix error when getting revision from audit with no changes
+               [Geoffrey Wiseman]
+* 2007-12-16 - Remove dependency on acts_as_list
+* 2007-06-17 - Added support getting previous revisions
+* 2006-11-17 - Replaced use of singleton User.current_user with cache sweeper
+               implementation for auditing the user that made the change
+* 2006-11-17 - added migration generator
+* 2006-08-14 - incorporated changes from Michael Schuerig to write_attribute
+               that saves the new value after every change and not just the
+               first, and performs proper type-casting before doing comparisons
+* 2006-08-14 - The "changes" are now saved as a serialized hash
+* 2006-07-21 - initial version

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2008 Brandon Keepers - Collective Idea
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,84 @@
+= acts_as_audited
+
+acts_as_audited is an ActiveRecord extension that logs all changes to your models in an audits table.
+
+The purpose of this fork is to store both the previous values and the changed value, making each audit record selfcontained.
+
+== Installation
+
+* acts_as_audited can be installed as a gem:
+    
+    # config/environment.rb
+    config.gem 'collectiveidea-acts_as_audited', :lib => false,
+      :source => 'http://gems.github.com'
+
+  or a plugin:
+
+    script/plugin install git://github.com/collectiveidea/acts_as_audited.git
+
+* Generate the migration
+    script/generate audited_migration add_audits_table
+    rake db:migrate
+
+== Usage
+
+If you're using acts_as_audited within Rails, you can simply declare which models should be audited.  acts_as_audited can also automatically record the user that made the change if your controller has a <tt>current_user</tt> method.
+
+  class ApplicationController < ActionController::Base
+    audit User, List, Item => {:except => :password}
+  protected
+    def current_user
+      @user ||= User.find(session[:user])
+    end
+  end
+
+To get auditing outside of Rails you can explicitly declare <tt>acts_as_audited</tt> on your models:
+
+    class User < ActiveRecord::Base
+      acts_as_audited :except => [:password, :mistress]
+    end
+
+To record a user in the audits when the sweepers are not available, you can use <tt>as_user</tt>:
+
+    Audit.as_user( user ) do
+      # Perform changes on audited models
+    end
+
+See http://opensoul.org/2006/07/21/acts_as_audited for more information.
+
+== Caveats
+
+If your model declares +attr_accessible+ after +acts_as_audited+, you need to set +:protect+ to false. acts_as_audited uses +attr_protected+ internally to prevent malicious users from unassociating your audits, and Rails does not allow both +attr_protected+ and +attr_accessible+. It will default to false if +attr_accessible+ is called before +acts_as_audited+, but needs to be explicitly set if it is called after.
+
+  class User < ActiveRecord::Base
+    acts_as_audited :protect => false
+    attr_accessible :name
+  end
+
+=== ActiveScaffold
+
+Many users have also reported problems with acts_as_audited and ActiveScaffold, which appears to be caused by a limitation in ActiveScaffold not supporting polymorphic associations. To get it to work with ActiveScaffold:
+
+  class ApplicationController < ActionController::Base
+    audit MyModel, :only => [:create, :update, :destroy]
+  end
+
+== Compatability
+
+acts_as_audited works with Rails 2.1 or later.
+
+== Contributing
+
+Contributions are always welcome. Checkout the latest code on GitHub:
+  http://github.com/collectiveidea/acts_as_audited
+
+Please include tests with your patches. There are a few gems required to run the tests:
+  $ gem install multi_rails
+  $ gem install thoughtbot-shoulda jnunemaker-matchy --source http://gems.github.com
+
+Make sure the tests pass against all versions of Rails since 2.1:
+
+  $ rake test:multi_rails:all
+
+Please report bugs or feature suggestions on GitHub:
+  http://github.com/collectiveidea/acts_as_audited/issues

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rake'
+require 'load_multi_rails_rake_tasks'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run tests.'
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_audited"
+    gem.summary = %Q{ActiveRecord extension that logs all changes to your models in an audits table}
+    gem.email = "brandon@opensoul.org"
+    gem.homepage = "http://github.com/collectiveidea/acts_as_audited"
+    gem.authors = ["Brandon Keepers"]
+    gem.add_dependency 'activerecord', '>=2.1'
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "jnunemaker-matchy"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  # Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Test the acts_as_audited plugin'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+    test.rcov_opts = %w(--exclude test,/usr/lib/ruby,/Library/Ruby,$HOME/.gem --sort coverage)
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+desc 'Generate documentation for the acts_as_audited plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'acts_as_audited'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/acts_as_audited.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_audited}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brandon Keepers"]
+  s.date = %q{2009-09-28}
+  s.email = %q{brandon@opensoul.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "acts_as_audited.gemspec",
+     "generators/audited_migration/USAGE",
+     "generators/audited_migration/audited_migration_generator.rb",
+     "generators/audited_migration/templates/migration.rb",
+     "init.rb",
+     "lib/acts_as_audited.rb",
+     "lib/acts_as_audited/audit.rb",
+     "lib/acts_as_audited/audit_sweeper.rb",
+     "rails/init.rb",
+     "test/acts_as_audited_test.rb",
+     "test/audit_sweeper_test.rb",
+     "test/audit_test.rb",
+     "test/db/database.yml",
+     "test/db/schema.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/collectiveidea/acts_as_audited}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ActiveRecord extension that logs all changes to your models in an audits table}
+  s.test_files = [
+    "test/acts_as_audited_test.rb",
+     "test/audit_sweeper_test.rb",
+     "test/audit_test.rb",
+     "test/db/schema.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.1"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<jnunemaker-matchy>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.1"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<jnunemaker-matchy>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.1"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<jnunemaker-matchy>, [">= 0"])
+  end
+end

data/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/generators/audited_migration/audited_migration_generator.rb

@@ -0,0 +1,7 @@
+class AuditedMigrationGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+end

data/generators/audited_migration/templates/migration.rb

@@ -0,0 +1,23 @@
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :audits, :force => true do |t|
+      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 :changes, :text
+      t.column :version, :integer, :default => 0
+      t.column :created_at, :datetime
+    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/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/lib/acts_as_audited/audit.rb

@@ -0,0 +1,122 @@
+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_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
+
+  cattr_accessor :audit_as_user
+  self.audit_as_user = nil
+
+  # 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({:version => version}))
+    end
+  end
+
+  def ancestors
+    self.class.find(:all, :order => 'version',
+      :conditions => ['auditable_id = ? and auditable_type = ? and version <= ?',
+      auditable_id, auditable_type, 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] = Array(values).last
+      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!(:version => 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_version_number
+    max = self.class.maximum(:version,
+      :conditions => {
+        :auditable_id => auditable_id,
+        :auditable_type => auditable_type
+      }) || 0
+    self.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,79 @@
+
+module CollectiveIdea #:nodoc:
+  module ActionController #:nodoc:
+    module Audited #:nodoc:
+
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # Declare models that should be audited in your controller
+        #
+        #   class ApplicationController < ActionController::Base
+        #     audit User, Widget
+        #   end
+        #
+        # You can optionally pass options for each model to be audited:
+        #
+        #    audit User, Widget, Task => { :except => :position }
+        #
+        # NOTE: Models which do not have options must be listed first in the
+        # call to <tt>audit</tt>.
+        #
+        # See <tt>CollectiveIdea::Acts::Audited::ClassMethods#acts_as_audited</tt>
+        # for configuration options
+        #
+        # You can also specify an options hash which will be passed on to
+        # Rails' cache_sweeper call:
+        #
+        #    audit User, :only => [:create, :edit, :destroy]
+        #
+        def audit(*models)
+          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 || {}
+
+            # disable ActiveRecord callbacks, which are replaced by the AuditSweeper
+            model.send :disable_auditing_callbacks
+            
+            # prevent observer from being registered multiple times
+            model.delete_observer(AuditSweeper.instance)
+            model.add_observer(AuditSweeper.instance)      
+          end
+
+          class_eval do
+            cache_sweeper :audit_sweeper, options
+          end
+        end
+      end
+
+    end
+  end
+end
+
+class AuditSweeper < ActionController::Caching::Sweeper #:nodoc:
+
+  def after_create(record)
+    record.send(:audit_create, current_user)
+  end
+
+  def after_destroy(record)
+    record.send(:audit_destroy, current_user)
+  end
+
+  def before_update(record)
+    record.send(:audit_update, current_user)
+  end
+
+  def current_user
+    controller.send :current_user if controller.respond_to?(:current_user, true)
+  end
+
+end