ericperko-acts_as_audited 1.1.2

data/.gitignore

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

data/CHANGELOG

@@ -0,0 +1,26 @@
+ acts_as_audited ChangeLog
+-------------------------------------------------------------------------------
+* 2010-07-07 - Renamed the audit.version field to audit.audit_version to avoid conflicts with an existing model's names
+* 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,76 @@
+= 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 rename audit fields to avoid conflicts with existing attributes of models in our webapp
+
+== Installation
+
+    script/plugin install git://github.com/ericperko/acts_as_audited.git
+
+* Generate the migration
+
+  * If installing without a previous version of acts_as_audited or you do not mind overwriting your audits table:
+
+      script/generate audited_migration add_audits_table
+
+  * If upgrading from a version of acts_as_audited that does not contain comment functionality:
+
+      script/generate audited_migration_update update_audits_table
+
+  * After running one of the generators:
+
+      rake db:migrate
+
+== Usage
+
+Declare <tt>acts_as_audited</tt> on your models:
+
+    class User < ActiveRecord::Base
+      acts_as_audited :except => [:password, :mistress]
+    end
+    
+Within a web request, will automatically record the user that made the change if your controller has a <tt>current_user</tt> method. Comments can be added to an audit by setting model.audit_comments 
+before create/update/destroy. If the :comment_required option is given to acts_as_audited, 
+the save/update/destroy action will fail with add an error on model.audit_comment and triggering a 
+transaction rollback if model.audit_comment is nil.
+
+To record a user in the audits outside of a web request, you can use <tt>as_user</tt>:
+
+    Audit.as_user(user) do
+      # Perform changes on audited models
+    end
+
+== 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
+
+== Compatability
+
+acts_as_audited works with Rails 2.1 or later.
+
+== Getting Help
+
+Join the mailing list for getting help or offering suggestions:
+  http://groups.google.com/group/acts_as_audited
+
+== 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.1.2

data/acts_as_audited.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ericperko-acts_as_audited}
+  s.version = "1.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brandon Keepers", "Eric Perko"]
+  s.date = %q{2010-04-03}
+  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",
+     "generators/audited_migration_update/audited_migration_update_generator.rb",
+     "generators/audited_migration_update/templates/migration.rb",
+     "generators/audited_migration_update/USAGE",
+     "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/ericperko/acts_as_audited}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  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,24 @@
+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 :audit_version, :integer, :default => 0
+      t.column :comment, :string
+      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/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 version 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/generators/audited_migration_update/audited_migration_update_generator.rb

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

data/generators/audited_migration_update/templates/migration.rb

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

data/init.rb

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

data/lib/acts_as_audited.rb

@@ -0,0 +1,277 @@
+# Copyright (c) 2006 Brandon Keepers
+#
+# 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.
+
+module CollectiveIdea #:nodoc:
+  module Acts #:nodoc:
+    # Specify this act if you want changes to your model to be saved in an
+    # audit table.  This assumes there is an audits table ready.
+    #
+    #   class User < ActiveRecord::Base
+    #     acts_as_audited
+    #   end
+    #
+    # To store an audit comment set model.audit_comment to your comment before
+    # a create, update or destroy operation.
+    #
+    # See <tt>CollectiveIdea::Acts::Audited::ClassMethods#acts_as_audited</tt>
+    # for configuration options
+    module Audited #:nodoc:
+      CALLBACKS = [:audit_create, :audit_update, :audit_destroy]
+
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # == Configuration options
+        #
+        #
+        # * +only+ - Only audit the given attributes
+        # * +except+ - Excludes fields from being saved in the audit log.
+        #   By default, acts_as_audited will audit all but these fields:
+        #
+        #     [self.primary_key, inheritance_column, 'lock_version', 'created_at', 'updated_at']
+        #   You can add to those by passing one or an array of fields to skip.
+        #
+        #     class User < ActiveRecord::Base
+        #       acts_as_audited :except => :password
+        #     end
+        # * +protect+ - If your model uses +attr_protected+, set this to false to prevent Rails from
+        #   raising an error.  If you declare +attr_accessibe+ before calling +acts_as_audited+, it
+        #   will automatically default to false.  You only need to explicitly set this if you are
+        #   calling +attr_accessible+ after.
+        #
+        # * +require_comment+ - Ensures that audit_comment is supplied before
+        #   any create, update or destroy operation.
+        #
+        #     class User < ActiveRecord::Base
+        #       acts_as_audited :protect => false
+        #       attr_accessible :name
+        #     end
+        #
+        def acts_as_audited(options = {})
+          # don't allow multiple calls
+          return if self.included_modules.include?(CollectiveIdea::Acts::Audited::InstanceMethods)
+
+          options = {:protect => accessible_attributes.nil?}.merge(options)
+
+          class_inheritable_reader :non_audited_columns
+          class_inheritable_reader :auditing_enabled
+          
+          if options[:only]
+            except = self.column_names - options[:only].flatten.map(&:to_s)
+          else
+            except = [self.primary_key, inheritance_column, 'lock_version',
+              'created_at', 'updated_at', 'created_on', 'updated_on']
+            except |= Array(options[:except]).collect(&:to_s) if options[:except]
+          end
+          write_inheritable_attribute :non_audited_columns, except
+
+          if options[:comment_required]
+            validates_presence_of :audit_comment
+            before_destroy :require_comment
+          end
+
+          attr_accessor :audit_comment
+          unless accessible_attributes.nil? || options[:protect]
+            attr_accessible :audit_comment
+          end
+
+          has_many :audits, :as => :auditable, :order => "#{Audit.quoted_table_name}.audit_version"
+          attr_protected :audit_ids if options[:protect]
+          Audit.audited_class_names << self.to_s
+
+          after_create  :audit_create if !options[:on] || (options[:on] && options[:on].include?(:create))
+          before_update :audit_update if !options[:on] || (options[:on] && options[:on].include?(:update))
+          after_destroy :audit_destroy if !options[:on] || (options[:on] && options[:on].include?(:destroy))
+
+          attr_accessor :audit_version
+
+          extend CollectiveIdea::Acts::Audited::SingletonMethods
+          include CollectiveIdea::Acts::Audited::InstanceMethods
+
+          write_inheritable_attribute :auditing_enabled, true
+        end
+      end
+
+      module InstanceMethods
+
+        # Temporarily turns off auditing while saving.
+        def save_without_auditing
+          without_auditing { save }
+        end
+
+        # Executes the block with the auditing callbacks disabled.
+        #
+        #   @foo.without_auditing do
+        #     @foo.save
+        #   end
+        #
+        def without_auditing(&block)
+          self.class.without_auditing(&block)
+        end
+
+        # Gets an array of the revisions available
+        #
+        #   user.revisions.each do |revision|
+        #     user.name
+        #     user.audit_version
+        #   end
+        #
+        def revisions(from_version = 1)
+          audits = self.audits.find(:all, :conditions => ['audit_version >= ?', from_version])
+          return [] if audits.empty?
+          revision = self.audits.find_by_audit_version(from_version).revision
+          Audit.reconstruct_attributes(audits) {|attrs| revision.revision_with(attrs) }
+        end
+
+        # Get a specific revision specified by the version number, or +:previous+
+        def revision(version)
+          revision_with Audit.reconstruct_attributes(audits_to(version))
+        end
+
+        def revision_at(date_or_time)
+          audits = self.audits.find(:all, :conditions => ["created_at <= ?", date_or_time])
+          revision_with Audit.reconstruct_attributes(audits) unless audits.empty?
+        end
+
+        def audited_attributes
+          attributes.except(*non_audited_columns)
+        end
+
+        protected
+
+        def revision_with(attributes)
+          returning self.dup do |revision|
+            revision.send :instance_variable_set, '@attributes', self.attributes_before_type_cast
+            Audit.assign_revision_attributes(revision, attributes)
+
+            # Remove any association proxies so that they will be recreated
+            # and reference the correct object for this revision. The only way
+            # to determine if an instance variable is a proxy object is to
+            # see if it responds to certain methods, as it forwards almost
+            # everything to its target.
+            for ivar in revision.instance_variables
+              proxy = revision.instance_variable_get ivar
+              if !proxy.nil? and proxy.respond_to? :proxy_respond_to?
+                revision.instance_variable_set ivar, nil
+              end
+            end
+          end
+        end
+
+        private
+
+        def audited_changes
+          changed_attributes.except(*non_audited_columns).inject({}) do |changes,(attr, old_value)|
+            changes[attr] = [old_value, self[attr]]
+            changes
+          end
+        end
+
+        def audits_to(version = nil)
+          if version == :previous
+            version = if self.audit_version
+              self.audit_version - 1
+            else
+              previous = audits.find(:first, :offset => 1,
+                :order => "#{Audit.quoted_table_name}.audit_version DESC")
+              previous ? previous.audit_version : 1
+            end
+          end
+          audits.find(:all, :conditions => ['audit_version <= ?', version])
+        end
+
+        def audit_create
+          write_audit(:action => 'create', :changes => audited_attributes, 
+            :comment => audit_comment)
+        end
+
+        def audit_update
+          unless (changes = audited_changes).empty?
+            write_audit(:action => 'update', :changes => changes, 
+              :comment => audit_comment)
+          end
+        end
+
+        def audit_destroy
+          write_audit(:action => 'destroy', :changes => audited_attributes,
+            :comment => audit_comment)
+        end
+
+        def write_audit(attrs)
+          self.audit_comment = nil
+          self.audits.create attrs if auditing_enabled
+        end
+  
+        def require_comment
+          if audit_comment.blank?
+            errors.add(:audit_comment, "Comment required before destruction")
+            return false
+          end
+        end
+
+        CALLBACKS.each do |attr_name|
+          alias_method "#{attr_name}_callback".to_sym, attr_name
+        end
+
+        def empty_callback #:nodoc:
+        end
+
+      end # InstanceMethods
+
+      module SingletonMethods
+        # Returns an array of columns that are audited.  See non_audited_columns
+        def audited_columns
+          self.columns.select { |c| !non_audited_columns.include?(c.name) }
+        end
+
+        # Executes the block with auditing disabled.
+        #
+        #   Foo.without_auditing do
+        #     @foo.save
+        #   end
+        #
+        def without_auditing(&block)
+          auditing_was_enabled = auditing_enabled
+          disable_auditing
+          returning(block.call) { enable_auditing if auditing_was_enabled }
+        end
+
+        def disable_auditing
+          write_inheritable_attribute :auditing_enabled, false
+        end
+
+        def enable_auditing
+          write_inheritable_attribute :auditing_enabled, true
+        end
+
+        # All audit operations during the block are recorded as being
+        # made by +user+. This is not model specific, the method is a
+        # convenience wrapper around #Audit.as_user.
+        def audit_as( user, &block )
+          Audit.as_user( user, &block )
+        end
+
+      end
+    end
+  end
+end