paper_trail 7.0.3 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11a429887d7b9272fd54814535da3c8d5beff4f0
-  data.tar.gz: 2d58e73069b0b929789382f3119bcdfa42c651ec
+  metadata.gz: '022806af0ea91aee393c67adb08dcf4a322c7652'
+  data.tar.gz: 50d52e94b4a93c6f89de10638cb3ddcad73a8312
 SHA512:
-  metadata.gz: 9b8bc23a333b80008c006bca40968f587ac40c71231326c4f8b1f3ef460e09fe3c4ad00085de912ce1991fa1007d2e50c04596a64181c4fae2ef8b7c18d51baa
-  data.tar.gz: 0c3ba5b7dfaaf2a448efa2a59dc2a4afbc15eb6a57cec024a536853172f561678afadf738320f01d212b6fa541053029982baadb9449a4fef0587e21ca7d2a8f
+  metadata.gz: 5282396646c7f8174d2cd866e5ee0d64f394e1f967a8c4ab979b593f772f0360f825f7312418edba016622f6088fb2cdae1264142c9b83fb2310309cd3868ff4
+  data.tar.gz: 48ab8574011657bcb0e4d2dbe60a78a53187ca79cef2d3a8770992bc0cf2ce179a144c821cbae194d8dc54e6a7cb4a0b44968ff513f60a16788dc2729efcff86

data/.github/CONTRIBUTING.md

@@ -7,10 +7,7 @@ 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 :)
+On github, we appreciate bug reports, feature suggestions, and pull requests.
 
 ## Reporting Bugs
 
@@ -18,9 +15,7 @@ Please use our [bug report template][1].
 
 ## Development
 
-Install gems with `bundle exec appraisal install`. This requires ruby >= 2.0.
-(It is still possible to run the `ar-4.2` gemfile locally on ruby 1.9.3, but
-not the `ar-5.0` gemfile.)
+Install gems with `bundle exec appraisal install`.
 
 Testing is a little awkward because the test suite:
 
@@ -32,13 +27,13 @@ Testing is a little awkward because the test suite:
 
 ```
 # Create the appropriate database config. file
-rm test/dummy/config/database.yml
+rm spec/dummy_app/config/database.yml
 DB=sqlite bundle exec rake prepare
 
 # If this is the first test run ever, create databases.
-# We can't use `appraisal` inside the test dummy, so we must set `BUNDLE_GEMFILE`.
-# See test/dummy/config/boot.rb for a complete explanation.
-cd test/dummy
+# We can't use `appraisal` inside the dummy app, so we must set `BUNDLE_GEMFILE`.
+# See spec/dummy_app/config/boot.rb for a complete explanation.
+cd spec/dummy_app
 export BUNDLE_GEMFILE=../../gemfiles/ar_4.2.gemfile
 RAILS_ENV=test bundle exec rake db:setup
 RAILS_ENV=foo bundle exec rake db:setup
@@ -49,8 +44,7 @@ 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
+# Run a single test
 DB=sqlite bundle exec appraisal ar-4.2 rspec spec/paper_trail/serializers/json_spec.rb
 ```
 
@@ -58,13 +52,13 @@ DB=sqlite bundle exec appraisal ar-4.2 rspec spec/paper_trail/serializers/json_s
 
 ```
 # Create the appropriate database config. file
-rm test/dummy/config/database.yml
+rm spec/dummy_app/config/database.yml
 DB=sqlite bundle exec rake prepare
 
 # If this is the first test run ever, create databases.
-# We can't use `appraisal` inside the test dummy, so we must set `BUNDLE_GEMFILE`.
-# See test/dummy/config/boot.rb for a complete explanation.
-cd test/dummy
+# We can't use `appraisal` inside the dummy app, so we must set `BUNDLE_GEMFILE`.
+# See spec/dummy_app/config/boot.rb for a complete explanation.
+cd spec/dummy_app
 export BUNDLE_GEMFILE=../../gemfiles/ar_5.0.gemfile
 RAILS_ENV=test bundle exec rake db:environment:set db:setup
 RAILS_ENV=foo bundle exec rake db:environment:set db:setup
@@ -80,13 +74,13 @@ DB=sqlite bundle exec appraisal ar-5.0 rake
 
 ```
 # Create the appropriate database config. file
-rm test/dummy/config/database.yml
+rm spec/dummy_app/config/database.yml
 DB=mysql bundle exec rake prepare
 
 # If this is the first test run ever, create databases.
-# We can't use `appraisal` inside the test dummy, so we must set `BUNDLE_GEMFILE`.
-# See test/dummy/config/boot.rb for a complete explanation.
-cd test/dummy
+# We can't use `appraisal` inside the dummy app, so we must set `BUNDLE_GEMFILE`.
+# See spec/dummy_app/config/boot.rb for a complete explanation.
+cd spec/dummy_app
 export BUNDLE_GEMFILE=../../gemfiles/ar_5.0.gemfile
 RAILS_ENV=test bundle exec rake db:environment:set db:setup
 RAILS_ENV=foo bundle exec rake db:environment:set db:setup
@@ -102,14 +96,14 @@ DB=mysql bundle exec appraisal ar-5.0 rake
 
 ```
 # Create the appropriate database config. file
-rm test/dummy/config/database.yml
+rm spec/dummy_app/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.
-# We can't use `appraisal` inside the test dummy, so we must set `BUNDLE_GEMFILE`.
-# See test/dummy/config/boot.rb for a complete explanation.
-cd test/dummy
+# We can't use `appraisal` inside the dummy app, so we must set `BUNDLE_GEMFILE`.
+# See spec/dummy_app/config/boot.rb for a complete explanation.
+cd spec/dummy_app
 export BUNDLE_GEMFILE=../../gemfiles/ar_5.0.gemfile
 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
@@ -124,10 +118,10 @@ DB=postgres bundle exec appraisal ar-5.0 rake
 
 ## Editing the migration
 
-After editing `test/dummy/db/migrate/20110208155312_set_up_test_tables.rb` ..
+After editing `spec/dummy_app/db/migrate/20110208155312_set_up_test_tables.rb` ..
 
 ```
-cd test/dummy
+cd spec/dummy_app
 export BUNDLE_GEMFILE=../../gemfiles/ar_5.1.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

data/.gitignore

@@ -2,10 +2,10 @@ gemfiles/*.lock
 NOTES
 test/debug.log
 test/paper_trail_plugin.sqlite3.db
-test/dummy/config/database.yml
-test/dummy/db/*.sqlite3
-test/dummy/log/*
-test/dummy/tmp/*
+spec/dummy_app/config/database.yml
+spec/dummy_app/db/*.sqlite3
+spec/dummy_app/log/*
+spec/dummy_app/tmp/*
 spec/dummy/
 coverage
 pkg/*

data/.rubocop.yml

@@ -12,7 +12,7 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   Exclude:
     - gemfiles/vendor/bundle/**/* # This dir only shows up on travis ¯\_(ツ)_/¯
-    - test/dummy/db/schema.rb # Generated, out of our control
+    - spec/dummy_app/db/schema.rb # Generated, out of our control
 
   # Set to lowest supported version
   TargetRubyVersion: 2.1
@@ -21,7 +21,7 @@ AllCops:
 # from these is of questionable value.
 Metrics/AbcSize:
   Exclude:
-    - 'test/dummy/db/migrate/*'
+    - 'spec/dummy_app/db/migrate/*'
 
 # Not a useful metric compared to, e.g. `AbcSize`.
 Metrics/BlockLength:

data/CHANGELOG.md

@@ -17,6 +17,23 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 
 - None
 
+## 7.1.0 (2017-07-09)
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- [#803](https://github.com/airblade/paper_trail/issues/803)
+  Deprecate `where_object_changes` when reading json from a text column
+- [#976](https://github.com/airblade/paper_trail/pull/976)
+  `PaperTrail.whodunnit` accepts a `Proc`
+
+### Fixed
+
+- None
+
 ## 7.0.3 (2017-06-01)
 
 ### 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 |
-| 7.0.3          | https://github.com/airblade/paper_trail/blob/v7.0.3/README.md |
+| 7.1.0          | https://github.com/airblade/paper_trail/blob/v7.1.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 |
@@ -716,6 +716,14 @@ PaperTrail.whodunnit('Dorian Marié') do
 end
 ```
 
+`whodunnit` also accepts a `Proc`.
+
+```ruby
+PaperTrail.whodunnit = proc do
+  caller.first{ |c| c.starts_with? Rails.root.to_s }
+end
+```
+
 If your controller has a `current_user` method, PaperTrail provides a
 `before_action` that will assign `current_user.id` to `PaperTrail.whodunnit`.
 You can add this `before_action` to your `ApplicationController`.
@@ -1090,7 +1098,23 @@ Generates (but does not run) a migration to add a versions table.  Also generate
 
 As of version 6, PT no longer supports rails 3 or the [protected_attributes][17]
 gem. If you are still using them, you may use PT 5 or lower. We recommend
-upgrading to [strong_parameters][18] as soon as possible.
+upgrading to [strong_parameters][18] as soon as possible.  
+
+If you must use [protected_attributes][17] for now, and want to use PT > 5, you 
+can reopen `PaperTrail::Version` and add the following `attr_accessible` fields:
+
+```ruby
+# app/models/paper_trail/version.rb
+module PaperTrail
+  class Version < ActiveRecord::Base
+    include PaperTrail::VersionConcern
+    attr_accessible :item_type, :item_id, :event, :whodunnit, :object, :object_changes, :created_at
+  end
+end
+```
+
+This unsupported workaround has been tested with protected_attributes 1.0.9 /
+rails 4.2.8 / paper_trail 7.0.3.
 
 ## 6. Extensibility
 
@@ -1534,6 +1558,10 @@ by Jared Beck, with contributions by over 150 people.
 
 https://github.com/airblade/paper_trail/graphs/contributors
 
+## Contributing
+
+See our [contribution guidelines][43]
+
 ## Inspirations
 
 * [Simply Versioned](http://github.com/github/simply_versioned)
@@ -1582,3 +1610,4 @@ Released under the MIT licence.
 [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
 [42]: https://github.com/activeadmin/activeadmin/wiki/Auditing-via-paper_trail-%28change-history%29
+[43]: https://github.com/airblade/paper_trail/blob/master/.github/CONTRIBUTING.md

data/Rakefile

@@ -4,7 +4,10 @@ Bundler::GemHelper.install_tasks
 desc "Set a relevant database.yml for testing"
 task :prepare do
   ENV["DB"] ||= "sqlite"
-  FileUtils.cp "test/dummy/config/database.#{ENV['DB']}.yml", "test/dummy/config/database.yml"
+  FileUtils.cp(
+    "spec/dummy_app/config/database.#{ENV['DB']}.yml",
+    "spec/dummy_app/config/database.yml"
+  )
 end
 
 require "rake/testtask"

data/lib/paper_trail.rb

@@ -111,6 +111,8 @@ module PaperTrail
         ensure
           paper_trail_store[:whodunnit] = previous_whodunnit
         end
+      elsif paper_trail_store[:whodunnit].respond_to?(:call)
+        paper_trail_store[:whodunnit].call
       else
         paper_trail_store[:whodunnit]
       end

data/lib/paper_trail/serializers/json.rb

@@ -4,6 +4,13 @@ module PaperTrail
   module Serializers
     # An alternate serializer for, e.g. `versions.object`.
     module JSON
+      E_WHERE_OBJ_CHANGES = <<-STR.squish.freeze
+        where_object_changes has a known issue. When reading json from a text
+        column, it may return more records than expected. Instead of a warning,
+        this method may raise an error in the future. Please join the discussion
+        at https://github.com/airblade/paper_trail/issues/803
+      STR
+
       extend self # makes all instance methods become module methods as well
 
       def load(string)
@@ -35,6 +42,8 @@ module PaperTrail
       # Returns a SQL LIKE condition to be used to match the given field and
       # value in the serialized `object_changes`.
       def where_object_changes_condition(arel_field, field, value)
+        ::ActiveSupport::Deprecation.warn(E_WHERE_OBJ_CHANGES)
+
         # Convert to JSON to handle strings and nulls correctly.
         json_value = value.to_json
 

data/lib/paper_trail/version_concern.rb

@@ -17,7 +17,7 @@ module PaperTrail
       # Since the test suite has test coverage for this, we want to declare
       # the association when the test suite is running. This makes it pass when
       # DB is not initialized prior to test runs such as when we run on Travis
-      # CI (there won't be a db in `test/dummy/db/`).
+      # CI (there won't be a db in `spec/dummy_app/db/`).
       if PaperTrail.config.track_associations?
         has_many :version_associations, dependent: :destroy
       end

data/lib/paper_trail/version_number.rb

@@ -6,8 +6,8 @@ module PaperTrail
   # People are encouraged to use `PaperTrail.gem_version` instead.
   module VERSION
     MAJOR = 7
-    MINOR = 0
-    TINY = 3
+    MINOR = 1
+    TINY = 0
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/paper_trail.gemspec

@@ -12,7 +12,7 @@ at any stage in its lifecycle, revert it to any version, or restore it after it
 has been destroyed.
   EOS
   s.homepage = "https://github.com/airblade/paper_trail"
-  s.authors = ["Andy Stewart", "Ben Atkins"]
+  s.authors = ["Andy Stewart", "Ben Atkins", "Jared Beck"]
   s.email = "batkinz@gmail.com"
   s.license = "MIT"
 
@@ -30,10 +30,9 @@ has been destroyed.
 
   s.add_development_dependency "appraisal", "~> 2.1"
   s.add_development_dependency "rake", "~> 12.0"
-  s.add_development_dependency "shoulda", "~> 3.5"
   s.add_development_dependency "ffaker", "~> 2.5"
 
-  # Why `railties`? Possibly used by `test/dummy` boot up?
+  # Why `railties`? Possibly used by `spec/dummy_app` boot up?
   s.add_development_dependency "railties", [">= 4.0", "< 5.2"]
 
   s.add_development_dependency "rack-test", "~> 0.6.3"

data/spec/controllers/widgets_controller_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+RSpec.describe WidgetsController, type: :controller, versioning: true do
+  before { request.env["REMOTE_ADDR"] = "127.0.0.1" }
+  after { RequestStore.store[:paper_trail] = nil }
+
+  describe "#create" do
+    context "PT enabled" do
+      it "stores information like IP address in version" do
+        post(:create, params_wrapper(widget: { name: "Flugel" }))
+        widget = assigns(:widget)
+        expect(widget.versions.length).to(eq(1))
+        expect(widget.versions.last.whodunnit.to_i).to(eq(153))
+        expect(widget.versions.last.ip).to(eq("127.0.0.1"))
+        expect(widget.versions.last.user_agent).to(eq("Rails Testing"))
+      end
+
+      it "controller metadata methods should get evaluated" do
+        request.env["HTTP_USER_AGENT"] = "User-Agent"
+        post :create, params_wrapper(widget: { name: "Flugel" })
+        expect(PaperTrail.enabled_for_controller?).to(eq(true))
+        expect(PaperTrail.whodunnit).to(eq(153))
+        expect(PaperTrail.controller_info.present?).to(eq(true))
+        expect(PaperTrail.controller_info.keys.include?(:ip)).to(eq(true))
+        expect(PaperTrail.controller_info.keys.include?(:user_agent)).to(eq(true))
+      end
+    end
+
+    context "PT disabled" do
+      it "does not save a version, and metadata is not set" do
+        request.env["HTTP_USER_AGENT"] = "Disable User-Agent"
+        post :create, params_wrapper(widget: { name: "Flugel" })
+        expect(assigns(:widget).versions.length).to(eq(0))
+        expect(PaperTrail).not_to be_enabled_for_controller
+        expect(PaperTrail.whodunnit).to be_nil
+        expect(PaperTrail.controller_info).to eq({})
+      end
+    end
+  end
+
+  describe "#destroy" do
+    it "can be disabled" do
+      request.env["HTTP_USER_AGENT"] = "Disable User-Agent"
+      post(:create, params_wrapper(widget: { name: "Flugel" }))
+      w = assigns(:widget)
+      expect(w.versions.length).to(eq(0))
+      delete(:destroy, params_wrapper(id: w.id))
+      expect(PaperTrail::Version.with_item_keys("Widget", w.id).size).to(eq(0))
+    end
+
+    it "stores information like IP address in version" do
+      w = Widget.create(name: "Roundel")
+      expect(w.versions.length).to(eq(1))
+      delete(:destroy, params_wrapper(id: w.id))
+      widget = assigns(:widget)
+      expect(widget.versions.length).to(eq(2))
+      expect(widget.versions.last.ip).to(eq("127.0.0.1"))
+      expect(widget.versions.last.user_agent).to(eq("Rails Testing"))
+      expect(widget.versions.last.whodunnit.to_i).to(eq(153))
+    end
+  end
+
+  describe "#update" do
+    it "stores information like IP address in version" do
+      w = Widget.create(name: "Duvel")
+      expect(w.versions.length).to(eq(1))
+      put(:update, params_wrapper(id: w.id, widget: { name: "Bugle" }))
+      widget = assigns(:widget)
+      expect(widget.versions.length).to(eq(2))
+      expect(widget.versions.last.whodunnit.to_i).to(eq(153))
+      expect(widget.versions.last.ip).to(eq("127.0.0.1"))
+      expect(widget.versions.last.user_agent).to(eq("Rails Testing"))
+    end
+
+    it "can be disabled" do
+      request.env["HTTP_USER_AGENT"] = "Disable User-Agent"
+      post(:create, params_wrapper(widget: { name: "Flugel" }))
+      w = assigns(:widget)
+      expect(w.versions.length).to(eq(0))
+      put(:update, params_wrapper(id: w.id, widget: { name: "Bugle" }))
+      widget = assigns(:widget)
+      expect(widget.versions.length).to(eq(0))
+    end
+  end
+end

data/{test/dummy → spec/dummy_app}/app/models/article.rb

@@ -1,3 +1,4 @@
+# Demonstrates the `only` and `ignore` attributes, among other things.
 class Article < ActiveRecord::Base
   has_paper_trail(
     ignore: [