paper_trail_without_deprecated 3.0.0.beta1

data/test/dummy/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/test/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# 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/functional/controller_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+class ControllerTest < ActionController::TestCase
+  tests WidgetsController
+
+  setup do
+    @request.env['REMOTE_ADDR'] = '127.0.0.1'
+  end
+
+  teardown do
+    PaperTrail.enabled_for_controller = true
+  end
+
+  test 'disable on create' do
+    @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    assert_equal 0, assigns(:widget).versions.length
+  end
+
+  test 'disable on update' do
+    @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    w = assigns(:widget)
+    assert_equal 0, w.versions.length
+    put :update, :id => w.id, :widget => { :name => 'Bugle' }
+    widget = assigns(:widget)
+    assert_equal 0, widget.versions.length
+  end
+
+  test 'disable on destroy' do
+    @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    w = assigns(:widget)
+    assert_equal 0, w.versions.length
+    delete :destroy, :id => w.id
+    widget = assigns(:widget)
+    assert_equal 0, PaperTrail::Version.with_item_keys('Widget', w.id).size
+  end
+
+  test 'create' do
+    post :create, :widget => { :name => 'Flugel' }
+    widget = assigns(:widget)
+    assert_equal 1, widget.versions.length
+    assert_equal 153, widget.versions.last.whodunnit.to_i
+    assert_equal '127.0.0.1', widget.versions.last.ip
+    assert_equal 'Rails Testing', widget.versions.last.user_agent
+  end
+
+  test 'update' do
+    w = Widget.create :name => 'Duvel'
+    assert_equal 1, w.versions.length
+    put :update, :id => w.id, :widget => { :name => 'Bugle' }
+    widget = assigns(:widget)
+    assert_equal 2, widget.versions.length
+    assert_equal 153, widget.versions.last.whodunnit.to_i
+    assert_equal '127.0.0.1', widget.versions.last.ip
+    assert_equal 'Rails Testing', widget.versions.last.user_agent
+  end
+
+  test 'destroy' do
+    w = Widget.create :name => 'Roundel'
+    assert_equal 1, w.versions.length
+    delete :destroy, :id => w.id
+    widget = assigns(:widget)
+    versions_for_widget = PaperTrail::Version.with_item_keys('Widget', w.id)
+    assert_equal 2,               versions_for_widget.length
+    assert_equal 153,             versions_for_widget.last.whodunnit.to_i
+    assert_equal '127.0.0.1',     versions_for_widget.last.ip
+    assert_equal 'Rails Testing', versions_for_widget.last.user_agent
+  end
+
+  test "controller metadata methods should get evaluated if paper trail is enabled for controller" do
+    @request.env['HTTP_USER_AGENT'] = 'User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    assert PaperTrail.enabled_for_controller?
+    assert_equal 153, PaperTrail.whodunnit
+    assert PaperTrail.controller_info.present?
+    assert PaperTrail.controller_info.keys.include?(:ip)
+    assert PaperTrail.controller_info.keys.include?(:user_agent)
+  end
+
+  test "controller metadata methods should not get evaluated if paper trail is disabled for controller" do
+    @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
+    post :create, :widget => { :name => 'Flugel' }
+    assert_equal 0, assigns(:widget).versions.length
+    assert !PaperTrail.enabled_for_controller?    
+    assert PaperTrail.whodunnit.nil?
+    assert PaperTrail.controller_info.nil?
+  end
+end

data/test/functional/modular_sinatra_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+require 'sinatra/base'
+
+# --- Tests for modular `Sinatra::Base` style ----
+class BaseApp < Sinatra::Base
+  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => File.expand_path('../../dummy/db/test.sqlite3', __FILE__))
+  register Sinatra::PaperTrail
+
+  get '/test' do
+    Widget.create!(:name => 'foo')
+    'Hello'
+  end
+
+  def current_user
+    'foobar'
+  end
+end
+
+class ModularSinatraTest < ActionDispatch::IntegrationTest
+  include Rack::Test::Methods
+
+  def app
+    @app ||= BaseApp
+  end
+
+  test 'baseline' do
+    assert_nil Widget.first
+    assert_nil Widget.create.versions.first.whodunnit
+  end
+
+  context "`PaperTrail::Sinatra` in a `Sinatra::Base` application" do
+  
+    should "sets the `user_for_paper_trail` from the `current_user` method" do
+      get '/test'
+      assert_equal 'Hello', last_response.body
+      widget = Widget.first
+      assert_not_nil widget
+      assert_equal 'foo', widget.name
+      assert_equal 1, widget.versions.size
+      assert_equal 'foobar', widget.versions.first.whodunnit
+    end
+
+  end
+end

data/test/functional/sinatra_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+# require 'sinatra/main'
+
+# --- Tests for non-modular `Sinatra::Application` style ----
+class Sinatra::Application
+  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => File.expand_path('../../dummy/db/test.sqlite3', __FILE__))
+  register Sinatra::PaperTrail # we shouldn't actually need this line if I'm not mistaken but the tests seem to fail without it ATM
+
+  get '/test' do
+    Widget.create!(:name => 'bar')
+    'Hai'
+  end
+
+  def current_user
+    'raboof'
+  end
+
+end
+
+class SinatraTest < ActionDispatch::IntegrationTest
+  include Rack::Test::Methods
+
+  def app
+    @app ||= Sinatra::Application
+  end
+
+  test 'baseline' do
+    assert_nil Widget.first
+    assert_nil Widget.create.versions.first.whodunnit
+  end
+
+  context "`PaperTrail::Sinatra` in a `Sinatra::Application` application" do
+
+    should "sets the `user_for_paper_trail` from the `current_user` method" do
+      get '/test'
+      assert_equal 'Hai', last_response.body
+      widget = Widget.first
+      assert_not_nil widget
+      assert_equal 'bar', widget.name
+      assert_equal 1, widget.versions.size
+      assert_equal 'raboof', widget.versions.first.whodunnit
+    end
+
+  end
+end

data/test/functional/thread_safety_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class ThreadSafetyTest < ActionController::TestCase
+  test "be thread safe" do
+    blocked = true
+
+    slow_thread = Thread.new do
+      controller = TestController.new
+      controller.send :set_whodunnit
+      begin
+        sleep 0.001
+      end while blocked
+      PaperTrail.whodunnit
+    end
+
+    fast_thread = Thread.new do
+      controller = TestController.new
+      controller.send :set_whodunnit
+      who = PaperTrail.whodunnit
+      blocked = false
+      who
+    end
+
+    assert_not_equal slow_thread.value, fast_thread.value
+  end
+end

data/test/paper_trail_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class PaperTrailTest < ActiveSupport::TestCase
+  test 'Sanity test' do
+    assert_kind_of Module, PaperTrail::Version
+  end
+
+  test 'create with plain model class' do
+    widget = Widget.create
+    assert_equal 1, widget.versions.length
+  end
+
+  test 'update with plain model class' do
+    widget = Widget.create
+    assert_equal 1, widget.versions.length
+    widget.update_attributes(:name => 'Bugle')
+    assert_equal 2, widget.versions.length
+  end
+
+  test 'destroy with plain model class' do
+    widget = Widget.create
+    assert_equal 1, widget.versions.length
+    widget.destroy
+    versions_for_widget = PaperTrail::Version.with_item_keys('Widget', widget.id)
+    assert_equal 2, versions_for_widget.length
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+#ActionMailer::Base.delivery_method = :test
+#ActionMailer::Base.perform_deliveries = true
+#ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+require 'shoulda'
+require 'ffaker'
+
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# global setup block resetting Thread.current
+class ActiveSupport::TestCase
+  teardown do
+    Thread.current[:paper_trail] = nil
+  end
+end
+
+#
+# Helpers
+#
+
+def change_schema
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Schema.define do
+    remove_column :widgets, :sacrificial_column
+    add_column :versions, :custom_created_at, :datetime
+  end
+  ActiveRecord::Migration.verbose = true
+end