paper_trail 5.2.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e5022690b85795b9f9d1543b34bcb2dc09cf7c1
-  data.tar.gz: 791c6da3f8bbe7da599f14814428cf4c038a6c11
+  metadata.gz: 094660b594e3a7fdd137f0b9a5e586146390223d
+  data.tar.gz: 9b0150f21b8ce6f20b2f9aefb558d03253e0e233
 SHA512:
-  metadata.gz: 97f5979d33a1f66ac7987981db9271ef2e6f2c746447eba32272ca5d3b564d5134166ad8434e6149824af6c1f048d447d8f136e9060ff64ff02fbdc34c6f975a
-  data.tar.gz: 33aa6d09d85870ec8bd1c34f71b2249f5dbb84651bb192fef2c2c57f4a4f3cbc569cb74869214926cc5038769d632dedddaafa9c858adbbb83b6911d4c5d71e6
+  metadata.gz: f382487c3077476976b91107d3fa4014859d028e45c5ae6d2b7f0dd5d9003ac24d1619029992f2fa4b2ffa5683be19f0142fd1d1f027f1f97182829775e00e14
+  data.tar.gz: 7102dab0875334e462c7ff46b7836de36028fb4ea7e1fabcf55dfcd0ec8545c56fa941ef6833f530353bf32f6aa8d42b86ee9dc64bb731cedbb0f997431a6a43

data/.github/CONTRIBUTING.md

@@ -18,6 +18,8 @@ Please use our [bug report template][1].
 
 ## Development
 
+Install gems with `bundle exec appraisal install`.
+
 Testing is a little awkward because the test suite:
 
 1. Supports three major versions of rails: 3, 4, 5

data/.rubocop.yml

@@ -6,10 +6,13 @@ inherit_from: .rubocop_todo.yml
 # - Alphabetize cops
 # - Only include permanent config; temporary goes in .rubocop_todo.yml
 
-# We do not control `schema.rb`. Exclude it from all cops.
 AllCops:
   Exclude:
-    - test/dummy/db/schema.rb
+    - gemfiles/vendor/bundle/**/* # This dir only shows up on travis ¯\_(ツ)_/¯
+    - test/dummy/db/schema.rb # Generated, out of our control
+
+  # Set to lowest supported version
+  TargetRubyVersion: 1.9
 
 # Migrations often contain long up/down methods, and extracting smaller methods
 # from these is of questionable value.

data/.rubocop_todo.yml

@@ -5,15 +5,18 @@ Metrics/AbcSize:
   Max: 30 # Goal: 15
 
 Metrics/ClassLength:
-  Max: 400
+  Max: 327
   Exclude:
     - test/**/*
 
 Metrics/CyclomaticComplexity:
-  Max: 13 # Goal: 6
+  Max: 8 # Goal: 6
 
 Metrics/ModuleLength:
   Max: 317
 
 Metrics/PerceivedComplexity:
-  Max: 16 # Goal: 7
+  Max: 10 # Goal: 7
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.3.0
+  - 2.3.1
   - 1.9.3
   - jruby-19mode
 env:

data/Appraisals

@@ -11,6 +11,7 @@ appraise "ar3" do
   gem "activerecord", "~> 3.2.22"
   gem "i18n", "~> 0.6.11"
   gem "request_store", "~> 1.1.0"
+  gem "sinatra", "~> 1.4.6"
 
   group :development, :test do
     gem 'railties', '~> 3.2.22'
@@ -23,15 +24,15 @@ end
 
 appraise "ar4" do
   gem "activerecord", "~> 4.2"
+  gem "sinatra", "~> 1.4.6"
 end
 
 appraise "ar5" do
-  gem "activerecord", "5.0.0.beta3"
-  gem "activemodel", "5.0.0.beta3"
-  gem "actionpack", "5.0.0.beta3"
-  gem "railties", "5.0.0.beta3"
-  gem "rspec-rails", "3.5.0.beta3"
+  gem "activerecord", "~> 5.0.0"
+  gem "rspec-rails", "~> 3.5.1"
   gem 'rails-controller-testing'
-  # Sinatra stable conflicts with AR5's rack dependency
-  gem 'sinatra', github: 'sinatra/sinatra'
+
+  # The AR5 version of PaperTrail is not compatible with sinatra 2 yet.
+  # Contributions welcome.
+  # gem "sinatra", "2.0.0.beta2"
 end

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## ?.?.? (Unreleased)
+# Changelog
+
+This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and the
+recommendations of [keepachangelog.com](http://keepachangelog.com/).
+
+## Unreleased
 
 ### Breaking Changes
 
@@ -14,8 +19,28 @@
 
 ### Fixed
 
+## 5.2.1 (2016-09-02)
+
+### Breaking Changes
+
+- None
+
+### Deprecated
+
+- None
+
+### Added
+
 - None
 
+### Fixed
+
+- [#857](https://github.com/airblade/paper_trail/pull/857) -
+  Fix deserialization of enums written by PT 4.
+- [#798](https://github.com/airblade/paper_trail/issues/798) -
+  Fix a rare bug with serialization of enums in rails 4.2 only when
+  using `touch_with_version`.
+
 ## 5.2.0 (2016-06-27)
 
 ### Breaking Changes

data/README.md

@@ -11,7 +11,7 @@ has been destroyed.
 | Version        | Documentation |
 | -------------- | ------------- |
 | Unreleased     | https://github.com/airblade/paper_trail/blob/master/README.md |
-| 5.2.0          | https://github.com/airblade/paper_trail/blob/v5.2.0/README.md |
+| 5.2.1          | https://github.com/airblade/paper_trail/blob/v5.2.1/README.md |
 | 4.2.0          | https://github.com/airblade/paper_trail/blob/v4.2.0/README.md |
 | 3.0.9          | https://github.com/airblade/paper_trail/blob/v3.0.9/README.md |
 | 2.7.2          | https://github.com/airblade/paper_trail/blob/v2.7.2/README.md |
@@ -24,6 +24,7 @@ has been destroyed.
   - [1.b. Installation](#1b-installation)
   - [1.c. Basic Usage](#1c-basic-usage)
   - [1.d. API Summary](#1d-api-summary)
+  - [1.e. Configuration](#1e-configuration)
 - [2. Limiting What is Versioned, and When](#2-limiting-what-is-versioned-and-when)
   - [2.a. Choosing Lifecycle Events To Monitor](#2a-choosing-lifecycle-events-to-monitor)
   - [2.b. Choosing When To Save New Versions](#2b-choosing-when-to-save-new-versions)
@@ -38,6 +39,7 @@ has been destroyed.
 - [4. Saving More Information About Versions](#4-saving-more-information-about-versions)
   - [4.a. Finding Out Who Was Responsible For A Change](#4a-finding-out-who-was-responsible-for-a-change)
   - [4.b. Associations](#4b-associations)
+    - [4.b.1. Known Issues](#4b1-known-issues)
   - [4.c. Storing metadata](#4c-storing-metadata)
 - [5. ActiveRecord](#5-activerecord)
   - [5.a. Single Table Inheritance](#5a-single-table-inheritance-sti)
@@ -67,7 +69,7 @@ has been destroyed.
 
     `gem 'paper_trail'`
 
-1. Add a `versions` table to your database.
+1. Add a `versions` table to your database and an initializer file for configuration:
 
     ```
     bundle exec rails generate paper_trail:install
@@ -87,7 +89,7 @@ has been destroyed.
     ```
 
 1. If your controllers have a `current_user` method, you can easily [track who
-is responsible for changes](#finding-out-who-was-responsible-for-a-change)
+is responsible for changes](#4a-finding-out-who-was-responsible-for-a-change)
 by adding a controller callback.
 
     ```ruby
@@ -252,6 +254,18 @@ user_for_paper_trail
 info_for_paper_trail
 ```
 
+### 1.e. Configuration
+
+Many aspects of PaperTrail are configurable for individual models; typically
+this is achieved by passing options to the `has_paper_trail` method within
+a given model.
+
+Some aspects of PaperTrail are configured globally for all models. These
+settings are assigned directly on the `PaperTrail.config` object.
+A common place to put these settings is in a Rails initializer file
+such as `config/initializers/paper_trail.rb` or in an environment-specific
+configuration file such as `config/environments/test.rb`.
+
 ## 2. Limiting What is Versioned, and When
 
 ### 2.a. Choosing Lifecycle Events To Monitor
@@ -269,7 +283,7 @@ end
 other callbacks in your model, their order relative to those installed by
 PaperTrail may matter, so be aware of any potential interactions.
 
-You may also have the `PaperTrail::Version` model save a custom string in it's
+You may also have the `PaperTrail::Version` model save a custom string in its
 `event` field instead of the typical `create`, `update`, `destroy`. PaperTrail
 supplies a custom accessor method called `paper_trail_event`, which it will
 attempt to use to fill the `event` field before falling back on one of the
@@ -431,7 +445,7 @@ Turn PaperTrail off for all threads in a `ruby` process.
 PaperTrail.enabled = false
 ```
 
-This is commonly used to speed up tests. See [Testing](#testing) below.
+This is commonly used to speed up tests. See [Testing](#7-testing) below.
 
 There is also a rails config option that does the same thing.
 
@@ -515,11 +529,12 @@ Note `version_at` gives you the object, not a version, so you don't need to call
 Undeleting is just as simple:
 
 ```ruby
-widget = Widget.find 42
+widget = Widget.find(42)
 widget.destroy
 # Time passes....
-widget = PaperTrail::Version.find(153).reify  # the widget as it was before destruction
-widget.save                                   # the widget lives!
+versions = widget.versions    # versions ordered by versions.created_at, ascending
+widget = versions.last.reify  # the widget as it was before destruction
+widget.save                   # the widget lives!
 ```
 
 You could even use PaperTrail to implement an undo system, [Ryan Bates has!][3]
@@ -749,19 +764,30 @@ string, please try the [paper_trail-globalid][37] gem.
 
 ### 4.b. Associations
 
-**Experimental feature**, see caveats below.
+**Experimental feature**, not recommended for production. See known issues
+below.
 
 PaperTrail can restore three types of associations: Has-One, Has-Many, and
-Has-Many-Through. In order to do this, you will need to create a
-`version_associations` table, either at installation time with the `rails
-generate paper_trail:install --with-associations` option or manually. PaperTrail
-will store in that table additional information to correlate versions of the
-association and versions of the model when the associated record is changed.
-When reifying the model, PaperTrail can use this table, together with the
-`transaction_id` to find the correct version of the association and reify it.
-The `transaction_id` is a unique id for version records created in the same
-transaction. It is used to associate the version of the model and the version of
-the association that are created in the same transaction.
+Has-Many-Through. In order to do this, you will need to do two things:
+
+1. Create a `version_associations` table
+2. Set `PaperTrail.config.track_associations = true` (e.g. in an initializer)
+
+Both will be done for you automatically if you install PaperTrail with the
+`--with_associations` option
+(e.g. `rails generate paper_trail:install --with-associations`)
+
+If you want to add this functionality after the initial installation, you will
+need to create the `version_associations` table manually, and you will need to
+ensure that `PaperTrail.config.track_associations = true` is set.
+
+PaperTrail will store in the `version_associations` table additional information
+to correlate versions of the association and versions of the model when the
+associated record is changed. When reifying the model, PaperTrail can use this
+table, together with the `transaction_id` to find the correct version of the
+association and reify it. The `transaction_id` is a unique id for version records
+created in the same transaction. It is used to associate the version of the model
+and the version of the association that are created in the same transaction.
 
 To restore Has-One associations as they were at the time, pass option `:has_one
 => true` to `reify`. To restore Has-Many and Has-Many-Through associations, use
@@ -840,11 +866,17 @@ widget_0.save!
 widget.reload.wotsit                             # nil
 ```
 
-**Caveats:**
+#### 4.b.1. Known Issues
 
-1. Not compatible with [transactional tests][34], aka. transactional fixtures.
-   This is a known issue [#542](https://github.com/airblade/paper_trail/issues/542)
-   that we'd like to solve.
+Associations are an **experimental feature** and have the following known
+issues, in order of descending importance.
+
+1. PaperTrail only reifies the first level of associations.
+1. [#542](https://github.com/airblade/paper_trail/issues/542) -
+   Not compatible with [transactional tests][34], aka. transactional fixtures.
+1. [#841](https://github.com/airblade/paper_trail/issues/841) -
+   Without a workaround, reified records cannot be persisted if their associated
+   records have been deleted.
 1. Requires database timestamp columns with fractional second precision.
    - Sqlite and postgres timestamps have fractional second precision by default.
    [MySQL timestamps do not][35]. Furthermore, MySQL 5.5 and earlier do not
@@ -853,11 +885,9 @@ widget.reload.wotsit                             # nil
    rails until ActiveRecord 4.2 (https://github.com/rails/rails/pull/14359).
 1. PaperTrail can't restore an association properly if the association record
    can be updated to replace its parent model (by replacing the foreign key)
-1. Currently PaperTrail only supports a single `version_associations` table. The
-   implication is that you can only use a single table to store the versions for
+1. Currently PaperTrail only supports a single `version_associations` table.
+   Therefore, you can only use a single table to store the versions for
    all related models. Sorry for those who use multiple version tables.
-1. PaperTrail only reifies the first level of associations, i.e., it does not
-   reify any associations of its associations, and so on.
 1. PaperTrail relies on the callbacks on the association model (and the :through
    association model for Has-Many-Through associations) to record the versions
    and the relationship between the versions. If the association is changed
@@ -1030,7 +1060,8 @@ Overriding associations is not recommended in general.
 ### 5.c. Generators
 
 PaperTrail has one generator, `paper_trail:install`. It writes, but does not
-run, a migration file. This migration adds (at least) the `versions` table. The
+run, a migration file.  It also creates a PaperTrail configuration intializer.
+The migration adds (at least) the `versions` table. The
 most up-to-date documentation for this generator can be found by running `rails
 generate paper_trail:install --help`, but a copy is included here for
 convenience.
@@ -1049,7 +1080,7 @@ Runtime options:
   -q, [--quiet], [--no-quiet]      # Suppress status output
   -s, [--skip], [--no-skip]        # Skip files that already exist
 
-Generates (but does not run) a migration to add a versions table.
+Generates (but does not run) a migration to add a versions table.  Also generates an initializer file for configuring PaperTrail
 ```
 
 ## 6. Extensibility
@@ -1449,7 +1480,11 @@ require 'paper_trail/frameworks/rspec'
 ## 8. Sinatra
 
 To configure PaperTrail for usage with [Sinatra][12], your `Sinatra`
-app must be using `ActiveRecord` 3 or 4. It is also recommended to use the
+app must be using `ActiveRecord` 3 or 4. There is no released version of sinatra yet
+that is compatible with AR 5. We expect sinatra 2.0 to support AR 5, but it will have
+breaking changes that will require changes to PaperTrail.
+
+It is also recommended to use the
 [Sinatra ActiveRecord Extension][13] or something similar for managing your
 applications `ActiveRecord` connection in a manner similar to the way `Rails`
 does. If using the aforementioned `Sinatra ActiveRecord Extension`, steps for
@@ -1498,7 +1533,7 @@ end
   [Thibault](http://samurails.com/about-me/), 29th September 2014
 * [Versioning with PaperTrail](http://www.sitepoint.com/versioning-papertrail),
   [Ilya Bodrov](http://www.sitepoint.com/author/ibodrov), 10th April 2014
-* [Using PaperTrail to track stack traces](http://rubyrailsexpert.com/?p=36),
+* [Using PaperTrail to track stack traces](http://web.archive.org/web/20141120233916/http://rubyrailsexpert.com/?p=36),
   T James Corcoran's blog, 1st October 2013.
 * [RailsCast #255 - Undo with PaperTrail](http://railscasts.com/episodes/255-undo-with-paper-trail),
   28th February 2011.

data/doc/bug_report_template.rb

@@ -1,19 +1,14 @@
 # Use this template to report PaperTrail bugs.
-# It is based on the ActiveRecord template.
-# https://github.com/rails/rails/blob/master/guides/bug_report_templates/active_record_gem.rb
-begin
-  require "bundler/inline"
-rescue LoadError => e
-  $stderr.puts "Bundler version 1.10 or later is required. Please update your Bundler"
-  raise e
-end
+# Please include only the minimum code necessary to reproduce your issue.
+require "bundler/inline"
 
+# STEP ONE: What versions are you using?
 gemfile(true) do
-  ruby "2.2.3"
+  ruby "2.3.1"
   source "https://rubygems.org"
-  gem "activerecord", "4.2.0"
-  gem "minitest", "5.8.3"
-  gem "paper_trail", "4.0.0", require: false
+  gem "activerecord", "5.0.0"
+  gem "minitest", "5.9.0"
+  gem "paper_trail", "5.2.0", require: false
   gem "sqlite3"
 end
 
@@ -21,13 +16,14 @@ require "active_record"
 require "minitest/autorun"
 require "logger"
 ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
-ActiveRecord::Base.logger = Logger.new(STDOUT)
-
+ActiveRecord::Base.logger = nil
 ActiveRecord::Schema.define do
+  # STEP TWO: Define your tables here.
   create_table :users, force: true do |t|
     t.text :first_name, null: false
     t.timestamps null: false
   end
+
   create_table :versions do |t|
     t.string :item_type, null: false
     t.integer :item_id, null: false
@@ -50,18 +46,20 @@ ActiveRecord::Schema.define do
   add_index :version_associations, [:foreign_key_name, :foreign_key_id],
     name: "index_version_associations_on_foreign_key"
 end
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+require "paper_trail/config"
+
+# STEP THREE: Configure PaperTrail as you would in your initializer
+PaperTrail::Config.instance.track_associations = true
 
-# Require `paper_trail.rb` after the `version_associations` table
-# exists so that PT will track associations.
 require "paper_trail"
 
-# Include your models here. Please only include the minimum code necessary to
-# reproduce your issue.
+# STEP FOUR: Define your AR models here.
 class User < ActiveRecord::Base
   has_paper_trail
 end
 
-# Please write a test that demonstrates your issue by failing.
+# STEP FIVE: Please write a test that demonstrates your issue.
 class BugTest < ActiveSupport::TestCase
   def test_1
     assert_difference(-> { PaperTrail::Version.count }, +1) {

data/gemfiles/ar3.gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "activerecord", "~> 3.2.22"
 gem "i18n", "~> 0.6.11"
 gem "request_store", "~> 1.1.0"
+gem "sinatra", "~> 1.4.6"
 
 group :development, :test do
   gem "railties", "~> 3.2.22"

data/gemfiles/ar4.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.2"
+gem "sinatra", "~> 1.4.6"
 
 gemspec :path => "../"

data/gemfiles/ar5.gemfile

@@ -2,12 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "5.0.0.beta3"
-gem "activemodel", "5.0.0.beta3"
-gem "actionpack", "5.0.0.beta3"
-gem "railties", "5.0.0.beta3"
-gem "rspec-rails", "3.5.0.beta3"
+gem "activerecord", "~> 5.0.0"
+gem "rspec-rails", "~> 3.5.1"
 gem "rails-controller-testing"
-gem "sinatra", :github => "sinatra/sinatra"
 
 gemspec :path => "../"

data/lib/generators/paper_trail/install_generator.rb

@@ -20,7 +20,8 @@ module PaperTrail
       desc: "Store transactional IDs to support association restoration"
     )
 
-    desc "Generates (but does not run) a migration to add a versions table."
+    desc "Generates (but does not run) a migration to add a versions table." \
+         "  Also generates an initializer file for configuring PaperTrail"
 
     def create_migration_file
       add_paper_trail_migration("create_versions")
@@ -31,6 +32,13 @@ module PaperTrail
       end
     end
 
+    def create_initializer
+      create_file(
+        "config/initializers/paper_trail.rb",
+        "PaperTrail.config.track_associations = #{!!options.with_associations?}"
+      )
+    end
+
     def self.next_migration_number(dirname)
       ::ActiveRecord::Generators::Base.next_migration_number(dirname)
     end

data/lib/paper_trail/attribute_serializers/cast_attribute_serializer.rb

@@ -8,19 +8,41 @@ module PaperTrail
     # This implementation depends on the `type_for_attribute` method, which was
     # introduced in rails 4.2. In older versions of rails, we shim this method
     # with `LegacyActiveRecordShim`.
+    class CastAttributeSerializer
+      def initialize(klass)
+        @klass = klass
+      end
+
+      private
+
+      # Returns a hash mapping attributes to hashes that map strings to
+      # integers. Example:
+      #
+      # ```
+      # { "status" => { "draft"=>0, "published"=>1, "archived"=>2 } }
+      # ```
+      #
+      # ActiveRecord::Enum was added in AR 4.1
+      # http://edgeguides.rubyonrails.org/4_1_release_notes.html#active-record-enums
+      def defined_enums
+        @defined_enums ||= (@klass.respond_to?(:defined_enums) ? @klass.defined_enums : {})
+      end
+    end
+
     if ::ActiveRecord::VERSION::MAJOR >= 5
       # This implementation uses AR 5's `serialize` and `deserialize`.
       class CastAttributeSerializer
-        def initialize(klass)
-          @klass = klass
-        end
-
         def serialize(attr, val)
           @klass.type_for_attribute(attr).serialize(val)
         end
 
         def deserialize(attr, val)
-          @klass.type_for_attribute(attr).deserialize(val)
+          if defined_enums[attr] && val.is_a?(::String)
+            # Because PT 4 used to save the string version of enums to `object_changes`
+            val
+          else
+            @klass.type_for_attribute(attr).deserialize(val)
+          end
         end
       end
     else
@@ -29,29 +51,29 @@ module PaperTrail
       # `type_cast_for_database` in our shim attribute type classes,
       # `NoOpAttribute` and `SerializedAttribute`.
       class CastAttributeSerializer
-        def initialize(klass)
-          @klass = klass
-        end
-
         def serialize(attr, val)
-          val = defined_enums[attr][val] if defined_enums[attr]
-          @klass.type_for_attribute(attr).type_cast_for_database(val)
+          castable_val = val
+          if defined_enums[attr]
+            # `attr` is an enum. Find the number that corresponds to `val`. If `val` is
+            # a number already, there won't be a corresponding entry, just use `val`.
+            castable_val = defined_enums[attr][val] || val
+          end
+          @klass.type_for_attribute(attr).type_cast_for_database(castable_val)
         end
 
         def deserialize(attr, val)
-          val = @klass.type_for_attribute(attr).type_cast_from_database(val)
-          if defined_enums[attr]
-            defined_enums[attr].key(val)
-          else
+          if defined_enums[attr] && val.is_a?(::String)
+            # Because PT 4 used to save the string version of enums to `object_changes`
             val
+          else
+            val = @klass.type_for_attribute(attr).type_cast_from_database(val)
+            if defined_enums[attr]
+              defined_enums[attr].key(val)
+            else
+              val
+            end
           end
         end
-
-        private
-
-        def defined_enums
-          @defined_enums ||= (@klass.respond_to?(:defined_enums) ? @klass.defined_enums : {})
-        end
       end
     end
   end

data/lib/paper_trail/model_config.rb

@@ -94,6 +94,11 @@ module PaperTrail
         ::ActiveRecord::Base.belongs_to_required_by_default
     end
 
+    def habtm_assocs_not_skipped
+      @model_class.reflect_on_all_associations(:has_and_belongs_to_many).
+        reject { |a| @model_class.paper_trail_options[:skip].include?(a.name.to_s) }
+    end
+
     def setup_associations(options)
       @model_class.class_attribute :version_association_name
       @model_class.version_association_name = options[:version] || :version
@@ -122,7 +127,7 @@ module PaperTrail
           @model_class.versions_association_name,
           class_name: @model_class.version_class_name,
           as: :item,
-          order: @model_class.paper_trail_version_class.timestamp_sort_order
+          order: @model_class.paper_trail.version_class.timestamp_sort_order
         )
       end
     end
@@ -133,18 +138,7 @@ module PaperTrail
       @model_class.send :attr_accessor, :paper_trail_habtm
       @model_class.class_attribute :paper_trail_save_join_tables
       @model_class.paper_trail_save_join_tables = Array.wrap(join_tables)
-      @model_class.reflect_on_all_associations(:has_and_belongs_to_many).
-        reject { |a| @model_class.paper_trail_options[:skip].include?(a.name.to_s) }.
-        each { |a|
-          added_callback = lambda do |*args|
-            update_habtm_state(a.name, :before_add, args[-2], args.last)
-          end
-          removed_callback = lambda do |*args|
-            update_habtm_state(a.name, :before_remove, args[-2], args.last)
-          end
-          @model_class.send(:"before_add_for_#{a.name}").send(:<<, added_callback)
-          @model_class.send(:"before_remove_for_#{a.name}").send(:<<, removed_callback)
-        }
+      habtm_assocs_not_skipped.each(&method(:setup_habtm_change_callbacks))
     end
 
     def setup_callbacks_from_options(options_on = [])
@@ -153,6 +147,18 @@ module PaperTrail
       end
     end
 
+    def setup_habtm_change_callbacks(assoc)
+      assoc_name = assoc.name
+      %w(add remove).each do |verb|
+        @model_class.send(:"before_#{verb}_for_#{assoc_name}").send(
+          :<<,
+          lambda do |*args|
+            update_habtm_state(assoc_name, :"before_#{verb}", args[-2], args.last)
+          end
+        )
+      end
+    end
+
     def setup_options(options)
       @model_class.class_attribute :paper_trail_options
       @model_class.paper_trail_options = options.dup
@@ -179,14 +185,16 @@ module PaperTrail
 
     def update_habtm_state(name, callback, model, assoc)
       model.paper_trail_habtm ||= {}
-      model.paper_trail_habtm.reverse_merge!(name => { removed: [], added: [] })
+      model.paper_trail_habtm[name] ||= { removed: [], added: [] }
+      state = model.paper_trail_habtm[name]
+      assoc_id = assoc.id
       case callback
       when :before_add
-        model.paper_trail_habtm[name][:added] |= [assoc.id]
-        model.paper_trail_habtm[name][:removed] -= [assoc.id]
+        state[:added] |= [assoc_id]
+        state[:removed] -= [assoc_id]
       when :before_remove
-        model.paper_trail_habtm[name][:removed] |= [assoc.id]
-        model.paper_trail_habtm[name][:added] -= [assoc.id]
+        state[:removed] |= [assoc_id]
+        state[:added] -= [assoc_id]
       else
         raise "Invalid callback: #{callback}"
       end

data/lib/paper_trail/version_number.rb

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

data/paper_trail.gemspec

@@ -3,7 +3,7 @@ require "paper_trail/version_number"
 
 Gem::Specification.new do |s|
   s.name = "paper_trail"
-  s.version = PaperTrail::VERSION::STRING
+  s.version = PaperTrail::VERSION::STRING.dup # The `dup` is for ruby 1.9.3
   s.platform = Gem::Platform::RUBY
   s.summary = "Track changes to your models' data. Good for auditing or versioning."
   s.description = s.summary
@@ -29,13 +29,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency "shoulda", "~> 3.5.0"
   s.add_development_dependency "ffaker", "~> 2.1.0"
   s.add_development_dependency "railties", [">= 3.0", "< 6.0"]
-  s.add_development_dependency "sinatra", "~> 1.4.6"
   s.add_development_dependency "rack-test", "~> 0.6.3"
-  s.add_development_dependency "rspec-rails", "~> 3.4.0"
+  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.40.0"
+  s.add_development_dependency "rubocop", "~> 0.41.1"
   s.add_development_dependency "timecop", "~> 0.8.0"
 
   if defined?(JRUBY_VERSION)

data/spec/models/gadget_spec.rb

@@ -25,7 +25,7 @@ describe Gadget, type: :model do
   describe "Methods" do
     describe "Instance", versioning: true do
       describe "private" do
-        describe '#changed_notably?' do
+        describe "#changed_notably?" do
           subject { Gadget.new(created_at: Time.now) }
 
           context "create events" do

data/spec/models/joined_version_spec.rb

@@ -14,19 +14,19 @@ describe JoinedVersion, type: :model, versioning: true do
     describe "VersionConcern::ClassMethods" do
       before { widget } # persist a widget
 
-      describe '#subsequent' do
+      describe "#subsequent" do
         it "shouldn't error out when there is a default_scope that joins" do
           JoinedVersion.subsequent(version).first
         end
       end
 
-      describe '#preceding' do
+      describe "#preceding" do
         it "shouldn't error out when there is a default scope that joins" do
           JoinedVersion.preceding(version).first
         end
       end
 
-      describe '#between' do
+      describe "#between" do
         it "shouldn't error out when there is a default scope that joins" do
           JoinedVersion.between(Time.now, 1.minute.from_now).first
         end
@@ -35,7 +35,7 @@ describe JoinedVersion, type: :model, versioning: true do
   end
 
   describe "Methods" do
-    describe '#index' do
+    describe "#index" do
       it { is_expected.to respond_to(:index) }
 
       it "shouldn't error out when there is a default scope that joins" do

data/spec/models/json_version_spec.rb

@@ -11,7 +11,7 @@ if JsonVersion.table_exists?
 
     describe "Methods" do
       describe "Class" do
-        describe '#where_object' do
+        describe "#where_object" do
           it { expect(JsonVersion).to respond_to(:where_object) }
 
           it "escapes values" do
@@ -50,7 +50,7 @@ if JsonVersion.table_exists?
           end
         end
 
-        describe '#where_object_changes' do
+        describe "#where_object_changes" do
           it { expect(JsonVersion).to respond_to(:where_object_changes) }
 
           it "escapes values" do

data/spec/models/kitchen/banana_spec.rb

@@ -4,7 +4,7 @@ module Kitchen
   describe Banana, type: :model do
     it { is_expected.to be_versioned }
 
-    describe '#versions' do
+    describe "#versions" do
       it "returns instances of Kitchen::BananaVersion", versioning: true do
         banana = described_class.create!
         expect(banana.versions.first).to be_a(Kitchen::BananaVersion)

data/spec/models/post_with_status_spec.rb

@@ -1,11 +1,11 @@
 require "rails_helper"
 
-# This model is in the test suite soley for the purpose of testing ActiveRecord::Enum,
-# which is available in ActiveRecord4+ only
+# This model tests ActiveRecord::Enum, which was added in AR 4.1
+# http://edgeguides.rubyonrails.org/4_1_release_notes.html#active-record-enums
 describe PostWithStatus, type: :model do
   if defined?(ActiveRecord::Enum)
     with_versioning do
-      let(:post) { PostWithStatus.create!(status: "draft") }
+      let(:post) { described_class.create!(status: "draft") }
 
       it "should stash the enum value properly in versions" do
         post.published!
@@ -13,6 +13,16 @@ describe PostWithStatus, type: :model do
         expect(post.paper_trail.previous_version.published?).to be true
       end
 
+      it "can read enums in version records written by PT 4" do
+        post = described_class.create(status: "draft")
+        post.published!
+        version = post.versions.last
+        # 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"]
+      end
+
       context "storing enum object_changes" do
         subject { post.versions.last }
 
@@ -22,6 +32,19 @@ describe PostWithStatus, type: :model do
           expect(subject.changeset["status"]).to eql %w(published archived)
         end
       end
+
+      describe "#touch_with_version" do
+        it "preserves the enum value (and all other attributes)" do
+          post = described_class.create(status: :draft)
+          expect(post.versions.count).to eq(1)
+          expect(post.status).to eq("draft")
+          Timecop.travel 1.second.since # because MySQL lacks fractional seconds precision
+          post.paper_trail.touch_with_version
+          expect(post.versions.count).to eq(2)
+          expect(post.versions.last[:object]).to include("status: 0")
+          expect(post.paper_trail.previous_version.status).to eq("draft")
+        end
+      end
     end
   end
 end

data/spec/models/version_spec.rb

@@ -6,13 +6,6 @@ describe PaperTrail::Version, type: :model do
   end
 
   describe "Attributes" do
-    it { is_expected.to have_db_column(:item_type).of_type(:string) }
-    it { is_expected.to have_db_column(:item_id).of_type(:integer) }
-    it { is_expected.to have_db_column(:event).of_type(:string) }
-    it { is_expected.to have_db_column(:whodunnit).of_type(:string) }
-    it { is_expected.to have_db_column(:object).of_type(:text) }
-    it { is_expected.to have_db_column(:created_at).of_type(:datetime) }
-
     describe "object_changes column", versioning: true do
       let(:widget) { Widget.create!(name: "Dashboard") }
       let(:value) { widget.versions.last.object_changes }
@@ -37,15 +30,11 @@ describe PaperTrail::Version, type: :model do
     end
   end
 
-  describe "Indexes" do
-    it { is_expected.to have_db_index([:item_type, :item_id]) }
-  end
-
   describe "Methods" do
     describe "Instance" do
       subject { PaperTrail::Version.new }
 
-      describe '#paper_trail_originator' do
+      describe "#paper_trail_originator" do
         it { is_expected.to respond_to(:paper_trail_originator) }
 
         context "No previous versions" do
@@ -89,7 +78,7 @@ describe PaperTrail::Version, type: :model do
         end
       end
 
-      describe '#terminator' do
+      describe "#terminator" do
         let(:attributes) { { whodunnit: FFaker::Name.first_name } }
         subject { PaperTrail::Version.new attributes }
 
@@ -100,7 +89,7 @@ describe PaperTrail::Version, type: :model do
         end
       end
 
-      describe '#version_author' do
+      describe "#version_author" do
         it { is_expected.to respond_to(:version_author) }
 
         it "should be an alias for the `terminator` method" do
@@ -140,7 +129,7 @@ describe PaperTrail::Version, type: :model do
             end
           end
 
-          describe '#where_object' do
+          describe "#where_object" do
             it { expect(PaperTrail::Version).to respond_to(:where_object) }
 
             context "invalid arguments" do
@@ -205,7 +194,7 @@ describe PaperTrail::Version, type: :model do
             end
           end
 
-          describe '#where_object_changes' do
+          describe "#where_object_changes" do
             context "invalid arguments" do
               it "should raise an error" do
                 expect {

data/spec/models/widget_spec.rb

@@ -140,7 +140,42 @@ describe Widget, type: :model do
 
   describe "Methods" do
     describe "Instance", versioning: true do
-      describe '#paper_trail.originator' do
+      describe "#create" do
+        it "creates a version record" do
+          wordget = Widget.create
+          assert_equal 1, wordget.versions.length
+        end
+      end
+
+      describe "#destroy" do
+        it "creates a version record" do
+          widget = Widget.create
+          assert_equal 1, widget.versions.length
+          widget.destroy
+          versions_for_widget = PaperTrail::Version.with_item_keys("Widget", widget.id)
+          assert_equal 2, versions_for_widget.length
+        end
+
+        it "can have multiple destruction records" do
+          versions = lambda { |widget|
+            # Workaround for AR 3. When we drop AR 3 support, we can simply use
+            # the `widget.versions` association, instead of `with_item_keys`.
+            PaperTrail::Version.with_item_keys("Widget", widget.id)
+          }
+          widget = Widget.create
+          assert_equal 1, widget.versions.length
+          widget.destroy
+          assert_equal 2, versions.call(widget).length
+          widget = widget.version.reify
+          widget.save
+          assert_equal 3, versions.call(widget).length
+          widget.destroy
+          assert_equal 4, versions.call(widget).length
+          assert_equal 2, versions.call(widget).where(event: "destroy").length
+        end
+      end
+
+      describe "#paper_trail.originator" do
         describe "return value" do
           let(:orig_name) { FFaker::Name.name }
           let(:new_name) { FFaker::Name.name }
@@ -192,7 +227,7 @@ describe Widget, type: :model do
         end
       end
 
-      describe '#version_at' do
+      describe "#version_at" do
         context "Timestamp argument is AFTER object has been destroyed" do
           it "should return `nil`" do
             widget.update_attribute(:name, "foobar")
@@ -202,7 +237,7 @@ describe Widget, type: :model do
         end
       end
 
-      describe '#whodunnit' do
+      describe "#whodunnit" do
         it { is_expected.to respond_to(:whodunnit) }
 
         context "no block given" do
@@ -250,7 +285,7 @@ describe Widget, type: :model do
         end
       end
 
-      describe '#touch_with_version' do
+      describe "#touch_with_version" do
         it "creates a version" do
           count = widget.versions.size
           # Travel 1 second because MySQL lacks sub-second resolution
@@ -269,6 +304,15 @@ describe Widget, type: :model do
           expect(widget.updated_at).to be > time_was
         end
       end
+
+      describe "#update" do
+        it "creates a version record" do
+          widget = Widget.create
+          assert_equal 1, widget.versions.length
+          widget.update_attributes(name: "Bugle")
+          assert_equal 2, widget.versions.length
+        end
+      end
     end
 
     describe "Class" do

data/spec/modules/paper_trail_spec.rb

@@ -1,7 +1,7 @@
 require "rails_helper"
 
 describe PaperTrail, type: :module, versioning: true do
-  describe '#config' do
+  describe "#config" do
     it { is_expected.to respond_to(:config) }
 
     it "should allow for config values to be set" do
@@ -17,7 +17,7 @@ describe PaperTrail, type: :module, versioning: true do
     end
   end
 
-  describe '#configure' do
+  describe "#configure" do
     it { is_expected.to respond_to(:configure) }
 
     it "should be an alias for the `config` method" do

data/spec/modules/version_number_spec.rb

@@ -36,7 +36,7 @@ describe PaperTrail::VERSION do
 end
 
 describe PaperTrail do
-  describe '#version' do
+  describe "#version" do
     it { is_expected.to respond_to(:version) }
     it { expect(subject.version).to eq(PaperTrail::VERSION::STRING) }
   end

data/spec/paper_trail_spec.rb

@@ -1,6 +1,17 @@
 require "rails_helper"
 
 describe PaperTrail do
+  context "when enabled" do
+    it "affects all threads" do
+      Thread.new { PaperTrail.enabled = false }.join
+      assert_equal false, PaperTrail.enabled?
+    end
+
+    after do
+      PaperTrail.enabled = true
+    end
+  end
+
   context "default" do
     it "should have versioning off by default" do
       expect(PaperTrail).not_to be_enabled

data/spec/rails_helper.rb

@@ -10,7 +10,6 @@ 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"
 

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

@@ -173,6 +173,7 @@ class SetUpTestTables < ActiveRecord::Migration
 
     create_table :post_with_statuses, force: true do |t|
       t.integer :status
+      t.timestamps null: false
     end
 
     create_table :animals, force: true do |t|

data/test/dummy/db/schema.rb

@@ -162,7 +162,9 @@ ActiveRecord::Schema.define(version: 20110208155312) do
   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.integer  "status"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
   create_table "posts", force: :cascade do |t|

data/test/functional/modular_sinatra_test.rb

@@ -1,11 +1,4 @@
-# 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
-#
+# PaperTrail is not compatible with sinatra 2 yet. Contributions welcome.
 if Gem::Version.new(Rack.release) < Gem::Version.new("2.0.0.alpha")
   require "test_helper"
   require "sinatra/base"

data/test/functional/sinatra_test.rb

@@ -1,11 +1,4 @@
-# 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
-#
+# PaperTrail is not compatible with sinatra 2 yet. Contributions welcome.
 if Gem::Version.new(Rack.release) < Gem::Version.new("2.0.0.alpha")
   require "test_helper"
   # require 'sinatra/main'

data/test/unit/model_test.rb

@@ -943,7 +943,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
   context "A reified item" do
     setup do
       widget = Widget.create name: "Bob"
-      %w( Tom Dick Jane ).each { |name| widget.update_attributes name: name }
+      %w(Tom Dick Jane).each { |name| widget.update_attributes name: name }
       @version = widget.versions.last
       @widget = @version.reify
     end
@@ -972,7 +972,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     context "with versions" do
       setup do
         @widget.save
-        %w( Tom Dick Jane ).each { |name| @widget.update_attributes name: name }
+        %w(Tom Dick Jane).each { |name| @widget.update_attributes name: name }
       end
 
       should "have a previous version" do
@@ -1405,7 +1405,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
   context "A reified item with a column -version- and custom version_method" do
     setup do
       widget = LegacyWidget.create(name: "foo", version: 2)
-      %w( bar baz ).each { |name| widget.update_attributes name: name }
+      %w(bar baz).each { |name| widget.update_attributes name: name }
       @version = widget.versions.last
       @widget = @version.reify
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.2.1
 platform: ruby
 authors:
 - Andy Stewart
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -141,20 +141,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.6
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -175,14 +161,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -231,14 +217,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.41.1
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -320,6 +306,7 @@ files:
 - gemfiles/ar4.gemfile
 - gemfiles/ar5.gemfile
 - lib/generators/paper_trail/USAGE
+- lib/generators/paper_trail/default_initializer.rb
 - lib/generators/paper_trail/install_generator.rb
 - lib/generators/paper_trail/templates/add_object_changes_to_versions.rb
 - lib/generators/paper_trail/templates/add_transaction_id_column_to_versions.rb
@@ -463,7 +450,6 @@ files:
 - test/functional/modular_sinatra_test.rb
 - test/functional/sinatra_test.rb
 - test/functional/thread_safety_test.rb
-- test/paper_trail_test.rb
 - test/test_helper.rb
 - test/time_travel_helper.rb
 - test/unit/associations_test.rb
@@ -612,7 +598,6 @@ test_files:
 - test/functional/modular_sinatra_test.rb
 - test/functional/sinatra_test.rb
 - test/functional/thread_safety_test.rb
-- test/paper_trail_test.rb
 - test/test_helper.rb
 - test/time_travel_helper.rb
 - test/unit/associations_test.rb

data/test/paper_trail_test.rb

@@ -1,39 +0,0 @@
-require "test_helper"
-
-class PaperTrailTest < ActiveSupport::TestCase
-  test "Sanity test" do
-    assert_kind_of Module, PaperTrail::Version
-  end
-
-  test "Version Number" do
-    assert PaperTrail.const_defined?(:VERSION)
-  end
-
-  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
-    widget = Widget.create
-    assert_equal 1, widget.versions.length
-  end
-
-  test "update with plain model class" do
-    widget = Widget.create
-    assert_equal 1, widget.versions.length
-    widget.update_attributes(name: "Bugle")
-    assert_equal 2, widget.versions.length
-  end
-
-  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)
-    assert_equal 2, versions_for_widget.length
-  end
-end