paper_trail 4.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6cf60ba027274553881419d2024a86547be00d2
-  data.tar.gz: 57495d17ebfa11d24a17cf7d65ba5e67aca92816
+  metadata.gz: 83f408e34bbaf733c5fdab5ad37fc8c3718ab7ad
+  data.tar.gz: b1e73feb664e29d18946f3c526b1bb6b1ccec024
 SHA512:
-  metadata.gz: d9c462e7bb9dfdf1404de3fb8de7484de342ab0516e0e8eaae67e3059a51e01d0e7c9b1699433857c2045bee768256ab811783ccc8568318cf14dc39c50bd6ff
-  data.tar.gz: 1e8c8098fa91e2cb9af8fae20268beceba18e885948a629e5fada7d84d2023159254da16875341436ce620365fb9f28432e4a37159ac7a9c8bc8883a2afef409
+  metadata.gz: b61edd25675bb0ea5254640920f04ff23aab1fc9dc729bc2bb27c5f4bd6774fb6e86df50d213d173a2892e7b2ef2e15240745e541d9f4fb0238c4b07574f6e56
+  data.tar.gz: 8b701f3921a8945fd3e7e55dbda82c7b716711e457f72caf7054dd502fd77a927ef5c5ebcf7d634f9c8465ba0bc8c44cc057220bea24cbaac1f5dbad7f2c9a96

data/.github/CONTRIBUTING.md

@@ -0,0 +1,105 @@
+# Contributing
+
+Thanks for your interest in PaperTrail!
+
+Ask usage questions on Stack Overflow:
+https://stackoverflow.com/tags/paper-trail-gem
+
+**Please do not use github issues to ask usage questions.**
+
+On github, we appreciate bug reports, feature
+suggestions, and especially pull requests.
+
+Thanks, and happy (paper) trails :)
+
+## Reporting Bugs
+
+Please use our [bug report template][1].
+
+## Development
+
+Testing is a little awkward because the test suite:
+
+1. Supports three major versions of rails: 3, 4, 5
+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:
+
+```
+# Create the appropriate database config. file
+rm test/dummy/config/database.yml
+DB=sqlite bundle exec rake prepare
+
+# If this is the first test run ever, create databases
+cd test/dummy
+RAILS_ENV=test bundle exec rake db:setup
+RAILS_ENV=foo bundle exec rake db:setup
+RAILS_ENV=bar bundle exec rake db:setup
+cd ../..
+
+# Run tests
+DB=sqlite bundle exec rake
+```
+
+Run tests with mysql:
+
+```
+# Create the appropriate database config. file
+rm test/dummy/config/database.yml
+DB=mysql bundle exec rake prepare
+
+# If this is the first test run ever, create databases
+cd test/dummy
+RAILS_ENV=test bundle exec rake db:setup
+RAILS_ENV=foo bundle exec rake db:setup
+RAILS_ENV=bar bundle exec rake db:setup
+cd ../..
+
+# Run tests
+DB=mysql bundle exec rake
+```
+
+Run tests with postgres:
+
+```
+# Create the appropriate database config. file
+rm test/dummy/config/database.yml
+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
+cd ../..
+
+# Run tests
+DB=postgres bundle exec rake
+```
+
+### 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.)
+1. In the changelog, replace "Unreleased" with the date.
+1. In the readme,
+  - remove "unreleased" from the doc versions table
+  - update any other references to version number
+1. Commit
+1. Tag with `git tag -a -m "v5.0.0" "v5.0.0"`
+1. `git push --tags origin master`
+1. `gem build paper_trail.gemspec`
+1. `gem push paper_trail-5.0.0.gem`
+
+[1]: https://github.com/airblade/paper_trail/blob/master/doc/bug_report_template.rb

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+Thanks for your interest in PaperTrail! Our volunteers' time is limited, so we
+can only respond on GitHub to bug reports and feature requests. Please ask
+*usage questions* on StackOverflow (https://stackoverflow.com/tags/paper-trail-gem)
+so that the whole community has a chance to answer your question.
+
+Please use our template
+(https://github.com/airblade/paper_trail/blob/master/doc/bug_report_template.rb)
+when reporting bugs.
+
+For other questions, please see our contributing guide.
+(https://github.com/airblade/paper_trail/blob/master/.github/CONTRIBUTING.md)
+
+Thanks for your contribution!

data/.gitignore

@@ -1,3 +1,4 @@
+gemfiles/*.lock
 NOTES
 test/debug.log
 test/paper_trail_plugin.sqlite3.db
@@ -19,3 +20,4 @@ vendor/*
 .tags_sorted_by_file
 .ruby-version
 .ruby-gemset
+.rbenv-gemsets

data/.rubocop.yml

@@ -0,0 +1,100 @@
+inherit_from: .rubocop_todo.yml
+
+# Please:
+#
+# - Comment any deviations from the Ruby Style Guide
+# - 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
+
+# Migrations often contain long up/down methods, and extracting smaller methods
+# from these is of questionable value.
+Metrics/AbcSize:
+  Exclude:
+    - 'test/dummy/db/migrate/*'
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*
+
+# 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.
+Metrics/LineLength:
+  Max: 100
+
+# The number of lines in a method is not a useful metric compared to `AbcSize`.
+# It's common to have very long methods (> 50 lines) which are quite simple. For
+# example, a method that returns a long string with only a few interpolations.
+Metrics/MethodLength:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# Please use semantic style, e.g. `do` when there's a side-effect, else `{}`.
+# The semantic style is too nuanced to lint, so the cop is disabled.
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Use double negation wherever it would otherwise be impractical to convert
+# a value to an actual boolean.
+Style/DoubleNegation:
+  Enabled: false
+
+# 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
+
+# Use postfix (modifier) conditionals for one-liners, unless doing so would
+# exceed 60 characters.
+Style/IfUnlessModifier:
+  MaxLineLength: 60
+
+# The Ruby Style Guide says:
+#
+# > Use \ instead of + or << to concatenate two string literals at line end.
+#
+# but in my experience the `\` style is rarely used and less readable. Please
+# concatenate multiline strings with `+` or use a HEREDOC.
+Style/LineEndConcatenation:
+  Enabled: false
+
+# Using `module_function` instead of `extend self` would make the instance
+# methods in these modules private. That would be a breaking change, so these
+# modules are excluded. See discussion in:
+# - https://github.com/airblade/paper_trail/pull/756
+# - https://github.com/bbatsov/ruby-style-guide/issues/556
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/paper_trail/serializers/json.rb'
+    - 'lib/paper_trail/serializers/yaml.rb'
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/PredicateName:
+  NameWhitelist: has_paper_trail
+
+# The Ruby Style Guide does not prescribe a particular quote character, only
+# that a project should pick one and be consistent. The decision has no
+# performance implications. Double quotes are slightly easier to read.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Use exactly one space on each side of an operator. Do not align operators
+# because it makes the code harder to edit, and makes lines unnecessarily long.
+Style/SpaceAroundOperators:
+  AllowForAlignment: false

data/.rubocop_todo.yml

@@ -0,0 +1,14 @@
+# Remove these configuration records
+# one by one as the offenses are removed from the code base.
+
+Metrics/AbcSize:
+  Max: 30 # Goal: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 13 # Goal: 6
+
+Metrics/ModuleLength:
+  Max: 313
+
+Metrics/PerceivedComplexity:
+  Max: 16 # Goal: 7

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.3.0
   - 1.9.3
-  - 1.8.7
   - jruby-19mode
-  - jruby-18mode
 env:
   global:
     - TRAVIS=true
@@ -16,24 +14,27 @@ env:
 sudo: false
 
 before_script:
+  - mysql --version
   - sh -c "if [ \"$DB\" = 'mysql' ]; then mysql   -e 'create database paper_trail_test;'; fi"
   - sh -c "if [ \"$DB\" = 'mysql' ]; then mysql   -e 'create database paper_trail_bar; '; fi"
   - sh -c "if [ \"$DB\" = 'mysql' ]; then mysql   -e 'create database paper_trail_foo; '; fi"
+  - psql --version
   - sh -c "if [ \"$DB\" = 'postgres' ]; then psql -c 'create database paper_trail_test;' -U postgres; fi"
   - sh -c "if [ \"$DB\" = 'postgres' ]; then psql -c 'create database paper_trail_bar;'  -U postgres; fi"
   - sh -c "if [ \"$DB\" = 'postgres' ]; then psql -c 'create database paper_trail_foo;'  -U postgres; fi"
 
 gemfile:
-  - Gemfile
-  - gemfiles/3.0.gemfile
+  - gemfiles/ar3.gemfile
+  - gemfiles/ar4.gemfile
+  - gemfiles/ar5.gemfile
 
 matrix:
   fast_finish: true
-  allow_failures:
-    - rvm: jruby-18mode
-      gemfile: Gemfile
-    - rvm: 1.8.7
-      gemfile: Gemfile
+  exclude:
+    - gemfile: gemfiles/ar5.gemfile
+      rvm: 1.9.3
+    - gemfile: gemfiles/ar5.gemfile
+      rvm: jruby-19mode
 
 addons:
   postgresql: "9.4"

data/Appraisals

@@ -0,0 +1,37 @@
+# Specify here only version constraints that differ from
+# `paper_trail.gemspec`.
+#
+# > The dependencies in your Appraisals file are combined with dependencies in
+# > your Gemfile, so you don't need to repeat anything that's the same for each
+# > appraisal. If something is specified in both the Gemfile and an appraisal,
+# > 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"
+
+  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
+  gem "activerecord", "~> 4.2"
+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 'rails-controller-testing'
+  # Sinatra stable conflicts with AR5's rack dependency
+  gem 'sinatra', github: 'sinatra/sinatra'
+end

data/CHANGELOG.md

@@ -1,11 +1,169 @@
-## 4.0.0
+## 5.?.? (Unreleased)
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- None
+
+### Fixed
+
+- None
+
+## 5.1.0 (2016-05-20)
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- [#809](https://github.com/airblade/paper_trail/pull/809) -
+  Print warning if version cannot be saved.
+
+### Fixed
+
+- [#812](https://github.com/airblade/paper_trail/pull/812) -
+  Issue with saving HABTM associated objects using accepts_nested_attributes_for
+- [#811](https://github.com/airblade/paper_trail/pull/811) -
+  Avoid unnecessary query in #record_destroy
+- Improvements to documentation
+
+## 5.0.1 (2016-05-04)
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- None
+
+### Fixed
+
+- [#791](https://github.com/airblade/paper_trail/issues/791) -
+  A rare issue in applications that override `warn`.
+- [#789](https://github.com/airblade/paper_trail/issues/789) -
+  A potentially common issue, in applications with initializers that use
+  versioned models.
+
+## 5.0.0 (2016-05-02)
+
+### Breaking Changes
+
+- [#758](https://github.com/airblade/paper_trail/pull/758) -
+  `PaperTrail.config.track_associations` getter method removed,
+  use `track_associations?` instead.
+- [#740](https://github.com/airblade/paper_trail/issues/740) -
+  `PaperTrail.config.track_associations?` now defaults to false
+- [#723](https://github.com/airblade/paper_trail/pull/723) -
+  `PaperTrail.enabled=` now affects all threads
+- [#556](https://github.com/airblade/paper_trail/pull/556) /
+  [#301](https://github.com/airblade/paper_trail/issues/301) -
+  If you are tracking who is responsible for changes with `whodunnit`, be aware
+  that PaperTrail no longer adds the `set_paper_trail_whodunnit` before_filter
+  for you. Please add this before_filter to your ApplicationController to
+  continue recording whodunnit. See the readme for an example.
+- [#683](https://github.com/airblade/paper_trail/pull/683) /
+  [#682](https://github.com/airblade/paper_trail/issues/682) -
+  Destroy callback default changed to :before to accommodate ActiveRecord 5
+  option `belongs_to_required_by_default` and new Rails 5 default.
+
+### Added
+
+- [#771](https://github.com/airblade/paper_trail/pull/771) -
+  Added support for has_and_belongs_to_many associations
+- [#741](https://github.com/airblade/paper_trail/issues/741) /
+  [#681](https://github.com/airblade/paper_trail/pull/681)
+  MySQL unicode support in migration generator
+- [#689](https://github.com/airblade/paper_trail/pull/689) -
+  Rails 5 compatibility
+- Added a rails config option: `config.paper_trail.enabled`
+- [#503](https://github.com/airblade/paper_trail/pull/730) -
+  Support for reifying belongs_to associations.
+
+### Fixed
+
+- [#777](https://github.com/airblade/paper_trail/issues/777) -
+  Support HMT associations with `:source` option.
+- [#738](https://github.com/airblade/paper_trail/issues/738) -
+  Rare bug where a non-versioned STI parent caused `changeset` to
+  return an empty hash.
+- [#731](https://github.com/airblade/paper_trail/pull/731) -
+  Map enums to database values before storing in `object_changes` column.
+- [#715](https://github.com/airblade/paper_trail/issues/715) -
+  Optimize post-rollback association reset.
+- [#701](https://github.com/airblade/paper_trail/pull/701) /
+  [#699](https://github.com/airblade/paper_trail/issues/699) -
+  Cleaning old versions explicitly preserves the most recent
+  versions instead of relying on database result ordering.
+- [#635](https://github.com/airblade/paper_trail/issues/635) -
+  A bug where it was not possible to disable PT when using a multi-threaded
+  webserver.
+- [#584](https://github.com/airblade/paper_trail/issues/584) -
+  Fixed deprecation warning for Active Record after_callback / after_commit
+
+## 4.1.0 (2016-01-30)
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- A way to control the order of AR callbacks.
+  [#614](https://github.com/airblade/paper_trail/pull/614)
+- Added `unversioned_attributes` option to `reify`.
+  [#579](https://github.com/airblade/paper_trail/pull/579)
+
+### Fixed
+
+- None
+
+## 4.0.2 (2016-01-19)
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- None
+
+### Fixed
+
+- [#696](https://github.com/airblade/paper_trail/issues/696) /
+  [#697](https://github.com/airblade/paper_trail/pull/697)
+  Bind JSON query parameters in `where_object` and `where_object_changes`.
+
+## 4.0.1 (2015-12-14)
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- None
+
+### Fixed
+
+- [#636](https://github.com/airblade/paper_trail/issues/636) -
+  Should compile assets without a db connection
+- [#589](https://github.com/airblade/paper_trail/pull/589) /
+  [#588](https://github.com/airblade/paper_trail/issues/588) -
+  Fixes timestamp for "create" versions
+
+## 4.0.0 (2015-07-30)
 
 This major release adds JSON column support in PostgreSQL, limited support for
 versioning associations, various new configuration options, and a year's worth
 of bug fixes. Thanks to everyone who helped test the two betas and two release
 candidates.
 
-### Changed
+### Breaking Changes
 
 - Using a Rails initializer to reopen PaperTrail::Version or otherwise extend
   PaperTrail is no longer recommended. An alternative is described in the
@@ -13,6 +171,9 @@ candidates.
   https://github.com/airblade/paper_trail/pull/492.
 - If you depend on the `RSpec` or `Cucumber` helpers, you must
   [require them in your test helper](https://github.com/airblade/paper_trail#testing).
+- [#566](https://github.com/airblade/paper_trail/pull/566) - Removed deprecated
+  methods `paper_trail_on` and `paper_trail_off`. Use `paper_trail_on!` and
+  `paper_trail_off!` instead.
 - [#458](https://github.com/airblade/paper_trail/pull/458) - Version metadata
   (the `:meta` option) from AR attributes for `create` events will now save the
   current value instead of `nil`.
@@ -29,12 +190,6 @@ candidates.
 - `3da1f104` - `PaperTrail.config` and `PaperTrail.configure` are now
   identical: both return the `PaperTrail::Config` instance and also
   yield it if a block is provided.
-  
-### Removed
-
-- [#566](https://github.com/airblade/paper_trail/pull/566) - Removed deprecated
-  methods `paper_trail_on` and `paper_trail_off`. Use `paper_trail_on!` and
-  `paper_trail_off!` instead.
 
 ### Added
 
@@ -121,6 +276,16 @@ candidates.
 - [#479](https://github.com/airblade/paper_trail/issues/479) - Deprecated
   `originator` method, use `paper_trail_originator`.
 
+## 3.0.9
+
+  - [#479](https://github.com/airblade/paper_trail/issues/479) - Deprecated
+    `originator` method in favor of `paper_trail_originator` Deprecation warning
+    informs users that the `originator` of the methods will be removed in
+    version `4.0`. (Backported from v4)
+  - Updated deprecation warnings for `Model.paper_trail_on` and
+    `Model.paper_trail_off` to have display correct version number the methods
+    will be removed (`4.0`)
+
 ## 3.0.8
 
   - [#525](https://github.com/airblade/paper_trail/issues/525) / [#512](https://github.com/airblade/paper_trail/pull/512) -

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec