paper_trail 4.2.0 → 5.0.0

data/test/dummy/script/rails

@@ -1,6 +1,8 @@
 #!/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'
+# 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

@@ -1,10 +1,10 @@
-require 'test_helper'
+require "test_helper"
 
 class ControllerTest < ActionController::TestCase
   tests WidgetsController
 
   setup do
-    @request.env['REMOTE_ADDR'] = '127.0.0.1'
+    @request.env["REMOTE_ADDR"] = "127.0.0.1"
   end
 
   # Mimick what RequestStore will do outside of the test env, since it is
@@ -13,66 +13,65 @@ class ControllerTest < ActionController::TestCase
     RequestStore.store[:paper_trail] = nil
   end
 
-  test 'disable on create' do
-    @request.env['HTTP_USER_AGENT'] = 'Disable User-Agent'
-    post :create, :widget => { :name => 'Flugel' }
+  test "disable on create" do
+    @request.env["HTTP_USER_AGENT"] = "Disable User-Agent"
+    post :create, params_wrapper(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' }
+  test "disable on update" do
+    @request.env["HTTP_USER_AGENT"] = "Disable User-Agent"
+    post :create, params_wrapper(widget: { name: "Flugel" })
     w = assigns(:widget)
     assert_equal 0, w.versions.length
-    put :update, :id => w.id, :widget => { :name => 'Bugle' }
+    put :update, params_wrapper(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' }
+  test "disable on destroy" do
+    @request.env["HTTP_USER_AGENT"] = "Disable User-Agent"
+    post :create, params_wrapper(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
+    delete :destroy, params_wrapper(id: w.id)
+    assert_equal 0, PaperTrail::Version.with_item_keys("Widget", w.id).size
   end
 
-  test 'create' do
-    post :create, :widget => { :name => 'Flugel' }
+  test "create" do
+    post :create, params_wrapper(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
+    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'
+  test "update" do
+    w = Widget.create name: "Duvel"
     assert_equal 1, w.versions.length
-    put :update, :id => w.id, :widget => { :name => 'Bugle' }
+    put :update, params_wrapper(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
+    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'
+  test "destroy" do
+    w = Widget.create name: "Roundel"
     assert_equal 1, w.versions.length
-    delete :destroy, :id => w.id
+    delete :destroy, params_wrapper(id: w.id)
     widget = assigns(:widget)
     assert_equal 2,               widget.versions.length
-    assert_equal '127.0.0.1',     widget.versions.last.ip
-    assert_equal 'Rails Testing', widget.versions.last.user_agent
+    assert_equal "127.0.0.1",     widget.versions.last.ip
+    assert_equal "Rails Testing", widget.versions.last.user_agent
     assert_equal 153,             widget.versions.last.whodunnit.to_i
   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' }
+  test "controller metadata methods should get evaluated if PT enabled for controller" do
+    @request.env["HTTP_USER_AGENT"] = "User-Agent"
+    post :create, params_wrapper(widget: { name: "Flugel" })
     assert PaperTrail.enabled_for_controller?
     assert_equal 153, PaperTrail.whodunnit
     assert PaperTrail.controller_info.present?
@@ -80,9 +79,9 @@ class ControllerTest < ActionController::TestCase
     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' }
+  test "controller metadata methods should not get evaluated if PT disabled for controller" do
+    @request.env["HTTP_USER_AGENT"] = "Disable User-Agent"
+    post :create, params_wrapper(widget: { name: "Flugel" })
     assert_equal 0, assigns(:widget).versions.length
     assert !PaperTrail.enabled_for_controller?
     assert PaperTrail.whodunnit.nil?

data/test/functional/enabled_for_controller_test.rb

@@ -1,12 +1,12 @@
-require 'test_helper'
+require "test_helper"
 
 class EnabledForControllerTest < ActionController::TestCase
   tests ArticlesController
 
   context "`PaperTrail.enabled? == true`" do
-    should 'enabled_for_controller?.should == true' do
+    should "enabled_for_controller?.should == true" do
       assert PaperTrail.enabled?
-      post :create, :article => { :title => 'Doh', :content => Faker::Lorem.sentence }
+      post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
       assert_not_nil assigns(:article)
       assert PaperTrail.enabled_for_controller?
       assert_equal 1, assigns(:article).versions.length
@@ -15,15 +15,14 @@ class EnabledForControllerTest < ActionController::TestCase
 
   context "`PaperTrail.enabled? == false`" do
     setup { PaperTrail.enabled = false }
-    
-    should 'enabled_for_controller?.should == false' do
+
+    should "enabled_for_controller?.should == false" do
       assert !PaperTrail.enabled?
-      post :create, :article => { :title => 'Doh', :content => Faker::Lorem.sentence }
+      post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
       assert !PaperTrail.enabled_for_controller?
       assert_equal 0, assigns(:article).versions.length
     end
 
     teardown { PaperTrail.enabled = true }
   end
-
 end

data/test/functional/modular_sinatra_test.rb

@@ -1,48 +1,53 @@
-require 'test_helper'
-require 'sinatra/base'
-
-# --- Tests for modular `Sinatra::Base` style ----
-class BaseApp < Sinatra::Base
-  configs = YAML.load_file(File.expand_path('../../dummy/config/database.yml', __FILE__))
-  ActiveRecord::Base.configurations = configs
-  ActiveRecord::Base.establish_connection(:test)
-  register PaperTrail::Sinatra
-
-  get '/test' do
-    Widget.create!(:name => 'foo')
-    'Hello'
-  end
+# Our ActiveRecord 5 gemfile (see `Appraisals`) must use `rack 2.0.0.alpha`
+# which renames several files that sinatra 1 depended on. Until there is
+# a released version of sinatra that supports `rack 2.0.0.alpha`, we
+# must exclude sinatra from our test suite. This is done in two files:
+#
+# - test/functional/sinatra_test.rb
+# - test/functional/modular_sinatra_test.rb
+#
+if Gem::Version.new(Rack.release) < Gem::Version.new("2.0.0.alpha")
+  require "test_helper"
+  require "sinatra/base"
+
+  # --- Tests for modular `Sinatra::Base` style ----
+  class BaseApp < Sinatra::Base
+    configs = YAML.load_file(File.expand_path("../../dummy/config/database.yml", __FILE__))
+    ActiveRecord::Base.configurations = configs
+    ActiveRecord::Base.establish_connection(:test)
+    register PaperTrail::Sinatra
+
+    get "/test" do
+      Widget.create!(name: "foo")
+      "Hello"
+    end
 
-  def current_user
-    @current_user ||= OpenStruct.new(:id => 'foobar').tap do |obj|
-      # Invoking `id` returns the `object_id` value in Ruby18 unless specifically overwritten
-      def obj.id; 'foobar'; end if RUBY_VERSION < '1.9'
+    def current_user
+      @current_user ||= OpenStruct.new(id: "foobar")
     end
   end
-end
 
-class ModularSinatraTest < ActionDispatch::IntegrationTest
-  include Rack::Test::Methods
+  class ModularSinatraTest < ActionDispatch::IntegrationTest
+    include Rack::Test::Methods
 
-  def app
-    @app ||= BaseApp
-  end
-
-  test 'baseline' do
-    assert_nil Widget.create.versions.first.whodunnit
-  end
+    def app
+      @app ||= BaseApp
+    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.last
-      assert_not_nil widget
-      assert_equal 'foo', widget.name
-      assert_equal 1, widget.versions.size
-      assert_equal 'foobar', widget.versions.first.whodunnit
+    test "baseline" do
+      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.last
+        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
 end

data/test/functional/sinatra_test.rb

@@ -1,49 +1,58 @@
-require 'test_helper'
-# require 'sinatra/main'
-
-# --- Tests for non-modular `Sinatra::Application` style ----
-class Sinatra::Application
-  configs = YAML.load_file(File.expand_path('../../dummy/config/database.yml', __FILE__))
-  ActiveRecord::Base.configurations = configs
-  ActiveRecord::Base.establish_connection(:test)
-  register PaperTrail::Sinatra # 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
-    @current_user ||= OpenStruct.new(:id => 'raboof').tap do |obj|
-      # Invoking `id` returns the `object_id` value in Ruby18 unless specifically overwritten
-      def obj.id; 'raboof'; end if RUBY_VERSION < '1.9'
+# Our ActiveRecord 5 gemfile (see `Appraisals`) must use `rack 2.0.0.alpha`
+# which renames several files that sinatra 1 depended on. Until there is
+# a released version of sinatra that supports `rack 2.0.0.alpha`, we
+# must exclude sinatra from our test suite. This is done in two files:
+#
+# - test/functional/sinatra_test.rb
+# - test/functional/modular_sinatra_test.rb
+#
+if Gem::Version.new(Rack.release) < Gem::Version.new("2.0.0.alpha")
+  require "test_helper"
+  # require 'sinatra/main'
+
+  # --- Tests for non-modular `Sinatra::Application` style ----
+  module Sinatra
+    class Application
+      configs = YAML.load_file(File.expand_path("../../dummy/config/database.yml", __FILE__))
+      ActiveRecord::Base.configurations = configs
+      ActiveRecord::Base.establish_connection(:test)
+
+      # We shouldn't actually need this line if I'm not mistaken but the tests
+      # seem to fail without it ATM
+      register PaperTrail::Sinatra
+
+      get "/test" do
+        Widget.create!(name: "bar")
+        "Hai"
+      end
+
+      def current_user
+        @current_user ||= OpenStruct.new(id: "raboof")
+      end
     end
   end
 
-end
-
-class SinatraTest < ActionDispatch::IntegrationTest
-  include Rack::Test::Methods
-
-  def app
-    @app ||= Sinatra::Application
-  end
-
-  test 'baseline' do
-    assert_nil Widget.create.versions.first.whodunnit
-  end
+  class SinatraTest < ActionDispatch::IntegrationTest
+    include Rack::Test::Methods
 
-  context "`PaperTrail::Sinatra` in a `Sinatra::Application` application" do
+    def app
+      @app ||= Sinatra::Application
+    end
 
-    should "sets the `user_for_paper_trail` from the `current_user` method" do
-      get '/test'
-      assert_equal 'Hai', last_response.body
-      widget = Widget.last
-      assert_not_nil widget
-      assert_equal 'bar', widget.name
-      assert_equal 1, widget.versions.size
-      assert_equal 'raboof', widget.versions.first.whodunnit
+    test "baseline" do
+      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.last
+        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
 end

data/test/functional/thread_safety_test.rb

@@ -1,15 +1,13 @@
-require 'test_helper'
+require "test_helper"
 
 class ThreadSafetyTest < ActionController::TestCase
-  test "be thread safe when using #set_paper_trail_whodunnit" do
+  test "thread-safe when using #set_paper_trail_whodunnit" do
     blocked = true
 
     slow_thread = Thread.new do
       controller = TestController.new
       controller.send :set_paper_trail_whodunnit
-      begin
-        sleep 0.001
-      end while blocked
+      sleep 0.001 while blocked
       PaperTrail.whodunnit
     end
 
@@ -24,7 +22,7 @@ class ThreadSafetyTest < ActionController::TestCase
     assert_not_equal slow_thread.value, fast_thread.value
   end
 
-  test "be thread safe when using #without_versioning" do
+  test "thread-safe when using #without_versioning" do
     enabled = nil
 
     slow_thread = Thread.new do

data/test/paper_trail_test.rb

@@ -1,38 +1,39 @@
-require 'test_helper'
+require "test_helper"
 
 class PaperTrailTest < ActiveSupport::TestCase
-  test 'Sanity test' do
+  test "Sanity test" do
     assert_kind_of Module, PaperTrail::Version
   end
 
-  test 'Version Number' do
+  test "Version Number" do
     assert PaperTrail.const_defined?(:VERSION)
   end
-  
-  test 'enabled is thread-safe' do
-    Thread.new do
-      PaperTrail.enabled = false
-    end.join
-    assert PaperTrail.enabled?
+
+  context "setting enabled" do
+    should "affect all threads" do
+      Thread.new { PaperTrail.enabled = false }.join
+      assert_equal false, PaperTrail.enabled?
+    end
+    teardown { PaperTrail.enabled = true }
   end
 
-  test 'create with plain model class' do
+  test "create with plain model class" do
     widget = Widget.create
     assert_equal 1, widget.versions.length
   end
 
-  test 'update with plain model class' do
+  test "update with plain model class" do
     widget = Widget.create
     assert_equal 1, widget.versions.length
-    widget.update_attributes(:name => 'Bugle')
+    widget.update_attributes(name: "Bugle")
     assert_equal 2, widget.versions.length
   end
 
-  test 'destroy with plain model class' do
+  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)
+    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

@@ -1,13 +1,9 @@
-begin
-  require 'pry-nav'
-rescue LoadError
-  # It's OK, we don't include pry in e.g. gemfiles/3.0.gemfile
-end
+require "pry-nav"
 
 ENV["RAILS_ENV"] = "test"
 ENV["DB"] ||= "sqlite"
 
-unless File.exists?(File.expand_path('../../test/dummy/config/database.yml', __FILE__))
+unless File.exist?(File.expand_path("../../test/dummy/config/database.yml", __FILE__))
   warn "WARNING: No database.yml detected for the dummy app, please run `rake prepare` first"
 end
 
@@ -15,11 +11,20 @@ def using_mysql?
   @using_mysql ||= ActiveRecord::Base.connection_config[:adapter].to_sym == :mysql2
 end
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
 require "rails/test_help"
-require 'shoulda'
-require 'ffaker'
-require 'database_cleaner'
+require "shoulda"
+require "ffaker"
+require "database_cleaner"
+
+def active_record_gem_version
+  Gem::Version.new(ActiveRecord::VERSION::STRING)
+end
+
+if active_record_gem_version >= Gem::Version.new("5.0.0.beta1")
+  # See https://github.com/rails/rails-controller-testing/issues/5
+  ActionController::TestCase.send(:include, Rails::Controller::Testing::TestProcess)
+end
 
 Rails.backtrace_cleaner.remove_silencers!
 
@@ -33,45 +38,53 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 DatabaseCleaner.strategy = :truncation
 
 # global setup block resetting Thread.current
-class ActiveSupport::TestCase
-  if using_mysql?
-    self.use_transactional_fixtures = false
-    setup { DatabaseCleaner.start }
-  end
+module ActiveSupport
+  class TestCase
+    if using_mysql?
+      if respond_to? :use_transactional_tests=
+        self.use_transactional_tests = false
+      else
+        self.use_transactional_fixtures = false
+      end
+      setup { DatabaseCleaner.start }
+    end
 
-  teardown do
-    DatabaseCleaner.clean if using_mysql?
-    Thread.current[:paper_trail] = nil
-  end
+    teardown do
+      DatabaseCleaner.clean if using_mysql?
+      Thread.current[:paper_trail] = nil
+    end
 
-  private
+    private
 
-  def assert_attributes_equal(expected, actual)
-    if using_mysql?
-      expected, actual = expected.dup, actual.dup
+    def assert_attributes_equal(expected, actual)
+      if using_mysql?
+        expected = expected.dup
+        actual = actual.dup
 
-      # Adjust timestamps for missing fractional seconds precision.
-      %w(created_at updated_at).each do |timestamp|
-        expected[timestamp] = expected[timestamp].change(:usec => 0)
-        actual[timestamp]   = actual[timestamp].change(:usec => 0)
+        # Adjust timestamps for missing fractional seconds precision.
+        %w(created_at updated_at).each do |timestamp|
+          expected[timestamp] = expected[timestamp].change(usec: 0)
+          actual[timestamp] = actual[timestamp].change(usec: 0)
+        end
       end
-    end
 
-    assert_equal expected, actual
-  end
+      assert_equal expected, actual
+    end
 
-  def assert_changes_equal(expected, actual)
-    if using_mysql?
-      expected, actual = expected.dup, actual.dup
+    def assert_changes_equal(expected, actual)
+      if using_mysql?
+        expected = expected.dup
+        actual = actual.dup
 
-      # Adjust timestamps for missing fractional seconds precision.
-      %w(created_at updated_at).each do |timestamp|
-        expected[timestamp][1] = expected[timestamp][1].change(:usec => 0)
-        actual[timestamp][1]   = actual[timestamp][1].change(:usec => 0)
+        # Adjust timestamps for missing fractional seconds precision.
+        %w(created_at updated_at).each do |timestamp|
+          expected[timestamp][1] = expected[timestamp][1].change(usec: 0)
+          actual[timestamp][1] = actual[timestamp][1].change(usec: 0)
+        end
       end
-    end
 
-    assert_equal expected, actual
+      assert_equal expected, actual
+    end
   end
 end
 
@@ -89,6 +102,22 @@ def change_schema
   reset_version_class_column_info!
 end
 
+# Wrap args in a hash to support the ActionController::TestCase and
+# ActionDispatch::Integration HTTP request method switch to keyword args
+# (see https://github.com/rails/rails/blob/master/actionpack/CHANGELOG.md)
+def params_wrapper(args)
+  if defined?(::Rails) && active_record_gem_version >= Gem::Version.new("5.0.0.beta1")
+    { params: args }
+  else
+    args
+  end
+end
+
+def reset_version_class_column_info!
+  PaperTrail::Version.connection.schema_cache.clear!
+  PaperTrail::Version.reset_column_information
+end
+
 def restore_schema
   ActiveRecord::Migration.verbose = false
   ActiveRecord::Schema.define do
@@ -98,8 +127,3 @@ def restore_schema
   ActiveRecord::Migration.verbose = true
   reset_version_class_column_info!
 end
-
-def reset_version_class_column_info!
-  PaperTrail::Version.connection.schema_cache.clear!
-  PaperTrail::Version.reset_column_information
-end