paper_trail 4.0.0.rc1 → 4.0.0.rc2

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

@@ -1,5 +1,10 @@
 class AddObjectChangesToVersions < ActiveRecord::Migration
+
+  # The largest text column available in all supported RDBMS.
+  # See `create_versions.rb` for details.
+  TEXT_BYTES = 1_073_741_823
+
   def change
-    add_column :versions, :object_changes, :text
+    add_column :versions, :object_changes, :text, limit: TEXT_BYTES
   end
 end

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

@@ -1,11 +1,18 @@
 class CreateVersions < ActiveRecord::Migration
+
+  # 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 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
+      t.text     :object,    :limit => TEXT_BYTES
       t.datetime :created_at
     end
     add_index :versions, [:item_type, :item_id]

data/lib/paper_trail.rb

@@ -104,7 +104,7 @@ module PaperTrail
   end
 
   def self.transaction?
-    ActiveRecord::Base.connection.open_transactions > 0
+    ::ActiveRecord::Base.connection.open_transactions > 0
   end
 
   def self.transaction_id
@@ -149,7 +149,7 @@ end
 
 # Require frameworks
 require 'paper_trail/frameworks/sinatra'
-if defined? Rails
+if defined? ::Rails
   require 'paper_trail/frameworks/rails'
 else
   require 'paper_trail/frameworks/active_record'

data/lib/paper_trail/config.rb

@@ -1,14 +1,14 @@
 require 'singleton'
+require 'paper_trail/serializers/yaml'
 
 module PaperTrail
   class Config
     include Singleton
-    attr_accessor :enabled, :timestamp_field, :serializer, :version_limit
+    attr_accessor :timestamp_field, :serializer, :version_limit
     attr_reader :serialized_attributes
     attr_writer :track_associations
 
     def initialize
-      @enabled         = true # Indicates whether PaperTrail is on or off.
       @timestamp_field = :created_at
       @serializer      = PaperTrail::Serializers::YAML
 
@@ -22,9 +22,11 @@ module PaperTrail
 
     def serialized_attributes=(value)
       if ::ActiveRecord::VERSION::MAJOR >= 5
-        warn("DEPRECATED: ActiveRecord 5.0 deprecated `serialized_attributes` "  +
+        ::ActiveSupport::Deprecation.warn(
+          "ActiveRecord 5.0 deprecated `serialized_attributes` "  +
           "without replacement, so this PaperTrail config setting does " +
-          "nothing with this version, and is always turned off")
+          "nothing with this version, and is always turned off"
+        )
       end
       @serialized_attributes = value
     end
@@ -33,5 +35,14 @@ module PaperTrail
       @track_associations ||= PaperTrail::VersionAssociation.table_exists?
     end
     alias_method :track_associations?, :track_associations
+
+    # Indicates whether PaperTrail is on or off.
+    def enabled
+      PaperTrail.paper_trail_store[:paper_trail_enabled].nil? || PaperTrail.paper_trail_store[:paper_trail_enabled]
+    end
+
+    def enabled= enable
+      PaperTrail.paper_trail_store[:paper_trail_enabled] = enable
+    end
   end
 end

data/lib/paper_trail/frameworks/active_record.rb

@@ -1,5 +1,4 @@
 # This file only needs to be loaded if the gem is being used outside of Rails, since otherwise
 # the model(s) will get loaded in via the `Rails::Engine`
-Dir[File.join(File.dirname(__FILE__), 'active_record', 'models', 'paper_trail', '*.rb')].each do |file|
-  require "paper_trail/frameworks/active_record/models/paper_trail/#{File.basename(file, '.rb')}"
-end
+require "paper_trail/frameworks/active_record/models/paper_trail/version_association"
+require "paper_trail/frameworks/active_record/models/paper_trail/version"

data/lib/paper_trail/has_paper_trail.rb

@@ -192,7 +192,7 @@ module PaperTrail
       end
 
       def originator
-        warn "DEPRECATED: use `paper_trail_originator` instead of `originator`. Support for `originator` will be removed in PaperTrail 4.0"
+        ::ActiveSupport::Deprecation.warn "Use paper_trail_originator instead of originator."
         self.paper_trail_originator
       end
 
@@ -266,11 +266,14 @@ module PaperTrail
         PaperTrail.whodunnit = current_whodunnit
       end
 
-      # Mimicks behavior of `touch` method from `ActiveRecord::Persistence`, but generates a version
+      # Mimics the `touch` method from `ActiveRecord::Persistence`, but also
+      # creates a version. A version is created regardless of options such as
+      # `:on`, `:if`, or `:unless`.
       #
-      # TODO: lookinto leveraging the `after_touch` callback from `ActiveRecord` to allow the
-      #  regular `touch` method go generate a version as normal. May make sense to switch the `record_update`
-      #  method to leverage an `after_update` callback anyways (likely for v4.0.0)
+      # TODO: look into leveraging the `after_touch` callback from
+      # `ActiveRecord` to allow the regular `touch` method go generate a version
+      # as normal. May make sense to switch the `record_update` method to
+      # leverage an `after_update` callback anyways (likely for v4.0.0)
       def touch_with_version(name = nil)
         raise ActiveRecordError, "can not touch on a new record object" unless persisted?
 
@@ -279,13 +282,20 @@ module PaperTrail
         current_time = current_time_from_proper_timezone
 
         attributes.each { |column| write_attribute(column, current_time) }
-        # ensure a version is written even if the `:on` collection is empty
-        record_update(true) if paper_trail_options[:on] == []
+
+        record_update(true) unless will_record_after_update?
         save!(:validate => false)
       end
 
       private
 
+      # Returns true if `save` will cause `record_update`
+      # to be called via the `after_update` callback.
+      def will_record_after_update?
+        on = paper_trail_options[:on]
+        on.nil? || on.include?(:update)
+      end
+
       def source_version
         send self.class.version_association_name
       end
@@ -459,18 +469,27 @@ module PaperTrail
         attrs
       end
 
-      # This method is invoked in order to determine whether it is appropriate to generate a new version instance.
-      # Because we are now using `after_(create/update/etc)` callbacks, we need to go out of our way to
-      # ensure that during updates timestamp attributes are not acknowledged as a notable changes
-      # to raise false positives when attributes are ignored.
+      # This method determines whether it is appropriate to generate a new
+      # version instance. A timestamp-only update (e.g. only `updated_at`
+      # changed) is considered notable unless an ignored attribute was also
+      # changed.
       def changed_notably?
-        if self.paper_trail_options[:ignore].any? && (changed & self.paper_trail_options[:ignore]).any?
-          (notably_changed - timestamp_attributes_for_update_in_model.map(&:to_s)).any?
+        if ignored_attr_has_changed?
+          timestamps = timestamp_attributes_for_update_in_model.map(&:to_s)
+          (notably_changed - timestamps).any?
         else
           notably_changed.any?
         end
       end
 
+      # An attributed is "ignored" if it is listed in the `:ignore` option
+      # and/or the `:skip` option.  Returns true if an ignored attribute
+      # has changed.
+      def ignored_attr_has_changed?
+        ignored = self.paper_trail_options[:ignore] + self.paper_trail_options[:skip]
+        ignored.any? && (changed & ignored).any?
+      end
+
       def notably_changed
         only = self.paper_trail_options[:only].dup
         # remove Hash arguments and then evaluate whether the attributes (the keys of the hash) should also get pushed into the collection

data/lib/paper_trail/version_concern.rb

@@ -257,7 +257,7 @@ module PaperTrail
     end
 
     def originator
-      warn "DEPRECATED: use `paper_trail_originator` instead of `originator`. Support for `originator` will be removed in PaperTrail 4.0"
+      ::ActiveSupport::Deprecation.warn "Use paper_trail_originator instead of originator."
       self.paper_trail_originator
     end
 

data/lib/paper_trail/version_number.rb

@@ -3,7 +3,7 @@ module PaperTrail
     MAJOR = 4
     MINOR = 0
     TINY  = 0
-    PRE   = 'rc1'
+    PRE   = 'rc2'
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
 

data/paper_trail.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activerecord', ['>= 3.0', '< 6.0']
   s.add_dependency 'activesupport', ['>= 3.0', '< 6.0']
-  s.add_dependency 'request_store', '~> 1.1.0'
+  s.add_dependency 'request_store', '~> 1.1'
 
   s.add_development_dependency 'rake', '~> 10.1.1'
   s.add_development_dependency 'shoulda', '~> 3.5'

data/spec/models/gadget_spec.rb

@@ -45,7 +45,7 @@ describe Gadget, :type => :model do
                 expect(subject.send(:changed_notably?)).to be true
               end
 
-              it "should not acknowledge ignored attrs and timestamps only" do
+              it "should not acknowledge ignored attr (brand)" do
                 subject.brand = 'Acme'
                 expect(subject.send(:changed_notably?)).to be false
               end

data/spec/models/kitchen/banana_spec.rb

@@ -0,0 +1,14 @@
+require 'rails_helper'
+
+module Kitchen
+  describe Banana, :type => :model do
+    it { is_expected.to be_versioned }
+
+    describe '#versions' do
+      it "returns instances of Kitchen::BananaVersion", :versioning => true do
+        banana = described_class.create!
+        expect(banana.versions.first).to be_a(Kitchen::BananaVersion)
+      end
+    end
+  end
+end

data/spec/models/not_on_update_spec.rb

@@ -0,0 +1,19 @@
+require 'rails_helper'
+
+describe NotOnUpdate, :type => :model do
+  describe "#touch_with_version", :versioning => true do
+    let!(:record) { described_class.create! }
+
+    it "should create a version, regardless" do
+      expect { record.touch_with_version }.to change {
+        PaperTrail::Version.count
+      }.by(+1)
+    end
+
+    it "increments the `:updated_at` timestamp" do
+      before = record.updated_at
+      record.touch_with_version
+      expect(record.updated_at).to be > before
+    end
+  end
+end

data/spec/models/skipper_spec.rb

@@ -0,0 +1,17 @@
+require 'rails_helper'
+
+describe Skipper, :type => :model do
+  describe "#update_attributes!", :versioning => true do
+    context "updating a skipped attribute" do
+      let(:t1) { Time.zone.local(2015, 7, 15, 20, 34, 0) }
+      let(:t2) { Time.zone.local(2015, 7, 15, 20, 34, 30) }
+
+      it "should not create a version" do
+        skipper = Skipper.create!(:another_timestamp => t1)
+        expect {
+          skipper.update_attributes!(:another_timestamp => t2)
+        }.to_not change { skipper.versions.length }
+      end
+    end
+  end
+end

data/spec/models/version_spec.rb

@@ -58,10 +58,10 @@ describe PaperTrail::Version, :type => :model do
 
         context "Has previous version", :versioning => true do
           let(:name) { Faker::Name.name }
-          let(:widget) { Widget.create!(name: Faker::Name.name) }
+          let(:widget) { Widget.create!(:name => Faker::Name.name) }
           before do
             widget.versions.first.update_attributes!(:whodunnit => name)
-            widget.update_attributes!(name: Faker::Name.first_name)
+            widget.update_attributes!(:name => Faker::Name.first_name)
           end
           subject { widget.versions.last }
 
@@ -75,19 +75,16 @@ describe PaperTrail::Version, :type => :model do
 
       describe "#originator" do
         it { is_expected.to respond_to(:originator) }
-        let(:warning_msg) do
-          "DEPRECATED: use `paper_trail_originator` instead of `originator`." +
-          " Support for `originator` will be removed in PaperTrail 4.0"
-        end
 
         it 'should set the invoke `paper_trail_originator`' do
-          is_expected.to receive(:warn)
+          allow(ActiveSupport::Deprecation).to receive(:warn)
           is_expected.to receive(:paper_trail_originator)
           subject.originator
         end
 
         it 'should display a deprecation warning' do
-          is_expected.to receive(:warn).with(warning_msg)
+          expect(ActiveSupport::Deprecation).to receive(:warn).
+            with(/Use paper_trail_originator instead of originator/)
           subject.originator
         end
       end

data/spec/models/widget_spec.rb

@@ -177,19 +177,16 @@ describe Widget, :type => :model do
         subject { widget }
 
         it { is_expected.to respond_to(:originator) }
-        let(:warning_msg) do
-          "DEPRECATED: use `paper_trail_originator` instead of `originator`." +
-          " Support for `originator` will be removed in PaperTrail 4.0"
-        end
 
         it 'should set the invoke `paper_trail_originator`' do
-          is_expected.to receive(:warn)
+          allow(::ActiveSupport::Deprecation).to receive(:warn)
           is_expected.to receive(:paper_trail_originator)
           subject.originator
         end
 
         it 'should display a deprecation warning' do
-          is_expected.to receive(:warn).with(warning_msg)
+          expect(::ActiveSupport::Deprecation).to receive(:warn).
+            with(/Use paper_trail_originator instead of originator/)
           subject.originator
         end
       end
@@ -252,13 +249,13 @@ describe Widget, :type => :model do
       describe '#touch_with_version' do
         it { is_expected.to respond_to(:touch_with_version) }
 
-        it "should generate a version" do
+        it "creates a version" do
           count = widget.versions.size
           widget.touch_with_version
           expect(widget.versions.size).to eq(count + 1)
         end
 
-        it "should increment the `:updated_at` timestamp" do
+        it "increments the `:updated_at` timestamp" do
           time_was = widget.updated_at
           widget.touch_with_version
           expect(widget.updated_at).to be > time_was

data/test/dummy/app/models/kitchen/banana.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  class Banana < ActiveRecord::Base
+    has_paper_trail :class_name => "Kitchen::BananaVersion"
+  end
+end

data/test/dummy/app/models/not_on_update.rb

@@ -0,0 +1,4 @@
+# This model does not record versions when updated.
+class NotOnUpdate < ActiveRecord::Base
+  has_paper_trail :on => [:create, :destroy]
+end

data/test/dummy/app/models/skipper.rb

@@ -0,0 +1,6 @@
+class Skipper < ActiveRecord::Base
+  has_paper_trail(
+    :ignore => [:created_at],
+    :skip => [:another_timestamp]
+  )
+end

data/test/dummy/app/versions/kitchen/banana_version.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  class BananaVersion < PaperTrail::Version
+    self.table_name = 'banana_versions'
+  end
+end

data/test/dummy/db/migrate/20110208155312_set_up_test_tables.rb

@@ -1,5 +1,10 @@
 class SetUpTestTables < ActiveRecord::Migration
   def self.up
+    create_table :skippers, :force => true do |t|
+      t.datetime :another_timestamp
+      t.timestamps :null => true
+    end
+
     create_table :widgets, :force => true do |t|
       t.string    :name
       t.text      :a_text
@@ -73,6 +78,24 @@ class SetUpTestTables < ActiveRecord::Migration
       add_index :json_versions, [:item_type, :item_id]
     end
 
+    create_table :not_on_updates, :force => true do |t|
+      t.timestamps :null => true
+    end
+
+    create_table :bananas, :force => true do |t|
+      t.timestamps :null => true
+    end
+
+    create_table :banana_versions, :force => true 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
+      t.datetime :created_at
+    end
+    add_index :banana_versions, [:item_type, :item_id]
+
     create_table :wotsits, :force => true do |t|
       t.integer :widget_id
       t.string  :name
@@ -191,6 +214,8 @@ class SetUpTestTables < ActiveRecord::Migration
 
   def self.down
     drop_table :animals
+    drop_table :skippers
+    drop_table :not_on_updates
     drop_table :posts
     drop_table :songs
     drop_table :editors

data/test/paper_trail_test.rb

@@ -8,6 +8,13 @@ class PaperTrailTest < ActiveSupport::TestCase
   test 'Version Number' do
     assert PaperTrail.const_defined?(:VERSION)
   end
+  
+  test 'enabled is thread-safe' do
+    Thread.new do
+      PaperTrail.enabled = false
+    end.join
+    assert PaperTrail.enabled?
+  end
 
   test 'create with plain model class' do
     widget = Widget.create