track_changes 0.5.1 → 1.0.0.pre1

data/test/railsapp/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env jruby.exe
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/schema.rb

@@ -0,0 +1,19 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :audits, :force => true do |t|
+    t.references :audited, :polymorphic => true, :null => false
+    t.references :user
+    t.text :change_set, :null => false
+
+    t.datetime :created_at, :null => false
+  end
+
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.text :body
+  end
+
+  create_table :users, :force => true do |t|
+    t.string :name
+  end
+
+end

data/test/test_helper.rb

@@ -1,29 +1,7 @@
-# Copied from the shoulda library
-require 'fileutils'
-
-# Load the environment
 ENV['RAILS_ENV'] = 'test'
+require File.expand_path("../railsapp/config/environment.rb",  __FILE__)
+require 'rails/test_help'
 
-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
+def load_schema
+  load(File.dirname(__FILE__) + "/schema.rb")
 end
-
-require 'track_changes'
-require 'shoulda'

data/test/track_changes_test.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TrackChangesTest < Test::Unit::TestCase
+  load_schema
+
+  def test_schema_has_loaded_correctly
+    assert_equal [], Audit.all
+    assert_equal [], Post.all
+    assert_equal [], User.all
+  end
+
+  def test_should_add_track_changes_method_to_models
+    assert Post.new.respond_to?(:current_user)
+    assert Post.new.respond_to?(:current_user=)
+  end
+
+  def test_should_add_association_to_models
+    assert Post.new.respond_to?(:audits)
+    assert_equal [], Post.new.audits.all
+  end
+
+  def test_should_audit_changes
+    user = User.create!(:name => "John Public")
+    post = Post.create!(:title => "Test Post", :body => "Hello, world!")
+
+    post.update_attributes(:title => "Title Changed")
+
+    audit = post.audits.desc.first
+    expected_change = {"title" => ["Test Post", "Title Changed"]}
+
+    assert_equal 2, post.audits.count
+    assert_equal expected_change, audit.change_set
+  end
+end

metadata

@@ -1,24 +1,65 @@
 --- !ruby/object:Gem::Specification 
 name: track_changes
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  prerelease: true
   segments: 
-  - 0
-  - 5
-  - 1
-  version: 0.5.1
+    - 1
+    - 0
+    - 0
+    - pre1
+  version: 1.0.0.pre1
 platform: ruby
 authors: 
-- Matt Haley
+  - Matt Haley
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-07-30 00:00:00 -07:00
+date: 2010-08-19 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 3
+              - 0
+              - 0
+              - rc
+            version: 3.0.0.rc
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: activerecord-jdbc-adapter
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: activerecord-jdbcsqlite3-adapter
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+            version: "0"
+    type: :development
+    version_requirements: *id003
 description: Easier auditing of Rails model changes in your controllers.
 email: matt@smajnr.net
 executables: []
@@ -26,76 +67,80 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-- TODO
+  - LICENSE
+  - README.rdoc
+  - TODO
 files: 
-- LICENSE
-- 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/configuration.rb
-- lib/track_changes/filter.rb
-- lib/track_changes/initializer.rb
-- lib/track_changes/instance_methods.rb
-- lib/track_changes/result.rb
-- 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/initializers/track_changes_setup.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
-- test/track_changes/configuration_test.rb
-- test/track_changes/initializer_test.rb
-- README.rdoc
+  - LICENSE
+  - TODO
+  - VERSION.yml
+  - lib/generators/track_changes/templates/initializer.rb
+  - lib/generators/track_changes/templates/migration.rb
+  - lib/generators/track_changes/templates/stylesheet.css
+  - lib/generators/track_changes/track_changes_generator.rb
+  - lib/track_changes.rb
+  - lib/track_changes/action_controller.rb
+  - lib/track_changes/active_record.rb
+  - lib/track_changes/around_save.rb
+  - lib/track_changes/changes.rb
+  - lib/track_changes/configuration.rb
+  - lib/track_changes/current_user.rb
+  - lib/track_changes/current_user_filter.rb
+  - lib/track_changes/engine.rb
+  - test/functional/posts_controller_test.rb
+  - test/railsapp/Gemfile
+  - test/railsapp/Gemfile.lock
+  - test/railsapp/Rakefile
+  - test/railsapp/app/controllers/application_controller.rb
+  - test/railsapp/app/controllers/posts_controller.rb
+  - test/railsapp/app/models/post.rb
+  - test/railsapp/app/models/user.rb
+  - test/railsapp/app/views/layouts/application.html.erb
+  - test/railsapp/app/views/posts/_form.html.erb
+  - test/railsapp/app/views/posts/_post.html.erb
+  - test/railsapp/app/views/posts/edit.html.erb
+  - test/railsapp/app/views/posts/index.html.erb
+  - test/railsapp/config.ru
+  - test/railsapp/config/application.rb
+  - test/railsapp/config/boot.rb
+  - test/railsapp/config/database.yml
+  - test/railsapp/config/environment.rb
+  - test/railsapp/config/environments/test.rb
+  - test/railsapp/config/routes.rb
+  - test/railsapp/db/test.sqlite3
+  - test/railsapp/log/test.log
+  - test/railsapp/script/rails
+  - test/schema.rb
+  - test/test_helper.rb
+  - test/track_changes_test.rb
+  - README.rdoc
 has_rdoc: true
 homepage: http://github.com/mhaley/track_changes
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset=UTF-8
+  - --charset=UTF-8
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 1
+          - 3
+          - 1
+        version: 1.3.1
 requirements: []
 
 rubyforge_project: mhaley
@@ -104,25 +149,16 @@ signing_key:
 specification_version: 3
 summary: Easier auditing of Rails model changes in your controllers.
 test_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/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/initializers/track_changes_setup.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/result_test.rb
-- test/test_helper.rb
-- test/track_changes/audit_filter_test.rb
-- test/track_changes/configuration_test.rb
-- test/track_changes/initializer_test.rb
+  - test/schema.rb
+  - test/test_helper.rb
+  - test/track_changes_test.rb
+  - test/functional/posts_controller_test.rb
+  - test/railsapp/app/controllers/application_controller.rb
+  - test/railsapp/app/controllers/posts_controller.rb
+  - test/railsapp/app/models/post.rb
+  - test/railsapp/app/models/user.rb
+  - test/railsapp/config/application.rb
+  - test/railsapp/config/boot.rb
+  - test/railsapp/config/environment.rb
+  - test/railsapp/config/routes.rb
+  - test/railsapp/config/environments/test.rb

data/lib/track_changes/audit_filter.rb

@@ -1,69 +0,0 @@
-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
-
-      @audit_accessor = options[:audit_accessor] || :audits
-      @current_user   = options[:current_user] || :current_user
-      @ignore_nils = if options[:ignore_nil] == false
-        false
-      else
-        true
-      end
-    end
-
-    def before(controller)
-      self.models.each do |model|
-        instance_variable_symbol = "@#{model}".to_sym
-        instance = controller.instance_variable_get(instance_variable_symbol)
-        next if instance.nil? && @ignore_nils
-
-        self.cached_models[instance_variable_symbol] = instance.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.send(@audit_accessor).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/base.rb

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

@@ -1,74 +0,0 @@
-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)
-      options = args.extract_options!
-      models = args.flatten
-      options = {:only => :update} if options.empty?
-
-      configuration = TrackChanges::Initializer.instance.configuration
-
-      audit_filter = AuditFilter.new(models,
-                                     :audit_accessor => configuration.audit_association,
-                                     :current_user   => configuration.current_user,
-                                     :ignore_nil     => configuration.ignore_nil)
-      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.
-    #
-    # 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)
-      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
-
-        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

@@ -1,43 +0,0 @@
-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/initializer.rb

@@ -1,18 +0,0 @@
-module TrackChanges
-  class Initializer
-    attr_accessor :configuration
-
-    include Singleton
-
-    class << self
-      alias_method :__tr_instance, :instance
-
-      def instance(&block)
-        obj = __tr_instance
-        obj.configuration ||= Configuration.new
-        yield obj.configuration if block_given?
-        obj
-      end
-    end
-  end
-end

data/lib/track_changes/instance_methods.rb

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

data/lib/track_changes/result.rb

@@ -1,36 +0,0 @@
-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/test/base_test.rb

@@ -1,20 +0,0 @@
-require 'test_helper'
-
-class BaseTest < Test::Unit::TestCase
-  context "when TrackChanges is included in a Class" do
-    setup do
-      class A
-        include TrackChanges
-      end
-    end
-
-    should "include InstanceMethods" do
-      assert A.included_modules.include?(TrackChanges::InstanceMethods)
-    end
-
-    should "extend class with ClassMethods" do
-      extended_modules = (class << A; self; end).included_modules
-      assert extended_modules.include?(TrackChanges::ClassMethods)
-    end
-  end
-end

data/test/class_methods_test.rb

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