paper_trail 5.2.3 → 11.0.0

data/Rakefile

@@ -1,30 +0,0 @@
-require "bundler"
-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"
-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
-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: [:rubocop, :prepare, :test, :spec]

data/doc/bug_report_template.rb

@@ -1,69 +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"
-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, [: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, [: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

data/doc/warning_about_not_setting_whodunnit.md

@@ -1,32 +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 the set_paper_trail_whodunnit before_action 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
-
-To disable this warning for any other reason, use `skip_after_action`.
-
-```
-skip_after_action :warn_about_not_setting_whodunnit
-```

data/gemfiles/ar3.gemfile

@@ -1,19 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-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
-
-gemspec :path => "../"

data/gemfiles/ar4.gemfile

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

data/gemfiles/ar5.gemfile

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

data/lib/generators/paper_trail/USAGE

@@ -1,2 +0,0 @@
-Description:
-  Generates (but does not run) a migration to add a versions table.

data/lib/generators/paper_trail/install_generator.rb

@@ -1,57 +0,0 @@
-require "rails/generators"
-require "rails/generators/active_record"
-
-module PaperTrail
-  # Installs PaperTrail in a rails app.
-  class InstallGenerator < ::Rails::Generators::Base
-    include ::Rails::Generators::Migration
-
-    source_root File.expand_path("../templates", __FILE__)
-    class_option(
-      :with_changes,
-      type: :boolean,
-      default: false,
-      desc: "Store changeset (diff) with each version"
-    )
-    class_option(
-      :with_associations,
-      type: :boolean,
-      default: false,
-      desc: "Store transactional IDs to support association restoration"
-    )
-
-    desc "Generates (but does not run) a migration to add a versions table." \
-         "  Also generates an initializer file for configuring PaperTrail"
-
-    def create_migration_file
-      add_paper_trail_migration("create_versions")
-      add_paper_trail_migration("add_object_changes_to_versions") if options.with_changes?
-      if options.with_associations?
-        add_paper_trail_migration("create_version_associations")
-        add_paper_trail_migration("add_transaction_id_column_to_versions")
-      end
-    end
-
-    def create_initializer
-      create_file(
-        "config/initializers/paper_trail.rb",
-        "PaperTrail.config.track_associations = #{!!options.with_associations?}"
-      )
-    end
-
-    def self.next_migration_number(dirname)
-      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
-    end
-
-    protected
-
-    def add_paper_trail_migration(template)
-      migration_dir = File.expand_path("db/migrate")
-      if self.class.migration_exists?(migration_dir, template)
-        ::Kernel.warn "Migration already exists: #{template}"
-      else
-        migration_template "#{template}.rb", "db/migrate/#{template}.rb"
-      end
-    end
-  end
-end

data/lib/generators/paper_trail/templates/add_transaction_id_column_to_versions.rb

@@ -1,13 +0,0 @@
-# This migration and CreateVersionAssociations provide the necessary
-# schema for tracking associations.
-class AddTransactionIdColumnToVersions < ActiveRecord::Migration
-  def self.up
-    add_column :versions, :transaction_id, :integer
-    add_index :versions, [:transaction_id]
-  end
-
-  def self.down
-    remove_index :versions, [:transaction_id]
-    remove_column :versions, :transaction_id
-  end
-end

data/lib/generators/paper_trail/templates/create_version_associations.rb

@@ -1,22 +0,0 @@
-# This migration and AddTransactionIdColumnToVersions provide the necessary
-# schema for tracking associations.
-class CreateVersionAssociations < ActiveRecord::Migration
-  def self.up
-    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,
-      [:foreign_key_name, :foreign_key_id],
-      name: "index_version_associations_on_foreign_key"
-  end
-
-  def self.down
-    remove_index :version_associations, [:version_id]
-    remove_index :version_associations,
-      name: "index_version_associations_on_foreign_key"
-    drop_table :version_associations
-  end
-end

data/lib/generators/paper_trail/templates/create_versions.rb

@@ -1,80 +0,0 @@
-# This migration creates the `versions` table, the only schema PT requires.
-# All other migrations PT provides are optional.
-class CreateVersions < ActiveRecord::Migration
-  # Class names of MySQL adapters.
-  # - `MysqlAdapter` - Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
-  # - `Mysql2Adapter` - Used by `mysql2` gem.
-  MYSQL_ADAPTERS = [
-    "ActiveRecord::ConnectionAdapters::MysqlAdapter",
-    "ActiveRecord::ConnectionAdapters::Mysql2Adapter"
-  ].freeze
-
-  # The largest text column available in all supported RDBMS is
-  # 1024^3 - 1 bytes, roughly one gibibyte.  We specify a size
-  # so that MySQL will use `longtext` instead of `text`.  Otherwise,
-  # when serializing very large objects, `text` might not be big enough.
-  TEXT_BYTES = 1_073_741_823
-
-  def change
-    create_table :versions, versions_table_options do |t|
-      t.string   :item_type, item_type_options
-      t.integer  :item_id,   null: false
-      t.string   :event,     null: false
-      t.string   :whodunnit
-      t.text     :object, limit: TEXT_BYTES
-
-      # Known issue in MySQL: fractional second precision
-      # -------------------------------------------------
-      #
-      # MySQL timestamp columns do not support fractional seconds unless
-      # defined with "fractional seconds precision". MySQL users should manually
-      # add fractional seconds precision to this migration, specifically, to
-      # the `created_at` column.
-      # (https://dev.mysql.com/doc/refman/5.6/en/fractional-seconds.html)
-      #
-      # MySQL users should also upgrade to rails 4.2, which is the first
-      # version of ActiveRecord with support for fractional seconds in MySQL.
-      # (https://github.com/rails/rails/pull/14359)
-      #
-      t.datetime :created_at
-    end
-    add_index :versions, [:item_type, :item_id]
-  end
-
-  private
-
-  # MySQL 5.6 utf8mb4 limit is 191 chars for keys used in indexes.
-  # See https://github.com/airblade/paper_trail/issues/651
-  def item_type_options
-    opt = { null: false }
-    opt[:limit] = 191 if mysql?
-    opt
-  end
-
-  def mysql?
-    MYSQL_ADAPTERS.include?(connection.class.name)
-  end
-
-  # Even modern versions of MySQL still use `latin1` as the default character
-  # encoding. Many users are not aware of this, and run into trouble when they
-  # try to use PaperTrail in apps that otherwise tend to use UTF-8. Postgres, by
-  # comparison, uses UTF-8 except in the unusual case where the OS is configured
-  # with a custom locale.
-  #
-  # - https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html
-  # - http://www.postgresql.org/docs/9.4/static/multibyte.html
-  #
-  # Furthermore, MySQL's original implementation of UTF-8 was flawed, and had
-  # to be fixed later by introducing a new charset, `utf8mb4`.
-  #
-  # - https://mathiasbynens.be/notes/mysql-utf8mb4
-  # - https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
-  #
-  def versions_table_options
-    if mysql?
-      { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }
-    else
-      {}
-    end
-  end
-end

data/lib/paper_trail/attribute_serializers/legacy_active_record_shim.rb

@@ -1,48 +0,0 @@
-module PaperTrail
-  module AttributeSerializers
-    # Included into model if AR version is < 4.2. Backport Rails 4.2 and later's
-    # `type_for_attribute` so we can build on a common interface.
-    module LegacyActiveRecordShim
-      # An attribute which needs no processing. It is part of our backport (shim)
-      # of rails 4.2's attribute API. See `type_for_attribute` below.
-      class NoOpAttribute
-        def type_cast_for_database(value)
-          value
-        end
-
-        def type_cast_from_database(data)
-          data
-        end
-      end
-      NO_OP_ATTRIBUTE = NoOpAttribute.new
-
-      # An attribute which requires manual (de)serialization to/from what we get
-      # from the database. It is part of our backport (shim) of rails 4.2's
-      # attribute API. See `type_for_attribute` below.
-      class SerializedAttribute
-        def initialize(coder)
-          @coder = coder.respond_to?(:dump) ? coder : PaperTrail.serializer
-        end
-
-        def type_cast_for_database(value)
-          @coder.dump(value)
-        end
-
-        def type_cast_from_database(data)
-          @coder.load(data)
-        end
-      end
-
-      def type_for_attribute(attr_name)
-        serialized_attribute_types[attr_name.to_s] || NO_OP_ATTRIBUTE
-      end
-
-      def serialized_attribute_types
-        @attribute_types ||= Hash[serialized_attributes.map do |attr_name, coder|
-          [attr_name, SerializedAttribute.new(coder)]
-        end]
-      end
-      private :serialized_attribute_types
-    end
-  end
-end

data/lib/paper_trail/frameworks/active_record/models/paper_trail/version_association.rb

@@ -1,11 +0,0 @@
-require "paper_trail/version_association_concern"
-
-module PaperTrail
-  # This is the default ActiveRecord model provided by PaperTrail. Most simple
-  # applications will only use this and its partner, `Version`, but it is
-  # possible to sub-class, extend, or even do without this model entirely.
-  # See the readme for details.
-  class VersionAssociation < ::ActiveRecord::Base
-    include PaperTrail::VersionAssociationConcern
-  end
-end

data/lib/paper_trail/frameworks/sinatra.rb

@@ -1,40 +0,0 @@
-require "active_support/core_ext/object" # provides the `try` method
-
-module PaperTrail
-  # Extensions to `Sinatra`.
-  module Sinatra
-    # Register this module inside your Sinatra application to gain access to
-    # controller-level methods used by PaperTrail.
-    def self.registered(app)
-      app.use RequestStore::Middleware
-      app.helpers self
-      app.before { set_paper_trail_whodunnit }
-    end
-
-    protected
-
-    # Returns the user who is responsible for any changes that occur.
-    # By default this calls `current_user` and returns the result.
-    #
-    # Override this method in your controller to call a different
-    # method, e.g. `current_person`, or anything you like.
-    def user_for_paper_trail
-      return unless defined?(current_user)
-      ActiveSupport::VERSION::MAJOR >= 4 ? current_user.try!(:id) : current_user.try(:id)
-    rescue NoMethodError
-      current_user
-    end
-
-    private
-
-    # Tells PaperTrail who is responsible for any changes that occur.
-    def set_paper_trail_whodunnit
-      @set_paper_trail_whodunnit_called = true
-      ::PaperTrail.whodunnit = user_for_paper_trail if ::PaperTrail.enabled?
-    end
-  end
-end
-
-if defined?(::Sinatra)
-  ::Sinatra.register(::PaperTrail::Sinatra)
-end