track_changes 0.3.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 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

@@ -0,0 +1,47 @@
+= track_changes
+
+TrackChanges is a Rails plugin to facilitate tracking
+changes made to an ActiveRecord model in your
+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.
+
+Consult the generated rdoc for more information.
+
+== Example
+
+  class PostController < ApplicationController
+    include TrackChanges
+
+    before_filter :get_post, :except => [:index, :new]
+
+    track_changes_to :post do |r|
+      # r.changes => Model#changes made during update action
+      RAILS_DEFAULT_LOGGER.debug(r.changes.inspect)
+    end
+
+
+    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 Matt Haley. See LICENSE for details.

data/TODO

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

data/VERSION.yml

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

data/lib/track_changes/base.rb

@@ -0,0 +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

data/lib/track_changes/class_methods.rb

@@ -0,0 +1,28 @@
+require 'track_changes/filter'
+
+module TrackChanges
+  module ClassMethods
+    # 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)
+      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/filter.rb

@@ -0,0 +1,43 @@
+require 'track_changes/result'
+
+module TrackChanges
+  class Filter
+    attr_accessor :call_proc, :changes, :model, :original
+
+    def initialize(model, yield_only_changed, call_proc)
+      @call_proc = call_proc
+      @model = model
+      @yield_only_changed = yield_only_changed
+      @changes = []
+      @original = []
+    end
+
+    def before(controller)
+      @original = clone_model(controller)
+    end
+
+    def after(controller)
+      cur_model = controller.instance_variable_get("@#{@model}")
+      # If changed? returns true, then the update didn't succeed.
+      unless cur_model.changed?
+        @changes = changes_between(@original, cur_model)
+        unless @yield_only_changed && @changes.empty?
+          @call_proc.call(Result.new(@model, controller, @changes))
+        end
+      end
+      nil
+    end
+
+    private
+
+    def changes_between(old, new)
+      old.attributes = new.attributes
+      old.changes
+    end
+
+    def clone_model(controller)
+      ivar = controller.instance_variable_get("@#{@model}")
+      ivar.clone if ivar.respond_to?(:clone)
+    end
+  end
+end

data/lib/track_changes/instance_methods.rb

@@ -0,0 +1,5 @@
+module TrackChanges
+  module InstanceMethods
+    attr_accessor :track_changes_filter
+  end
+end

data/lib/track_changes/result.rb

@@ -0,0 +1,36 @@
+module TrackChanges
+  # A Result instance is yielded by ClassMethods#track_changes_to.
+  #
+  # Example:
+  #
+  #   track_changes_to :post do |result|
+  #     result.post         # => The instance variable in the current_controler
+  #                         #    given by the :post option.
+  #     result.controller   # => The instance of the current controller
+  #     result.current_user # => The current controllers @current_user
+  #     result.some_method  # => Call some_method on the current controller instance
+  #   end
+  class Result
+    attr_accessor :changes, :controller
+
+    def initialize(model_name, controller, changes)
+      @changes = changes
+      @controller = controller
+
+      self.class.send(:define_method, model_name) do
+        @controller.instance_variable_get("@#{model_name}")
+      end
+    end
+
+    # Pass all other methods to the controller.
+    def method_missing(method_sym, *args)
+      controller.send(method_sym, *args)
+    end
+
+    # A convienence method that returns the <tt>@current_user</tt>
+    # in the current controller.
+    def current_user
+      user = controller.instance_variable_get("@current_user")
+    end
+  end
+end

data/lib/track_changes.rb

@@ -0,0 +1,9 @@
+require 'track_changes/result'
+require 'track_changes/filter'
+require 'track_changes/instance_methods'
+require 'track_changes/class_methods'
+require 'track_changes/base'
+
+module TrackChanges
+
+end

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

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

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: track_changes
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Matt Haley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Easier auditing of Rails model changes in your controllers.
+email: matt@smajn.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- TODO
+- VERSION.yml
+- lib/track_changes.rb
+- lib/track_changes/base.rb
+- lib/track_changes/class_methods.rb
+- lib/track_changes/filter.rb
+- lib/track_changes/instance_methods.rb
+- lib/track_changes/result.rb
+- test/class_methods_test.rb
+- test/filter_test.rb
+- test/result_test.rb
+- test/test_helper.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/smajn/track_changes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: mhaley
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easier auditing of Rails model changes in your controllers.
+test_files: 
+- test/result_test.rb
+- test/class_methods_test.rb
+- test/filter_test.rb
+- test/test_helper.rb