acts_as_audited 1.0.2 → 1.1.0

data/README

@@ -21,30 +21,20 @@ The purpose of this fork is to store both the previous values and the changed va
 
 == 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:
+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.
 
-To record a user in the audits when the sweepers are not available, you can use <tt>as_user</tt>:
+To record a user in the audits outside of a web request, you can use <tt>as_user</tt>:
 
-    Audit.as_user( user ) do
+    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.
@@ -54,18 +44,15 @@ If your model declares +attr_accessible+ after +acts_as_audited+, you need to se
     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.
 
+== 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:

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/acts_as_audited.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_audited}
-  s.version = "1.0.2"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brandon Keepers"]
-  s.date = %q{2009-10-29}
+  s.date = %q{2009-11-01}
   s.email = %q{brandon@opensoul.org}
   s.extra_rdoc_files = [
     "LICENSE",

data/lib/acts_as_audited/audit_sweeper.rb

@@ -1,65 +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
 
-      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 || {}
-          end
-
-          class_eval do
-            # prevent observer from being registered multiple times
-            Audit.delete_observer(AuditSweeper.instance)
-            Audit.add_observer(AuditSweeper.instance)      
-            cache_sweeper :audit_sweeper, options
-          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(record)
-    record.user ||= current_user
+  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/lib/acts_as_audited.rb

@@ -82,9 +82,9 @@ module CollectiveIdea #:nodoc:
           attr_protected :audit_ids if options[:protect]
           Audit.audited_class_names << self.to_s
 
-          after_create :audit_create_callback
-          before_update :audit_update_callback
-          after_destroy :audit_destroy_callback
+          after_create  :audit_create
+          before_update :audit_update
+          after_destroy :audit_destroy
 
           attr_accessor :version
 
@@ -200,14 +200,6 @@ module CollectiveIdea #:nodoc:
         def write_audit(attrs)
           self.audits.create attrs if auditing_enabled
         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
@@ -236,22 +228,6 @@ module CollectiveIdea #:nodoc:
           write_inheritable_attribute :auditing_enabled, true
         end
 
-        def disable_auditing_callbacks
-          class_eval do
-            CALLBACKS.each do |attr_name|
-              alias_method "#{attr_name}_callback", :empty_callback
-            end
-          end
-        end
-
-        def enable_auditing_callbacks
-          class_eval do
-            CALLBACKS.each do |attr_name|
-              alias_method "#{attr_name}_callback".to_sym, attr_name
-            end
-          end
-        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.

data/rails/init.rb

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

data/test/acts_as_audited_test.rb

@@ -295,15 +295,6 @@ module CollectiveIdea
             User.without_auditing { User.create(:name => 'Brandon') }
           end.should_not change { Audit.count }
         end
-
-        should "not save an audit when callbacks are disabled" do
-          begin
-            User.disable_auditing_callbacks
-            lambda { create_user }.should_not change { Audit.count }
-          ensure
-            User.enable_auditing_callbacks
-          end
-        end
       end
 
       context "attr_protected and attr_accessible" do

data/test/audit_sweeper_test.rb

@@ -1,8 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/test_helper')
 
 class AuditsController < ActionController::Base
-  audit Company, User
-  
   def audit
     @company = Company.create
     render :nothing => true
@@ -20,11 +18,6 @@ AuditsController.view_paths = [File.dirname(__FILE__)]
 ActionController::Routing::Routes.draw {|m| m.connect ':controller/:action/:id' }
 
 class AuditsControllerTest < ActionController::TestCase
-
-  should "call acts as audited on non audited models" do
-    Company.should be_kind_of(CollectiveIdea::Acts::Audited::SingletonMethods)
-  end
-  
   should "audit user" do
     user = @controller.send(:current_user=, create_user)
     lambda { post :audit }.should change { Audit.count }
@@ -35,5 +28,4 @@ class AuditsControllerTest < ActionController::TestCase
     user = @controller.send(:current_user=, create_user)
     lambda { post :update_user }.should_not change { Audit.count }
   end
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_audited
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-29 00:00:00 -04:00
+date: 2009-11-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency