track_changes 0.3.2 → 0.4.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Matt Haley
+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

data/README.rdoc

@@ -2,27 +2,55 @@
 
 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.
+Controller actions.
 
-A TrackChanges::Filter is instantiated on each run of the <tt>before_filter</tt>
-so it should be thread-safe.
+== Why?
 
-Consult the generated rdoc for more information.
+I originally looked at the available auditing solutions
+and it appeared that most of them were not thread-safe.
 
-== Example
+== 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
+
+== 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]
 
-    track_changes_to :post do |r|
-      # r.changes => Model#changes made during update action
-      RAILS_DEFAULT_LOGGER.debug(r.changes.inspect)
-    end
-
+    # 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."
@@ -44,4 +72,4 @@ Consult the generated rdoc for more information.
 
 == COPYRIGHT
 
-Copyright (c) 2008 Matt Haley. See LICENSE for details.
+Copyright (c) 2008-2010 Matt Haley. See LICENSE for details.

data/VERSION.yml

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

data/lib/track_changes/audit_filter.rb

@@ -0,0 +1,58 @@
+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
+    end
+
+    def before(controller)
+      self.models.each do |model|
+        instance_variable_symbol = "@#{model}".to_sym
+        self.cached_models[instance_variable_symbol] = controller.instance_variable_get(instance_variable_symbol).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.audits.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/class_methods.rb

@@ -1,7 +1,46 @@
+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)
+      models = args.flatten
+      options = args.extract_options!
+      options = [:only => :update] if options.empty?
+      audit_filter = AuditFilter.new(models)
+      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.
@@ -13,6 +52,7 @@ module TrackChanges
     # * <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

data/lib/track_changes.rb

@@ -1,4 +1,5 @@
 require 'track_changes/result'
+require 'track_changes/audit_filter'
 require 'track_changes/filter'
 require 'track_changes/instance_methods'
 require 'track_changes/class_methods'

data/test/functional/posts_controller_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class PostsControllerTest < ActionController::TestCase
+  test "should update post" do
+    post = Post.create!(:title => "Hello, World", :body => "This is a test.", :author => "Matt Haley")
+    assert !post.new_record?
+
+    assert_difference("Audit.count") do
+      put :update, :id => post.to_param, :post => { :title => "First post!" }
+      assert_redirected_to post_path(assigns(:post))
+
+      audit = assigns(:post).audits.first
+      assert_equal ["Hello, World", "First post!"], audit.change_set["title"]
+    end
+  end
+end

data/test/rails_root/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/test/rails_root/app/controllers/posts_controller.rb

@@ -0,0 +1,36 @@
+require 'track_changes'
+
+class PostsController < ApplicationController
+  include TrackChanges
+  before_filter :find_post
+  track_changes :post
+
+  def show
+    render :text => @post.inspect
+  end
+
+  # PUT /posts/1
+  # PUT /posts/1.xml
+  def update
+    respond_to do |format|
+      if @post.update_attributes(params[:post])
+        flash[:notice] = 'Post was successfully updated.'
+        format.html { redirect_to(@post) }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @post.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  protected
+
+  def current_user
+    "John Smith"
+  end
+
+  def find_post
+    @post = Post.find(params[:id])
+  end
+end

data/test/rails_root/app/models/audit.rb

@@ -0,0 +1,4 @@
+class Audit < ActiveRecord::Base
+  belongs_to :audited, :polymorphic => true
+  serialize :change_set
+end

data/test/rails_root/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  has_many :audits, :as => :audited
+end

data/test/rails_root/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/rails_root/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  :adapter: sqlite3
+  :database: ":memory:"

data/test/rails_root/config/environment.rb

@@ -0,0 +1,7 @@
+RAILS_GEM_VERSION = '2.3.5' unless defined? RAILS_GEM_VERSION
+
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.time_zone = 'UTC'
+end

data/test/rails_root/config/environments/test.rb

@@ -0,0 +1,7 @@
+config.cache_classes = true
+config.whiny_nils = true
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+config.action_controller.allow_forgery_protection    = false
+config.action_mailer.delivery_method = :test

data/test/rails_root/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,7 @@
+if defined?(ActiveRecord)
+  ActiveRecord::Base.include_root_in_json = true
+  ActiveRecord::Base.store_full_sti_class = true
+end
+ActionController::Routing.generate_best_match = false
+ActiveSupport.use_standard_json_time_format = true
+ActiveSupport.escape_html_entities_in_json = false

data/test/rails_root/config/initializers/session_store.rb

@@ -0,0 +1,4 @@
+ActionController::Base.session = {
+  :key         => '_rails_root_session',
+  :secret      => '54bf4d986f9e5cf80f28c31e03278d3689cb30e84aceb32893bfa617ad7a0fe0bfc4e7012f6b6e1bb9787f2c02cdff1fef4bc928f3ad060d5d6687dd2f813a54'
+}

data/test/rails_root/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :posts
+end

data/test/rails_root/db/migrate/20100115021125_create_audits.rb

@@ -0,0 +1,16 @@
+class CreateAudits < ActiveRecord::Migration
+  def self.up
+    create_table :audits do |t|
+      t.string :audited_type
+      t.integer :audited_id
+      t.string :user
+      t.text :change_set
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/test/rails_root/db/migrate/20100115021151_create_posts.rb

@@ -0,0 +1,15 @@
+class CreatePosts < ActiveRecord::Migration
+  def self.up
+    create_table :posts do |t|
+      t.string :title
+      t.text :body
+      t.string :author
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :posts
+  end
+end

data/test/rails_root/log/test.log

@@ -0,0 +1,117 @@
+# Logfile created on 2010-01-14 20:01:04 -0700  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   select sqlite_version(*)
+  SQL (0.2ms)   CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+  SQL (0.1ms)   CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  SQL (0.1ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.0ms)   SELECT version FROM schema_migrations
+Migrating to CreateAudits (20100115021125)
+  SQL (0.1ms)   CREATE TABLE "audits" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "audited_type" varchar(255), "audited_id" integer, "user" varchar(255), "change_set" text, "created_at" datetime, "updated_at" datetime) 
+  SQL (0.0ms)   INSERT INTO schema_migrations (version) VALUES ('20100115021125')
+Migrating to CreatePosts (20100115021151)
+  SQL (0.1ms)   CREATE TABLE "posts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "body" text, "author" varchar(255), "created_at" datetime, "updated_at" datetime) 
+  SQL (0.0ms)   INSERT INTO schema_migrations (version) VALUES ('20100115021151')
+  Post Create (0.1ms)   INSERT INTO "posts" ("title", "body", "author", "created_at", "updated_at") VALUES('Hello, World', 'This is a test.', 'Matt Haley', '2010-01-15 03:01:04', '2010-01-15 03:01:04')
+  SQL (0.1ms)   SELECT count(*) AS count_all FROM "audits" 
+
+
+Processing PostsController#update (for 0.0.0.0 at 2010-01-14 20:01:04) [PUT]
+  Parameters: {"post"=>{"title"=>"First post!"}, "id"=>"1"}
+  Post Load (0.1ms)   SELECT * FROM "posts" WHERE ("posts"."id" = 1) 
+  Post Update (0.0ms)   UPDATE "posts" SET "title" = 'First post!', "updated_at" = '2010-01-15 03:01:04' WHERE "id" = 1
+Redirected to http://test.host/posts/1
+WARNING: Can't mass-assign these protected attributes: id
+  Audit Create (0.1ms)   INSERT INTO "audits" ("audited_type", "audited_id", "user", "change_set", "created_at", "updated_at") VALUES('Post', 1, 'John Smith', '--- 
+title: 
+- Hello, World
+- First post!
+updated_at: 
+- 2010-01-15 03:01:04 Z
+- 2010-01-15 03:01:04.996091 Z
+', '2010-01-15 03:01:05', '2010-01-15 03:01:05')
+Completed in 47ms (DB: 1) | 302 Found [http://test.host/posts/1?post%5Btitle%5D=First+post%21]
+  Audit Load (0.1ms)   SELECT * FROM "audits" WHERE ("audits".audited_id = 1 AND "audits".audited_type = 'Post') LIMIT 1
+  SQL (0.1ms)   SELECT count(*) AS count_all FROM "audits" 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   select sqlite_version(*)
+  SQL (0.2ms)   CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+  SQL (0.1ms)   CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  SQL (0.1ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.0ms)   SELECT version FROM schema_migrations
+Migrating to CreateAudits (20100115021125)
+  SQL (0.1ms)   CREATE TABLE "audits" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "audited_type" varchar(255), "audited_id" integer, "user" varchar(255), "change_set" text, "created_at" datetime, "updated_at" datetime) 
+  SQL (0.0ms)   INSERT INTO schema_migrations (version) VALUES ('20100115021125')
+Migrating to CreatePosts (20100115021151)
+  SQL (0.1ms)   CREATE TABLE "posts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "body" text, "author" varchar(255), "created_at" datetime, "updated_at" datetime) 
+  SQL (0.0ms)   INSERT INTO schema_migrations (version) VALUES ('20100115021151')
+  Post Create (0.1ms)   INSERT INTO "posts" ("title", "body", "author", "created_at", "updated_at") VALUES('Hello, World', 'This is a test.', 'Matt Haley', '2010-01-15 03:02:19', '2010-01-15 03:02:19')
+  SQL (0.1ms)   SELECT count(*) AS count_all FROM "audits" 
+
+
+Processing PostsController#update (for 0.0.0.0 at 2010-01-14 20:02:19) [PUT]
+  Parameters: {"post"=>{"title"=>"First post!"}, "id"=>"1"}
+  Post Load (0.1ms)   SELECT * FROM "posts" WHERE ("posts"."id" = 1) 
+  Post Update (0.0ms)   UPDATE "posts" SET "title" = 'First post!', "updated_at" = '2010-01-15 03:02:19' WHERE "id" = 1
+Redirected to http://test.host/posts/1
+WARNING: Can't mass-assign these protected attributes: id
+  Audit Create (0.1ms)   INSERT INTO "audits" ("audited_type", "audited_id", "user", "change_set", "created_at", "updated_at") VALUES('Post', 1, 'John Smith', '--- 
+title: 
+- Hello, World
+- First post!
+updated_at: 
+- 2010-01-15 03:02:19 Z
+- 2010-01-15 03:02:19.156565 Z
+', '2010-01-15 03:02:19', '2010-01-15 03:02:19')
+Completed in 47ms (DB: 1) | 302 Found [http://test.host/posts/1?post%5Btitle%5D=First+post%21]
+  Audit Load (0.1ms)   SELECT * FROM "audits" WHERE ("audits".audited_id = 1 AND "audits".audited_type = 'Post') LIMIT 1
+  SQL (0.1ms)   SELECT count(*) AS count_all FROM "audits" 
+  SQL (0.2ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.1ms)   select sqlite_version(*)
+  SQL (0.2ms)   CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+  SQL (0.1ms)   CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  SQL (0.1ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.0ms)   SELECT version FROM schema_migrations
+Migrating to CreateAudits (20100115021125)
+  SQL (0.1ms)   CREATE TABLE "audits" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "audited_type" varchar(255), "audited_id" integer, "user" varchar(255), "change_set" text, "created_at" datetime, "updated_at" datetime) 
+  SQL (0.0ms)   INSERT INTO schema_migrations (version) VALUES ('20100115021125')
+Migrating to CreatePosts (20100115021151)
+  SQL (0.1ms)   CREATE TABLE "posts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "body" text, "author" varchar(255), "created_at" datetime, "updated_at" datetime) 
+  SQL (0.0ms)   INSERT INTO schema_migrations (version) VALUES ('20100115021151')
+  Post Create (0.1ms)   INSERT INTO "posts" ("title", "body", "author", "created_at", "updated_at") VALUES('Hello, World', 'This is a test.', 'Matt Haley', '2010-01-15 03:02:28', '2010-01-15 03:02:28')
+  SQL (0.1ms)   SELECT count(*) AS count_all FROM "audits" 
+
+
+Processing PostsController#update (for 0.0.0.0 at 2010-01-14 20:02:28) [PUT]
+  Parameters: {"post"=>{"title"=>"First post!"}, "id"=>"1"}
+  Post Load (0.1ms)   SELECT * FROM "posts" WHERE ("posts"."id" = 1) 
+  Post Update (0.0ms)   UPDATE "posts" SET "title" = 'First post!', "updated_at" = '2010-01-15 03:02:28' WHERE "id" = 1
+Redirected to http://test.host/posts/1
+WARNING: Can't mass-assign these protected attributes: id
+  Audit Create (0.1ms)   INSERT INTO "audits" ("audited_type", "audited_id", "user", "change_set", "created_at", "updated_at") VALUES('Post', 1, 'John Smith', '--- 
+title: 
+- Hello, World
+- First post!
+updated_at: 
+- 2010-01-15 03:02:28 Z
+- 2010-01-15 03:02:28.791727 Z
+', '2010-01-15 03:02:28', '2010-01-15 03:02:28')
+Completed in 47ms (DB: 1) | 302 Found [http://test.host/posts/1?post%5Btitle%5D=First+post%21]
+  Audit Load (0.1ms)   SELECT * FROM "audits" WHERE ("audits".audited_id = 1 AND "audits".audited_type = 'Post') LIMIT 1
+  SQL (0.1ms)   SELECT count(*) AS count_all FROM "audits" 

data/test/rails_root/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/console'

data/test/rails_root/script/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../config/boot',  __FILE__)
+require 'commands/generate'

data/test/test_helper.rb

@@ -1,12 +1,29 @@
-require 'rubygems'
-begin
-  gem 'test-unit'
-rescue Gem::LoadError
+# Copied from the shoulda library
+require 'fileutils'
+
+# Load the environment
+ENV['RAILS_ENV'] = 'test'
+
+rails_root = File.dirname(__FILE__) + '/rails_root'
+
+require "#{rails_root}/config/environment.rb"
+
+# Load the testing framework
+require 'test_help'
+silence_warnings { RAILS_ENV = ENV['RAILS_ENV'] }
+
+# Run the migrations
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate")
+
+# Setup the fixtures path
+ActiveSupport::TestCase.fixture_path =
+  File.join(File.dirname(__FILE__), "fixtures")
+
+class ActiveSupport::TestCase #:nodoc:
+  self.use_transactional_fixtures = false
+  self.use_instantiated_fixtures  = false
 end
-require 'test/unit'
-require 'shoulda'
-require 'mocha'
-require 'ostruct'
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'track_changes'
+require 'shoulda'

data/test/track_changes/audit_filter_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module TrackChanges
+  class AuditFilterTest < Test::Unit::TestCase
+    should "accept a single model" do
+      assert TrackChanges::AuditFilter.new(:model)
+    end
+
+    should "accept multiple models" do
+      assert TrackChanges::AuditFilter.new(:model_a, :model_b)
+    end
+
+    should "respond to #before" do
+      assert TrackChanges::AuditFilter.new.respond_to?(:before)
+    end
+
+    should "respond to #after" do
+      assert TrackChanges::AuditFilter.new.respond_to?(:after)
+    end
+
+    should "create an audit when before and after called" do
+      expected_change_set = {"value" => ["old", "new"]}
+      expected_user       = "current user"
+
+      audit = mock('audit')
+
+      model = mock('model')
+      model.stubs(:attributes=).returns({})
+      model.stubs(:changes).returns(expected_change_set)
+
+      modified_model = mock('modified model')
+      modified_model.stubs(:changed?).returns(false)
+      modified_model.stubs(:attributes).returns({})
+      modified_model.stubs(:audits).returns(audit)
+
+      controller = mock('controller')
+      controller.stubs(:instance_variable_get).returns(model, modified_model)
+      controller.stubs(:current_user).returns(expected_user)
+
+      audit_filter = AuditFilter.new(:model)
+      audit_filter.before(controller)
+
+      audit.expects(:create!).with(has_entries(:user => expected_user, :change_set => expected_change_set)).returns(true)
+      audit_filter.after(controller)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: track_changes
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors: 
 - Matt Haley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-15 00:00:00 -07:00
+date: 2010-01-14 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,6 +28,7 @@ files:
 - TODO
 - VERSION.yml
 - lib/track_changes.rb
+- lib/track_changes/audit_filter.rb
 - lib/track_changes/base.rb
 - lib/track_changes/class_methods.rb
 - lib/track_changes/filter.rb
@@ -36,8 +37,26 @@ files:
 - test/base_test.rb
 - test/class_methods_test.rb
 - test/filter_test.rb
+- test/functional/posts_controller_test.rb
+- test/rails_root/app/controllers/application_controller.rb
+- test/rails_root/app/controllers/posts_controller.rb
+- test/rails_root/app/models/audit.rb
+- test/rails_root/app/models/post.rb
+- test/rails_root/config/boot.rb
+- test/rails_root/config/database.yml
+- test/rails_root/config/environment.rb
+- test/rails_root/config/environments/test.rb
+- test/rails_root/config/initializers/new_rails_defaults.rb
+- test/rails_root/config/initializers/session_store.rb
+- test/rails_root/config/routes.rb
+- test/rails_root/db/migrate/20100115021125_create_audits.rb
+- test/rails_root/db/migrate/20100115021151_create_posts.rb
+- test/rails_root/log/test.log
+- test/rails_root/script/console
+- test/rails_root/script/generate
 - test/result_test.rb
 - test/test_helper.rb
+- test/track_changes/audit_filter_test.rb
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/mhaley/track_changes
@@ -68,8 +87,22 @@ signing_key:
 specification_version: 3
 summary: Easier auditing of Rails model changes in your controllers.
 test_files: 
-- test/base_test.rb
-- test/test_helper.rb
+- test/functional/posts_controller_test.rb
+- test/rails_root/db/migrate/20100115021151_create_posts.rb
+- test/rails_root/db/migrate/20100115021125_create_audits.rb
+- test/rails_root/config/environments/test.rb
+- test/rails_root/config/initializers/session_store.rb
+- test/rails_root/config/initializers/new_rails_defaults.rb
+- test/rails_root/config/boot.rb
+- test/rails_root/config/routes.rb
+- test/rails_root/config/environment.rb
+- test/rails_root/app/models/audit.rb
+- test/rails_root/app/models/post.rb
+- test/rails_root/app/controllers/posts_controller.rb
+- test/rails_root/app/controllers/application_controller.rb
 - test/class_methods_test.rb
 - test/result_test.rb
 - test/filter_test.rb
+- test/track_changes/audit_filter_test.rb
+- test/base_test.rb
+- test/test_helper.rb