paper_trail 1.6.5 → 2.0.0

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/{paper_trail_controller_test.rb → functional/controller_test.rb}

@@ -1,47 +1,9 @@
 require 'test_helper'
 
-ActionController::Routing::Routes.draw do |map|
-  map.resources :widgets
-end
-
-class ApplicationController < ActionController::Base
-  def rescue_action(e)
-    raise e
-  end
-
-  # Returns id of hypothetical current user
-  def current_user
-    153
-  end
-
-  def info_for_paper_trail
-    {:ip => request.remote_ip, :user_agent => request.user_agent}
-  end
-end
-
-class WidgetsController < ApplicationController
-  def create
-    @widget = Widget.create params[:widget]
-    head :ok
-  end
-
-  def update
-    @widget = Widget.find params[:id]
-    @widget.update_attributes params[:widget]
-    head :ok
-  end
-
-  def destroy
-    @widget = Widget.find params[:id]
-    @widget.destroy
-    head :ok
-  end
-end
-
-class PaperTrailControllerTest < ActionController::TestCase
+class ControllerTest < ActionController::TestCase
   tests WidgetsController
 
-  def setup
+  setup do
     @request.env['REMOTE_ADDR'] = '127.0.0.1'
   end
 
@@ -70,9 +32,10 @@ class PaperTrailControllerTest < ActionController::TestCase
     assert_equal 1, w.versions.length
     delete :destroy, :id => w.id
     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
+    versions_for_widget = 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
 end

data/test/{thread_safe_test.rb → functional/thread_safety_test.rb}

@@ -1,12 +1,6 @@
 require 'test_helper'
 
-class TestController < ActionController::Base
-  def current_user
-    Thread.current.object_id
-  end
-end
-
-class ThreadSafeTest < Test::Unit::TestCase
+class ThreadSafetyTest < ActionController::TestCase
   should "be thread safe" do
     blocked = true
 

data/test/integration/navigation_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class NavigationTest < ActiveSupport::IntegrationCase
+  test 'Sanity test' do
+    assert_kind_of Dummy::Application, Rails.application
+  end
+end

data/test/paper_trail_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class PaperTrailTest < ActiveSupport::TestCase
+  test 'Sanity test' do
+    assert_kind_of Module, PaperTrail
+  end
+end

data/test/support/integration_case.rb

@@ -0,0 +1,5 @@
+# Define a bare test case to use with Capybara
+class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
+  include Capybara
+  include Rails.application.routes.url_helpers
+end

data/test/test_helper.rb

@@ -1,43 +1,37 @@
-require 'rubygems'
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
 
-require 'test/unit'
-require 'shoulda'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
 
-require 'active_record'
-require 'action_controller'
-require 'action_controller/test_process'
-require 'active_support'
-require 'active_support/test_case'
+#ActionMailer::Base.delivery_method = :test
+#ActionMailer::Base.perform_deliveries = true
+#ActionMailer::Base.default_url_options[:host] = "test.com"
 
-require File.expand_path('../../lib/paper_trail', __FILE__)
+Rails.backtrace_cleaner.remove_silencers!
 
-def connect_to_database
-  ActiveRecord::Base.establish_connection(
-    :adapter  => "sqlite3",
-    :database => ":memory:"
-  )
-  ActiveRecord::Migration.verbose = false
-end
+require 'shoulda'
 
-def load_schema
-  connect_to_database
-  load File.dirname(__FILE__) + '/schema.rb'
-end
+# Configure capybara for integration testing
+require "capybara/rails"
+Capybara.default_driver   = :rack_test
+Capybara.default_selector = :css
 
-def change_schema
-  load File.dirname(__FILE__) + '/schema_change.rb'
-end
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
 
-class ActiveRecord::Base
-  def logger
-    @logger ||= Logger.new(nil)
-  end
-end
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+
+#
+# Helpers
+#
 
-class ActionController::Base
-  def logger
-    @logger ||= Logger.new(nil)
+def change_schema
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Schema.define do
+    remove_column :widgets, :sacrificial_column
   end
+  ActiveRecord::Migration.verbose = true
 end
-
-load_schema

data/test/{paper_trail_model_test.rb → unit/model_test.rb}

@@ -1,69 +1,6 @@
 require 'test_helper'
 
-class Widget < ActiveRecord::Base
-  has_paper_trail
-  has_one :wotsit
-  has_many :fluxors, :order => :name
-end
-
-class FooWidget < Widget
-end
-
-class Wotsit < ActiveRecord::Base
-  has_paper_trail
-  belongs_to :widget
-end
-
-class Fluxor < ActiveRecord::Base
-  belongs_to :widget
-end
-
-class Article < ActiveRecord::Base
-  has_paper_trail :ignore => [:title],
-                  :meta   => {:answer => 42,
-                              :action => :action_data_provider_method,
-                              :question => Proc.new { "31 + 11 = #{31 + 11}" },
-                              :article_id => Proc.new { |article| article.id } }
-
-  def action_data_provider_method
-    self.object_id.to_s
-  end
-end
-
-class Book < ActiveRecord::Base
-  has_many :authorships, :dependent => :destroy
-  has_many :authors, :through => :authorships, :source => :person
-  has_paper_trail
-end
-
-class Authorship < ActiveRecord::Base
-  belongs_to :book
-  belongs_to :person
-  has_paper_trail
-end
-
-class Person < ActiveRecord::Base
-  has_many :authorships, :dependent => :destroy
-  has_many :books, :through => :authorships
-  has_paper_trail
-end
-
-# Example from 'Overwriting default accessors' in ActiveRecord::Base.
-class Song < ActiveRecord::Base
-  has_paper_trail
-
-  # Uses an integer of seconds to hold the length of the song
-  def length=(minutes)
-    write_attribute(:length, minutes.to_i * 60)
-  end
-  def length
-    read_attribute(:length) / 60
-  end
-end
-
-
-class HasPaperTrailModelTest < Test::Unit::TestCase
-  load_schema
+class HasPaperTrailModelTest < ActiveSupport::TestCase
 
   context 'A record' do
     setup { @article = Article.create }
@@ -184,15 +121,15 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
           setup do
             @fluxor = @widget.fluxors.create :name => 'flux'
             @widget.destroy
-            @reified_widget = @widget.versions.last.reify
+            @reified_widget = Version.last.reify
           end
 
           should 'record the correct event' do
-            assert_match /destroy/i, @widget.versions.last.event
+            assert_match /destroy/i, Version.last.event
           end
 
           should 'have three previous versions' do
-            assert_equal 3, @widget.versions.length
+            assert_equal 3, Version.with_item_keys('Widget', @widget.id).length
           end
 
           should 'be available in its previous version' do
@@ -395,7 +332,7 @@ class HasPaperTrailModelTest < Test::Unit::TestCase
           setup do
             PaperTrail.whodunnit = 'Charlie'
             @widget.destroy
-            @version = @widget.versions.last
+            @version = Version.last
           end
 
           should 'track who made the change' do