smajn-track_changes 0.2.1 → 0.3.0

data/README

@@ -2,7 +2,8 @@
 
 TrackChanges is a Rails plugin to facilitate tracking
 changes made to an ActiveRecord model in your
-Controller#update actions.
+Controller#update actions. By default, the block is
+only called if the changes hash is not empty.
 
 A TrackChanges::Filter is instantiated on each run of the <tt>before_filter</tt>
 so it should be thread-safe.

data/TODO

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

data/VERSION.yml

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

data/lib/track_changes/class_methods.rb

@@ -9,11 +9,12 @@ module TrackChanges
     # 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, options = {:only => :update}, &block)
+    def track_changes_to(models, only_if_changed = true, options = {:only => :update}, &block)
       append_before_filter(options) do |controller|
-        track_filter = Filter.new(models, block)
+        track_filter = Filter.new(models, only_if_changed, block)
         controller.track_changes_filter = track_filter
 
         track_filter.before(controller)

data/lib/track_changes/filter.rb

@@ -4,9 +4,10 @@ module TrackChanges
   class Filter
     attr_accessor :call_proc, :changes, :model, :original
 
-    def initialize(model, call_proc)
+    def initialize(model, yield_only_changed, call_proc)
       @call_proc = call_proc
       @model = model
+      @yield_only_changed = yield_only_changed
       @changes = []
       @original = []
     end
@@ -17,11 +18,14 @@ module TrackChanges
 
     def after(controller)
       cur_model = controller.instance_variable_get("@#{@model}")
-      # If changed? returns true, then the update didn't success.
+      # If changed? returns true, then the update didn't succeed.
       unless cur_model.changed?
         @changes = changes_between(@original, cur_model)
-        @call_proc.call(Result.new(@model, controller, @changes))
+        unless @yield_only_changed && @changes.empty?
+          @call_proc.call(Result.new(@model, controller, @changes))
+        end
       end
+      nil
     end
 
     private

data/test/class_methods_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class ClassMethodsTest < Test::Unit::TestCase
+  include TrackChanges::ClassMethods
+
+  context "a ClassMethods module" do
+    context "when track_changes_to method called" do
+      setup { track_changes_to(:something) {} }
+
+      should "call append_before_filter" do
+        assert @before_filter
+      end
+
+      should "call append_after_filter" do
+        assert @after_filter
+      end
+    end
+  end
+
+  protected
+
+  def append_before_filter(options = {}, &block)
+    @before_filter = block
+  end
+
+  def append_after_filter(options = {}, &block)
+    @after_filter = block
+  end
+end

data/test/filter_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+class FilterTest < Test::Unit::TestCase
+  context "a Filter instance" do
+    setup do
+      @controller = mock('@controller')
+      @model = mock('@model')
+      @proc_result = nil
+      @proc = Proc.new { |value| @proc_result = value }
+
+      @filter = TrackChanges::Filter.new(:model, true, @proc)
+    end
+
+    should "set @original when method before called" do
+      @model.expects(:clone).returns(mock('@model cloned', :my_mock? => true))
+      @controller.expects(:instance_variable_get).returns(@model)
+      @filter.before(@controller)
+
+      assert @filter.original.my_mock?
+    end
+
+    should "return a Result when after called" do
+      @filter.original = mock('original', :attributes= => {"attr" => "new"},
+                                          :changes => {"attr" => ["old", "new"]})
+      @new_model       = mock('new_model', :attributes => {"attr" => "new"},
+                                           :changed? => false)
+
+      @controller.expects(:instance_variable_get).once.returns(@new_model)
+
+      @filter.after(@controller)
+      assert @proc_result.is_a?(TrackChanges::Result)
+      assert_equal({"attr" => ["old", "new"]}, @proc_result.changes)
+    end
+
+    context "when yield_only_changed is true" do
+      setup do
+        @proc_result = nil
+        @filter = TrackChanges::Filter.new(:model, true, @proc)
+      end
+
+      should "not call block when method after called and changes is empty" do
+        @filter.original = mock('original', :attributes= => {"attr" => "new"},
+                                            :changes => {})
+        @new_model       = mock('new_model', :attributes => {"attr" => "new"},
+                                             :changed? => false)
+
+        @controller.expects(:instance_variable_get).once.returns(@new_model)
+
+        @filter.after(@controller)
+        assert_nil @proc_result
+      end
+    end
+
+    context "when yield_only_changed is false" do
+      setup do
+        @proc_result = nil
+        @filter = TrackChanges::Filter.new(:model, false, @proc)
+      end
+
+      should "call block when method after called and changes is empty" do
+        @filter.original = mock('original', :attributes= => {"attr" => "new"},
+                                            :changes => {})
+        @new_model       = mock('new_model', :attributes => {"attr" => "new"},
+                                             :changed? => false)
+
+        @controller.expects(:instance_variable_get).once.returns(@new_model)
+
+        @filter.after(@controller)
+        assert_not_nil @proc_result
+      end
+    end
+  end
+end

data/test/result_test.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ResultTest < Test::Unit::TestCase
+  context "a Result instance" do
+    setup do
+      @controller = mock()
+      @changes = { "attr" => ["old", "new"] }
+
+      @filter = TrackChanges::Result.new(:model, @controller, @changes)
+    end
+
+    should "define given symbol as method" do
+      @controller.expects(:instance_variable_get).with() {|v| v == "@model"}.returns(:ivar_result)
+      assert_equal :ivar_result, @filter.model
+    end
+
+    should "send method_missing calls to controller" do
+      @controller.expects(:bogus_method).returns(:got_it)
+      assert_equal :got_it, @filter.bogus_method
+    end
+
+    should "get @current_user from controller" do
+      @controller.expects(:instance_variable_get).with() {|v| v == "@current_user"}.returns(:ivar_result)
+      assert_equal :ivar_result, @filter.current_user
+    end
+
+    should "return changes" do
+      assert_equal @changes, @filter.changes
+    end
+
+    should "return controller" do
+      assert_equal @controller, @filter.controller
+    end
+  end
+end

data/test/test_helper.rb

@@ -2,9 +2,13 @@ require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 require 'mocha'
+require 'ostruct'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'track_changes'
 
 class Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smajn-track_changes
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Matt Haley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-29 00:00:00 -08:00
+date: 2009-02-18 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -33,7 +33,9 @@ files:
 - lib/track_changes/class_methods.rb
 - lib/track_changes/filter.rb
 - lib/track_changes.rb
-- test/track_changes_test.rb
+- test/result_test.rb
+- test/class_methods_test.rb
+- test/filter_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/smajn/track_changes

data/test/track_changes_test.rb

@@ -1,7 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-
-class TrackChangesTest < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end