track_changes 0.5.0 → 0.5.1

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2008-2010 Matt Haley
-
-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.
+Copyright (c) 2008-2010 Matt Haley
+
+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.rdoc

@@ -1,87 +1,87 @@
-= track_changes
-
-TrackChanges is a Rails plugin to facilitate tracking
-changes made to an ActiveRecord model in your
-Controller actions.
-
-== Why?
-
-I originally looked at the available auditing solutions
-and it appeared that most of them were not thread-safe.
-
-== Installation
-
-  gem install track_changes
-
-== Configuration
-
-You need to have an Audit class that has a polymorphic
-<tt>belongs_to</tt> association to <tt>:audited</tt>. In
-addition, the Audit model must have a <tt>user</tt>
-attribute, and your controllers must respond to
-<tt>current_user</tt>.
-
-Example Audit class:
-
-  class Audit < ActiveRecord::Base
-    belongs_to :audited, :polymorphic => true
-    serialize :change_set
-  end
-
-Example Audited class:
-
-  class Post < ActiveRecord::Base
-    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,
-the `@post` will be compared to a previous version, and
-if there are any changes, an audit will be created.
-
-  class PostController < ApplicationController
-    include TrackChanges
-
-    before_filter :get_post, :except => [:index, :new]
-
-    # specify a single model
-    track_changes :post
-
-    # you can also specify multiple models
-    #track_changes :post1, :post2, ...
-    
-    def update
-      if @post.update_attributes(params[:post])
-        flash[:notice] = "Success."
-      else
-        render :action => "edit"
-      end
-    end
-
-    # Normal controller actions
-    # ...
-
-    protected
-
-    def get_post
-      @post = Post.find(params[:id])
-    end
-  end
-
-
-== COPYRIGHT
-
-Copyright (c) 2008-2010 Matt Haley. See LICENSE for details.
+= track_changes
+
+TrackChanges is a Rails plugin to facilitate tracking
+changes made to an ActiveRecord model in your
+Controller actions.
+
+== Why?
+
+I originally looked at the available auditing solutions
+and it appeared that most of them were not thread-safe.
+
+== Installation
+
+  gem install track_changes
+
+== Configuration
+
+You need to have an Audit class that has a polymorphic
+<tt>belongs_to</tt> association to <tt>:audited</tt>. In
+addition, the Audit model must have a <tt>user</tt>
+attribute, and your controllers must respond to
+<tt>current_user</tt>.
+
+Example Audit class:
+
+  class Audit < ActiveRecord::Base
+    belongs_to :audited, :polymorphic => true
+    serialize :change_set
+  end
+
+Example Audited class:
+
+  class Post < ActiveRecord::Base
+    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,
+the `@post` will be compared to a previous version, and
+if there are any changes, an audit will be created.
+
+  class PostController < ApplicationController
+    include TrackChanges
+
+    before_filter :get_post, :except => [:index, :new]
+
+    # specify a single model
+    track_changes :post
+
+    # you can also specify multiple models
+    #track_changes :post1, :post2, ...
+    
+    def update
+      if @post.update_attributes(params[:post])
+        flash[:notice] = "Success."
+      else
+        render :action => "edit"
+      end
+    end
+
+    # Normal controller actions
+    # ...
+
+    protected
+
+    def get_post
+      @post = Post.find(params[:id])
+    end
+  end
+
+
+== COPYRIGHT
+
+Copyright (c) 2008-2010 Matt Haley. See LICENSE for details.

data/TODO

@@ -1,4 +1,4 @@
-Track Changes TODO List
-=======================
-
-* Check for ivars
+Track Changes TODO List
+=======================
+
+* Check for ivars

data/VERSION.yml

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

data/lib/track_changes/audit_filter.rb

@@ -1,69 +1,69 @@
-module TrackChanges
-  # An around filter that will audit changes to your models.
-  #
-  # Example:
-  #   class OrdersController < ApplicationController
-  #     before_filter :find_order, :except => [:index, :new, :create]
-  #     around_filter AuditFilter.new(:order), :only => :update
-  #
-  #     def update
-  #       ...
-  #     end
-  #
-  #     protected
-  #
-  #     def find_order
-  #       @order = Order.find(params[:id])
-  #     end
-  #   end
-  class AuditFilter
-    attr_accessor :cached_models, :models
-
-    def initialize(*models)
-      models.flatten!
-      options = models.extract_options!
-
-      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? && @ignore_nils
-
-        self.cached_models[instance_variable_symbol] = instance.clone
-      end
-    end
-
-    def after(controller)
-      self.cached_models.each_pair do |instance_variable_symbol, original_instance|
-        new_instance = controller.instance_variable_get(instance_variable_symbol)
-        next if new_instance.changed? # Dirty objects didn't save
-
-        changes = changes_between(new_instance, original_instance)
-
-        unless changes.empty?
-          audit = new_instance.send(@audit_accessor).create!(:user => controller.send(@current_user), :change_set => changes)
-        end
-      end
-    end
-
-    private
-
-    def changes_between(new, old)
-      clone = old.clone
-      clone.attributes = new.attributes
-      clone.changes
-    end
-  end
-end
+module TrackChanges
+  # An around filter that will audit changes to your models.
+  #
+  # Example:
+  #   class OrdersController < ApplicationController
+  #     before_filter :find_order, :except => [:index, :new, :create]
+  #     around_filter AuditFilter.new(:order), :only => :update
+  #
+  #     def update
+  #       ...
+  #     end
+  #
+  #     protected
+  #
+  #     def find_order
+  #       @order = Order.find(params[:id])
+  #     end
+  #   end
+  class AuditFilter
+    attr_accessor :cached_models, :models
+
+    def initialize(*models)
+      models.flatten!
+      options = models.extract_options!
+
+      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? && @ignore_nils
+
+        self.cached_models[instance_variable_symbol] = instance.clone
+      end
+    end
+
+    def after(controller)
+      self.cached_models.each_pair do |instance_variable_symbol, original_instance|
+        new_instance = controller.instance_variable_get(instance_variable_symbol)
+        next if new_instance.changed? # Dirty objects didn't save
+
+        changes = changes_between(new_instance, original_instance)
+
+        unless changes.empty?
+          audit = new_instance.send(@audit_accessor).create!(:user => controller.send(@current_user), :change_set => changes)
+        end
+      end
+    end
+
+    private
+
+    def changes_between(new, old)
+      clone = old.clone
+      clone.attributes = new.attributes
+      clone.changes
+    end
+  end
+end

data/lib/track_changes/base.rb

@@ -1,9 +1,9 @@
-require 'track_changes/instance_methods'
-require 'track_changes/class_methods'
-
-module TrackChanges
-  def self.included(controller)
-    controller.send(:include, InstanceMethods)
-    controller.extend(ClassMethods)
-  end
-end
+require 'track_changes/instance_methods'
+require 'track_changes/class_methods'
+
+module TrackChanges
+  def self.included(controller)
+    controller.send(:include, InstanceMethods)
+    controller.extend(ClassMethods)
+  end
+end

data/lib/track_changes/class_methods.rb

@@ -1,74 +1,74 @@
-require 'active_support'
-require 'track_changes/filter'
-
-module TrackChanges
-  module ClassMethods
-    # Create an audit of the changes made to a module during a controller action.
-    # Some assumptions are made, primarily that the given models will have a
-    # polymorphic association to an Audit model. An example Audit model:
-    #
-    #   class Audit < ActiveRecord::Base
-    #     belongs_to :audited, :polymorphic => true
-    #     belongs_to :user
-    #     serialize :change_set
-    #   end
-    #
-    #   # Example model that would be audited:
-    #   class Order < ActiveRecord::Base
-    #     has_many :audits, :as => :audited
-    #   end
-    #
-    # ==== Parameters
-    #
-    # * A symbol or many symbols of the name(s) of the instance variable to create audits for.
-    # * An optional hash that will be passed as filter conditions to <tt>around_filter</tt>
-    #
-    # ==== Examples
-    #
-    #   # Create an audit of changes made to @order during the <tt>:update</tt> action.
-    #   track_changes :order
-    #
-    #   # Creates an audit of changes made to @order or @customer during the <tt>:update</tt> action.
-    #   track_changes :order, :customer
-    #
-    #   # 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)
-      options = args.extract_options!
-      models = args.flatten
-      options = [:only => :update] if options.empty?
-
-      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
-
-    # Uses a combination of <tt>before_filter</tt> and <tt>after_filter</tt>
-    # to act on changes made to a module during a controllers <tt>update</tt>
-    # action.
-    #
-    # Parameters:
-    #
-    # * <tt>model</tt>: A symbol of the model instance name to track changes to
-    # * <tt>only_if_changed</tt>: If true, will only yield block if changes is not empty. Defaults to <tt>true</tt>.
-    # * <tt>options</tt>: An options hash the will be supplied to <tt>before_filter</tt> and <tt>after_filter</tt>. Defaults to <tt>:only => :update</tt>.
-    # * <tt>&block</tt>: The supplied block is called with an instance of Result as its parameter.
-    def track_changes_to(models, only_if_changed = true, options = {:only => :update}, &block)
-      warn "[DEPRECATED] track_changes_to is deprecated. Use track_changes instead"
-      append_before_filter(options) do |controller|
-        track_filter = Filter.new(models, only_if_changed, block)
-        controller.track_changes_filter = track_filter
-
-        track_filter.before(controller)
-      end
-
-      append_after_filter(options)do |controller|
-        controller.track_changes_filter.after(controller)
-      end
-    end
-  end
-end
+require 'active_support'
+require 'track_changes/filter'
+
+module TrackChanges
+  module ClassMethods
+    # Create an audit of the changes made to a module during a controller action.
+    # Some assumptions are made, primarily that the given models will have a
+    # polymorphic association to an Audit model. An example Audit model:
+    #
+    #   class Audit < ActiveRecord::Base
+    #     belongs_to :audited, :polymorphic => true
+    #     belongs_to :user
+    #     serialize :change_set
+    #   end
+    #
+    #   # Example model that would be audited:
+    #   class Order < ActiveRecord::Base
+    #     has_many :audits, :as => :audited
+    #   end
+    #
+    # ==== Parameters
+    #
+    # * A symbol or many symbols of the name(s) of the instance variable to create audits for.
+    # * An optional hash that will be passed as filter conditions to <tt>around_filter</tt>
+    #
+    # ==== Examples
+    #
+    #   # Create an audit of changes made to @order during the <tt>:update</tt> action.
+    #   track_changes :order
+    #
+    #   # Creates an audit of changes made to @order or @customer during the <tt>:update</tt> action.
+    #   track_changes :order, :customer
+    #
+    #   # 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)
+      options = args.extract_options!
+      models = args.flatten
+      options = {:only => :update} if options.empty?
+
+      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
+
+    # Uses a combination of <tt>before_filter</tt> and <tt>after_filter</tt>
+    # to act on changes made to a module during a controllers <tt>update</tt>
+    # action.
+    #
+    # Parameters:
+    #
+    # * <tt>model</tt>: A symbol of the model instance name to track changes to
+    # * <tt>only_if_changed</tt>: If true, will only yield block if changes is not empty. Defaults to <tt>true</tt>.
+    # * <tt>options</tt>: An options hash the will be supplied to <tt>before_filter</tt> and <tt>after_filter</tt>. Defaults to <tt>:only => :update</tt>.
+    # * <tt>&block</tt>: The supplied block is called with an instance of Result as its parameter.
+    def track_changes_to(models, only_if_changed = true, options = {:only => :update}, &block)
+      warn "[DEPRECATED] track_changes_to is deprecated. Use track_changes instead"
+      append_before_filter(options) do |controller|
+        track_filter = Filter.new(models, only_if_changed, block)
+        controller.track_changes_filter = track_filter
+
+        track_filter.before(controller)
+      end
+
+      append_after_filter(options)do |controller|
+        controller.track_changes_filter.after(controller)
+      end
+    end
+  end
+end

data/lib/track_changes/configuration.rb

@@ -1,38 +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
+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