paper_trail 4.0.0 → 5.1.0

data/spec/paper_trail/config_spec.rb

@@ -0,0 +1,33 @@
+require "rails_helper"
+
+module PaperTrail
+  RSpec.describe Config do
+    describe ".instance" do
+      it "returns the singleton instance" do
+        expect { described_class.instance }.to_not raise_error
+      end
+    end
+
+    describe ".new" do
+      it "raises NoMethodError" do
+        expect { described_class.new }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "track_associations?" do
+      context "@track_associations is nil" do
+        after do
+          PaperTrail.config.track_associations = true
+        end
+
+        it "returns false and prints a deprecation warning" do
+          config = described_class.instance
+          config.track_associations = nil
+          expect {
+            expect(config.track_associations?).to eq(false)
+          }.to output(/DEPRECATION WARNING/).to_stderr
+        end
+      end
+    end
+  end
+end

data/spec/paper_trail_spec.rb

@@ -1,11 +1,12 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe "PaperTrail RSpec Helper" do
-  context 'default' do
-    it 'should have versioning off by default' do
+describe PaperTrail do
+  context "default" do
+    it "should have versioning off by default" do
       expect(PaperTrail).not_to be_enabled
     end
-    it 'should turn versioning on in a `with_versioning` block' do
+
+    it "should turn versioning on in a `with_versioning` block" do
       expect(PaperTrail).not_to be_enabled
       with_versioning do
         expect(PaperTrail).to be_enabled
@@ -16,17 +17,18 @@ describe "PaperTrail RSpec Helper" do
     context "error within `with_versioning` block" do
       it "should revert the value of `PaperTrail.enabled?` to it's previous state" do
         expect(PaperTrail).not_to be_enabled
-        expect { with_versioning { raise } }.to raise_error
+        expect { with_versioning { raise } }.to raise_error(RuntimeError)
         expect(PaperTrail).not_to be_enabled
       end
     end
   end
 
-  context '`versioning: true`', :versioning => true do
-    it 'should have versioning on by default' do
+  context "`versioning: true`", versioning: true do
+    it "should have versioning on by default" do
       expect(PaperTrail).to be_enabled
     end
-    it 'should keep versioning on after a with_versioning block' do
+
+    it "should keep versioning on after a with_versioning block" do
       expect(PaperTrail).to be_enabled
       with_versioning do
         expect(PaperTrail).to be_enabled
@@ -35,21 +37,21 @@ describe "PaperTrail RSpec Helper" do
     end
   end
 
-  context '`with_versioning` block at class level' do
+  context "`with_versioning` block at class level" do
     it { expect(PaperTrail).not_to be_enabled }
 
     with_versioning do
-      it 'should have versioning on by default' do
+      it "should have versioning on by default" do
         expect(PaperTrail).to be_enabled
       end
     end
-    it 'should not leak the `enabled?` state into successive tests' do
+    it "should not leak the `enabled?` state into successive tests" do
       expect(PaperTrail).not_to be_enabled
     end
   end
 
   describe :whodunnit do
-    before(:all) { PaperTrail.whodunnit = 'foobar' }
+    before(:all) { PaperTrail.whodunnit = "foobar" }
 
     it "should get set to `nil` by default" do
       expect(PaperTrail.whodunnit).to be_nil
@@ -57,7 +59,7 @@ describe "PaperTrail RSpec Helper" do
   end
 
   describe :controller_info do
-    before(:all) { ::PaperTrail.controller_info = {:foo => 'bar'} }
+    before(:all) { ::PaperTrail.controller_info = { foo: "bar" } }
 
     it "should get set to an empty hash before each test" do
       expect(PaperTrail.controller_info).to eq({})

data/spec/rails_helper.rb

@@ -1,17 +1,18 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
-ENV["DB"] ||= 'sqlite'
+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
 
-require 'spec_helper'
-require File.expand_path('../../test/dummy/config/environment', __FILE__)
-require 'rspec/rails'
-require 'paper_trail/frameworks/rspec'
-require 'shoulda/matchers'
-require 'ffaker'
+require "spec_helper"
+require File.expand_path("../../test/dummy/config/environment", __FILE__)
+require "rspec/rails"
+require "paper_trail/frameworks/rspec"
+require "shoulda/matchers"
+require "ffaker"
+require "timecop"
 
 # prevent Test::Unit's AutoRunner from executing during RSpec's rake task
 Test::Unit.run = true if defined?(Test::Unit) && Test::Unit.respond_to?(:run=)

data/spec/requests/articles_spec.rb

@@ -1,14 +1,16 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe "Articles management", :type => :request, :order => :defined do
-  let(:valid_params) { { :article => { :title => 'Doh', :content => Faker::Lorem.sentence } } }
+describe "Articles management", type: :request, order: :defined do
+  let(:valid_params) { { article: { title: "Doh", content: FFaker::Lorem.sentence } } }
 
   context "versioning disabled" do
     specify { expect(PaperTrail).not_to be_enabled }
 
     it "should not create a version" do
       expect(PaperTrail).to be_enabled_for_controller
-      expect { post(articles_path, valid_params) }.to_not change(PaperTrail::Version, :count)
+      expect {
+        post articles_path, params_wrapper(valid_params)
+      }.to_not change(PaperTrail::Version, :count)
     end
 
     it "should not leak the state of the `PaperTrail.enabled_for_controller?` into the next test" do
@@ -21,9 +23,11 @@ describe "Articles management", :type => :request, :order => :defined do
 
     context "`current_user` method returns a `String`" do
       it "should set that value as the `whodunnit`" do
-        expect { post articles_path, valid_params }.to change(PaperTrail::Version, :count).by(1)
-        expect(article.title).to eq('Doh')
-        expect(article.versions.last.whodunnit).to eq('foobar')
+        expect {
+          post articles_path, params_wrapper(valid_params)
+        }.to change(PaperTrail::Version, :count).by(1)
+        expect(article.title).to eq("Doh")
+        expect(article.versions.last.whodunnit).to eq("foobar")
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require "pry-nav"
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause this
@@ -38,52 +40,75 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
+  # Support for disabling `verify_partial_doubles` on specific examples.
+  config.around(:each, verify_stubs: false) do |ex|
+    config.mock_with :rspec do |mocks|
+      mocks.verify_partial_doubles = false
+      ex.run
+      mocks.verify_partial_doubles = true
+    end
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
   # These two settings work together to allow you to limit a spec run
   # to individual examples or groups you care about by tagging them with
   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
   # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
 
   # Limits the available syntax to the non-monkey patched syntax that is recommended.
   # For more details, see:
   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
   #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
+  # config.disable_monkey_patching!
 
   # This setting enables warnings. It's recommended, but in some cases may
   # be too noisy due to issues in dependencies.
-  config.warnings = true
+  # config.warnings = true
 
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
   # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = 'doc'
+  # end
 
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 10
+  # config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = :random
+  # config.order = :random
 
   # Seed global randomization in this process using the `--seed` CLI option.
   # Setting this allows you to use `--seed` to deterministically reproduce
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
+  # Kernel.srand config.seed
+end
+
+def active_record_gem_version
+  Gem::Version.new(ActiveRecord::VERSION::STRING)
+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

data/spec/support/alt_db_init.rb

@@ -2,21 +2,16 @@
 # then defines those namespaces, then establishes the sqlite3 connection for the namespaces
 # to simulate an application with multiple database connections.
 
-#Load database yaml to use
+# Load database yaml to use
 configs = YAML.load_file("#{Rails.root}/config/database.yml")
 
-#If we are testing with sqlite make it quick
+# If we are testing with sqlite make it quick
 db_directory = "#{Rails.root}/db"
-# setup alternate databases
+
+# Set up alternate databases
 if ENV["DB"] == "sqlite"
-  if  RUBY_VERSION >= '1.9'
-    FileUtils.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-foo.sqlite3"
-    FileUtils.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-bar.sqlite3"
-  else
-    require 'ftools'
-    File.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-foo.sqlite3"
-    File.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-bar.sqlite3"
-  end
+  FileUtils.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-foo.sqlite3"
+  FileUtils.cp "#{db_directory}/test.sqlite3", "#{db_directory}/test-bar.sqlite3"
 end
 
 module Foo
@@ -29,7 +24,7 @@ module Foo
   end
 
   class Document < Base
-    has_paper_trail :class_name => 'Foo::Version'
+    has_paper_trail class_name: "Foo::Version"
   end
 end
 
@@ -48,7 +43,7 @@ module Bar
   end
 
   class Document < Base
-    has_paper_trail :class_name => 'Bar::Version'
+    has_paper_trail class_name: "Bar::Version"
   end
 end
 

data/test/custom_json_serializer.rb

@@ -4,10 +4,10 @@ module CustomJsonSerializer
 
   def self.load(string)
     parsed_value = super(string)
-    parsed_value.is_a?(Hash) ? parsed_value.reject { |k,v| k.blank? || v.blank? } : parsed_value
+    parsed_value.is_a?(Hash) ? parsed_value.reject { |k, v| k.blank? || v.blank? } : parsed_value
   end
 
   def self.dump(object)
-    object.is_a?(Hash) ? super(object.reject { |k,v| v.nil? }) : super
+    object.is_a?(Hash) ? super(object.reject { |_k, v| v.nil? }) : super
   end
-end
+end

data/test/dummy/Rakefile

@@ -1,7 +1,7 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
-require 'rake'
+require File.expand_path("../config/application", __FILE__)
+require "rake"
 
 Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -1,20 +1,33 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
 
+  # Rails 5 deprecates `before_filter`
+  name_of_before_callback = respond_to?(:before_action) ? :before_action : :before_filter
+
+  # Some applications and libraries modify `current_user`. Their changes need
+  # to be reflected in `whodunnit`, so the `set_paper_trail_whodunnit` below
+  # must happen after this.
+  send(name_of_before_callback, :modify_current_user)
+
+  # Going forward, we'll no longer add this `before_filter`, requiring people
+  # to do so themselves, allowing them to control the order in which this filter
+  # happens.
+  send(name_of_before_callback, :set_paper_trail_whodunnit)
+
   def rescue_action(e)
     raise e
   end
 
   # Returns id of hypothetical current user
-  def current_user
-    @current_user ||= OpenStruct.new(:id => 153).tap do |obj|
-      # Invoking `id` returns the `object_id` value in Ruby18 unless specifically overwritten
-      def obj.id; 153; end if RUBY_VERSION < '1.9'
-    end
-  end
+  attr_reader :current_user
 
   def info_for_paper_trail
-    {:ip => request.remote_ip, :user_agent => request.user_agent}
+    { ip: request.remote_ip, user_agent: request.user_agent }
+  end
+
+  private
+
+  def modify_current_user
+    @current_user = OpenStruct.new(id: 153)
   end
-  
 end

data/test/dummy/app/controllers/articles_controller.rb

@@ -1,17 +1,20 @@
 class ArticlesController < ApplicationController
   def create
-    if PaperTrail.active_record_protected_attributes?
-      @article = Article.create params[:article]
-    else
-      @article = Article.create params.require(:article).permit!
-    end
+    @article = Article.create article_params
     head :ok
   end
 
   def current_user
-    'foobar'.tap do |string|
-      # Invoking `id` returns the `object_id` value in Ruby18 by default
-      string.class_eval { undef_method(:id) } if RUBY_VERSION < '1.9'
+    "foobar"
+  end
+
+  private
+
+  def article_params
+    if PaperTrail.active_record_protected_attributes?
+      params[:article]
+    else
+      params.require(:article).permit!
     end
   end
 end

data/test/dummy/app/controllers/widgets_controller.rb

@@ -1,25 +1,16 @@
 class WidgetsController < ApplicationController
-
   def paper_trail_enabled_for_controller
-    request.user_agent != 'Disable User-Agent'
+    request.user_agent != "Disable User-Agent"
   end
 
   def create
-    if PaperTrail.active_record_protected_attributes?
-      @widget = Widget.create params[:widget]
-    else
-      @widget = Widget.create params[:widget].permit!
-    end
+    @widget = Widget.create widget_params
     head :ok
   end
 
   def update
     @widget = Widget.find params[:id]
-    if PaperTrail.active_record_protected_attributes?
-      @widget.update_attributes params[:widget]
-    else
-      @widget.update_attributes params[:widget].permit!
-    end
+    @widget.update_attributes widget_params
     head :ok
   end
 
@@ -28,4 +19,14 @@ class WidgetsController < ApplicationController
     @widget.destroy
     head :ok
   end
+
+  private
+
+  def widget_params
+    if PaperTrail.active_record_protected_attributes?
+      params[:widget]
+    else
+      params[:widget].permit!
+    end
+  end
 end

data/test/dummy/app/models/animal.rb

@@ -1,6 +1,6 @@
 class Animal < ActiveRecord::Base
   has_paper_trail
-  self.inheritance_column = 'species'
+  self.inheritance_column = "species"
 
   attr_accessible :species, :name if ::PaperTrail.active_record_protected_attributes?
 end

data/test/dummy/app/models/article.rb

@@ -1,16 +1,24 @@
 class Article < ActiveRecord::Base
-  has_paper_trail :ignore => [:title, { :abstract => Proc.new { |obj| ['ignore abstract', 'Other abstract'].include? obj.abstract } } ],
-                  :only => [:content, { :abstract => Proc.new { |obj| obj.abstract.present? } } ],
-                  :skip => [:file_upload],
-                  :meta => {
-                              :answer => 42,
-                              :action => :action_data_provider_method,
-                              :question => Proc.new { "31 + 11 = #{31 + 11}" },
-                              :article_id => Proc.new { |article| article.id },
-                              :title => :title
-                            }
+  has_paper_trail(
+    ignore: [
+      :title, {
+        abstract: proc { |obj|
+          ["ignore abstract", "Other abstract"].include? obj.abstract
+        }
+      }
+    ],
+    only: [:content, { abstract: proc { |obj| obj.abstract.present? } }],
+    skip: [:file_upload],
+    meta: {
+      answer: 42,
+      action: :action_data_provider_method,
+      question: proc { "31 + 11 = #{31 + 11}" },
+      article_id: proc { |article| article.id },
+      title: :title
+    }
+  )
 
   def action_data_provider_method
-    self.object_id.to_s
+    object_id.to_s
   end
 end

data/test/dummy/app/models/authorship.rb

@@ -1,5 +1,5 @@
 class Authorship < ActiveRecord::Base
   belongs_to :book
-  belongs_to :person
+  belongs_to :author, class_name: "Person"
   has_paper_trail
 end

data/test/dummy/app/models/bar_habtm.rb

@@ -0,0 +1,4 @@
+class BarHabtm < ActiveRecord::Base
+  has_and_belongs_to_many :foo_habtms
+  has_paper_trail
+end

data/test/dummy/app/models/book.rb

@@ -1,9 +1,9 @@
 class Book < ActiveRecord::Base
-  has_many :authorships, :dependent => :destroy
-  has_many :authors, :through => :authorships, :source => :person
+  has_many :authorships, dependent: :destroy
+  has_many :authors, through: :authorships
 
-  has_many :editorships, :dependent => :destroy
-  has_many :editors, :through => :editorships
+  has_many :editorships, dependent: :destroy
+  has_many :editors, through: :editorships
 
   has_paper_trail
 end

data/test/dummy/app/models/boolit.rb

@@ -1,4 +1,4 @@
 class Boolit < ActiveRecord::Base
-  default_scope { where(:scoped => true) }
+  default_scope { where(scoped: true) }
   has_paper_trail
 end

data/test/dummy/app/models/callback_modifier.rb

@@ -0,0 +1,45 @@
+class CallbackModifier < ActiveRecord::Base
+  has_paper_trail on: []
+
+  def test_destroy
+    transaction do
+      run_callbacks(:destroy) do
+        self.deleted = true
+        save!
+      end
+    end
+  end
+
+  def flagged_deleted?
+    deleted?
+  end
+end
+
+class BeforeDestroyModifier < CallbackModifier
+  has_paper_trail on: []
+  paper_trail_on_destroy :before
+end
+
+class AfterDestroyModifier < CallbackModifier
+  has_paper_trail on: []
+  paper_trail_on_destroy :after
+end
+
+class NoArgDestroyModifier < CallbackModifier
+  has_paper_trail on: []
+  paper_trail_on_destroy
+end
+
+class UpdateModifier < CallbackModifier
+  has_paper_trail on: []
+  paper_trail_on_update
+end
+
+class CreateModifier < CallbackModifier
+  has_paper_trail on: []
+  paper_trail_on_create
+end
+
+class DefaultModifier < CallbackModifier
+  has_paper_trail
+end

data/test/dummy/app/models/car.rb

@@ -0,0 +1,3 @@
+class Car < Vehicle
+  has_paper_trail
+end

data/test/dummy/app/models/chapter.rb

@@ -0,0 +1,9 @@
+class Chapter < ActiveRecord::Base
+  has_many :sections, dependent: :destroy
+  has_many :paragraphs, through: :sections
+
+  has_many :quotations, dependent: :destroy
+  has_many :citations, through: :quotations
+
+  has_paper_trail
+end

data/test/dummy/app/models/citation.rb

@@ -0,0 +1,5 @@
+class Citation < ActiveRecord::Base
+  belongs_to :quotation
+
+  has_paper_trail
+end

data/test/dummy/app/models/customer.rb

@@ -1,4 +1,4 @@
 class Customer < ActiveRecord::Base
-  has_many :orders, :dependent => :destroy
+  has_many :orders, dependent: :destroy
   has_paper_trail
 end

data/test/dummy/app/models/document.rb

@@ -1,4 +1,4 @@
 class Document < ActiveRecord::Base
-  has_paper_trail :versions => :paper_trail_versions,
-                  :on => [:create, :update]
+  has_paper_trail versions: :paper_trail_versions,
+                  on: [:create, :update]
 end

data/test/dummy/app/models/editor.rb

@@ -1,4 +1,4 @@
 # to demonstrate a has_through association that does not have paper_trail enabled
 class Editor < ActiveRecord::Base
-  has_many :editorships, :dependent => :destroy
+  has_many :editorships, dependent: :destroy
 end

data/test/dummy/app/models/foo_habtm.rb

@@ -0,0 +1,5 @@
+class FooHabtm < ActiveRecord::Base
+  has_and_belongs_to_many :bar_habtms
+  accepts_nested_attributes_for :bar_habtms
+  has_paper_trail
+end

data/test/dummy/app/models/fruit.rb

@@ -1,5 +1,5 @@
 class Fruit < ActiveRecord::Base
-  if ENV['DB'] == 'postgres' || JsonVersion.table_exists?
-    has_paper_trail :class_name => 'JsonVersion'
+  if ENV["DB"] == "postgres" || JsonVersion.table_exists?
+    has_paper_trail class_name: "JsonVersion"
   end
 end

data/test/dummy/app/models/gadget.rb

@@ -1,3 +1,3 @@
 class Gadget < ActiveRecord::Base
-  has_paper_trail :ignore => :brand
+  has_paper_trail ignore: :brand
 end