paper_trail 4.0.0 → 5.1.0

data/lib/paper_trail.rb

@@ -1,146 +1,178 @@
-require 'request_store'
-
-# Require core library
-Dir[File.join(File.dirname(__FILE__), 'paper_trail', '*.rb')].each do |file|
-  require File.join('paper_trail', File.basename(file, '.rb'))
-end
-
-# Require serializers
-Dir[File.join(File.dirname(__FILE__), 'paper_trail', 'serializers', '*.rb')].each do |file|
-  require File.join('paper_trail', 'serializers', File.basename(file, '.rb'))
-end
-
+require "request_store"
+require "paper_trail/cleaner"
+require "paper_trail/config"
+require "paper_trail/has_paper_trail"
+require "paper_trail/record_history"
+require "paper_trail/reifier"
+require "paper_trail/version_association_concern"
+require "paper_trail/version_concern"
+require "paper_trail/version_number"
+require "paper_trail/serializers/json"
+require "paper_trail/serializers/yaml"
+
+# An ActiveRecord extension that tracks changes to your models, for auditing or
+# versioning.
 module PaperTrail
   extend PaperTrail::Cleaner
 
-  # Switches PaperTrail on or off.
-  def self.enabled=(value)
-    PaperTrail.config.enabled = value
-  end
-
-  # Returns `true` if PaperTrail is on, `false` otherwise.
-  # PaperTrail is enabled by default.
-  def self.enabled?
-    !!PaperTrail.config.enabled
-  end
-
-  # ActiveRecord 5 drops support for serialized attributes; for previous
-  # versions of ActiveRecord it is supported, we have a config option 
-  # to enable it within PaperTrail.
-  def self.serialized_attributes?
-    !!PaperTrail.config.serialized_attributes && ::ActiveRecord::VERSION::MAJOR < 5
-  end
-
-  # Sets whether PaperTrail is enabled or disabled for the current request.
-  def self.enabled_for_controller=(value)
-    paper_trail_store[:request_enabled_for_controller] = value
-  end
-
-  # Returns `true` if PaperTrail is enabled for the request, `false` otherwise.
-  #
-  # See `PaperTrail::Rails::Controller#paper_trail_enabled_for_controller`.
-  def self.enabled_for_controller?
-    !!paper_trail_store[:request_enabled_for_controller]
-  end
-
-  # Sets whether PaperTrail is enabled or disabled for this model in the current request.
-  def self.enabled_for_model(model, value)
-    paper_trail_store[:"enabled_for_#{model}"] = value
-  end
-
-  # Returns `true` if PaperTrail is enabled for this model in the current request, `false` otherwise.
-  def self.enabled_for_model?(model)
-    !!paper_trail_store.fetch(:"enabled_for_#{model}", true)
-  end
-
-  # Set the field which records when a version was created.
-  def self.timestamp_field=(field_name)
-    PaperTrail.config.timestamp_field = field_name
-  end
-
-  # Returns the field which records when a version was created.
-  def self.timestamp_field
-    PaperTrail.config.timestamp_field
-  end
-
-  # Sets who is responsible for any changes that occur.
-  # You would normally use this in a migration or on the console,
-  # when working with models directly.  In a controller it is set
-  # automatically to the `current_user`.
-  def self.whodunnit=(value)
-    paper_trail_store[:whodunnit] = value
-  end
-
-  # Returns who is reponsible for any changes that occur.
-  def self.whodunnit
-    paper_trail_store[:whodunnit]
-  end
-
-  # Sets any information from the controller that you want PaperTrail
-  # to store.  By default this is set automatically by a before filter.
-  def self.controller_info=(value)
-    paper_trail_store[:controller_info] = value
-  end
-
-  # Returns any information from the controller that you want
-  # PaperTrail to store.
-  #
-  # See `PaperTrail::Rails::Controller#info_for_paper_trail`.
-  def self.controller_info
-    paper_trail_store[:controller_info]
-  end
-
-  # Getter and Setter for PaperTrail Serializer
-  def self.serializer=(value)
-    PaperTrail.config.serializer = value
-  end
-
-  def self.serializer
-    PaperTrail.config.serializer
-  end
-
-  def self.active_record_protected_attributes?
-    @active_record_protected_attributes ||= ::ActiveRecord::VERSION::MAJOR < 4 || !!defined?(ProtectedAttributes)
-  end
-
-  def self.transaction?
-    ::ActiveRecord::Base.connection.open_transactions > 0
-  end
-
-  def self.transaction_id
-    paper_trail_store[:transaction_id]
-  end
-
-  def self.transaction_id=(id)
-    paper_trail_store[:transaction_id] = id
-  end
-
-  private
-
-  # Thread-safe hash to hold PaperTrail's data.
-  # Initializing with needed default values.
-  def self.paper_trail_store
-    RequestStore.store[:paper_trail] ||= { :request_enabled_for_controller => true }
-  end
-
-  # Returns PaperTrail's configuration object.
-  def self.config
-    @@config ||= PaperTrail::Config.instance
-    yield @@config if block_given?
-    @@config
-  end
-
   class << self
-    alias_method :configure, :config
+    # Switches PaperTrail on or off.
+    # @api public
+    def enabled=(value)
+      PaperTrail.config.enabled = value
+    end
+
+    # Returns `true` if PaperTrail is on, `false` otherwise.
+    # PaperTrail is enabled by default.
+    # @api public
+    def enabled?
+      !!PaperTrail.config.enabled
+    end
+
+    def serialized_attributes?
+      ActiveSupport::Deprecation.warn(
+        "PaperTrail.serialized_attributes? is deprecated without replacement " +
+          "and always returns false."
+      )
+      false
+    end
+
+    # Sets whether PaperTrail is enabled or disabled for the current request.
+    # @api public
+    def enabled_for_controller=(value)
+      paper_trail_store[:request_enabled_for_controller] = value
+    end
+
+    # Returns `true` if PaperTrail is enabled for the request, `false` otherwise.
+    #
+    # See `PaperTrail::Rails::Controller#paper_trail_enabled_for_controller`.
+    # @api public
+    def enabled_for_controller?
+      !!paper_trail_store[:request_enabled_for_controller]
+    end
+
+    # Sets whether PaperTrail is enabled or disabled for this model in the
+    # current request.
+    # @api public
+    def enabled_for_model(model, value)
+      paper_trail_store[:"enabled_for_#{model}"] = value
+    end
+
+    # Returns `true` if PaperTrail is enabled for this model in the current
+    # request, `false` otherwise.
+    # @api public
+    def enabled_for_model?(model)
+      !!paper_trail_store.fetch(:"enabled_for_#{model}", true)
+    end
+
+    # Set the field which records when a version was created.
+    # @api public
+    def timestamp_field=(field_name)
+      PaperTrail.config.timestamp_field = field_name
+    end
+
+    # Returns the field which records when a version was created.
+    # @api public
+    def timestamp_field
+      PaperTrail.config.timestamp_field
+    end
+
+    # Sets who is responsible for any changes that occur. You would normally use
+    # this in a migration or on the console, when working with models directly.
+    # In a controller it is set automatically to the `current_user`.
+    # @api public
+    def whodunnit=(value)
+      paper_trail_store[:whodunnit] = value
+    end
+
+    # Returns who is reponsible for any changes that occur.
+    # @api public
+    def whodunnit
+      paper_trail_store[:whodunnit]
+    end
+
+    # Sets any information from the controller that you want PaperTrail to
+    # store.  By default this is set automatically by a before filter.
+    # @api public
+    def controller_info=(value)
+      paper_trail_store[:controller_info] = value
+    end
+
+    # Returns any information from the controller that you want
+    # PaperTrail to store.
+    #
+    # See `PaperTrail::Rails::Controller#info_for_paper_trail`.
+    # @api public
+    def controller_info
+      paper_trail_store[:controller_info]
+    end
+
+    # Getter and Setter for PaperTrail Serializer
+    # @api public
+    def serializer=(value)
+      PaperTrail.config.serializer = value
+    end
+
+    # @api public
+    def serializer
+      PaperTrail.config.serializer
+    end
+
+    # Returns a boolean indicating whether "protected attibutes" should be
+    # configured, e.g. attr_accessible, mass_assignment_sanitizer,
+    # whitelist_attributes, etc.
+    # @api public
+    def active_record_protected_attributes?
+      @active_record_protected_attributes ||= ::ActiveRecord::VERSION::MAJOR < 4 ||
+        !!defined?(ProtectedAttributes)
+    end
+
+    # @api public
+    def transaction?
+      ::ActiveRecord::Base.connection.open_transactions > 0
+    end
+
+    # @api public
+    def transaction_id
+      paper_trail_store[:transaction_id]
+    end
+
+    # @api public
+    def transaction_id=(id)
+      paper_trail_store[:transaction_id] = id
+    end
+
+    # Thread-safe hash to hold PaperTrail's data. Initializing with needed
+    # default values.
+    # @api private
+    def paper_trail_store
+      RequestStore.store[:paper_trail] ||= { request_enabled_for_controller: true }
+    end
+
+    # Returns PaperTrail's configuration object.
+    # @api private
+    def config
+      @config ||= PaperTrail::Config.instance
+      yield @config if block_given?
+      @config
+    end
+    alias configure config
+
+    def version
+      VERSION::STRING
+    end
   end
 end
 
-# Ensure `ProtectedAttributes` gem gets required if it is available before the `Version` class gets loaded in
+# If available, ensure that the `protected_attributes` gem is loaded
+# before the `Version` class.
 unless PaperTrail.active_record_protected_attributes?
   PaperTrail.send(:remove_instance_variable, :@active_record_protected_attributes)
   begin
-    require 'protected_attributes'
-  rescue LoadError; end # will rescue if `ProtectedAttributes` gem is not available
+    require "protected_attributes"
+  rescue LoadError # rubocop:disable Lint/HandleExceptions
+    # In case `protected_attributes` gem is not available.
+  end
 end
 
 ActiveSupport.on_load(:active_record) do
@@ -148,9 +180,9 @@ ActiveSupport.on_load(:active_record) do
 end
 
 # Require frameworks
-require 'paper_trail/frameworks/sinatra'
-if defined?(::Rails) && ActiveRecord::VERSION::STRING >= '3.2'
-  require 'paper_trail/frameworks/rails'
+require "paper_trail/frameworks/sinatra"
+if defined?(::Rails) && ActiveRecord::VERSION::STRING >= "3.2"
+  require "paper_trail/frameworks/rails"
 else
-  require 'paper_trail/frameworks/active_record'
+  require "paper_trail/frameworks/active_record"
 end

data/paper_trail.gemspec

@@ -1,54 +1,52 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-require 'paper_trail/version_number'
+$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
-  s.platform      = Gem::Platform::RUBY
-  s.summary       = "Track changes to your models' data. Good for auditing or versioning."
-  s.description   = s.summary
-  s.homepage      = 'https://github.com/airblade/paper_trail'
-  s.authors       = ['Andy Stewart', 'Ben Atkins']
-  s.email         = 'batkinz@gmail.com'
-  s.license       = 'MIT'
+  s.name = "paper_trail"
+  s.version = PaperTrail::VERSION::STRING
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Track changes to your models' data. Good for auditing or versioning."
+  s.description = s.summary
+  s.homepage = "https://github.com/airblade/paper_trail"
+  s.authors = ["Andy Stewart", "Ben Atkins"]
+  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.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_rubygems_version = ">= 1.3.6"
+  s.required_ruby_version = ">= 1.9.3"
 
-  s.add_dependency 'activerecord', ['>= 3.0', '< 6.0']
-  s.add_dependency 'activesupport', ['>= 3.0', '< 6.0']
-  s.add_dependency 'request_store', '~> 1.1'
+  s.add_dependency "activerecord", [">= 3.0", "< 6.0"]
+  s.add_dependency "activesupport", [">= 3.0", "< 6.0"]
+  s.add_dependency "request_store", "~> 1.1"
 
-  s.add_development_dependency 'rake', '~> 10.1.1'
-  s.add_development_dependency 'shoulda', '~> 3.5'
-  # s.add_development_dependency 'shoulda-matchers', '~> 1.5' # needed for ActiveRecord < 4
-  s.add_development_dependency 'ffaker', '<= 1.31.0'
-  s.add_development_dependency 'railties', ['>= 3.0', '< 5.0']
-  s.add_development_dependency 'sinatra', '~> 1.0'
-  s.add_development_dependency 'rack-test', '>= 0.6'
-  s.add_development_dependency 'rspec-rails', '~> 3.1.0'
-  s.add_development_dependency 'generator_spec'
-  s.add_development_dependency 'database_cleaner', '~> 1.2'
+  s.add_development_dependency "appraisal", "~> 2.1"
+  s.add_development_dependency "rake", "~> 10.4.2"
+  s.add_development_dependency "shoulda", "~> 3.5.0"
+  s.add_development_dependency "ffaker", "~> 2.1.0"
+  s.add_development_dependency "railties", [">= 3.0", "< 6.0"]
+  s.add_development_dependency "sinatra", "~> 1.4.6"
+  s.add_development_dependency "rack-test", "~> 0.6.3"
+  s.add_development_dependency "rspec-rails", "~> 3.4.0"
+  s.add_development_dependency "generator_spec", "~> 0.9.3"
+  s.add_development_dependency "database_cleaner", "~> 1.2"
+  s.add_development_dependency "pry-nav", "~> 0.2.4"
+  s.add_development_dependency "rubocop", "~> 0.40.0"
+  s.add_development_dependency "timecop", "~> 0.8.0"
 
-  # Allow time travel in testing. timecop is only supported after 1.9.2 but does a better cleanup at 'return'
-  if RUBY_VERSION < "1.9.2"
-    s.add_development_dependency 'delorean'
+  if defined?(JRUBY_VERSION)
+    s.add_development_dependency "activerecord-jdbcsqlite3-adapter", "~> 1.3.15"
+    s.add_development_dependency "activerecord-jdbcpostgresql-adapter", "~> 1.3.15"
+    s.add_development_dependency "activerecord-jdbcmysql-adapter", "~> 1.3.15"
   else
-    s.add_development_dependency 'timecop'
-  end
+    s.add_development_dependency "sqlite3", "~> 1.2"
+    s.add_development_dependency "pg", "~> 0.17"
 
-  # JRuby support for the test ENV
-  unless defined?(JRUBY_VERSION)
-    s.add_development_dependency 'sqlite3', '~> 1.2'
-    s.add_development_dependency 'mysql2', '~> 0.3'
-    s.add_development_dependency 'pg', '~> 0.17'
-  else
-    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '~> 1.3'
-    s.add_development_dependency 'activerecord-jdbcpostgresql-adapter', '~> 1.3'
-    s.add_development_dependency 'activerecord-jdbcmysql-adapter', '~> 1.3'
+    # activerecord >= 4.2.5 may use mysql2 >= 0.4
+    s.add_development_dependency "mysql2", "~> 0.4.2"
   end
 end

data/spec/generators/install_generator_spec.rb

@@ -1,10 +1,10 @@
-require 'rails_helper'
-require 'generator_spec/test_case'
-require File.expand_path('../../../lib/generators/paper_trail/install_generator', __FILE__)
+require "rails_helper"
+require "generator_spec/test_case"
+require File.expand_path("../../../lib/generators/paper_trail/install_generator", __FILE__)
 
-describe PaperTrail::InstallGenerator, :type => :generator do
+describe PaperTrail::InstallGenerator, type: :generator do
   include GeneratorSpec::TestCase
-  destination File.expand_path('../tmp', __FILE__)
+  destination File.expand_path("../tmp", __FILE__)
 
   after(:all) { prepare_destination } # cleanup the tmp directory
 
@@ -13,15 +13,15 @@ describe PaperTrail::InstallGenerator, :type => :generator do
       prepare_destination
       run_generator
     end
-  
+
     it "generates a migration for creating the 'versions' table" do
       expect(destination_root).to have_structure {
-        directory 'db' do
-          directory 'migrate' do
-            migration 'create_versions' do
-              contains 'class CreateVersions'
-              contains 'def change'
-              contains 'create_table :versions do |t|'
+        directory "db" do
+          directory "migrate" do
+            migration "create_versions" do
+              contains "class CreateVersions"
+              contains "def change"
+              contains "create_table :versions"
             end
           end
         end
@@ -37,12 +37,12 @@ describe PaperTrail::InstallGenerator, :type => :generator do
 
     it "generates a migration for creating the 'versions' table" do
       expect(destination_root).to have_structure {
-        directory 'db' do
-          directory 'migrate' do
-            migration 'create_versions' do
-              contains 'class CreateVersions'
-              contains 'def change'
-              contains 'create_table :versions do |t|'
+        directory "db" do
+          directory "migrate" do
+            migration "create_versions" do
+              contains "class CreateVersions"
+              contains "def change"
+              contains "create_table :versions"
             end
           end
         end
@@ -51,17 +51,16 @@ describe PaperTrail::InstallGenerator, :type => :generator do
 
     it "generates a migration for adding the 'object_changes' column to the 'versions' table" do
       expect(destination_root).to have_structure {
-        directory 'db' do
-          directory 'migrate' do
-            migration 'add_object_changes_to_versions' do
-              contains 'class AddObjectChangesToVersions'
-              contains 'def change'
-              contains 'add_column :versions, :object_changes, :text'
+        directory "db" do
+          directory "migrate" do
+            migration "add_object_changes_to_versions" do
+              contains "class AddObjectChangesToVersions"
+              contains "def change"
+              contains "add_column :versions, :object_changes, :text"
             end
           end
         end
       }
     end
   end
-
 end

data/spec/generators/paper_trail/templates/create_versions_spec.rb

@@ -0,0 +1,51 @@
+require "rails_helper"
+require "generators/paper_trail/templates/create_versions"
+
+RSpec.describe CreateVersions do
+  describe "#change", verify_stubs: false do
+    let(:migration) { described_class.new }
+
+    before do
+      allow(migration).to receive(:add_index)
+      allow(migration).to receive(:create_table)
+    end
+
+    it "creates the versions table" do
+      migration.change
+      expect(migration).to have_received(:create_table) do |arg1|
+        expect(arg1).to eq(:versions)
+      end
+    end
+
+    case ENV["DB"]
+    when "mysql"
+      it "uses InnoDB engine" do
+        migration.change
+        expect(migration).to have_received(:create_table) do |_, arg2|
+          expect(arg2[:options]).to match(/ENGINE=InnoDB/)
+        end
+      end
+
+      it "uses utf8mb4 character set" do
+        migration.change
+        expect(migration).to have_received(:create_table) do |_, arg2|
+          expect(arg2[:options]).to match(/DEFAULT CHARSET=utf8mb4/)
+        end
+      end
+
+      it "uses utf8mb4_col collation" do
+        migration.change
+        expect(migration).to have_received(:create_table) do |_, arg2|
+          expect(arg2[:options]).to match(/COLLATE=utf8mb4_general_ci/)
+        end
+      end
+    else
+      it "passes an empty options hash to create_table" do
+        migration.change
+        expect(migration).to have_received(:create_table) do |_, arg2|
+          expect(arg2).to eq({})
+        end
+      end
+    end
+  end
+end

data/spec/models/animal_spec.rb

@@ -1,19 +1,36 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe Animal, :type => :model do
+describe Animal, type: :model do
   it { is_expected.to be_versioned }
 
-  describe "STI", :versioning => true do
-    it { expect(Animal.inheritance_column).to eq('species') }
+  describe "STI", versioning: true do
+    it { expect(Animal.inheritance_column).to eq("species") }
 
     describe "updates to the `inheritance_column`" do
-      subject { Cat.create!(:name => 'Leo') }
+      subject { Cat.create!(name: "Leo") }
 
       it "should be allowed" do
-        subject.update_attributes(:name => 'Spike', :species => 'Dog')
+        subject.update_attributes(name: "Spike", species: "Dog")
         dog = Animal.find(subject.id)
         expect(dog).to be_instance_of(Dog)
       end
     end
+
+    context "with callback-methods" do
+      context "when only has_paper_trail set in super class" do
+        let(:callback_cat) { Cat.create(name: "Markus") }
+
+        it "trails all events" do
+          callback_cat.update_attributes(name: "Billie")
+          callback_cat.destroy
+          expect(callback_cat.versions.collect(&:event)).to eq %w(create update destroy)
+        end
+
+        it "does not break reify" do
+          callback_cat.destroy
+          expect { callback_cat.versions.last.reify }.not_to raise_error
+        end
+      end
+    end
   end
 end

data/spec/models/boolit_spec.rb

@@ -1,16 +1,16 @@
-require 'rails_helper'
-require Rails.root.join('..', 'custom_json_serializer')
+require "rails_helper"
+require Rails.root.join("..", "custom_json_serializer")
 
-describe Boolit, :type => :model do
+describe Boolit, type: :model do
   it { is_expected.to be_versioned }
 
   it "has a default scope" do
     expect(subject.default_scopes).to_not be_empty
   end
 
-  describe "Versioning", :versioning => true do
+  describe "Versioning", versioning: true do
     subject { Boolit.create! }
-    before { subject.update_attributes!(:name => Faker::Name.name) }
+    before { subject.update_attributes!(name: FFaker::Name.name) }
 
     it "should have versions" do
       expect(subject.versions.size).to eq(2)
@@ -21,7 +21,7 @@ describe Boolit, :type => :model do
     end
 
     context "Instance falls out of default scope" do
-      before { subject.update_attributes!(:scoped => false) }
+      before { subject.update_attributes!(scoped: false) }
 
       it "is NOT scoped" do
         expect(Boolit.first).to be_nil
@@ -34,8 +34,8 @@ describe Boolit, :type => :model do
       context "with `nil` attributes on the live instance" do
         before do
           PaperTrail.serializer = CustomJsonSerializer
-          subject.update_attributes!(:name => nil)
-          subject.update_attributes!(:name => Faker::Name.name)
+          subject.update_attributes!(name: nil)
+          subject.update_attributes!(name: FFaker::Name.name)
         end
         after { PaperTrail.serializer = PaperTrail::Serializers::YAML }