acts_as_audited_customized 1.2.2 → 1.3.1

data/README

@@ -7,7 +7,7 @@ The purpose of this fork is to store both the previous values and the changed va
 == Installation
 
 * acts_as_audited can be installed as a gem:
-    
+
     # config/environment.rb
     config.gem 'acts_as_audited', :lib => false, :source => 'http://gemcutter.org'
 
@@ -26,7 +26,7 @@ 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 outside of a web request, you can use <tt>as_user</tt>:
@@ -44,6 +44,10 @@ If your model declares +attr_accessible+ after +acts_as_audited+, you need to se
     attr_accessible :name
   end
 
+12/21/10:
+
+There have been no tests written for any of the new features.  There's just been no time.
+
 == Compatability
 
 acts_as_audited works with Rails 2.1 or later.

data/VERSION

@@ -1 +1 @@
-1.2.2
+1.3.1

data/lib/acts_as_audited.rb

@@ -37,6 +37,16 @@ module CollectiveIdea #:nodoc:
       mattr_accessor :human_model
       @@human_model = :user
 
+      # Any additional attributes you wish your model to write to.  Default: []
+      mattr_accessor :additional_attributes
+      @@additional_attributes = []
+
+      # Whether or not you want to use the Observer to set current_<%= human_model %>.
+      # Set this to :false if your models have access to the current_<%= human_model %> method.
+      # Default :true
+      mattr_accessor :use_observer
+      @@use_observer = :true
+
       class << self
         # Call this method to modify defaults in your initializers.
         #
@@ -46,6 +56,36 @@ module CollectiveIdea #:nodoc:
         #   end
         def configure
           yield self
+
+          modify_audit_model
+        end
+
+        def modify_audit_model
+          Audit.class_eval do
+            belongs_to @@human_model, :polymorphic => true
+
+            [@@additional_attributes].flatten.each do |attrib|
+              belongs_to attrib, :class_name => @@human_model.to_s.classify, :foreign_key => "#{attrib}_id"
+            end
+
+            alias_method :user_as_model=, "#{@@human_model}=".to_sym
+            alias_method "#{@@human_model}=".to_sym, :user_as_string=
+
+            alias_method :user_as_model, @@human_model
+            alias_method @@human_model, :user_as_string
+
+            def set_audit_user
+              self.send(@@human_model, Thread.current[:acts_as_audited_user]) if Thread.current[:acts_as_audited_user]
+              nil # prevent stopping callback chains
+            end
+          end
+
+          if @@use_observer
+            ::ActionController::Base.class_eval do
+              cache_sweeper :audit_sweeper
+            end
+            Audit.add_observer(AuditSweeper.instance)
+          end
         end
 
         def included(base) # :nodoc:
@@ -81,10 +121,14 @@ module CollectiveIdea #:nodoc:
           # don't allow multiple calls
           return if self.included_modules.include?(CollectiveIdea::Acts::Audited::InstanceMethods)
 
+          reserved_options = [:protect, :on, :create, :update, :destroy, :only, :except, :if, :unless]
           options = {:protect => accessible_attributes.nil?}.merge(options)
 
           class_inheritable_reader :non_audited_columns
           class_inheritable_reader :auditing_enabled
+          class_inheritable_reader :manually_set_columns
+          class_inheritable_reader :if_condition
+          class_inheritable_reader :unless_condition
 
           if options[:only]
             except = self.column_names - options[:only].flatten.map(&:to_s)
@@ -94,6 +138,9 @@ module CollectiveIdea #:nodoc:
             except |= Array(options[:except]).collect(&:to_s) if options[:except]
           end
           write_inheritable_attribute :non_audited_columns, except
+          write_inheritable_attribute :manually_set_columns, options.reject {|k, v| reserved_options.include?(k) }
+          write_inheritable_attribute :if_condition, options.delete(:if)
+          write_inheritable_attribute :unless_condition, options.delete(:unless)
 
           has_many :audits, :as => :auditable, :order => "#{Audit.quoted_table_name}.version"
           attr_protected :audit_ids if options[:protect]
@@ -187,6 +234,43 @@ module CollectiveIdea #:nodoc:
           end
         end
 
+        def evaluate(value)
+          case value
+          when Proc
+            value.arity > 0 ? value.call(self) : value.call
+          else
+            value
+          end
+        end
+
+        def on_behalf_of_result
+          evaluate(on_behalf_of_call)
+        end
+
+        def set_manually_set_columns
+          manually_set_columns.inject(set_current_user) do |attrs, (attrib, value)|
+            attrs[attrib] = evaluate(value)
+            attrs
+          end
+        end
+
+        def set_current_user
+          method = "current_#{CollectiveIdea::Acts::Audited.human_model}"
+          !CollectiveIdea::Acts::Audited.use_observer && self.class.respond_to?(method) ? { CollectiveIdea::Acts::Audited.human_model => self.class.send(method) } : {}
+        end
+
+        def eval_condition(condition)
+          evaluate(condition)
+        end
+
+        def eval_if_condition
+          !if_condition || eval_condition(if_condition)
+        end
+
+        def eval_unless_condition
+          !unless_condition || !eval_condition(unless_condition)
+        end
+
         def audits_to(version = nil)
           if version == :previous
             version = if self.version
@@ -215,7 +299,8 @@ module CollectiveIdea #:nodoc:
         end
 
         def write_audit(attrs)
-          self.audits.create attrs if auditing_enabled
+          attrs = attrs.merge(set_manually_set_columns)
+          self.audits.create attrs if auditing_enabled && eval_if_condition && eval_unless_condition
         end
       end # InstanceMethods
 
@@ -251,7 +336,6 @@ module CollectiveIdea #:nodoc:
         def audit_as( user, &block )
           Audit.as_user( user, &block )
         end
-
       end
     end
   end

data/{generators/audit_model/templates/model.rb → lib/acts_as_audited/audit.rb}

@@ -3,16 +3,17 @@ require 'set'
 # Audit saves the changes to ActiveRecord models.  It has the following attributes:
 #
 # * <tt>auditable</tt>: the ActiveRecord model that was changed
-# * <tt><%= human_model %></tt>: the <%= human_model %> that performed the change; a string or an ActiveRecord model
+# * <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 :<%= human_model %>, :polymorphic => true
+  # belongs_to :user, :polymorphic => true
+  # belongs_to :on_behalf_of, :class_name => 'User', :foreign_key => 'on_behalf_of_id'
 
-  before_create :set_version_number, :set_audit_<%= human_model %>
+  before_create :set_version_number, :set_audit_user
 
   serialize :changes
 
@@ -28,19 +29,19 @@ class Audit < ActiveRecord::Base
     # by +user+. This method is hopefully threadsafe, making it ideal
     # for background operations that require audit information.
     def as_user(user, &block)
-      Thread.current[:acts_as_audited_<%= human_model %>] = user
+      Thread.current[:acts_as_audited_user] = user
       yield
-      Thread.current[:acts_as_audited_<%= human_model %>] = nil
+      Thread.current[:acts_as_audited_user] = nil
     end
 
-    def manual_audit(<%= human_model %>, action, auditable = nil)
+    def manual_audit(user, action, on_behalf_of = nil, auditable = nil)
       attribs = { :action => action }
 
-      case <%= human_model %>
+      case user
       when ActiveRecord::Base
-        attribs[:<%= human_model %>] = <%= human_model %>
+        attribs[CollectiveIdea::Acts::Audited.human_model] = user
       when String
-        attribs[:username] = <%= human_model %>
+        attribs[:username] = user
       end
 
       case auditable
@@ -50,26 +51,27 @@ class Audit < ActiveRecord::Base
         attribs[:auditable_type] = auditable
       end
 
+      attribs[:on_behalf_of] = on_behalf_of if on_behalf_of
       Audit.create attribs
     end
   end
 
-  # Allows <%= human_model %> to be set to either a string or an ActiveRecord object
-  def <%= human_model %>_as_string=(<%= human_model %>) #:nodoc:
+  # Allows user to be set to either a string or an ActiveRecord object
+  def user_as_string=(user) #:nodoc:
     # reset both either way
-    self.<%= human_model %>_as_model = self.username = nil
-    <%= human_model %>.is_a?(ActiveRecord::Base) ?
-      self.<%= human_model %>_as_model = <%= human_model %> :
-      self.username = <%= human_model %>
+    self.user_as_model = self.username = nil
+    user.is_a?(ActiveRecord::Base) ?
+      self.user_as_model = user :
+      self.username = user
   end
-  alias_method :<%= human_model %>_as_model=, :<%= human_model %>=
-  alias_method :<%= human_model %>=, :<%= human_model %>_as_string=
+  # alias_method :user_as_model=, :user=
+  # alias_method :user=, :user_as_string=
 
-  def <%= human_model %>_as_string #:nodoc:
-    self.<%= human_model %>_as_model || self.username
+  def user_as_string #:nodoc:
+    self.user_as_model || self.username
   end
-  alias_method :<%= human_model %>_as_model, :<%= human_model %>
-  alias_method :<%= human_model %>, :<%= human_model %>_as_string
+  # alias_method :user_as_model, :user
+  # alias_method :user, :user_as_string
 
   def revision
     clazz = auditable_type.constantize
@@ -131,9 +133,9 @@ private
     self.version = max + 1
   end
 
-  def set_audit_<%= human_model %>
-    self.<%= human_model %> = Thread.current[:acts_as_audited_<%= human_model %>] if Thread.current[:acts_as_audited_<%= human_model %>]
-    nil # prevent stopping callback chains
-  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

@@ -19,19 +19,22 @@ module CollectiveIdea #:nodoc:
   end
 end
 
+ActionController::Base.class_eval do
+  extend CollectiveIdea::ActionController::Audited
+end
+
 class AuditSweeper < ActionController::Caching::Sweeper #:nodoc:
+  def current_user_method
+    "current_#{CollectiveIdea::Acts::Audited.human_model}".to_sym
+  end
+
   def before_create(audit)
-    audit.send("#{CollectiveIdea::Acts::Audited.human_model}=", current_user) unless audit.send(CollectiveIdea::Acts::Audited.human_model)
+    raise "Got here"
+    audit.send("#{CollectiveIdea::Acts::Audited.human_model}=".to_sym, current_user) unless audit.send(CollectiveIdea::Acts::Audited.human_model)
   end
 
   def current_user
-    method = "current_#{CollectiveIdea::Acts::Audited.human_model}"
-    controller.send(method) if controller.respond_to?(method, true)
+    controller.send current_user_method if controller.respond_to?(current_user_method, 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

@@ -1,3 +1,4 @@
+require 'acts_as_audited/audit'
 require 'acts_as_audited'
 
 ActiveRecord::Base.send :include, CollectiveIdea::Acts::Audited

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_audited_customized
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 1
-  - 2
-  - 2
-  version: 1.2.2
+  - 3
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -77,14 +77,12 @@ files:
 - README
 - Rakefile
 - VERSION
-- generators/audit_model/USAGE
-- generators/audit_model/audit_model_generator.rb
-- generators/audit_model/templates/model.rb
 - 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

data/generators/audit_model/USAGE

@@ -1,9 +0,0 @@
-Description:
-	The audit model generator creates the Audit model in app/models/ associating it with the correct "human" class ("user" by default).
-
-Example:
-    ./script/generate audit_model Person
-
-    This will create the Audit model in app/models/ associating it to the Person model.
-
-    You must generate the migration using the same "human" class.

data/generators/audit_model/audit_model_generator.rb

@@ -1,20 +0,0 @@
-class AuditModelGenerator < Rails::Generator::NamedBase
-  def initialize(runtime_args, runtime_options = {})
-    runtime_args << 'user' if runtime_args.empty?
-    super
-    @human_model = runtime_args[0] ? runtime_args[0].underscore : 'user'
-  end
-
-  def manifest
-    record do |m|
-      m.directory(File.join('app', 'models'))
-      m.template('model.rb', "app/models/audit.rb", :assigns => { :human_model => @human_model })
-    end
-  end
-
-  protected
-
-  def banner
-    "Usage: #{$0} audit_model [human_model_name]"
-  end
-end