track_changes 1.0.0.pre3 → 1.0.0

data/README.rdoc

@@ -3,6 +3,33 @@
 TrackChanges is a Rails engine to facilitate tracking changes made to your
 models.
 
+== Release Notes
+
+Version 1.0 is a major change. This gem has been re-written from scratch as a
+Rails 3.0 engine. You will need to take additional steps to upgrade from
+versions prior to 1.0.
+
+=== General Upgrade Notes:
+
+* You no longer need to <tt>include TrackChanges</tt> in your controllers.
+* Additional arguments such as <tt>:only</tt>, and <tt>:except</tt> are no longer accepted in controllers
+* Any model that specifies <tt>track_changes</tt> will always have an Audit created on updates.
+* The revert capability is no longer available. This feature may return in the future.
+
+=== Specific Upgrade Instructions:
+
+* Update your <tt>Gemfile</tt>
+* Remove all occurences of <tt>include TrackChanges</tt> from your controllers
+* Remove your existing Audit class in <tt>RAILS_ROOT/app/models</tt>, this class is now part of the engine
+* Modify any calls to <tt>track_changes</tt> to remove additional arguments
+* Modify your <tt>RAILS_ROOT/config/track_changes_configuration</tt> to the following:
+
+    # Use whatever call you need to find the default user to be used if
+    # current_user is not set in your controller.
+    TrackChanges::Configuration::DEFAULT_USER_FINDER = Proc.new {
+      User.where(:login => "admin")
+    }
+
 == Why?
 
 I originally looked at the available auditing solutions and it appeared that

data/VERSION.yml

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

data/lib/track_changes/action_controller.rb

@@ -1,33 +1,33 @@
 module TrackChanges
-  module ActionController #:nodoc:
-    def self.included(base)
-      base.send :extend, ClassMethods
-    end
+  module ActionController
 
-    module ClassMethods
+    # Sets up an around filter to assign the controller's <tt>current_user</tt>
+    # to the given model names that are already set as instance variables in a
+    # prior <tt>before_filter</tt>.
+    #
+    # Example:
+    #
+    #  track_changes :post
+    #  track_changes :post, :post_attribute
+    #
+    # Currently does not work if the instance variable is anything except
+    # an model that has <tt>current_user</tt> accessors.
+    def track_changes models, *args
+      models_to_track = []
+      models_to_track << models
+      if args.kind_of?(Array)
+        models_to_track << args
+      end
+      models_to_track.flatten!
 
-      # Sets up an around filter to assign the controller's <tt>current_user</tt>
-      # to the given model names that are already set as instance variables in a
-      # prior <tt>before_filter</tt>.
-      #
-      # Example:
-      #
-      #  track_changes :post
-      #  track_changes :post, :post_attribute
-      #
-      # Currently does not work if the instance variable is anything except
-      # an model that has <tt>current_user</tt> accessors.
-      def track_changes models
-        models_to_track = [models].flatten
-        define_method(:__track_changes_to_models) { models_to_track }
+      define_method(:__track_changes_to_models) { models_to_track }
 
-        self.class_eval do
-          helper :audits
-          before_filter TrackChanges::CurrentUserFilter
-        end
+      self.class_eval do
+        helper :audits
+        before_filter TrackChanges::CurrentUserFilter
       end
     end
   end
 end
 
-ActionController::Base.send :include, TrackChanges::ActionController
+ActionController::Base.extend TrackChanges::ActionController

data/lib/track_changes/active_record.rb

@@ -1,28 +1,22 @@
 module TrackChanges
-  module ActiveRecord #:nodoc:
-    def self.included(base)
-      base.send :extend, ClassMethods
-    end
-
-    module ClassMethods
+  module ActiveRecord
 
-      # Enables auditing of all changes to an ActiveRecord model. Sets up an
-      # around filter that will create an Audit for the models <tt>changes</tt>
-      # attribute.
-      #
-      # In addition, this will also define a <tt>attr_accessor</tt> for <tt>current_user</tt>.
-      def track_changes
-        send :include, TrackChanges::CurrentUser
-        send :include, TrackChanges::Changes
+    # Enables auditing of all changes to an ActiveRecord model. Sets up an
+    # around filter that will create an Audit for the models <tt>changes</tt>
+    # attribute.
+    #
+    # In addition, this will also define a <tt>attr_accessor</tt> for <tt>current_user</tt>.
+    def track_changes
+      send :include, TrackChanges::CurrentUser
+      send :include, TrackChanges::Changes
 
-        self.class_eval do
-          has_many :audits, :as => :audited
+      self.class_eval do
+        has_many :audits, :as => :audited
 
-          around_save TrackChanges::AroundSave
-        end
+        around_update TrackChanges::AroundUpdate
       end
     end
   end
 end
 
-ActiveRecord::Base.send :include, TrackChanges::ActiveRecord
+ActiveRecord::Base.extend TrackChanges::ActiveRecord

data/lib/track_changes/{around_save.rb → around_update.rb}

@@ -1,6 +1,6 @@
 module TrackChanges
-  class AroundSave #:nodoc:
-    def self.around_save(model)
+  class AroundUpdate #:nodoc:
+    def self.around_update(model)
       model.send(:track_changes_get_changes)
       yield
       model.send(:track_changes_save_audit)

data/lib/track_changes/changes.rb

@@ -8,6 +8,8 @@ module TrackChanges
     end
 
     def track_changes_save_audit
+      return unless self.id
+
       user = current_user || TrackChanges::Configuration::get_default_user
       Audit.create_changes(self, @__model_changes, current_user)
     end

data/lib/track_changes/current_user_filter.rb

@@ -1,5 +1,5 @@
 module TrackChanges
-  module CurrentUserFilter #:nodoc:
+  class CurrentUserFilter #:nodoc:
     def self.filter(controller)
       controller.send(:__track_changes_to_models).each do |model|
         instance = controller.instance_variable_get("@#{model}")

data/lib/track_changes.rb

@@ -4,7 +4,7 @@ end
 
 require 'track_changes/action_controller'
 require 'track_changes/active_record'
-require 'track_changes/around_save'
+require 'track_changes/around_update'
 require 'track_changes/changes'
 require 'track_changes/configuration'
 require 'track_changes/current_user'

data/test/action_controller_test.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/test_helper'
+class ActionControllerTest < Test::Unit::TestCase
+  class ActionControllerMock
+    def self.helper(args)
+      @__helper = args
+    end
+
+    def self.helper_value
+      @__helper
+    end
+
+    def self.before_filter(args)
+      @__before_filter = args
+    end
+
+    def self.before_filter_value
+      @__before_filter
+    end
+
+    extend TrackChanges::ActionController
+  end
+
+
+  def setup
+    @action_controller = ActionControllerMock.new
+  end
+
+  def test_should_add_track_changes_class_method
+    assert ActionControllerMock.respond_to?(:track_changes)
+  end
+
+  def test_should_set_a_before_filter
+    ActionControllerMock.class_eval do
+      track_changes :some_var
+    end
+
+    assert ActionControllerMock.before_filter_value.respond_to?(:filter)
+  end
+
+  def test_should_accept_multiple_arguments
+    assert_nothing_raised do
+      ActionControllerMock.class_eval do
+        track_changes :foo
+      end
+      
+      ActionControllerMock.class_eval do
+        track_changes :foo, :bar
+      end
+
+      ActionControllerMock.class_eval do
+        track_changes :foo, :bar, :baz
+      end
+    end
+  end
+
+  def test_should_define_a_method_that_returns_interested_vars
+    ActionControllerMock.class_eval do
+      track_changes :foo, :bar, :baz
+    end
+
+    interesting_vars = ActionControllerMock.new.__track_changes_to_models
+    assert interesting_vars.include?(:foo), interesting_vars.inspect
+    assert interesting_vars.include?(:bar), interesting_vars.inspect
+    assert interesting_vars.include?(:baz), interesting_vars.inspect
+  end
+
+  def test_should_include_helpers
+    ActionControllerMock.class_eval do
+      track_changes :foo
+    end
+
+    assert_equal :audits, ActionControllerMock.helper_value
+  end
+end

data/test/current_user_test.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/test_helper'
+class CurrentUserTest < Test::Unit::TestCase
+
+  class ClassUnderTest
+  end
+
+  def test_should_add_current_user_accessor_when_included
+    ClassUnderTest.send(:include, TrackChanges::CurrentUser)
+
+    class_under_test = ClassUnderTest.new
+
+    assert class_under_test.respond_to?(:current_user)
+    assert class_under_test.respond_to?(:current_user=)
+  end
+end

data/test/functional/posts_controller_test.rb

@@ -13,7 +13,7 @@ class PostsControllerTest < ActionController::TestCase
     @post.reload
     expected_change = { "title" => ["Hello", "Changed"]}
     assert_equal "Changed", @post.title
-    assert_equal 2, @post.audits.count
+    assert_equal 1, @post.audits.count
     assert_equal expected_change, @post.audits.desc.first.change_set
   end
 

data/test/railsapp/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'rails', '3.0.0.rc'
+gem 'rails', '~> 3.0.0'
 
 if defined?(JRUBY_VERSION)
   gem 'activerecord-jdbc-adapter'

data/test/railsapp/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: C:/Users/Matt/Code/track_changes
   specs:
-    track_changes (1.0.0.pre2)
+    track_changes (1.0.0.pre3)
 
 GEM
   remote: http://rubygems.org/
@@ -51,7 +51,7 @@ GEM
     mime-types (1.16)
     polyglot (0.3.1)
     rack (1.2.1)
-    rack-mount (0.6.9)
+    rack-mount (0.6.11)
       rack (>= 1.0.0)
     rack-test (0.5.4)
       rack (>= 1.0)
@@ -72,7 +72,7 @@ GEM
     thor (0.14.0)
     treetop (1.4.8)
       polyglot (>= 0.3.1)
-    tzinfo (0.3.22)
+    tzinfo (0.3.23)
 
 PLATFORMS
   java
@@ -80,5 +80,5 @@ PLATFORMS
 DEPENDENCIES
   activerecord-jdbc-adapter
   activerecord-jdbcsqlite3-adapter
-  rails (= 3.0.0.rc)
+  rails (~> 3.0.0)
   track_changes!