track_changes 0.4.1 → 0.5.0

data/README.rdoc

@@ -34,6 +34,18 @@ Example Audited class:
     has_many :audits, :as => :audited
   end
 
+You can also tweak some of the defaults by creating an initializer
+in <tt>RAILS_ROOT/config/initializers/track_changes_configuration.rb</tt>
+and calling TrackChanges::Initializer.instance which yields a
+TrackChanges::Configuration object:
+
+  # These are the defaults anyways
+  TrackChanges::Initializer.instance do |c|
+    c.audit_assocation = :audits        # Calls <tt>create!</tt> on this association method
+    c.current_user     = :current_user  # Controller is sent this method to obtain current user.
+    c.ignore_nil       = true           # Don't crash if a model is nil.
+  end
+
 == Controller Example
 
 In this example, after the `update` action is called,

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
-:minor: 4
-:patch: 1
+:minor: 5
+:patch: 0
 :build: 

data/lib/track_changes/audit_filter.rb

@@ -25,13 +25,21 @@ module TrackChanges
 
       self.cached_models = {}
       self.models = models
+
+      @audit_accessor = options[:audit_accessor] || :audits
+      @current_user   = options[:current_user] || :current_user
+      @ignore_nils = if options[:ignore_nil] == false
+        false
+      else
+        true
+      end
     end
 
     def before(controller)
       self.models.each do |model|
         instance_variable_symbol = "@#{model}".to_sym
         instance = controller.instance_variable_get(instance_variable_symbol)
-        next if instance.nil?
+        next if instance.nil? && @ignore_nils
 
         self.cached_models[instance_variable_symbol] = instance.clone
       end
@@ -45,7 +53,7 @@ module TrackChanges
         changes = changes_between(new_instance, original_instance)
 
         unless changes.empty?
-          audit = new_instance.audits.create!(:user => controller.send(:current_user), :change_set => changes)
+          audit = new_instance.send(@audit_accessor).create!(:user => controller.send(@current_user), :change_set => changes)
         end
       end
     end

data/lib/track_changes/class_methods.rb

@@ -34,10 +34,16 @@ module TrackChanges
     #   # Create an audit of changes made to @order during the <tt>:update</tt> or <tt>:process</tt> actions.
     #   track_changes :order, :only => [:update, :process]
     def track_changes(*args)
-      models = args.flatten
       options = args.extract_options!
+      models = args.flatten
       options = [:only => :update] if options.empty?
-      audit_filter = AuditFilter.new(models)
+
+      configuration = TrackChanges::Initializer.instance.configuration
+
+      audit_filter = AuditFilter.new(models,
+                                     :audit_accessor => configuration.audit_association,
+                                     :current_user   => configuration.current_user,
+                                     :ignore_nil     => configuration.ignore_nil)
       around_filter(audit_filter, options)
     end
 

data/lib/track_changes/configuration.rb

@@ -0,0 +1,38 @@
+module TrackChanges
+  class Configuration
+    # The association used to create an audit. Defaults to
+    # <tt>:audits</tt>
+    #
+    # Example:
+    #   :audits  # => Call model.audits.create
+    #   :changes # => Call model.changes.create
+    attr_accessor :audit_association
+
+    # The controller method called to obtain the current user.
+    # Defaults to <tt>:current_user</tt>
+    attr_accessor :current_user
+
+    # Ignore if the audited item is nil. Defaults to <tt>true</tt>.
+    attr_accessor :ignore_nil
+
+    def initialize
+      self.audit_association = default_audit_association
+      self.current_user      = default_current_user
+      self.ignore_nil        = default_ignore_nil
+    end
+
+    private
+
+    def default_audit_association
+      :audits
+    end
+
+    def default_current_user
+      :current_user
+    end
+
+    def default_ignore_nil
+      true
+    end
+  end
+end

data/lib/track_changes/initializer.rb

@@ -0,0 +1,18 @@
+module TrackChanges
+  class Initializer
+    attr_accessor :configuration
+
+    include Singleton
+
+    class << self
+      alias_method :__tr_instance, :instance
+
+      def instance(&block)
+        obj = __tr_instance
+        obj.configuration ||= Configuration.new
+        yield obj.configuration if block_given?
+        obj
+      end
+    end
+  end
+end

data/lib/track_changes.rb

@@ -1,4 +1,6 @@
 require 'track_changes/result'
+require 'track_changes/configuration'
+require 'track_changes/initializer'
 require 'track_changes/audit_filter'
 require 'track_changes/filter'
 require 'track_changes/instance_methods'

data/test/rails_root/app/controllers/posts_controller.rb

@@ -3,7 +3,7 @@ require 'track_changes'
 class PostsController < ApplicationController
   include TrackChanges
   before_filter :find_post
-  track_changes :post
+  track_changes :post, :only => :update
 
   def show
     render :text => @post.inspect

data/test/rails_root/config/initializers/track_changes_setup.rb

@@ -0,0 +1,8 @@
+require 'track_changes'
+
+TrackChanges::Initializer.instance do |config|
+  config.audit_association = :audits
+  config.current_user      = :current_user
+  config.ignore_nil        = true
+end
+