paper_trail 7.1.0 → 7.1.1

data/Rakefile

@@ -1,38 +0,0 @@
-require "bundler"
-Bundler::GemHelper.install_tasks
-
-desc "Set a relevant database.yml for testing"
-task :prepare do
-  ENV["DB"] ||= "sqlite"
-  FileUtils.cp(
-    "spec/dummy_app/config/database.#{ENV['DB']}.yml",
-    "spec/dummy_app/config/database.yml"
-  )
-end
-
-require "rake/testtask"
-desc "Run tests on PaperTrail with Test::Unit."
-Rake::TestTask.new(:test) do |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.verbose = false
-
-  # Enabling ruby interpreter warnings (-w) is, sadly, impractical. There are
-  # too many noisy warnings that we have no control over, e.g. caused by libs we
-  # depend on.
-  t.warning = false
-end
-
-require "rspec/core/rake_task"
-desc "Run tests on PaperTrail with RSpec"
-task(:spec).clear
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.verbose = false # hide list of specs bit.ly/1nVq3Jn
-end
-
-require "rubocop/rake_task"
-RuboCop::RakeTask.new
-
-desc "Default: run all available test suites"
-task default: %i[rubocop prepare test spec]

data/doc/bug_report_template.rb

@@ -1,73 +0,0 @@
-# Use this template to report PaperTrail bugs.
-# 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.3.1"
-  source "https://rubygems.org"
-  gem "activerecord", "5.0.0"
-  gem "minitest", "5.9.0"
-  gem "paper_trail", "5.2.0", require: false
-  gem "sqlite3"
-end
-
-require "active_record"
-require "minitest/autorun"
-require "logger"
-
-# Please use sqlite for your bug reports, if possible.
-ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
-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
-    t.string :event, null: false
-    t.string :whodunnit
-    t.text :object, limit: 1_073_741_823
-    t.text :object_changes, limit: 1_073_741_823
-    t.integer :transaction_id
-    t.datetime :created_at
-  end
-  add_index :versions, %i[item_type item_id]
-  add_index :versions, [:transaction_id]
-
-  create_table :version_associations do |t|
-    t.integer  :version_id
-    t.string   :foreign_key_name, null: false
-    t.integer  :foreign_key_id
-  end
-  add_index :version_associations, [:version_id]
-  add_index :version_associations, %i[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"
-
-# STEP FOUR: Define your AR models here.
-class User < ActiveRecord::Base
-  has_paper_trail
-end
-
-# STEP FIVE: Please write a test that demonstrates your issue.
-class BugTest < ActiveSupport::TestCase
-  def test_1
-    assert_difference(-> { PaperTrail::Version.count }, +1) {
-      User.create(first_name: "Jane")
-    }
-  end
-end
-
-# STEP SIX: Run this script using `ruby my_bug_report.rb`

data/doc/triage.md

@@ -1,27 +0,0 @@
-# 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/doc/warning_about_not_setting_whodunnit.md

@@ -1,33 +0,0 @@
-# The warning about not setting whodunnit
-
-After upgrading to PaperTrail 5, you see this warning:
-
-> user_for_paper_trail is present, but whodunnit has not been set. PaperTrail no
-> longer adds the set_paper_trail_whodunnit before_action for you. Please add this
-> before_action to your ApplicationController to continue recording whodunnit.
-
-## You want to track whodunnit
-
-Add `before_action :set_paper_trail_whodunnit` to your ApplicationController.
-See the PaperTrail readme for an example (https://git.io/vrsbt).
-
-## You don't want to track whodunnit
-
-If you no longer want to track whodunnit, you may disable this
-warning by overriding user_for_paper_trail to return nil.
-
-```
-# in application_controller.rb
-def user_for_paper_trail
-  nil # disable whodunnit tracking
-end
-```
-
-## You just want the warning to go away
-
-Upgrade to PT 6.
-
-## Why does PT no longer add this callback for me?
-
-So that you can control the order of callbacks. Maybe you have another callback
-that must happen first, before `set_paper_trail_whodunnit`.

data/gemfiles/ar_4.0.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 4.0"
-
-gemspec path: "../"

data/gemfiles/ar_4.2.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 4.2"
-
-gemspec path: "../"

data/gemfiles/ar_5.0.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 5.0.3"
-gem "rails-controller-testing"
-
-gemspec path: "../"

data/gemfiles/ar_5.1.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "5.1.1"
-gem "rails-controller-testing"
-
-gemspec path: "../"

data/gemfiles/ar_master.gemfile

@@ -1,9 +0,0 @@
-# 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/paper_trail.gemspec

@@ -1,49 +0,0 @@
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "paper_trail/version_number"
-
-Gem::Specification.new do |s|
-  s.name = "paper_trail"
-  s.version = PaperTrail::VERSION::STRING
-  s.platform = Gem::Platform::RUBY
-  s.summary = "Track changes to your models."
-  s.description = <<-EOS
-Track changes to your models, for auditing or versioning. See how a model looked
-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", "Jared Beck"]
-  s.email = "batkinz@gmail.com"
-  s.license = "MIT"
-
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.required_rubygems_version = ">= 1.3.6"
-  s.required_ruby_version = ">= 2.1.0"
-
-  # Rails does not follow semver, makes breaking changes in minor versions.
-  s.add_dependency "activerecord", [">= 4.0", "< 5.2"]
-  s.add_dependency "request_store", "~> 1.1"
-
-  s.add_development_dependency "appraisal", "~> 2.1"
-  s.add_development_dependency "rake", "~> 12.0"
-  s.add_development_dependency "ffaker", "~> 2.5"
-
-  # 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"
-  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-byebug", "~> 3.4"
-  s.add_development_dependency "rubocop", "0.48.1"
-  s.add_development_dependency "rubocop-rspec", "~> 1.15.0"
-  s.add_development_dependency "timecop", "~> 0.8.0"
-  s.add_development_dependency "sqlite3", "~> 1.2"
-  s.add_development_dependency "pg", "~> 0.19.0"
-  s.add_development_dependency "mysql2", "~> 0.4.2"
-end

data/spec/controllers/articles_controller_spec.rb

@@ -1,28 +0,0 @@
-require "spec_helper"
-
-RSpec.describe ArticlesController, type: :controller do
-  describe "PaperTrail.enabled_for_controller?" do
-    context "PaperTrail.enabled? == true" do
-      before { PaperTrail.enabled = true }
-
-      it "returns true" do
-        assert PaperTrail.enabled?
-        post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
-        expect(assigns(:article)).not_to be_nil
-        assert PaperTrail.enabled_for_controller?
-        assert_equal 1, assigns(:article).versions.length
-      end
-
-      after { PaperTrail.enabled = false }
-    end
-
-    context "PaperTrail.enabled? == false" do
-      it "returns false" do
-        assert !PaperTrail.enabled?
-        post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
-        assert !PaperTrail.enabled_for_controller?
-        assert_equal 0, assigns(:article).versions.length
-      end
-    end
-  end
-end

data/spec/controllers/widgets_controller_spec.rb

@@ -1,85 +0,0 @@
-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/spec/dummy_app/Rakefile

@@ -1,7 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path("../config/application", __FILE__)
-require "rake"
-
-Dummy::Application.load_tasks

data/spec/dummy_app/app/controllers/application_controller.rb

@@ -1,30 +0,0 @@
-class ApplicationController < ActionController::Base
-  protect_from_forgery
-
-  # Some applications and libraries modify `current_user`. Their changes need
-  # to be reflected in `whodunnit`, so the `set_paper_trail_whodunnit` below
-  # must happen after this.
-  before_action :modify_current_user
-
-  # PT used to add this callback automatically. Now people are required to add
-  # it themsevles, like this, allowing them to control the order of callbacks.
-  # The `modify_current_user` callback above shows why this control is useful.
-  before_action :set_paper_trail_whodunnit
-
-  def rescue_action(e)
-    raise e
-  end
-
-  # Returns id of hypothetical current user
-  attr_reader :current_user
-
-  def info_for_paper_trail
-    { ip: request.remote_ip, user_agent: request.user_agent }
-  end
-
-  private
-
-  def modify_current_user
-    @current_user = OpenStruct.new(id: 153)
-  end
-end

data/spec/dummy_app/app/controllers/articles_controller.rb

@@ -1,16 +0,0 @@
-class ArticlesController < ApplicationController
-  def create
-    @article = Article.create article_params
-    head :ok
-  end
-
-  def current_user
-    "foobar"
-  end
-
-  private
-
-  def article_params
-    params.require(:article).permit!
-  end
-end