paper_trail 4.2.0 → 5.0.0

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

@@ -1,9 +1,9 @@
 class Chapter < ActiveRecord::Base
-  has_many :sections, :dependent => :destroy
-  has_many :paragraphs, :through => :sections
+  has_many :sections, dependent: :destroy
+  has_many :paragraphs, through: :sections
 
-  has_many :quotations, :dependent => :destroy
-  has_many :citations, :through => :quotations
+  has_many :quotations, dependent: :destroy
+  has_many :citations, through: :quotations
 
   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,4 @@
+class FooHabtm < ActiveRecord::Base
+  has_and_belongs_to_many :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

data/test/dummy/app/models/kitchen/banana.rb

@@ -1,5 +1,5 @@
 module Kitchen
   class Banana < ActiveRecord::Base
-    has_paper_trail :class_name => "Kitchen::BananaVersion"
+    has_paper_trail class_name: "Kitchen::BananaVersion"
   end
 end

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

@@ -1,4 +1,4 @@
 class LegacyWidget < ActiveRecord::Base
-  has_paper_trail :ignore  => :version,
-                  :version => 'custom_version'
+  has_paper_trail ignore: :version,
+                  version: "custom_version"
 end

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

@@ -1,4 +1,4 @@
 class LineItem < ActiveRecord::Base
-  belongs_to :order, :dependent => :destroy
+  belongs_to :order, dependent: :destroy
   has_paper_trail
 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: [:create, :destroy]
 end

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

@@ -1,6 +1,6 @@
 class Person < ActiveRecord::Base
-  has_many :authorships, :dependent => :destroy
-  has_many :books, :through => :authorships
+  has_many :authorships, foreign_key: :author_id, dependent: :destroy
+  has_many :books, through: :authorships
   has_paper_trail
 
   # Convert strings to TimeZone objects when assigned
@@ -8,7 +8,7 @@ class Person < ActiveRecord::Base
     if value.is_a? ActiveSupport::TimeZone
       super
     else
-      zone = ::Time.find_zone(value)  # nil if can't find time zone
+      zone = ::Time.find_zone(value) # nil if can't find time zone
       super zone
     end
   end
@@ -19,9 +19,9 @@ class Person < ActiveRecord::Base
       def dump(zone)
         zone.try(:name)
       end
-   
+
       def load(value)
-        ::Time.find_zone!(value) rescue nil
+        ::Time.find_zone(value)
       end
     end
 
@@ -33,6 +33,6 @@ class Person < ActiveRecord::Base
       self.class.load(value)
     end
   end
- 
+
   serialize :time_zone, TimeZoneSerializer.new
 end

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

@@ -1,3 +1,3 @@
 class Post < ActiveRecord::Base
-  has_paper_trail :class_name => "PostVersion"
+  has_paper_trail class_name: "PostVersion"
 end

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

@@ -3,6 +3,6 @@ class PostWithStatus < ActiveRecord::Base
 
   # ActiveRecord::Enum is only supported in AR4.1+
   if defined?(ActiveRecord::Enum)
-    enum :status => { :draft => 0, :published => 1, :archived => 2 }
+    enum status: { draft: 0, published: 1, archived: 2 }
   end
 end

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

@@ -1,5 +1,5 @@
 class Quotation < ActiveRecord::Base
   belongs_to :chapter
-  has_many :citations, :dependent => :destroy
+  has_many :citations, dependent: :destroy
   has_paper_trail
 end

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

@@ -1,6 +1,6 @@
 class Section < ActiveRecord::Base
   belongs_to :chapter
-  has_many :paragraphs, :dependent => :destroy
+  has_many :paragraphs, dependent: :destroy
 
   has_paper_trail
 end

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

@@ -1,6 +1,6 @@
 class Skipper < ActiveRecord::Base
   has_paper_trail(
-    :ignore => [:created_at],
-    :skip => [:another_timestamp]
+    ignore: [:created_at],
+    skip: [:another_timestamp]
   )
 end

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

@@ -7,6 +7,7 @@ class Song < ActiveRecord::Base
   def length=(minutes)
     write_attribute(:length, minutes.to_i * 60)
   end
+
   def length
     read_attribute(:length) / 60
   end
@@ -14,19 +15,27 @@ class Song < ActiveRecord::Base
   # override attributes hashes like some libraries do
   def attributes_with_name
     if name
-      attributes_without_name.merge(:name => name)
+      attributes_without_name.merge(name: name)
     else
       attributes_without_name
     end
   end
-  alias_method_chain :attributes, :name
+
+  # `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)
+      changed_attributes_without_name.merge(name: name)
     else
       changed_attributes_without_name
     end
   end
-  alias_method_chain :changed_attributes, :name
+
+  # `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
 end

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

@@ -1,3 +1,3 @@
 class Thing < ActiveRecord::Base
-  has_paper_trail :save_changes => false
-end
+  has_paper_trail save_changes: false
+end

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

@@ -1,4 +1,4 @@
 class Translation < ActiveRecord::Base
-  has_paper_trail :if     => Proc.new { |t| t.language_code == 'US' },
-                  :unless => Proc.new { |t| t.type == 'DRAFT'       }
+  has_paper_trail if: proc { |t| t.language_code == "US" },
+                  unless: proc { |t| t.type == "DRAFT" }
 end

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

@@ -0,0 +1,4 @@
+class Truck < Vehicle
+  # This STI child class specifically does not call `has_paper_trail`.
+  # Of the sub-classes of `Vehicle`, only `Car` is versioned.
+end

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

@@ -0,0 +1,4 @@
+class Vehicle < ActiveRecord::Base
+  # This STI parent class specifically does not call `has_paper_trail`.
+  # Of the sub-classes of `Vehicle`, only `Car` is versioned.
+end

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

@@ -1,4 +1,4 @@
 class Whatchamajigger < ActiveRecord::Base
   has_paper_trail
-  belongs_to :owner, :polymorphic => true
+  belongs_to :owner, polymorphic: true
 end

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

@@ -1,15 +1,16 @@
 class Widget < ActiveRecord::Base
   has_paper_trail
   has_one :wotsit
-  has_many :whatchamajiggers, :as => :owner
+  has_many :whatchamajiggers, as: :owner
 
-  EXCLUDED_NAME = 'Biglet'
+  EXCLUDED_NAME = "Biglet".freeze
 
-  validates :name, :exclusion => { :in => [EXCLUDED_NAME] }
+  validates :name, exclusion: { in: [EXCLUDED_NAME] }
 
-  if ::ActiveRecord::VERSION::MAJOR >= 4 # `has_many` syntax for specifying order uses a lambda in Rails 4
-    has_many :fluxors, lambda { order(:name) }
+  # `has_many` syntax for specifying order uses a lambda in Rails 4
+  if ::ActiveRecord::VERSION::MAJOR >= 4
+    has_many :fluxors, -> { order(:name) }
   else
-    has_many :fluxors, :order => :name
+    has_many :fluxors, order: :name
   end
 end

data/test/dummy/app/versions/joined_version.rb

@@ -1,5 +1,6 @@
-# The purpose of this custom version class is to test the scope methods on the VersionConcern::ClassMethods
-# module. See https://github.com/airblade/paper_trail/issues/295 for more details.
+# The purpose of this custom version class is to test the scope methods on the
+# VersionConcern::ClassMethods module. See
+# https://github.com/airblade/paper_trail/issues/295 for more details.
 class JoinedVersion < PaperTrail::Version
-  default_scope { joins('INNER JOIN widgets ON widgets.id = versions.item_id') }
+  default_scope { joins("INNER JOIN widgets ON widgets.id = versions.item_id") }
 end

data/test/dummy/app/versions/json_version.rb

@@ -1,3 +1,3 @@
 class JsonVersion < PaperTrail::Version
-  self.table_name = 'json_versions'
+  self.table_name = "json_versions"
 end

data/test/dummy/app/versions/kitchen/banana_version.rb

@@ -1,5 +1,5 @@
 module Kitchen
   class BananaVersion < PaperTrail::Version
-    self.table_name = 'banana_versions'
+    self.table_name = "banana_versions"
   end
 end

data/test/dummy/app/versions/post_version.rb

@@ -1,3 +1,3 @@
 class PostVersion < PaperTrail::Version
-  self.table_name = 'post_versions'
-end
+  self.table_name = "post_versions"
+end

data/test/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path("../config/environment", __FILE__)
 run Dummy::Application

data/test/dummy/config/application.rb

@@ -1,11 +1,11 @@
-require File.expand_path('../boot', __FILE__)
+require File.expand_path("../boot", __FILE__)
 
 # Pick the frameworks you want:
 require "active_record/railtie"
 require "action_controller/railtie"
 
 Bundler.require(:default, Rails.env) if defined?(Bundler)
-require 'paper_trail'
+require "paper_trail"
 
 module Dummy
   class Application < Rails::Application
@@ -49,19 +49,30 @@ module Dummy
     # This will create an empty whitelist of attributes available for mass-assignment for all models
     # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
     # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = false if ::PaperTrail.active_record_protected_attributes?
+    if ::PaperTrail.active_record_protected_attributes?
+      config.active_record.whitelist_attributes = false
+    end
 
-    # Enable the asset pipeline
-    config.assets.enabled = false
+    # `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.'
-
-    # supress warnings about raises in transactional callbacks on AR 4.2+
-    config.active_record.raise_in_transactional_callbacks = true if ActiveRecord::VERSION::STRING >= '4.2'
+    config.secret_key_base = "A fox regularly kicked the screaming pile of biscuits."
+
+    # `raise_in_transactional_callbacks` was added in rails 4, then deprecated
+    # in rails 5. Oh, how fickle are the gods.
+    if ActiveRecord.respond_to?(:gem_version)
+      v = ActiveRecord.gem_version
+      if v >= Gem::Version.new("4.2") && v < Gem::Version.new("5.0.0.beta1")
+        config.active_record.raise_in_transactional_callbacks = true
+      end
+      if v >= Gem::Version.new("5.0.0.beta1")
+        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=)

data/test/dummy/config/boot.rb

@@ -1,10 +1,10 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+require "rubygems"
+gemfile = File.expand_path("../../../../Gemfile", __FILE__)
 
 if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
+  ENV["BUNDLE_GEMFILE"] = gemfile
+  require "bundler"
   Bundler.setup
 end
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)

data/test/dummy/config/environment.rb

@@ -1,5 +1,5 @@
 # Load the rails application
-require File.expand_path('../application', __FILE__)
+require File.expand_path("../application", __FILE__)
 
 # Initialize the rails application
 Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -10,7 +10,7 @@ Dummy::Application.configure do
   config.eager_load = false
 
   # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
+  config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send
@@ -23,7 +23,9 @@ Dummy::Application.configure do
   config.action_dispatch.best_standards_support = :builtin
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict if ::PaperTrail.active_record_protected_attributes?
+  if ::PaperTrail.active_record_protected_attributes?
+    config.active_record.mass_assignment_sanitizer = :strict
+  end
 
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)
@@ -37,4 +39,3 @@ Dummy::Application.configure do
   # number of complex assets.
   config.assets.debug = true
 end
-

data/test/dummy/config/environments/production.rb

@@ -11,7 +11,7 @@ Dummy::Application.configure do
   config.eager_load = true
 
   # Full error reports are disabled and caching is turned on
-  config.consider_all_requests_local       = false
+  config.consider_all_requests_local = false
   config.action_controller.perform_caching = true
 
   # Disable Rails's static asset server (Apache or nginx will already do this)
@@ -51,7 +51,8 @@ Dummy::Application.configure do
   # Enable serving of images, stylesheets, and JavaScripts from an asset server
   # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # Precompile additional assets (application.js, application.css, and all
+  # non-JS/CSS are already added)
   # config.assets.precompile += %w( search.js )
 
   # Disable delivery errors, bad email addresses will be ignored

data/test/dummy/config/environments/test.rb

@@ -10,16 +10,24 @@ Dummy::Application.configure do
   # Eager loads all registered namespaces
   config.eager_load = true
 
-  # Configure static asset server for tests with Cache-Control for performance
-  if config.respond_to?(:serve_static_files=)
+  if config.respond_to?(:public_file_server)
+    config.public_file_server.enabled = true
+  elsif config.respond_to?(:serve_static_files=)
     config.serve_static_files = true
   else
     config.serve_static_assets = true
   end
-  config.static_cache_control = "public, max-age=3600"
+
+  if config.respond_to?(:public_file_server)
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=3600"
+    }
+  else
+    config.static_cache_control = "public, max-age=3600"
+  end
 
   # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
+  config.consider_all_requests_local = true
   config.action_controller.perform_caching = false
 
   # Raise exceptions instead of rendering exception templates
@@ -34,7 +42,9 @@ Dummy::Application.configure do
   # config.action_mailer.delivery_method = :test
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict if ::PaperTrail.active_record_protected_attributes?
+  if ::PaperTrail.active_record_protected_attributes?
+    config.active_record.mass_assignment_sanitizer = :strict
+  end
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr