paper_trail 5.2.3 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 096e05463c63093078629b25f9be4449a57d3fa7
-  data.tar.gz: 56ab2c64e8a17af51d4acb67076740f4dd07d17e
+  metadata.gz: 70bf4fda92d269f953d7e88fc0a78f72ff3e288e
+  data.tar.gz: 52bf0491880b3dba4905af331f84bc9de67d0bef
 SHA512:
-  metadata.gz: 6e10ad3f94b5604ba97f8d49b9f5191ace437d5bd777fa78aa0f2459c82acd852aa62ddb73bd589f90b8d28f4cdd702cdc89438bb0dd63fa020edb265bf4a3db
-  data.tar.gz: 09ccd0195883ddba04a640c4a235ac4ca5ea94e006d39549d974f4181cc55c5f6856525fdcf39c32089fcfcb4cffb088b3b8894b2077ce07a46ab02a0faa2405
+  metadata.gz: 7b139581b4bf0efa29562edc58d30e3854d746d6064c1e4d0a36204ffb1ed34c81d909eea0e6866fa42b35c34f8a3b0fef5e77858f00579bdeca50441d3c13d7
+  data.tar.gz: 1608f17448169a8f2084ce44782cfcac844bd6cf4faba4f283c81b5c338dbed9afc68f5b985279e35019cdb5f40f90a2835a2f9b4ed50ff1e998dc5d78471ea2

data/.github/CONTRIBUTING.md

@@ -22,17 +22,11 @@ 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
+1. Supports multiple versions of rails
 1. Contains a "dummy" rails app with three databases (test, foo, and bar)
 1. Supports three different RDBMS': sqlite, mysql, and postgres
 
-Test against rails 3:
-
-```
-bundle exec appraisal ar3 rake
-```
-
-Run tests with sqlite:
+### Run tests with sqlite
 
 ```
 # Create the appropriate database config. file
@@ -47,10 +41,10 @@ RAILS_ENV=bar bundle exec rake db:setup
 cd ../..
 
 # Run tests
-DB=sqlite bundle exec rake
+DB=sqlite bundle exec appraisal ar-5.0 rake
 ```
 
-Run tests with mysql:
+### Run tests with mysql
 
 ```
 # Create the appropriate database config. file
@@ -65,10 +59,10 @@ RAILS_ENV=bar bundle exec rake db:setup
 cd ../..
 
 # Run tests
-DB=mysql bundle exec rake
+DB=mysql bundle exec appraisal ar-5.0 rake
 ```
 
-Run tests with postgres:
+### Run tests with postgres
 
 ```
 # Create the appropriate database config. file
@@ -78,19 +72,17 @@ DB=postgres bundle exec rake prepare
 # If this is the first test run ever, create databases.
 # Unlike mysql, use create/migrate instead of setup.
 cd test/dummy
-DB=postgres RAILS_ENV=test bundle exec rake db:create
-DB=postgres RAILS_ENV=test bundle exec rake db:migrate
-DB=postgres RAILS_ENV=foo bundle exec rake db:create
-DB=postgres RAILS_ENV=foo bundle exec rake db:migrate
-DB=postgres RAILS_ENV=bar bundle exec rake db:create
-DB=postgres RAILS_ENV=bar bundle exec rake db:migrate
+DB=postgres RAILS_ENV=test bundle exec rake db:drop db:create db:migrate
+DB=postgres RAILS_ENV=foo bundle exec rake db:drop db:create db:migrate
+DB=postgres RAILS_ENV=bar bundle exec rake db:drop db:create db:migrate
 cd ../..
 
 # Run tests
 DB=postgres bundle exec rake
+DB=postgres bundle exec appraisal ar-5.0 rake
 ```
 
-### Releases
+## Releases
 
 1. Set the version in lib/paper_trail/version_number.rb
   - Set PRE to nil unless it's a pre-release (beta, rc, etc.)
@@ -102,7 +94,7 @@ DB=postgres bundle exec rake
   - Update version number(s) in the documentation links table
 1. Commit
 1. git tag -a -m "v5.0.0" "v5.0.0" # or whatever number
-1. git push --tags origin master
+1. git push --tags origin 5-stable # or whatever branch
 1. gem build paper_trail.gemspec
 1. gem push paper_trail-5.0.0.gem
 

data/.rubocop.yml

@@ -20,6 +20,10 @@ Metrics/AbcSize:
   Exclude:
     - 'test/dummy/db/migrate/*'
 
+# Not a useful metric compared to, e.g. `AbcSize`.
+Metrics/ClassLength:
+  Enabled: false
+
 # The Ruby Style Guide recommends to "Limit lines to 80 characters."
 # (https://github.com/bbatsov/ruby-style-guide#80-character-limits)
 # but 100 is also reasonable.
@@ -32,6 +36,10 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Enabled: false
 
+# Not a useful metric compared to, e.g. `AbcSize`.
+Metrics/ModuleLength:
+  Enabled: false
+
 Style/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 

data/.rubocop_todo.yml

@@ -4,17 +4,9 @@
 Metrics/AbcSize:
   Max: 30 # Goal: 15
 
-Metrics/ClassLength:
-  Max: 327
-  Exclude:
-    - test/**/*
-
 Metrics/CyclomaticComplexity:
   Max: 8 # Goal: 6
 
-Metrics/ModuleLength:
-  Max: 317
-
 Metrics/PerceivedComplexity:
   Max: 10 # Goal: 7
 

data/.travis.yml

@@ -25,17 +25,19 @@ before_script:
   - sh -c "if [ \"$DB\" = 'postgres' ]; then psql -c 'create database paper_trail_foo;'  -U postgres; fi"
 
 gemfile:
-  - gemfiles/ar3.gemfile
-  - gemfiles/ar4.gemfile
-  - gemfiles/ar5.gemfile
+  - gemfiles/ar_4.2.gemfile
+  - gemfiles/ar_5.0.gemfile
+  - gemfiles/ar_master.gemfile
 
 matrix:
   fast_finish: true
   exclude:
-    - gemfile: gemfiles/ar5.gemfile
+    - gemfile: gemfiles/ar_5.0.gemfile
       rvm: 1.9.3
-    - gemfile: gemfiles/ar5.gemfile
+    - gemfile: gemfiles/ar_5.0.gemfile
       rvm: jruby-19mode
+  allow_failures:
+    - gemfile: gemfiles/ar_master.gemfile
 
 addons:
   postgresql: "9.4"

data/Appraisals

@@ -7,27 +7,12 @@
 # > the version from the appraisal takes precedence.
 # > https://github.com/thoughtbot/appraisal
 
-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'
-    gem 'test-unit', '~> 3.1.5'
-    platforms :ruby do
-      gem 'mysql2', '~> 0.3.20'
-    end
-  end
-end
-
-appraise "ar4" do
+appraise "ar-4.2" do
   gem "activerecord", "~> 4.2"
   gem "sinatra", "~> 1.4.6"
 end
 
-appraise "ar5" do
+appraise "ar-5.0" do
   gem "activerecord", "~> 5.0.0"
   gem "rspec-rails", "~> 3.5.1"
   gem 'rails-controller-testing'
@@ -36,3 +21,9 @@ appraise "ar5" do
   # Contributions welcome.
   # gem "sinatra", "2.0.0.beta2"
 end
+
+appraise "ar_master" do
+  gem "rails", github: "rails/rails"
+  gem "rspec-rails", "~> 3.5.1"
+  gem "rails-controller-testing"
+end

data/CHANGELOG.md

@@ -3,6 +3,51 @@
 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
+
+- None
+
+### Added
+
+- None
+
+### Fixed
+
+- None
+
+## 6.0.0 (2016-12-03)
+
+Now with rails 5.1 support, and less model pollution! About 40 methods that were
+polluting your models' namespaces have been removed, reducing the chances of a
+name conflict with your methods.
+
+### Breaking Changes
+
+- [#898](https://github.com/airblade/paper_trail/pull/898) - Dropped support
+  for rails 3
+- [#864](https://github.com/airblade/paper_trail/pull/864) - The model methods
+  deprecated in 5.2.0 have been removed. Use `paper_trail.x` instead of `x`.
+- [#861](https://github.com/airblade/paper_trail/pull/861) - `timestamp_field=`
+  removed without replacement. It is no longer configurable. The
+  timestamp field in the `versions` table must now be named `created_at`.
+
+### Deprecated
+
+- None
+
+### Added
+
+- [#900](https://github.com/airblade/paper_trail/pull/900/files) -
+  Support for rails 5.1
+- [#881](https://github.com/airblade/paper_trail/pull/881) - Add RSpec matcher
+  `have_a_version_with_changes` for easier testing.
+
+### Fixed
+
+- None
+
 ## 5.2.3 (2016-11-29)
 
 ### Breaking Changes
@@ -24,6 +69,7 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 - [#868](https://github.com/airblade/paper_trail/pull/868)
   Fix usage of find_by_id when primary key is not id, affecting reifying certain records.
 
+
 ## 5.2.2 (2016-09-08)
 
 ### Breaking Changes

data/README.md

@@ -10,7 +10,7 @@ has been destroyed.
 
 | Version        | Documentation |
 | -------------- | ------------- |
-| Unreleased     | https://github.com/airblade/paper_trail/blob/master/README.md |
+| 6.0.0          | https://github.com/airblade/paper_trail/blob/master/README.md |
 | 5.2.3          | https://github.com/airblade/paper_trail/blob/v5.2.3/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 |
@@ -49,20 +49,25 @@ has been destroyed.
   - [6.a. Custom Version Classes](#6a-custom-version-classes)
   - [6.b. Custom Serializer](#6b-custom-serializer)
 - [7. Testing](#7-testing)
+  - [7.a Minitest](#7a-minitest)
+  - [7.b RSpec](#7b-rspec)
+  - [7.c Cucumber](#7c-cucumber)
+  - [7.d Spork](#7d-spork)
+  - [7.e Zeus or Spring](#7e-zeus-or-spring)
 - [8. Sinatra](#8-sinatra)
 
 ## 1. Introduction
 
 ### 1.a. Compatibility
 
-| paper_trail    | branch     | tags   | ruby     | activerecord |
-| -------------- | ---------- | ------ | -------- | ------------ |
-| 6 (unreleased) | master     |        | >= 1.9.3 | >= 3.0, < 6  |
-| 5              | 5-stable   | v5.x   | >= 1.9.3 | >= 3.0, < 6  |
-| 4              | 4-stable   | v4.x   | >= 1.8.7 | >= 3.0, < 6  |
-| 3              | 3.0-stable | v3.x   | >= 1.8.7 | >= 3.0, < 5  |
-| 2              | 2.7-stable | v2.x   | >= 1.8.7 | >= 3.0, < 4  |
-| 1              | rails2     | v1.x   | >= 1.8.7 | >= 2.3, < 3  |
+| paper_trail    | branch     | tags   | ruby     | activerecord  |
+| -------------- | ---------- | ------ | -------- | ------------- |
+| 6              | master     | v6.x   | >= 1.9.3 | >= 4.0, < 6   |
+| 5              | 5-stable   | v5.x   | >= 1.9.3 | >= 3.0, < 5.1 |
+| 4              | 4-stable   | v4.x   | >= 1.8.7 | >= 3.0, < 5.1 |
+| 3              | 3.0-stable | v3.x   | >= 1.8.7 | >= 3.0, < 5   |
+| 2              | 2.7-stable | v2.x   | >= 1.8.7 | >= 3.0, < 4   |
+| 1              | rails2     | v1.x   | >= 1.8.7 | >= 2.3, < 3   |
 
 ### 1.b. Installation
 
@@ -721,14 +726,12 @@ the `whodunnit` value for an operation inside a block like this:
 
 ```ruby
 PaperTrail.whodunnit = 'Andy Stewart'
-widget.whodunnit('Lucas Souza') do
+widget.paper_trail.whodunnit('Lucas Souza') do
   widget.update_attributes :name => 'Wibble'
 end
 widget.versions.last.whodunnit              # Lucas Souza
 widget.update_attributes :name => 'Clair'
 widget.versions.last.whodunnit              # Andy Stewart
-widget.whodunnit('Ben Atkins') { |w| w.update_attributes :name => 'Beth' } # this syntax also works
-widget.versions.last.whodunnit              # Ben Atkins
 ```
 
 A version's `whodunnit` records who changed the object causing the `version` to
@@ -1061,7 +1064,7 @@ 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.  It also creates a PaperTrail configuration intializer.
+run, a migration file.  It also creates a PaperTrail configuration initializer.
 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
@@ -1386,26 +1389,44 @@ describe Widget do
 end
 ```
 
-It is also possible to do assertions on the versions using `have_a_version_with`
-matcher
+It is also possible to do assertions on the versions using `have_a_version_with` matcher.
 
+```ruby
+describe '`have_a_version_with` matcher' do
+  before do
+    widget.update_attributes!(name: 'Leonard', an_integer: 1)
+    widget.update_attributes!(name: 'Tom')
+    widget.update_attributes!(name: 'Bob')
+  end
+
+  it "is possible to do assertions on version attributes" do
+    expect(widget).to have_a_version_with name: 'Leonard', an_integer: 1
+    expect(widget).to have_a_version_with an_integer: 1
+    expect(widget).to have_a_version_with name: 'Tom'
+  end
+end
 ```
- describe '`have_a_version_with` matcher' do
-    before do
-      widget.update_attributes!(:name => 'Leonard', :an_integer => 1 )
-      widget.update_attributes!(:name => 'Tom')
-      widget.update_attributes!(:name => 'Bob')
-    end
+There is also a `have_a_version_with_changes` matcher. This is only usable if your versions table [has an `object_changes` column for storing changesets](#3c-diffing-versions).
 
-    it "is possible to do assertions on versions" do
-       expect(widget).to have_a_version_with :name => 'Leonard', :an_integer => 1
-       expect(widget).to have_a_version_with :an_integer => 1
-       expect(widget).to have_a_version_with :name => 'Tom'
-    end
+```ruby
+describe '`have_a_version_with_changes` matcher' do
+  before do
+    widget.update_attributes!(name: 'Leonard', an_integer: 1)
+    widget.update_attributes!(name: 'Tom')
+    widget.update_attributes!(name: 'Bob')
   end
 
+  it "is possible to do assertions on version changes" do
+    expect(widget).to have_a_version_with name: 'Leonard', an_integer: 2
+    expect(widget).to have_a_version_with an_integer: 2
+    expect(widget).to have_a_version_with name: 'Bob'
+  end
+end
 ```
 
+For more examples of the RSpec matchers, see the
+[Widget spec](https://github.com/airblade/paper_trail/blob/master/spec/models/widget_spec.rb)
+
 ### 7.c. Cucumber
 
 PaperTrail provides a helper for [Cucumber][28] that works similar to the RSpec

data/doc/triage.md

@@ -0,0 +1,27 @@
+# Triage
+
+## Response to Usage Question
+
+```
+Per our [contributing guide][1], please ask usage questions on [StackOverflow][2].
+
+Due to limited volunteer time, we can only accept bug reports and feature requests here on GitHub.
+
+Once you create a question on StackOverflow, please feel free to comment here with the URL.
+
+For instructions on how to file a bug report, please see our [issue template][3].
+
+[1]: https://github.com/airblade/paper_trail/blob/master/.github/CONTRIBUTING.md
+[2]: https://stackoverflow.com/tags/paper-trail-gem
+[3]: https://github.com/airblade/paper_trail/blob/master/.github/ISSUE_TEMPLATE.md
+```
+
+## Responses to Common Problems
+
+```
+Thanks for the bug report. Per our [contributing guide][1] please use
+our [bug report template][2].
+
+[1]: https://github.com/airblade/paper_trail/blob/master/.github/CONTRIBUTING.md
+[2]: https://github.com/airblade/paper_trail/blob/master/doc/bug_report_template.rb
+```

data/gemfiles/ar_master.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", :github => "rails/rails"
+gem "rspec-rails", "~> 3.5.1"
+gem "rails-controller-testing"
+
+gemspec :path => "../"

data/lib/paper_trail/cleaner.rb

@@ -52,7 +52,7 @@ module PaperTrail
     # versions.
     # @api private
     def group_versions_by_date(versions)
-      versions.group_by { |v| v.send(PaperTrail.timestamp_field).to_date }
+      versions.group_by { |v| v.created_at.to_date }
     end
   end
 end

data/lib/paper_trail/config.rb

@@ -7,7 +7,6 @@ module PaperTrail
   class Config
     include Singleton
     attr_accessor :serializer, :version_limit
-    attr_reader :timestamp_field # deprecated
     attr_writer :track_associations
 
     def initialize
@@ -16,7 +15,6 @@ module PaperTrail
       @enabled = true
 
       # Variables which affect all threads, whose access is *not* synchronized.
-      @timestamp_field = :created_at
       @serializer = PaperTrail::Serializers::YAML
     end
 
@@ -35,18 +33,6 @@ module PaperTrail
       )
     end
 
-    # Set the field which records when a version was created.
-    # @api public
-    # @deprecated
-    def timestamp_field=(field_name)
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.config.timestamp_field= is deprecated without replacement." \
-          "See https://github.com/airblade/paper_trail/pull/861 for discussion",
-        caller(1)
-      )
-      @timestamp_field = field_name
-    end
-
     # Previously, we checked `PaperTrail::VersionAssociation.table_exists?`
     # here, but that proved to be problematic in situations when the database
     # connection had not been established, or when the database does not exist
@@ -54,7 +40,7 @@ module PaperTrail
     def track_associations?
       if @track_associations.nil?
         ActiveSupport::Deprecation.warn <<-EOS.strip_heredoc.gsub(/\s+/, " ")
-          PaperTrail.track_associations has not been set. As of PaperTrail 5, it
+          PaperTrail.config.track_associations has not been set. As of PaperTrail 5, it
           defaults to false. Tracking associations is an experimental feature so
           we recommend setting PaperTrail.config.track_associations = false in
           your config/initializers/paper_trail.rb