smajn-track_changes 0.2.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

@@ -0,0 +1,46 @@
+= track_changes
+
+TrackChanges is a Rails plugin to facilitate tracking
+changes made to an ActiveRecord model in your
+Controller#update actions.
+
+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 link:files/LICENSE.html for details.

data/TODO

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

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+: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,27 @@
+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>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)
+      append_before_filter(options) do |controller|
+        track_filter = Filter.new(models, 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,39 @@
+require 'track_changes/result'
+
+module TrackChanges
+  class Filter
+    attr_accessor :call_proc, :changes, :model, :original
+
+    def initialize(model, call_proc)
+      @call_proc = call_proc
+      @model = model
+      @changes = []
+      @original = []
+    end
+
+    def before(controller)
+      @original = clone_model(controller)
+    end
+
+    def after(controller)
+      cur_model = clone_model(controller)
+      # If changed? returns true, then the update didn't success.
+      unless cur_model.changed?
+        @changes = changes_between(@original, cur_model)
+        @call_proc.call(Result.new(@model, controller, @changes))
+      end
+    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/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'track_changes'
+
+class Test::Unit::TestCase
+end

data/test/track_changes_test.rb

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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: smajn-track_changes
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Matt Haley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-29 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Easier auditing of Rails model changes in your controllers.
+email: matt@smajn.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- TODO
+- LICENSE
+- VERSION.yml
+- lib/track_changes
+- lib/track_changes/instance_methods.rb
+- lib/track_changes/result.rb
+- lib/track_changes/base.rb
+- lib/track_changes/class_methods.rb
+- lib/track_changes/filter.rb
+- lib/track_changes.rb
+- test/track_changes_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/smajn/track_changes
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easier auditing of Rails model changes in your controllers.
+test_files: []
+