paper_trail 6.0.2 → 7.0.0

data/spec/requests/articles_spec.rb

@@ -6,14 +6,14 @@ describe "Articles management", type: :request, order: :defined do
   context "versioning disabled" do
     specify { expect(PaperTrail).not_to be_enabled }
 
-    it "should not create a version" do
+    it "does not create a version" do
       expect(PaperTrail).to be_enabled_for_controller
       expect {
         post articles_path, params_wrapper(valid_params)
-      }.to_not change(PaperTrail::Version, :count)
+      }.not_to change(PaperTrail::Version, :count)
     end
 
-    it "should not leak the state of the `PaperTrail.enabled_for_controller?` into the next test" do
+    it "does not leak the state of the `PaperTrail.enabled_for_controller?` into the next test" do
       expect(PaperTrail).to be_enabled_for_controller
     end
   end
@@ -22,7 +22,7 @@ describe "Articles management", type: :request, order: :defined do
     let(:article) { Article.last }
 
     context "`current_user` method returns a `String`" do
-      it "should set that value as the `whodunnit`" do
+      it "sets that value as the `whodunnit`" do
         expect {
           post articles_path, params_wrapper(valid_params)
         }.to change(PaperTrail::Version, :count).by(1)

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

@@ -1,11 +1,13 @@
 require "securerandom"
+
 class CustomPrimaryKeyRecord < ActiveRecord::Base
   self.primary_key = :uuid
 
   has_paper_trail class_name: "CustomPrimaryKeyRecordVersion"
-  # this unusual default_scope is to test the case of the Version#item association
+
+  # This default_scope is to test the case of the Version#item association
   # not returning the item due to unmatched default_scope on the model.
-  default_scope -> { where(name: "custom_primary_key_record") }
+  default_scope { where(name: "custom_primary_key_record") }
 
   before_create do
     self.uuid ||= SecureRandom.uuid

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

@@ -1,6 +1,6 @@
 class Document < ActiveRecord::Base
   has_paper_trail(
     versions: :paper_trail_versions,
-    on: [:create, :update]
+    on: %i(create update)
   )
 end

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

@@ -1,4 +1,4 @@
 # This model does not record versions when updated.
 class NotOnUpdate < ActiveRecord::Base
-  has_paper_trail on: [:create, :destroy]
+  has_paper_trail on: %i(create destroy)
 end

data/test/dummy/app/models/on/create.rb

@@ -0,0 +1,6 @@
+module On
+  class Create < ActiveRecord::Base
+    self.table_name = :on_create
+    has_paper_trail on: [:create]
+  end
+end

data/test/dummy/app/models/on/destroy.rb

@@ -0,0 +1,6 @@
+module On
+  class Destroy < ActiveRecord::Base
+    self.table_name = :on_destroy
+    has_paper_trail on: [:destroy]
+  end
+end

data/test/dummy/app/models/on/empty_array.rb

@@ -0,0 +1,6 @@
+module On
+  class EmptyArray < ActiveRecord::Base
+    self.table_name = :on_empty_array
+    has_paper_trail on: []
+  end
+end

data/test/dummy/app/models/on/update.rb

@@ -0,0 +1,6 @@
+module On
+  class Update < ActiveRecord::Base
+    self.table_name = :on_update
+    has_paper_trail on: [:update]
+  end
+end

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

@@ -1,6 +1,7 @@
 class Person < ActiveRecord::Base
   has_many :authorships, foreign_key: :author_id, dependent: :destroy
   has_many :books, through: :authorships
+  belongs_to :mentor, class_name: "Person", foreign_key: :mentor_id
   has_paper_trail
 
   # Convert strings to TimeZone objects when assigned

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

@@ -1,4 +1,21 @@
-# Example from 'Overwriting default accessors' in ActiveRecord::Base.
+module OverrideSongAttributesTheRails4Way
+  def attributes
+    if name
+      super.merge(name: name)
+    else
+      super
+    end
+  end
+
+  def changed_attributes
+    if name
+      super.merge(name: name)
+    else
+      super
+    end
+  end
+end
+
 class Song < ActiveRecord::Base
   has_paper_trail
 
@@ -15,32 +32,6 @@ class Song < ActiveRecord::Base
     attribute :name, :string
   else
     attr_accessor :name
-
-    # override attributes hashes like some libraries do
-    def attributes_with_name
-      if name
-        attributes_without_name.merge(name: name)
-      else
-        attributes_without_name
-      end
-    end
-
-    # `alias_method_chain` is deprecated in rails 5, but we cannot use the
-    # suggested replacement, `Module#prepend`, because we still support ruby 1.9.
-    alias attributes_without_name attributes
-    alias attributes attributes_with_name
-
-    def changed_attributes_with_name
-      if name
-        changed_attributes_without_name.merge(name: name)
-      else
-        changed_attributes_without_name
-      end
-    end
-
-    # `alias_method_chain` is deprecated in rails 5, but we cannot use the
-    # suggested replacement, `Module#prepend`, because we still support ruby 1.9.
-    alias changed_attributes_without_name changed_attributes
-    alias changed_attributes changed_attributes_with_name
+    prepend OverrideSongAttributesTheRails4Way
   end
 end

data/test/dummy/config/application.rb

@@ -4,54 +4,24 @@ require File.expand_path("../boot", __FILE__)
 require "active_record/railtie"
 require "action_controller/railtie"
 
-Bundler.require(:default, Rails.env) if defined?(Bundler)
+Bundler.require(:default, Rails.env)
 require "paper_trail"
 
 module Dummy
   class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Configure the default encoding used in templates for Ruby 1.9.
     config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
-
-    # Enable escaping HTML in JSON.
     config.active_support.escape_html_entities_in_json = true
+    config.active_support.test_order = :sorted
+
+    # Disable assets in rails 4.2. In rails 5, config does not respond to
+    # assets, probably because it was moved out of railties to some other gem,
+    # and we only have dev. dependencies on railties, not all of rails. When
+    # we drop support for rails 4.2, we can remove this whole conditional.
+    if config.respond_to?(:assets)
+      config.assets.enabled = false
+    end
 
-    # Use SQL instead of Active Record's schema dumper when creating the database.
-    # This is necessary if your schema can't be completely dumped by the schema dumper,
-    # like if you have constraints or database-specific column types
-    # config.active_record.schema_format = :sql
-
-    # `config.assets` is a `NoMethodError` in rails 5.
-    config.assets.enabled = false if config.respond_to?(:assets)
-
-    # Version of your assets, change this if you want to expire all your assets
-    # config.assets.version = '1.0'
-
-    # Rails 4 key for generating secret key
     config.secret_key_base = "A fox regularly kicked the screaming pile of biscuits."
 
     # `raise_in_transactional_callbacks` was added in rails 4, then deprecated
@@ -65,8 +35,5 @@ module Dummy
         config.active_record.time_zone_aware_types = [:datetime]
       end
     end
-
-    # Set test order for Test::Unit if possible
-    config.active_support.test_order = :sorted if config.active_support.respond_to?(:test_order=)
   end
 end

data/test/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Dummy::Application.routes.draw do
   resources :articles, only: [:create]
-  resources :widgets, only: [:create, :update, :destroy]
+  resources :widgets, only: %i(create update destroy)
 end

data/test/dummy/db/migrate/20110208155312_set_up_test_tables.rb

@@ -9,6 +9,22 @@ class SetUpTestTables < ActiveRecord::Migration
   TEXT_BYTES = 1_073_741_823
 
   def up
+    create_table :on_create, force: true do |t|
+      t.string :name, null: false
+    end
+
+    create_table :on_destroy, force: true do |t|
+      t.string :name, null: false
+    end
+
+    create_table :on_empty_array, force: true do |t|
+      t.string :name, null: false
+    end
+
+    create_table :on_update, force: true do |t|
+      t.string :name, null: false
+    end
+
     # Classes: Vehicle, Car, Truck
     create_table :vehicles, force: true do |t|
       t.string :name, null: false
@@ -57,7 +73,7 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :ip
       t.string :user_agent
     end
-    add_index :versions, [:item_type, :item_id]
+    add_index :versions, %i(item_type item_id)
 
     create_table :version_associations do |t|
       t.integer  :version_id
@@ -66,7 +82,7 @@ class SetUpTestTables < ActiveRecord::Migration
     end
     add_index :version_associations, [:version_id]
     add_index :version_associations,
-      [:foreign_key_name, :foreign_key_id],
+      %i(foreign_key_name foreign_key_id),
       name: "index_version_associations_on_foreign_key"
 
     create_table :post_versions, force: true do |t|
@@ -81,7 +97,7 @@ class SetUpTestTables < ActiveRecord::Migration
       t.string :ip
       t.string :user_agent
     end
-    add_index :post_versions, [:item_type, :item_id]
+    add_index :post_versions, %i(item_type item_id)
 
     if ENV["DB"] == "postgres" && ::ActiveRecord::VERSION::MAJOR >= 4
       create_table :json_versions, force: true do |t|
@@ -93,7 +109,7 @@ class SetUpTestTables < ActiveRecord::Migration
         t.json     :object_changes
         t.datetime :created_at
       end
-      add_index :json_versions, [:item_type, :item_id]
+      add_index :json_versions, %i(item_type item_id)
     end
 
     create_table :not_on_updates, force: true do |t|
@@ -112,7 +128,7 @@ class SetUpTestTables < ActiveRecord::Migration
       t.text     :object
       t.datetime :created_at
     end
-    add_index :banana_versions, [:item_type, :item_id]
+    add_index :banana_versions, %i(item_type item_id)
 
     create_table :wotsits, force: true do |t|
       t.integer :widget_id
@@ -150,6 +166,7 @@ class SetUpTestTables < ActiveRecord::Migration
     create_table :people, force: true do |t|
       t.string :name
       t.string :time_zone
+      t.integer :mentor_id
     end
 
     create_table :editorships, force: true do |t|
@@ -288,55 +305,12 @@ class SetUpTestTables < ActiveRecord::Migration
       t.text     :object
       t.datetime :created_at
     end
-    add_index :custom_primary_key_record_versions, [:item_type, :item_id], name: "idx_cust_pk_item"
+    add_index :custom_primary_key_record_versions, %i(item_type item_id), name: "idx_cust_pk_item"
   end
 
   def down
-    drop_table :bar_habtms_foo_habtms
-    drop_table :foo_habtms
-    drop_table :bar_habtms
-    drop_table :citations
-    drop_table :quotations
-    drop_table :animals
-    drop_table :skippers
-    drop_table :not_on_updates
-    drop_table :posts
-    drop_table :songs
-    drop_table :editors
-    drop_table :editorships
-    drop_table :people
-    drop_table :authorships
-    drop_table :books
-    drop_table :articles
-    drop_table :whatchamajiggers
-    drop_table :fluxors
-    drop_table :wotsits
-    remove_index :post_versions, column: [:item_type, :item_id]
-    drop_table :post_versions
-    remove_index :versions, column: [:item_type, :item_id]
-    drop_table :versions
-    if JsonVersion.table_exists?
-      remove_index :json_versions, column: [:item_type, :item_id]
-      drop_table :json_versions
-    end
-    drop_table :widgets
-    drop_table :documents
-    drop_table :legacy_widgets
-    drop_table :things
-    drop_table :translations
-    drop_table :gadgets
-    drop_table :customers
-    drop_table :orders
-    drop_table :line_items
-    drop_table :fruits
-    drop_table :boolits
-    drop_table :chapters
-    drop_table :sections
-    drop_table :paragraphs
-    remove_index :version_associations, column: [:version_id]
-    remove_index :version_associations, name: "index_version_associations_on_foreign_key"
-    drop_table :version_associations
-    drop_table :callback_modifiers
+    # Not actually irreversible, but there is no need to maintain this method.
+    raise ActiveRecord::IrreversibleMigration
   end
 
   private

data/test/dummy/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -37,10 +36,9 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.string   "whodunnit"
     t.text     "object"
     t.datetime "created_at"
+    t.index ["item_type", "item_id"], name: "index_banana_versions_on_item_type_and_item_id"
   end
 
-  add_index "banana_versions", ["item_type", "item_id"], name: "index_banana_versions_on_item_type_and_item_id"
-
   create_table "bananas", force: :cascade do |t|
     t.datetime "created_at"
     t.datetime "updated_at"
@@ -53,11 +51,10 @@ ActiveRecord::Schema.define(version: 20110208155312) do
   create_table "bar_habtms_foo_habtms", id: false, force: :cascade do |t|
     t.integer "foo_habtm_id"
     t.integer "bar_habtm_id"
+    t.index ["bar_habtm_id"], name: "index_bar_habtms_foo_habtms_on_bar_habtm_id"
+    t.index ["foo_habtm_id"], name: "index_bar_habtms_foo_habtms_on_foo_habtm_id"
   end
 
-  add_index "bar_habtms_foo_habtms", ["bar_habtm_id"], name: "index_bar_habtms_foo_habtms_on_bar_habtm_id"
-  add_index "bar_habtms_foo_habtms", ["foo_habtm_id"], name: "index_bar_habtms_foo_habtms_on_foo_habtm_id"
-
   create_table "books", force: :cascade do |t|
     t.string "title"
   end
@@ -87,15 +84,14 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.string   "whodunnit"
     t.text     "object"
     t.datetime "created_at"
+    t.index ["item_type", "item_id"], name: "idx_cust_pk_item"
   end
 
-  add_index "custom_primary_key_record_versions", ["item_type", "item_id"], name: "idx_cust_pk_item"
-
-  create_table "custom_primary_key_records", id: false, force: :cascade do |t|
-    t.string   "uuid"
+  create_table "custom_primary_key_records", primary_key: "uuid", id: :string, force: :cascade do |t|
     t.string   "name"
     t.datetime "created_at"
     t.datetime "updated_at"
+    t.index ["uuid"], unique: true
   end
 
   create_table "customers", force: :cascade do |t|
@@ -151,6 +147,22 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.datetime "updated_at"
   end
 
+  create_table "on_create", force: :cascade do |t|
+    t.string "name", null: false
+  end
+
+  create_table "on_destroy", force: :cascade do |t|
+    t.string "name", null: false
+  end
+
+  create_table "on_empty_array", force: :cascade do |t|
+    t.string "name", null: false
+  end
+
+  create_table "on_update", force: :cascade do |t|
+    t.string "name", null: false
+  end
+
   create_table "orders", force: :cascade do |t|
     t.integer "customer_id"
     t.string  "order_date"
@@ -162,8 +174,9 @@ ActiveRecord::Schema.define(version: 20110208155312) do
   end
 
   create_table "people", force: :cascade do |t|
-    t.string "name"
-    t.string "time_zone"
+    t.string  "name"
+    t.string  "time_zone"
+    t.integer "mentor_id"
   end
 
   create_table "post_versions", force: :cascade do |t|
@@ -175,10 +188,9 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.datetime "created_at"
     t.string   "ip"
     t.string   "user_agent"
+    t.index ["item_type", "item_id"], name: "index_post_versions_on_item_type_and_item_id"
   end
 
-  add_index "post_versions", ["item_type", "item_id"], name: "index_post_versions_on_item_type_and_item_id"
-
   create_table "post_with_statuses", force: :cascade do |t|
     t.integer  "status"
     t.datetime "created_at", null: false
@@ -232,11 +244,10 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.integer "version_id"
     t.string  "foreign_key_name", null: false
     t.integer "foreign_key_id"
+    t.index ["foreign_key_name", "foreign_key_id"], name: "index_version_associations_on_foreign_key"
+    t.index ["version_id"], name: "index_version_associations_on_version_id"
   end
 
-  add_index "version_associations", ["foreign_key_name", "foreign_key_id"], name: "index_version_associations_on_foreign_key"
-  add_index "version_associations", ["version_id"], name: "index_version_associations_on_version_id"
-
   create_table "versions", force: :cascade do |t|
     t.string   "item_type",                         null: false
     t.integer  "item_id",                           null: false
@@ -253,10 +264,9 @@ ActiveRecord::Schema.define(version: 20110208155312) do
     t.string   "title"
     t.string   "ip"
     t.string   "user_agent"
+    t.index ["item_type", "item_id"], name: "index_versions_on_item_type_and_item_id"
   end
 
-  add_index "versions", ["item_type", "item_id"], name: "index_versions_on_item_type_and_item_id"
-
   create_table "whatchamajiggers", force: :cascade do |t|
     t.string  "owner_type"
     t.integer "owner_id"