paper_trail 7.0.2 → 7.0.3

data/Rakefile

@@ -14,6 +14,11 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"
   t.verbose = false
+
+  # Enabling ruby interpreter warnings (-w) is, sadly, impractical. There are
+  # too many noisy warnings that we have no control over, e.g. caused by libs we
+  # depend on.
+  t.warning = false
 end
 
 require "rspec/core/rake_task"
@@ -27,4 +32,4 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 desc "Default: run all available test suites"
-task default: %i(rubocop prepare test spec)
+task default: %i[rubocop prepare test spec]

data/doc/bug_report_template.rb

@@ -15,6 +15,8 @@ end
 require "active_record"
 require "minitest/autorun"
 require "logger"
+
+# Please use sqlite for your bug reports, if possible.
 ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
 ActiveRecord::Base.logger = nil
 ActiveRecord::Schema.define do
@@ -34,7 +36,7 @@ ActiveRecord::Schema.define do
     t.integer :transaction_id
     t.datetime :created_at
   end
-  add_index :versions, %i(item_type item_id)
+  add_index :versions, %i[item_type item_id]
   add_index :versions, [:transaction_id]
 
   create_table :version_associations do |t|
@@ -43,7 +45,7 @@ ActiveRecord::Schema.define do
     t.integer  :foreign_key_id
   end
   add_index :version_associations, [:version_id]
-  add_index :version_associations, %i(foreign_key_name foreign_key_id),
+  add_index :version_associations, %i[foreign_key_name foreign_key_id],
     name: "index_version_associations_on_foreign_key"
 end
 ActiveRecord::Base.logger = Logger.new(STDOUT)

data/doc/warning_about_not_setting_whodunnit.md

@@ -8,7 +8,7 @@ After upgrading to PaperTrail 5, you see this warning:
 
 ## You want to track whodunnit
 
-Add the set_paper_trail_whodunnit before_action to your ApplicationController.
+Add `before_action :set_paper_trail_whodunnit` to your ApplicationController.
 See the PaperTrail readme for an example (https://git.io/vrsbt).
 
 ## You don't want to track whodunnit
@@ -25,8 +25,9 @@ end
 
 ## You just want the warning to go away
 
-To disable this warning for any other reason, use `skip_after_action`.
+Upgrade to PT 6.
 
-```
-skip_after_action :warn_about_not_setting_whodunnit
-```
+## Why does PT no longer add this callback for me?
+
+So that you can control the order of callbacks. Maybe you have another callback
+that must happen first, before `set_paper_trail_whodunnit`.

data/gemfiles/ar_4.0.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "activerecord", "~> 4.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/ar_4.2.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "activerecord", "~> 4.2"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/ar_5.0.gemfile

@@ -2,8 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 5.0.0"
-gem "rspec-rails", "~> 3.5.1"
+gem "activerecord", "~> 5.0.3"
 gem "rails-controller-testing"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/ar_5.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.1.1"
+gem "rails-controller-testing"
+
+gemspec path: "../"

data/gemfiles/ar_master.gemfile

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "rails", :github => "rails/rails"
+gem "rails", github: "rails/rails"
 gem "rspec-rails", "~> 3.5.1"
 gem "rails-controller-testing"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/generators/paper_trail/templates/add_object_changes_to_versions.rb.erb

@@ -1,7 +1,7 @@
 # This migration adds the optional `object_changes` column, in which PaperTrail
 # will store the `changes` diff for each update event. See the readme for
 # details.
-class AddObjectChangesToVersions < ActiveRecord::Migration
+class AddObjectChangesToVersions < ActiveRecord::Migration<%= migration_version %>
   # The largest text column available in all supported RDBMS.
   # See `create_versions.rb` for details.
   TEXT_BYTES = 1_073_741_823

data/lib/generators/paper_trail/templates/add_transaction_id_column_to_versions.rb.erb

@@ -1,6 +1,6 @@
 # This migration and CreateVersionAssociations provide the necessary
 # schema for tracking associations.
-class AddTransactionIdColumnToVersions < ActiveRecord::Migration
+class AddTransactionIdColumnToVersions < ActiveRecord::Migration<%= migration_version %>
   def self.up
     add_column :versions, :transaction_id, :integer
     add_index :versions, [:transaction_id]

data/lib/generators/paper_trail/templates/create_version_associations.rb.erb

@@ -1,6 +1,6 @@
 # This migration and AddTransactionIdColumnToVersions provide the necessary
 # schema for tracking associations.
-class CreateVersionAssociations < ActiveRecord::Migration
+class CreateVersionAssociations < ActiveRecord::Migration<%= migration_version %>
   def self.up
     create_table :version_associations do |t|
       t.integer  :version_id

data/lib/paper_trail/model_config.rb

@@ -40,7 +40,7 @@ module PaperTrail
 
     # Adds a callback that records a version before or after a "destroy" event.
     def on_destroy(recording_order = "before")
-      unless %w(after before).include?(recording_order.to_s)
+      unless %w[after before].include?(recording_order.to_s)
         raise ArgumentError, 'recording order can only be "after" or "before"'
       end
 
@@ -76,7 +76,7 @@ module PaperTrail
     # "class attributes", instance methods, and more.
     # @api private
     def setup(options = {})
-      options[:on] ||= %i(create update destroy)
+      options[:on] ||= %i[create update destroy]
       options[:on] = Array(options[:on]) # Support single symbol
       @model_class.send :include, ::PaperTrail::Model::InstanceMethods
       if ::ActiveRecord::VERSION::STRING < "4.2"
@@ -153,7 +153,7 @@ module PaperTrail
 
     def setup_habtm_change_callbacks(assoc)
       assoc_name = assoc.name
-      %w(add remove).each do |verb|
+      %w[add remove].each do |verb|
         @model_class.send(:"before_#{verb}_for_#{assoc_name}").send(
           :<<,
           lambda do |*args|
@@ -167,7 +167,7 @@ module PaperTrail
       @model_class.class_attribute :paper_trail_options
       @model_class.paper_trail_options = options.dup
 
-      %i(ignore skip only).each do |k|
+      %i[ignore skip only].each do |k|
         @model_class.paper_trail_options[k] = [@model_class.paper_trail_options[k]].
           flatten.
           compact.

data/lib/paper_trail/version_concern.rb

@@ -24,7 +24,7 @@ module PaperTrail
 
       validates_presence_of :event
       after_create :enforce_version_limit!
-      scope :within_transaction, ->(id) { where transaction_id: id }
+      scope(:within_transaction, ->(id) { where transaction_id: id })
     end
 
     # :nodoc:
@@ -162,13 +162,13 @@ module PaperTrail
       # Returns whether the `object` column is using the `json` type supported
       # by PostgreSQL.
       def object_col_is_json?
-        %i(json jsonb).include?(columns_hash["object"].type)
+        %i[json jsonb].include?(columns_hash["object"].type)
       end
 
       # Returns whether the `object_changes` column is using the `json` type
       # supported by PostgreSQL.
       def object_changes_col_is_json?
-        %i(json jsonb).include?(columns_hash["object_changes"].try(:type))
+        %i[json jsonb].include?(columns_hash["object_changes"].try(:type))
       end
     end
 
@@ -239,7 +239,7 @@ module PaperTrail
     alias version_author terminator
 
     def sibling_versions(reload = false)
-      if reload || @sibling_versions.nil?
+      if reload || !defined?(@sibling_versions) || @sibling_versions.nil?
         @sibling_versions = self.class.with_item_keys(item_type, item_id)
       end
       @sibling_versions

data/lib/paper_trail/version_number.rb

@@ -7,7 +7,7 @@ module PaperTrail
   module VERSION
     MAJOR = 7
     MINOR = 0
-    TINY = 2
+    TINY = 3
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/paper_trail.gemspec

@@ -29,9 +29,9 @@ has been destroyed.
   s.add_dependency "request_store", "~> 1.1"
 
   s.add_development_dependency "appraisal", "~> 2.1"
-  s.add_development_dependency "rake", "~> 10.4.2"
-  s.add_development_dependency "shoulda", "~> 3.5.0"
-  s.add_development_dependency "ffaker", "~> 2.1.0"
+  s.add_development_dependency "rake", "~> 12.0"
+  s.add_development_dependency "shoulda", "~> 3.5"
+  s.add_development_dependency "ffaker", "~> 2.5"
 
   # Why `railties`? Possibly used by `test/dummy` boot up?
   s.add_development_dependency "railties", [">= 4.0", "< 5.2"]
@@ -40,8 +40,8 @@ has been destroyed.
   s.add_development_dependency "rspec-rails", "~> 3.5"
   s.add_development_dependency "generator_spec", "~> 0.9.3"
   s.add_development_dependency "database_cleaner", "~> 1.2"
-  s.add_development_dependency "pry-nav", "~> 0.2.4"
-  s.add_development_dependency "rubocop", "0.48.0"
+  s.add_development_dependency "pry-byebug", "~> 3.4"
+  s.add_development_dependency "rubocop", "0.48.1"
   s.add_development_dependency "rubocop-rspec", "~> 1.15.0"
   s.add_development_dependency "timecop", "~> 0.8.0"
   s.add_development_dependency "sqlite3", "~> 1.2"

data/spec/controllers/articles_controller_spec.rb

@@ -1,4 +1,4 @@
-require "rails_helper"
+require "spec_helper"
 
 RSpec.describe ArticlesController, type: :controller do
   describe "PaperTrail.enabled_for_controller?" do

data/spec/generators/install_generator_spec.rb

@@ -1,4 +1,4 @@
-require "rails_helper"
+require "spec_helper"
 require "generator_spec/test_case"
 require File.expand_path("../../../lib/generators/paper_trail/install_generator", __FILE__)
 
@@ -50,7 +50,7 @@ RSpec.describe PaperTrail::InstallGenerator, type: :generator do
   describe "`--with-changes` option set to `true`" do
     before(:all) do
       prepare_destination
-      run_generator %w(--with-changes)
+      run_generator %w[--with-changes]
     end
 
     it "generates a migration for creating the 'versions' table" do

data/spec/models/animal_spec.rb

@@ -1,6 +1,6 @@
-require "rails_helper"
+require "spec_helper"
 
-describe Animal, type: :model, versioning: true do
+RSpec.describe Animal, type: :model, versioning: true do
   it "baseline test setup" do
     expect(Animal.new).to be_versioned
     expect(Animal.inheritance_column).to eq("species")
@@ -28,11 +28,11 @@ describe Animal, type: :model, versioning: true do
     dog_versions = PaperTrail::Version.where(item_id: dog.id).order(:created_at)
     expect(dog_versions.count).to(eq(4))
     expect(dog_versions.first.reify).to(be_nil)
-    expect(dog_versions.map { |v| v.reify.class.name }).to eq(%w(NilClass Dog Dog Dog))
+    expect(dog_versions.map { |v| v.reify.class.name }).to eq(%w[NilClass Dog Dog Dog])
     cat_versions = PaperTrail::Version.where(item_id: cat.id).order(:created_at)
     expect(cat_versions.count).to(eq(4))
     expect(cat_versions.first.reify).to(be_nil)
-    expect(cat_versions.map { |v| v.reify.class.name }).to eq(%w(NilClass Cat Cat Cat))
+    expect(cat_versions.map { |v| v.reify.class.name }).to eq(%w[NilClass Cat Cat Cat])
   end
 
   it "allows the inheritance_column (species) to be updated" do
@@ -49,7 +49,7 @@ describe Animal, type: :model, versioning: true do
       it "trails all events" do
         callback_cat.update_attributes(name: "Billie")
         callback_cat.destroy
-        expect(callback_cat.versions.collect(&:event)).to eq %w(create update destroy)
+        expect(callback_cat.versions.collect(&:event)).to eq %w[create update destroy]
       end
 
       it "does not break reify" do

data/spec/models/boolit_spec.rb

@@ -1,5 +1,5 @@
-require "rails_helper"
-require Rails.root.join("..", "custom_json_serializer")
+require "spec_helper"
+require "support/custom_json_serializer"
 
 RSpec.describe Boolit, type: :model, versioning: true do
   subject { Boolit.create! }

data/spec/models/callback_modifier_spec.rb

@@ -1,4 +1,4 @@
-require "rails_helper"
+require "spec_helper"
 
 RSpec.describe CallbackModifier, type: :model, versioning: true do
   describe "paper_trail_on_destroy" do
@@ -60,7 +60,7 @@ RSpec.describe CallbackModifier, type: :model, versioning: true do
   context "when no callback-method used" do
     it "sets paper_trail_options[:on] to [:create, :update, :destroy]" do
       modifier = DefaultModifier.create!(some_content: FFaker::Lorem.sentence)
-      expect(modifier.paper_trail_options[:on]).to eq %i(create update destroy)
+      expect(modifier.paper_trail_options[:on]).to eq %i[create update destroy]
     end
 
     it "tracks destroy" do

data/spec/models/car_spec.rb

@@ -1,6 +1,6 @@
-require "rails_helper"
+require "spec_helper"
 
-describe Car, type: :model do
+RSpec.describe Car, type: :model do
   it { is_expected.to be_versioned }
 
   describe "changeset", versioning: true do

data/spec/models/custom_primary_key_record_spec.rb

@@ -1,6 +1,6 @@
-require "rails_helper"
+require "spec_helper"
 
-describe CustomPrimaryKeyRecord, type: :model do
+RSpec.describe CustomPrimaryKeyRecord, type: :model do
   it { is_expected.to be_versioned }
 
   describe "#versions" do

data/spec/models/document_spec.rb

@@ -1,6 +1,6 @@
-require "rails_helper"
+require "spec_helper"
 
-describe Document, type: :model do
+RSpec.describe Document, type: :model do
   describe "`have_a_version_with` matcher", versioning: true do
     it "works with custom versions association" do
       document = Document.create!(name: "Foo")

data/spec/models/gadget_spec.rb

@@ -1,6 +1,6 @@
-require "rails_helper"
+require "spec_helper"
 
-describe Gadget, type: :model do
+RSpec.describe Gadget, type: :model do
   it { is_expected.to be_versioned }
 
   let(:gadget) { Gadget.create!(name: "Wrench", brand: "Acme") }

data/spec/models/joined_version_spec.rb

@@ -1,4 +1,4 @@
-require "rails_helper"
+require "spec_helper"
 
 RSpec.describe JoinedVersion, type: :model, versioning: true do
   let(:widget) { Widget.create!(name: FFaker::Name.name) }

data/spec/models/json_version_spec.rb

@@ -1,4 +1,4 @@
-require "rails_helper"
+require "spec_helper"
 
 # The `json_versions` table tests postgres' `json` data type. So, that
 # table is only created when testing against postgres and ActiveRecord >= 4.
@@ -31,7 +31,7 @@ if JsonVersion.table_exists?
           end
 
           context "valid arguments", versioning: true do
-            let(:fruit_names) { %w(apple orange lemon banana lime coconut strawberry blueberry) }
+            let(:fruit_names) { %w[apple orange lemon banana lime coconut strawberry blueberry] }
             let(:fruit) { Fruit.new }
             let(:name) { "pomegranate" }
             let(:color) { FFaker::Color.name }
@@ -70,9 +70,9 @@ if JsonVersion.table_exists?
           end
 
           context "valid arguments", versioning: true do
-            let(:color) { %w(red green) }
+            let(:color) { %w[red green] }
             let(:fruit) { Fruit.create!(name: name[0]) }
-            let(:name) { %w(banana kiwi mango) }
+            let(:name) { %w[banana kiwi mango] }
 
             before do
               fruit.update_attributes!(name: name[1], color: color[0])

data/spec/models/kitchen/banana_spec.rb

@@ -1,7 +1,7 @@
-require "rails_helper"
+require "spec_helper"
 
 module Kitchen
-  describe Banana, type: :model do
+  RSpec.describe Banana, type: :model do
     it { is_expected.to be_versioned }
 
     describe "#versions" do

data/spec/models/not_on_update_spec.rb

@@ -1,6 +1,6 @@
-require "rails_helper"
+require "spec_helper"
 
-describe NotOnUpdate, type: :model do
+RSpec.describe NotOnUpdate, type: :model do
   describe "#touch_with_version", versioning: true do
     let!(:record) { described_class.create! }
 

data/spec/models/post_with_status_spec.rb

@@ -1,6 +1,6 @@
-require "rails_helper"
+require "spec_helper"
 
-describe PostWithStatus, type: :model do
+RSpec.describe PostWithStatus, type: :model do
   with_versioning do
     let(:post) { described_class.create!(status: "draft") }
 
@@ -17,7 +17,7 @@ describe PostWithStatus, type: :model do
       # Simulate behavior PT 4, which used to save the string version of
       # enums to `object_changes`
       version.update(object_changes: "---\nid:\n- \n- 1\nstatus:\n- draft\n- published\n")
-      assert_equal %w(draft published), version.changeset["status"]
+      assert_equal %w[draft published], version.changeset["status"]
     end
 
     context "storing enum object_changes" do
@@ -26,7 +26,7 @@ describe PostWithStatus, type: :model do
       it "saves the enum value properly in versions object_changes" do
         post.published!
         post.archived!
-        expect(subject.changeset["status"]).to eql %w(published archived)
+        expect(subject.changeset["status"]).to eql %w[published archived]
       end
     end
 

data/spec/models/skipper_spec.rb

@@ -1,4 +1,4 @@
-require "rails_helper"
+require "spec_helper"
 
 RSpec.describe Skipper, type: :model, versioning: true do
   it { is_expected.to be_versioned }