paper_trail 6.0.2 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c23b36829183d413cfe6fa50f86b50dc5d5dd99a
-  data.tar.gz: c1964749e5fb1f1d23d8d066558d8d61323a6b73
+  metadata.gz: c3a67c57c19665911311eab6dc66bd670e390f57
+  data.tar.gz: f74e8562ba1ac3e305d5785e50fc1357ee0a69ca
 SHA512:
-  metadata.gz: 31692c33ac64c0322c894038b1a75c50ba5231a42ba7ebfa08a08517b721d0a08eba2e2e821566586da4a7bca7c7da92b7f74aee257bc5c698dbe8e8284a42dd
-  data.tar.gz: 0fe50a103b744687e0e2acd02dbb24c5f32f82c0255a356e89f2a66a1c5bd4bd0b688ac7eb8394cb34fb08b856780cc8e55b53be6afbaea7f6f99c24cfc5d408
+  metadata.gz: 8e493b2ef87fb52d53c54cefa55369ee31ac82261d30dac5833bc4d010aeff5387fd9362deef390b97e7b646bc22fbbaeb5ea2620d63cc2369e5e9ddcd78744e
+  data.tar.gz: 4cb5a0c791d890011e9aff19d0e8119955e43d8aab22a2bd57f5c7c9457dd5dc60345d79494aedf87e254dd3dde524832b04e2baeeca4eaedc1b7e1f91b5b893

data/.github/CONTRIBUTING.md

@@ -48,6 +48,10 @@ cd ../..
 
 # Run tests
 DB=sqlite bundle exec appraisal ar-4.2 rake
+
+# Run a single test file
+DB=sqlite bundle exec appraisal ar-4.2 ruby -I test test/unit/associations_test.rb
+DB=sqlite bundle exec appraisal ar-4.2 rspec spec/paper_trail/serializers/json_spec.rb
 ```
 
 ### Test sqlite, AR 5
@@ -118,6 +122,22 @@ DB=postgres bundle exec rake
 DB=postgres bundle exec appraisal ar-5.0 rake
 ```
 
+## Editing the migration
+
+After editing `test/dummy/db/migrate/20110208155312_set_up_test_tables.rb` ..
+
+```
+cd test/dummy
+export BUNDLE_GEMFILE=../../gemfiles/ar_5.0.gemfile
+RAILS_ENV=test bundle exec rake db:environment:set db:drop db:create db:migrate
+RAILS_ENV=foo bundle exec rake db:environment:set db:drop db:create db:migrate
+RAILS_ENV=bar bundle exec rake db:environment:set db:drop db:create db:migrate
+unset BUNDLE_GEMFILE
+cd ../..
+```
+
+Don't forget to commit changes to `schema.rb`.
+
 ## Releases
 
 1. Set the version in lib/paper_trail/version_number.rb

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-rspec
+
 inherit_from: .rubocop_todo.yml
 
 # Please:
@@ -12,7 +15,7 @@ AllCops:
     - test/dummy/db/schema.rb # Generated, out of our control
 
   # Set to lowest supported version
-  TargetRubyVersion: 1.9
+  TargetRubyVersion: 2.1
 
 # Migrations often contain long up/down methods, and extracting smaller methods
 # from these is of questionable value.
@@ -20,6 +23,10 @@ Metrics/AbcSize:
   Exclude:
     - 'test/dummy/db/migrate/*'
 
+# Not a useful metric compared to, e.g. `AbcSize`.
+Metrics/BlockLength:
+  Enabled: false
+
 # Not a useful metric compared to, e.g. `AbcSize`.
 Metrics/ClassLength:
   Enabled: false
@@ -40,6 +47,19 @@ Metrics/MethodLength:
 Metrics/ModuleLength:
   Enabled: false
 
+# In an ideal world, each example has a single expectation. In the real world,
+# sometimes setup is a pain and you don't want to duplicate setup in multiple
+# examples, or make the specs more confusing with many nested `context`s, and
+# the practical thing is to have multiple expectations.
+RSpec/MultipleExpectations:
+  Enabled: false
+
+# Yes, ideally examples would be short. Is it possible to pick a limit and say,
+# "no example will ever be longer than this"? Hard to say. Sometimes they're
+# quite long.
+RSpec/ExampleLength:
+  Enabled: false
+
 Style/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
@@ -56,17 +76,25 @@ Style/DotPosition:
 Style/DoubleNegation:
   Enabled: false
 
+Style/FileName:
+  Exclude:
+    - Appraisals
+
 # The decision of when to use a guard clause to improve readability is subtle,
 # and it's not clear that it can be linted. Certainly, the default
 # `MinBodyLength` of 1 can actually hurt readability.
 Style/GuardClause:
-  MinBodyLength: 3
+  Enabled: false
 
 # Use postfix (modifier) conditionals for one-liners, unless doing so would
 # exceed 60 characters.
 Style/IfUnlessModifier:
   MaxLineLength: 60
 
+Style/IndentHeredoc:
+  Exclude:
+    - paper_trail.gemspec
+
 # The Ruby Style Guide says:
 #
 # > Use \ instead of + or << to concatenate two string literals at line end.

data/.rubocop_todo.yml

@@ -1,3 +1,5 @@
+require: rubocop-rspec
+
 # Remove these configuration records
 # one by one as the offenses are removed from the code base.
 
@@ -12,3 +14,21 @@ Metrics/PerceivedComplexity:
 
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5 # goal: 3
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -2,8 +2,7 @@ language: ruby
 cache: bundler
 rvm:
   - 2.3.1
-  - 1.9.3
-  - jruby-19mode
+  - 2.1.10
 env:
   global:
     - TRAVIS=true
@@ -25,6 +24,7 @@ before_script:
   - sh -c "if [ \"$DB\" = 'postgres' ]; then psql -c 'create database paper_trail_foo;'  -U postgres; fi"
 
 gemfile:
+  - gemfiles/ar_4.0.gemfile
   - gemfiles/ar_4.2.gemfile
   - gemfiles/ar_5.0.gemfile
   - gemfiles/ar_master.gemfile
@@ -33,9 +33,7 @@ matrix:
   fast_finish: true
   exclude:
     - gemfile: gemfiles/ar_5.0.gemfile
-      rvm: 1.9.3
-    - gemfile: gemfiles/ar_5.0.gemfile
-      rvm: jruby-19mode
+      rvm: 2.1.10
   allow_failures:
     - gemfile: gemfiles/ar_master.gemfile
 

data/Appraisals

@@ -7,19 +7,18 @@
 # > the version from the appraisal takes precedence.
 # > https://github.com/thoughtbot/appraisal
 
+appraise "ar-4.0" do
+  gem "activerecord", "~> 4.0"
+end
+
 appraise "ar-4.2" do
   gem "activerecord", "~> 4.2"
-  gem "sinatra", "~> 1.4.6"
 end
 
 appraise "ar-5.0" do
   gem "activerecord", "~> 5.0.0"
   gem "rspec-rails", "~> 3.5.1"
-  gem 'rails-controller-testing'
-
-  # The AR5 version of PaperTrail is not compatible with sinatra 2 yet.
-  # Contributions welcome.
-  # gem "sinatra", "2.0.0.beta2"
+  gem "rails-controller-testing"
 end
 
 appraise "ar_master" do

data/CHANGELOG.md

@@ -17,6 +17,35 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 
 - None
 
+## 7.0.0 (2017-04-01)
+
+### Breaking Changes
+
+- Drop support for ruby 1.9.3, whose EOL was 2015-02-23
+- Drop support for ruby 2.0.0, whose EOL was 2016-02-24
+- Remove deprecated config methods:
+  - PaperTrail.serialized_attributes?
+  - PaperTrail.config.serialized_attributes
+  - PaperTrail.config.serialized_attributes=
+- Sinatra integration moved to
+  [paper_trail-sinatra](https://github.com/jaredbeck/paper_trail-sinatra) gem
+
+### Added
+
+- `PaperTrail.gem_version` returns a `Gem::Version`, nice for comparisons.
+
+### Fixed
+
+- [#925](https://github.com/airblade/paper_trail/pull/925) - Update RSpec
+  matchers to work with custom version association names
+- [#929](https://github.com/airblade/paper_trail/pull/929) -
+  Fix error calling private method in rails 4.0
+- [#938](https://github.com/airblade/paper_trail/pull/938) - Fix bug where
+  non-standard foreign key names broke belongs_to associations
+- [#940](https://github.com/airblade/paper_trail/pull/940) - When destroying
+  versions to stay under version_limit, don't rely on the database to
+  implicitly return the versions in the right order
+
 ## 6.0.2 (2016-12-13)
 
 ### Breaking Changes
@@ -297,6 +326,10 @@ name conflict with your methods.
 
 ## 4.1.0 (2016-01-30)
 
+### Known Issues
+
+- Version changesets now store ENUM values incorrectly (as nulls). Previously the values were stored as strings. This only affects Rails 4, not Rails 5. See [#926](https://github.com/airblade/paper_trail/pull/926)
+
 ### Breaking Changes
 
 - None

data/README.md

@@ -11,6 +11,7 @@ has been destroyed.
 | Version        | Documentation |
 | -------------- | ------------- |
 | Unreleased     | https://github.com/airblade/paper_trail/blob/master/README.md |
+| 7.0.0          | https://github.com/airblade/paper_trail/blob/v7.0.0/README.md |
 | 6.0.2          | https://github.com/airblade/paper_trail/blob/v6.0.2/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 |
@@ -64,7 +65,9 @@ has been destroyed.
 
 | paper_trail    | branch     | tags   | ruby     | activerecord  |
 | -------------- | ---------- | ------ | -------- | ------------- |
-| 6              | master     | v6.x   | >= 1.9.3 | >= 4.0, < 6   |
+| unreleased     | master     |        | >= 2.1.0 | >= 4.0, < 6   |
+| 7              | 7-stable   | v7.x   | >= 2.1.0 | >= 4.0, < 6   |
+| 6              | 6-stable   | 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   |
@@ -356,84 +359,88 @@ use attribute_name_was instead of attribute_name.
 
 ### 2.c. Choosing Attributes To Monitor
 
-You can ignore changes to certain attributes like this:
+#### Ignore
+
+You can `ignore` changes to certain attributes:
 
 ```ruby
 class Article < ActiveRecord::Base
-  has_paper_trail :ignore => [:title, :rating]
+  has_paper_trail ignore: [:title, :rating]
 end
 ```
 
-This means that changes to just the `title` or `rating` will not store another
-version of the article.  It does not mean that the `title` and `rating`
-attributes will be ignored if some other change causes a new
-`PaperTrail::Version` to be created.  For example:
+Changes to just the `title` or `rating` will not create a version record.
+Changes to other attributes will create a version record.
 
 ```ruby
 a = Article.create
 a.versions.length                         # 1
-a.update_attributes :title => 'My Title', :rating => 3
+a.update_attributes title: 'My Title', rating: 3
 a.versions.length                         # 1
-a.update_attributes :title => 'Greeting', :content => 'Hello'
+a.update_attributes title: 'Greeting', content: 'Hello'
 a.versions.length                         # 2
 a.paper_trail.previous_version.title      # 'My Title'
 ```
 
-Or, you can specify a list of all attributes you care about:
+#### Only
+
+Or, you can specify a list of the `only` attributes you care about:
 
 ```ruby
 class Article < ActiveRecord::Base
-  has_paper_trail :only => [:title]
+  has_paper_trail only: [:title]
 end
 ```
 
-This means that only changes to the `title` will save a version of the article:
+Only changes to the `title` will create a version record.
 
 ```ruby
 a = Article.create
 a.versions.length                         # 1
-a.update_attributes :title => 'My Title'
+a.update_attributes title: 'My Title'
 a.versions.length                         # 2
-a.update_attributes :content => 'Hello'
+a.update_attributes content: 'Hello'
 a.versions.length                         # 2
 a.paper_trail.previous_version.content    # nil
 ```
 
-The `:ignore` and `:only` options can also accept `Hash` arguments, where the :
+The `:ignore` and `:only` options can also accept `Hash` arguments.
 
 ```ruby
 class Article < ActiveRecord::Base
-  has_paper_trail :only => [:title => Proc.new { |obj| !obj.title.blank? } ]
+  has_paper_trail only: { title: Proc.new { |obj| !obj.title.blank? } }
 end
 ```
 
-This means that if the `title` is not blank, then only changes to the `title`
-will save a version of the article:
+If the `title` is not blank, then only changes to the `title`
+will create a version record.
 
 ```ruby
 a = Article.create
 a.versions.length                         # 1
-a.update_attributes :content => 'Hello'
+a.update_attributes content: 'Hello'
 a.versions.length                         # 2
-a.update_attributes :title => 'My Title'
+a.update_attributes title: 'Title One'
 a.versions.length                         # 3
-a.update_attributes :content => 'Hai'
+a.update_attributes content: 'Hai'
 a.versions.length                         # 3
 a.paper_trail.previous_version.content    # "Hello"
-a.update_attributes :title => 'Dif Title'
+a.update_attributes title: 'Title Two'
 a.versions.length                         # 4
 a.paper_trail.previous_version.content    # "Hai"
 ```
 
-Passing both `:ignore` and `:only` options will result in the article being
-saved if a changed attribute is included in `:only` but not in `:ignore`.
+Configuring both `:ignore` and `:only` is not recommended, but it should work as
+expected. Passing both `:ignore` and `:only` options will result in the
+article being saved if a changed attribute is included in `:only` but not in
+`:ignore`.
 
-You can skip fields altogether with the `:skip` option.  As with `:ignore`,
-updates to these fields will not create a new `PaperTrail::Version`.  In
-addition, these fields will not be included in the serialized version of the
-object whenever a new `PaperTrail::Version` is created.
+#### Skip
 
-For example:
+You can skip attributes completely with the `:skip` option.  As with `:ignore`,
+updates to these attributes will not create a version record.  In addition, if a
+version record is created for some other reason, these attributes will not be
+persisted.
 
 ```ruby
 class Article < ActiveRecord::Base
@@ -498,6 +505,9 @@ Or a block:
 end
 ```
 
+PaperTrail is disabled for the whole model
+(e.g. `Widget`), not just for the instance (e.g. `@widget`).
+
 ### 2.e. Limiting the Number of Versions Created
 
 Configure `version_limit` to cap the number of versions saved per record. This
@@ -545,7 +555,7 @@ 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]
+You could even use PaperTrail to implement an undo system; [Ryan Bates has!][3]
 
 If your model uses [optimistic locking][1] don't forget to [increment your
 `lock_version`][2] before saving or you'll get a `StaleObjectError`.
@@ -1191,7 +1201,7 @@ there's no automatic way to migrate your data. The first (slow) option is to
 loop over every record and parse it in Ruby, then write to a temporary column:
 
 ```ruby
-add_column :versions, :object, :new_object, :jsonb # or :json
+add_column :versions, :new_object, :jsonb # or :json
 
 PaperTrail::Version.reset_column_information
 PaperTrail::Version.find_each do |version|
@@ -1491,53 +1501,7 @@ 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. 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
-setting up your app with PaperTrail will look something like this:
-
-1. Add PaperTrail to your `Gemfile`.
-
-    `gem 'paper_trail'`
-
-2. Generate a migration to add a `versions` table to your database.
-
-    `bundle exec rake db:create_migration NAME=create_versions`
-
-3. Copy contents of [create_versions.rb][14]
-into the `create_versions` migration that was generated into your `db/migrate` directory.
-
-4. Run the migration.
-
-    `bundle exec rake db:migrate`
-
-5. Add `has_paper_trail` to the models you want to track.
-
-
-PaperTrail provides a helper extension that acts similar to the controller mixin
-it provides for `Rails` applications.
-
-It will set `PaperTrail.whodunnit` to whatever is returned by a method named
-`user_for_paper_trail` which you can define inside your Sinatra Application. (by
-default it attempts to invoke a method named `current_user`)
-
-If you're using the modular [`Sinatra::Base`][15] style of application, you will
-need to register the extension:
-
-```ruby
-# bleh_app.rb
-require 'sinatra/base'
-
-class BlehApp < Sinatra::Base
-  register PaperTrail::Sinatra
-end
-```
+See [paper_trail-sinatra][41].
 
 ## Articles
 
@@ -1634,10 +1598,7 @@ Released under the MIT licence.
 [9]: https://github.com/airblade/paper_trail/tree/3.0-stable
 [10]: https://github.com/airblade/paper_trail/tree/2.7-stable
 [11]: https://github.com/airblade/paper_trail/tree/rails2
-[12]: http://www.sinatrarb.com
-[13]: https://github.com/janko-m/sinatra-activerecord
 [14]: https://raw.github.com/airblade/paper_trail/master/lib/generators/paper_trail/templates/create_versions.rb
-[15]: http://www.sinatrarb.com/intro.html#Modular%20vs.%20Classic%20Style
 [16]: https://github.com/airblade/paper_trail/issues/113
 [17]: https://github.com/rails/protected_attributes
 [18]: https://github.com/rails/strong_parameters
@@ -1663,3 +1624,4 @@ Released under the MIT licence.
 [38]: https://github.com/sferik/rails_admin
 [39]: http://api.rubyonrails.org/classes/ActiveRecord/Base.html#class-ActiveRecord::Base-label-Single+table+inheritance
 [40]: http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#module-ActiveRecord::Associations::ClassMethods-label-Polymorphic+Associations
+[41]: https://github.com/jaredbeck/paper_trail-sinatra