track_changes 0.5.1 → 1.0.0.pre1

data/README.rdoc

@@ -1,60 +1,72 @@
 = track_changes
 
-TrackChanges is a Rails plugin to facilitate tracking
-changes made to an ActiveRecord model in your
-Controller actions.
+TrackChanges is a Rails engine to facilitate tracking changes made to your
+models.
 
 == Why?
 
-I originally looked at the available auditing solutions
-and it appeared that most of them were not thread-safe.
+I originally looked at the available auditing solutions and it appeared that
+most of them were not thread-safe.
+
+== Requirements
+
+* Rails 3
+* A User model
+
+=== Development Requirements
+
+* JRuby
+* Rails 3
 
 == Installation
 
-  gem install track_changes
+Add to your Gemfile:
+
+  gem 'track_changes'
+
+Then, you can run <tt>rails generate track_changes</tt> to create the migration
+file, the initializer, and copy the CSS stylesheet to your application.
 
 == 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>.
+Currently, the only configuration available is in the initializer
+<tt>config/initializers/track_changes_configuration.rb</tt>. In this file, you
+can set a constant TrackChanges::Configuration::DEFAULT_USER_FINDER to a Proc
+that will return a User model when no <tt>current_user</tt> is specified.
 
-Example Audit class:
+== Model Example
 
-  class Audit < ActiveRecord::Base
-    belongs_to :audited, :polymorphic => true
-    serialize :change_set
-  end
+To enable tracking for your model, add the statement <tt>track_changes</tt> in
+your model definition.
 
-Example Audited class:
+Example:
 
   class Post < ActiveRecord::Base
-    has_many :audits, :as => :audited
+    track_changes
   end
 
-You can also tweak some of the defaults by creating an initializer
-in <tt>RAILS_ROOT/config/initializers/track_changes_configuration.rb</tt>
-and calling TrackChanges::Initializer.instance which yields a
-TrackChanges::Configuration object:
-
-  # These are the defaults anyways
-  TrackChanges::Initializer.instance do |c|
-    c.audit_assocation = :audits        # Calls <tt>create!</tt> on this association method
-    c.current_user     = :current_user  # Controller is sent this method to obtain current user.
-    c.ignore_nil       = true           # Don't crash if a model is nil.
-  end
+This will add a polymorphic <tt>has_many</tt> association to the Audit class. It
+will also add an accessor <tt>current_user</tt> which you can set prior to
+updating your model. This will be saved in the Audit entry.
 
 == Controller Example
 
+To enable automatic user tracking in your controllers. Add the <tt>track_changes</tt>
+statement to your controller. Pass a Symbol as an argument which is the name
+of the instance variable(s) (without the <tt>@</tt>). Theses instance variables
+will have their <tt>current_user</tt> attribute assigned to via the controller's
+<tt>current_user</tt> method.
+
+The <tt>track_changes</tt> method in your controller will also pull in the
+AuditsHelper module which provides some simple helpers.
+
+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]
 
     # specify a single model
@@ -62,7 +74,7 @@ if there are any changes, an audit will be created.
 
     # you can also specify multiple models
     #track_changes :post1, :post2, ...
-    
+
     def update
       if @post.update_attributes(params[:post])
         flash[:notice] = "Success."
@@ -81,6 +93,8 @@ if there are any changes, an audit will be created.
     end
   end
 
+Note, you must have a <tt>before_filter</tt> that assigns the model to the expected
+instance variable.
 
 == COPYRIGHT
 

data/TODO

@@ -1,4 +1,4 @@
 Track Changes TODO List
 =======================
 
-* Check for ivars
+* Documentation update for re-write

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 1
-:major: 0
-:build: 
-:minor: 5
+:major: 1
+:minor: 0
+:patch: 0
+:build: pre1

data/lib/generators/track_changes/templates/initializer.rb

@@ -0,0 +1 @@
+TrackChanges::Configuration::DEFAULT_USER_FINDER = Proc.new { User.first }

data/lib/generators/track_changes/templates/migration.rb

@@ -0,0 +1,18 @@
+class CreateAuditsTable < ActiveRecord::Migration #:nodoc:
+  def self.up
+    create_table :audits 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
+
+    add_index :audits, [:audited_id, :audited_type]
+    add_index :audits, [:user_id]
+  end
+
+  def self.down
+    drop_table :audits
+  end
+end

data/lib/generators/track_changes/templates/stylesheet.css

@@ -0,0 +1,12 @@
+.audit {
+  font-size: 12px;
+}
+
+li.audit {
+  list-style: none;
+}
+
+h4.audit div { display: inline; }
+.audit_meta { font-weight: normal; color: #666; }
+
+p.audit  { line-height: 10px; margin-left: 13px;}

data/lib/generators/track_changes/track_changes_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class TrackChangesGenerator < Rails::Generators::Base #:nodoc:
+  include Rails::Generators::Migration
+
+  source_root File.expand_path("templates", File.dirname(__FILE__))
+
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_audits_table.rb'
+  end
+
+  def generate_layout
+    copy_file 'stylesheet.css', 'public/stylesheets/track_changes.css'
+  end
+
+  def create_initializer_file
+    copy_file 'initializer.rb', 'config/initializers/track_changes_configuration.rb'
+  end
+end

data/lib/track_changes/action_controller.rb

@@ -0,0 +1,31 @@
+module TrackChanges
+  module ActionController #:nodoc:
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+
+      # Sets up an around filter to assign the controller's <tt>current_user</tt>
+      # to the given model names that are already set as instance variables in a
+      # prior <tt>before_filter</tt>.
+      #
+      # Example:
+      #
+      #  track_changes :post
+      #  track_changes :post, :post_attribute
+      #
+      # Currently does not work if the instance variable is anything except
+      # an model that has <tt>current_user</tt> accessors.
+      def track_changes models
+        models_to_track = [models].flatten
+        define_method(:__track_changes_to_models) { models_to_track }
+
+        self.class_eval do
+          helper :audits
+          before_filter TrackChanges::CurrentUserFilter
+        end
+      end
+    end
+  end
+end

data/lib/track_changes/active_record.rb

@@ -0,0 +1,26 @@
+module TrackChanges
+  module ActiveRecord #:nodoc:
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+
+      # Enables auditing of all changes to an ActiveRecord model. Sets up an
+      # around filter that will create an Audit for the models <tt>changes</tt>
+      # attribute.
+      #
+      # In addition, this will also define a <tt>attr_accessor</tt> for <tt>current_user</tt>.
+      def track_changes
+        send :include, TrackChanges::CurrentUser
+        send :include, TrackChanges::Changes
+
+        self.class_eval do
+          has_many :audits, :as => :audited
+
+          around_save TrackChanges::AroundSave
+        end
+      end
+    end
+  end
+end

data/lib/track_changes/around_save.rb

@@ -0,0 +1,9 @@
+module TrackChanges
+  class AroundSave #:nodoc:
+    def self.around_save(model)
+      model.send(:track_changes_get_changes)
+      yield
+      model.send(:track_changes_save_audit)
+    end
+  end
+end

data/lib/track_changes/changes.rb

@@ -0,0 +1,15 @@
+module TrackChanges
+   module Changes #:nodoc:
+
+    protected
+
+    def track_changes_get_changes
+      @__model_changes = self.changes
+    end
+
+    def track_changes_save_audit
+      user = current_user || TrackChanges::Configuration::get_default_user
+      Audit.create_changes(self, @__model_changes, current_user)
+    end
+  end
+end

data/lib/track_changes/configuration.rb

@@ -1,38 +1,9 @@
 module TrackChanges
   class Configuration
-    # The association used to create an audit. Defaults to
-    # <tt>:audits</tt>
-    #
-    # Example:
-    #   :audits  # => Call model.audits.create
-    #   :changes # => Call model.changes.create
-    attr_accessor :audit_association
 
-    # The controller method called to obtain the current user.
-    # Defaults to <tt>:current_user</tt>
-    attr_accessor :current_user
-
-    # Ignore if the audited item is nil. Defaults to <tt>true</tt>.
-    attr_accessor :ignore_nil
-
-    def initialize
-      self.audit_association = default_audit_association
-      self.current_user      = default_current_user
-      self.ignore_nil        = default_ignore_nil
-    end
-
-    private
-
-    def default_audit_association
-      :audits
-    end
-
-    def default_current_user
-      :current_user
-    end
-
-    def default_ignore_nil
-      true
+    # If a constant DEFAULT_USER_FINDER is defined in this class. Call it.
+    def self.get_default_user
+      defined?(DEFAULT_USER_FINDER) && DEFAULT_USER_FINDER.call
     end
   end
 end

data/lib/track_changes/current_user.rb

@@ -0,0 +1,5 @@
+module TrackChanges
+  module CurrentUser #:nodoc:
+    attr_accessor :current_user
+  end
+end

data/lib/track_changes/current_user_filter.rb

@@ -0,0 +1,12 @@
+module TrackChanges
+  module CurrentUserFilter #:nodoc:
+    def self.filter(controller)
+      controller.send(:__track_changes_to_models).each do |model|
+        instance = controller.instance_variable_get("@#{model}")
+        return if instance.nil?
+
+        instance.current_user = controller.send(:current_user)
+      end
+    end
+  end
+end

data/lib/track_changes/engine.rb

@@ -0,0 +1,7 @@
+require 'track_changes'
+require 'rails'
+
+module TrackChanges
+  class Engine < Rails::Engine #:nodoc:
+  end
+end

data/lib/track_changes.rb

@@ -1,12 +1,13 @@
-require 'track_changes/result'
-require 'track_changes/configuration'
-require 'track_changes/initializer'
-require 'track_changes/audit_filter'
-require 'track_changes/filter'
-require 'track_changes/instance_methods'
-require 'track_changes/class_methods'
-require 'track_changes/base'
-
 module TrackChanges
-
+  require 'track_changes/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'track_changes/action_controller'
+  require 'track_changes/active_record'
+  require 'track_changes/around_save'
+  require 'track_changes/changes'
+  require 'track_changes/configuration'
+  require 'track_changes/current_user'
+  require 'track_changes/current_user_filter'
 end
+
+ActiveRecord::Base.send :include, TrackChanges::ActiveRecord
+ActionController::Base.send :include, TrackChanges::ActionController

data/test/functional/posts_controller_test.rb

@@ -1,16 +1,45 @@
-require 'test_helper'
+require File.dirname(__FILE__) + '/../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?
+  load_schema
 
-    assert_difference("Audit.count") do
-      put :update, :id => post.to_param, :post => { :title => "First post!" }
-      assert_redirected_to post_path(assigns(:post))
+  def setup
+    @post = Post.create(:title => "Hello", :body => "Hello World")
+  end
+
+  def test_should_audit_changes
+    put :update, :id => @post.to_param, :post => { :title => "Changed" }
+
+    @post.reload
+    expected_change = { "title" => ["Hello", "Changed"]}
+    assert_equal "Changed", @post.title
+    assert_equal 2, @post.audits.count
+    assert_equal expected_change, @post.audits.desc.first.change_set
+  end
+
+  def test_should_respect_current_user
+    User.delete_all
+    @user = User.create!(:name => "ControllerTest")
+    User.create!(:name => "Someone Else")
+
+    put :update, :id => @post.to_param, :post => { :title => "Changed User Test"},
+      :user_id => @user.id
+
+    @post.reload
+    audit = @post.audits.desc.first
+
+    assert_equal @user.id, audit.user_id
+  end
+
+  def test_should_not_fail_if_current_user_nil
+    User.delete_all
+
+    put :update, :id => @post.to_param, :post => { :title => "Changed User Test"},
+      :user_id => nil
+
+    @post.reload
+    audit = @post.audits.desc.first
 
-      audit = assigns(:post).audits.first
-      assert_equal ["Hello, World", "First post!"], audit.change_set["title"]
-    end
+    assert_equal nil, audit.user_id
   end
 end

data/test/railsapp/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.0.rc'
+
+if defined?(JRUBY_VERSION)
+  gem 'activerecord-jdbc-adapter'
+  gem 'activerecord-jdbcsqlite3-adapter', :require => false
+else
+  gem 'sqlite3-ruby'
+end
+
+gem 'track_changes', :path => "../.."

data/test/railsapp/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: C:/Users/Matt/Code/track_changes
+  specs:
+    track_changes (0.5.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      mail (~> 2.2.5)
+    actionpack (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.9)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.22)
+    activemodel (3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      arel (~> 0.4.0)
+      tzinfo (~> 0.3.22)
+    activerecord-jdbc-adapter (0.9.7-java)
+    activerecord-jdbcsqlite3-adapter (0.9.7-java)
+      activerecord-jdbc-adapter (= 0.9.7)
+      jdbc-sqlite3 (>= 3.6.3.054)
+    activeresource (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+    activesupport (3.0.0.rc)
+    arel (0.4.0)
+      activesupport (>= 3.0.0.beta)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    jdbc-sqlite3 (3.6.3.054)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.9)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0.rc)
+      actionmailer (= 3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      activerecord (= 3.0.0.rc)
+      activeresource (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      bundler (>= 1.0.0.rc.1)
+      railties (= 3.0.0.rc)
+    railties (3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      rake (>= 0.8.3)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.22)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  activerecord-jdbc-adapter
+  activerecord-jdbcsqlite3-adapter
+  rails (= 3.0.0.rc)
+  track_changes!

data/test/railsapp/Rakefile

@@ -0,0 +1,4 @@
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Railsapp::Application.load_tasks

data/test/{rails_root → railsapp}/app/controllers/application_controller.rb

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

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

@@ -0,0 +1,40 @@
+class PostsController < ApplicationController
+  before_filter :get_user
+  before_filter :get_post
+
+  track_changes :post
+
+  def index
+    @posts = Post.all
+  end
+
+  def edit
+
+  end
+
+  def update
+    if @post.update_attributes(params[:post])
+      flash[:notice] = "Post updated"
+      redirect_to posts_url
+    else
+      render :action => "edit"
+    end
+  end
+
+  protected
+
+  def get_post
+    Rails.logger.debug("get_post")
+    @post = Post.find(params[:id])
+  end
+
+  def get_user
+    Rails.logger.debug("get_user")
+    @user = User.find_by_id(params[:user_id])
+  end
+
+  def current_user
+    Rails.logger.debug("current_user")
+    @user
+  end
+end

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

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  track_changes
+end

data/test/railsapp/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+
+end

data/test/railsapp/app/views/layouts/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Railsapp</title>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/railsapp/app/views/posts/_form.html.erb

@@ -0,0 +1,13 @@
+<p>
+  <b><%= form.label :title %></b><br />
+  <%= form.text_field :title %>
+</p>
+
+<p>
+  <b><%= form.label :body %></b><br />
+  <%= form.text_area :body%>
+</p>
+
+<p>
+  <%= form.submit "Save" %>
+</p>

data/test/railsapp/app/views/posts/_post.html.erb

@@ -0,0 +1,3 @@
+<h2><%= post.title %></h2>
+<p><%= post.body %></p>
+<p><%= link_to 'Edit', edit_post_path(post) %></p>

data/test/railsapp/app/views/posts/edit.html.erb

@@ -0,0 +1,5 @@
+<h1>Edit Post</h1>
+
+<%= form_for @post do |form| %>
+  <%= render form %>
+<% end %>

data/test/railsapp/app/views/posts/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Posts</h1>
+<%= render @posts %>

data/test/railsapp/config/application.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module Railsapp
+  class Application < Rails::Application
+    config.action_view.javascript_expansions[:defaults] = %w()
+    config.encoding = "utf-8"
+  end
+end