paper_trail 5.1.1 → 5.2.0

data/lib/paper_trail/reifier.rb

@@ -65,7 +65,7 @@ module PaperTrail
       # @api private
       def each_enabled_association(associations)
         associations.each do |assoc|
-          next unless assoc.klass.paper_trail_enabled_for_model?
+          next unless assoc.klass.paper_trail.enabled?
           yield assoc
         end
       end
@@ -112,7 +112,7 @@ module PaperTrail
         collection_keys = through_collection.map { |through_model|
           through_model.send(assoc.source_reflection.foreign_key)
         }
-        version_id_subquery = assoc.klass.paper_trail_version_class.
+        version_id_subquery = assoc.klass.paper_trail.version_class.
           select("MIN(id)").
           where("item_type = ?", assoc.class_name).
           where("item_id IN (?)", collection_keys).
@@ -140,7 +140,7 @@ module PaperTrail
       # from the point in time identified by `transaction_id` or `version_at`.
       # @api private
       def load_version_for_habtm(assoc, id, transaction_id, version_at)
-        assoc.klass.paper_trail_version_class.
+        assoc.klass.paper_trail.version_class.
           where("item_type = ?", assoc.klass.name).
           where("item_id = ?", id).
           where("created_at >= ? OR transaction_id = ?", version_at, transaction_id).
@@ -153,8 +153,8 @@ module PaperTrail
       # record from the point in time identified by `transaction_id` or `version_at`.
       # @api private
       def load_version_for_has_one(assoc, model, transaction_id, version_at)
-        version_table_name = model.class.paper_trail_version_class.table_name
-        model.class.paper_trail_version_class.joins(:version_associations).
+        version_table_name = model.class.paper_trail.version_class.table_name
+        model.class.paper_trail.version_class.joins(:version_associations).
           where("version_associations.foreign_key_name = ?", assoc.foreign_key).
           where("version_associations.foreign_key_id = ?", model.id).
           where("#{version_table_name}.item_type = ?", assoc.class_name).
@@ -263,7 +263,7 @@ module PaperTrail
             if options[:mark_for_destruction]
               model.send(assoc.name).mark_for_destruction if model.send(assoc.name, true)
             else
-              model.appear_as_new_record do
+              model.paper_trail.appear_as_new_record do
                 model.send "#{assoc.name}=", nil
               end
             end
@@ -276,7 +276,7 @@ module PaperTrail
                 has_and_belongs_to_many: false
               )
             )
-            model.appear_as_new_record do
+            model.paper_trail.appear_as_new_record do
               without_persisting(child) do
                 model.send "#{assoc.name}=", child
               end
@@ -289,7 +289,7 @@ module PaperTrail
         associations = model.class.reflect_on_all_associations(:belongs_to)
         each_enabled_association(associations) do |assoc|
           collection_key = model.send(assoc.association_foreign_key)
-          version = assoc.klass.paper_trail_version_class.
+          version = assoc.klass.paper_trail.version_class.
             where("item_type = ?", assoc.class_name).
             where("item_id = ?", collection_key).
             where("created_at >= ? OR transaction_id = ?", options[:version_at], transaction_id).
@@ -326,7 +326,7 @@ module PaperTrail
       # Restore the `model`'s has_many associations not associated through
       # another association.
       def reify_has_many_directly(transaction_id, associations, model, options = {})
-        version_table_name = model.class.paper_trail_version_class.table_name
+        version_table_name = model.class.paper_trail.version_class.table_name
         each_enabled_association(associations) do |assoc|
           version_id_subquery = PaperTrail::VersionAssociation.
             joins(model.class.version_association_name).
@@ -366,7 +366,7 @@ module PaperTrail
 
       def reify_has_and_belongs_to_many(transaction_id, model, options = {})
         model.class.reflect_on_all_associations(:has_and_belongs_to_many).each do |assoc|
-          papertrail_enabled = assoc.klass.paper_trail_enabled_for_model?
+          papertrail_enabled = assoc.klass.paper_trail.enabled?
           next unless
             model.class.paper_trail_save_join_tables.include?(assoc.name) ||
                 papertrail_enabled
@@ -429,7 +429,7 @@ module PaperTrail
       #
       def versions_by_id(klass, version_id_subquery)
         klass.
-          paper_trail_version_class.
+          paper_trail.version_class.
           where("id IN (#{version_id_subquery})").
           inject({}) { |a, e| a.merge!(e.item_id => e) }
       end

data/lib/paper_trail/version_number.rb

@@ -2,8 +2,8 @@ module PaperTrail
   # :nodoc:
   module VERSION
     MAJOR = 5
-    MINOR = 1
-    TINY = 1
+    MINOR = 2
+    TINY = 0
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/spec/models/boolit_spec.rb

@@ -28,7 +28,7 @@ describe Boolit, type: :model do
       end
 
       it "should still be able to be reified and persisted" do
-        expect { subject.previous_version.save! }.to_not raise_error
+        expect { subject.paper_trail.previous_version.save! }.to_not raise_error
       end
 
       context "with `nil` attributes on the live instance" do
@@ -40,7 +40,7 @@ describe Boolit, type: :model do
         after { PaperTrail.serializer = PaperTrail::Serializers::YAML }
 
         it "should not overwrite that attribute during the reification process" do
-          expect(subject.previous_version.name).to be_nil
+          expect(subject.paper_trail.previous_version.name).to be_nil
         end
       end
     end

data/spec/models/fluxor_spec.rb

@@ -7,12 +7,10 @@ describe Fluxor, type: :model do
 
   describe "Methods" do
     describe "Class" do
-      subject { Fluxor }
-
-      describe "#paper_trail_enabled_for_model?" do
-        it { is_expected.to respond_to(:paper_trail_enabled_for_model?) }
-
-        it { expect(subject.paper_trail_enabled_for_model?).to be false }
+      describe ".paper_trail.enabled?" do
+        it "returns false" do
+          expect(Fluxor.paper_trail.enabled?).to eq(false)
+        end
       end
     end
   end

data/spec/models/gadget_spec.rb

@@ -28,10 +28,8 @@ describe Gadget, type: :model do
         describe '#changed_notably?' do
           subject { Gadget.new(created_at: Time.now) }
 
-          it { expect(subject.private_methods).to include(:changed_notably?) }
-
           context "create events" do
-            it { expect(subject.send(:changed_notably?)).to be true }
+            it { expect(subject.paper_trail.changed_notably?).to be true }
           end
 
           context "update events" do
@@ -40,12 +38,12 @@ describe Gadget, type: :model do
             context "without update timestamps" do
               it "should only acknowledge non-ignored attrs" do
                 subject.name = "Wrench"
-                expect(subject.send(:changed_notably?)).to be true
+                expect(subject.paper_trail.changed_notably?).to be true
               end
 
               it "should not acknowledge ignored attr (brand)" do
                 subject.brand = "Acme"
-                expect(subject.send(:changed_notably?)).to be false
+                expect(subject.paper_trail.changed_notably?).to be false
               end
             end
 
@@ -53,13 +51,13 @@ describe Gadget, type: :model do
               it "should only acknowledge non-ignored attrs" do
                 subject.name = "Wrench"
                 subject.updated_at = Time.now
-                expect(subject.send(:changed_notably?)).to be true
+                expect(subject.paper_trail.changed_notably?).to be true
               end
 
               it "should not acknowledge ignored attrs and timestamps only" do
                 subject.brand = "Acme"
                 subject.updated_at = Time.now
-                expect(subject.send(:changed_notably?)).to be false
+                expect(subject.paper_trail.changed_notably?).to be false
               end
             end
           end

data/spec/models/not_on_update_spec.rb

@@ -5,7 +5,7 @@ describe NotOnUpdate, type: :model do
     let!(:record) { described_class.create! }
 
     it "should create a version, regardless" do
-      expect { record.touch_with_version }.to change {
+      expect { record.paper_trail.touch_with_version }.to change {
         PaperTrail::Version.count
       }.by(+1)
     end
@@ -14,7 +14,7 @@ describe NotOnUpdate, type: :model do
       before = record.updated_at
       # Travel 1 second because MySQL lacks sub-second resolution
       Timecop.travel(1) do
-        record.touch_with_version
+        record.paper_trail.touch_with_version
       end
       expect(record.updated_at).to be > before
     end

data/spec/models/post_with_status_spec.rb

@@ -10,7 +10,7 @@ describe PostWithStatus, type: :model do
       it "should stash the enum value properly in versions" do
         post.published!
         post.archived!
-        expect(post.previous_version.published?).to be true
+        expect(post.paper_trail.previous_version.published?).to be true
       end
 
       context "storing enum object_changes" do

data/spec/models/widget_spec.rb

@@ -64,11 +64,11 @@ describe Widget, type: :model do
 
       subject { widget.versions.last.reify }
 
-      it { expect(subject).not_to be_live }
+      it { expect(subject.paper_trail).not_to be_live }
 
       it "should clear the `versions_association_name` virtual attribute" do
         subject.save!
-        expect(subject).to be_live
+        expect(subject.paper_trail).to be_live
       end
 
       it "corresponding version should use the widget updated_at" do
@@ -140,21 +140,21 @@ describe Widget, type: :model do
 
   describe "Methods" do
     describe "Instance", versioning: true do
-      describe '#paper_trail_originator' do
-        it { is_expected.to respond_to(:paper_trail_originator) }
-
+      describe '#paper_trail.originator' do
         describe "return value" do
           let(:orig_name) { FFaker::Name.name }
           let(:new_name) { FFaker::Name.name }
           before { PaperTrail.whodunnit = orig_name }
 
           context "accessed from live model instance" do
-            specify { expect(widget).to be_live }
+            specify { expect(widget.paper_trail).to be_live }
 
             it "should return the originator for the model at a given state" do
-              expect(widget.paper_trail_originator).to eq(orig_name)
-              widget.whodunnit(new_name) { |w| w.update_attributes(name: "Elizabeth") }
-              expect(widget.paper_trail_originator).to eq(new_name)
+              expect(widget.paper_trail.originator).to eq(orig_name)
+              widget.paper_trail.whodunnit(new_name) { |w|
+                w.update_attributes(name: "Elizabeth")
+              }
+              expect(widget.paper_trail.originator).to eq(new_name)
             end
           end
 
@@ -169,7 +169,7 @@ describe Widget, type: :model do
               let(:reified_widget) { widget.versions[1].reify }
 
               it "should return the appropriate originator" do
-                expect(reified_widget.paper_trail_originator).to eq(orig_name)
+                expect(reified_widget.paper_trail.originator).to eq(orig_name)
               end
 
               it "should not create a new model instance" do
@@ -181,7 +181,7 @@ describe Widget, type: :model do
               let(:reified_widget) { widget.versions[1].reify(dup: true) }
 
               it "should return the appropriate originator" do
-                expect(reified_widget.paper_trail_originator).to eq(orig_name)
+                expect(reified_widget.paper_trail.originator).to eq(orig_name)
               end
 
               it "should not create a new model instance" do
@@ -192,35 +192,12 @@ describe Widget, type: :model do
         end
       end
 
-      describe "#originator" do
-        subject { widget }
-
-        it { is_expected.to respond_to(:originator) }
-
-        it "should set the invoke `paper_trail_originator`" do
-          allow(::ActiveSupport::Deprecation).to receive(:warn)
-          is_expected.to receive(:paper_trail_originator)
-          subject.originator
-        end
-
-        it "should display a deprecation warning" do
-          expect(::ActiveSupport::Deprecation).to receive(:warn).
-            with(/Use paper_trail_originator instead of originator/)
-          subject.originator
-        end
-      end
-
       describe '#version_at' do
-        it { is_expected.to respond_to(:version_at) }
-
         context "Timestamp argument is AFTER object has been destroyed" do
-          before do
+          it "should return `nil`" do
             widget.update_attribute(:name, "foobar")
             widget.destroy
-          end
-
-          it "should return `nil`" do
-            expect(widget.version_at(Time.now)).to be_nil
+            expect(widget.paper_trail.version_at(Time.now)).to be_nil
           end
         end
       end
@@ -231,7 +208,7 @@ describe Widget, type: :model do
         context "no block given" do
           it "should raise an error" do
             expect {
-              widget.whodunnit("Ben")
+              widget.paper_trail.whodunnit("Ben")
             }.to raise_error(ArgumentError, "expected to receive a block")
           end
         end
@@ -246,7 +223,7 @@ describe Widget, type: :model do
           end
 
           it "should modify value of `PaperTrail.whodunnit` while executing the block" do
-            widget.whodunnit(new_name) do
+            widget.paper_trail.whodunnit(new_name) do
               expect(PaperTrail.whodunnit).to eq(new_name)
               widget.update_attributes(name: "Elizabeth")
             end
@@ -255,7 +232,9 @@ describe Widget, type: :model do
 
           context "after executing the block" do
             it "reverts value of whodunnit to previous value" do
-              widget.whodunnit(new_name) { |w| w.update_attributes(name: "Elizabeth") }
+              widget.paper_trail.whodunnit(new_name) { |w|
+                w.update_attributes(name: "Elizabeth")
+              }
               expect(PaperTrail.whodunnit).to eq(orig_name)
             end
           end
@@ -263,7 +242,7 @@ describe Widget, type: :model do
           context "error within block" do
             it "still reverts the whodunnit value to previous value" do
               expect {
-                widget.whodunnit(new_name) { raise }
+                widget.paper_trail.whodunnit(new_name) { raise }
               }.to raise_error(RuntimeError)
               expect(PaperTrail.whodunnit).to eq(orig_name)
             end
@@ -272,13 +251,11 @@ describe Widget, type: :model do
       end
 
       describe '#touch_with_version' do
-        it { is_expected.to respond_to(:touch_with_version) }
-
         it "creates a version" do
           count = widget.versions.size
           # Travel 1 second because MySQL lacks sub-second resolution
           Timecop.travel(1) do
-            widget.touch_with_version
+            widget.paper_trail.touch_with_version
           end
           expect(widget.versions.size).to eq(count + 1)
         end
@@ -287,7 +264,7 @@ describe Widget, type: :model do
           time_was = widget.updated_at
           # Travel 1 second because MySQL lacks sub-second resolution
           Timecop.travel(1) do
-            widget.touch_with_version
+            widget.paper_trail.touch_with_version
           end
           expect(widget.updated_at).to be > time_was
         end
@@ -295,33 +272,26 @@ describe Widget, type: :model do
     end
 
     describe "Class" do
-      subject { Widget }
-
-      describe "#paper_trail_enabled_for_model?" do
-        it { is_expected.to respond_to(:paper_trail_enabled_for_model?) }
-
-        it { expect(subject.paper_trail_enabled_for_model?).to be true }
+      describe ".paper_trail.enabled?" do
+        it "returns true" do
+          expect(Widget.paper_trail.enabled?).to eq(true)
+        end
       end
 
-      describe '#paper_trail_off!' do
-        it { is_expected.to respond_to(:paper_trail_off!) }
-
-        it "should set the `paper_trail_enabled_for_model?` to `false`" do
-          expect(subject.paper_trail_enabled_for_model?).to be true
-          subject.paper_trail_off!
-          expect(subject.paper_trail_enabled_for_model?).to be false
+      describe ".disable" do
+        it "should set the `paper_trail.enabled?` to `false`" do
+          expect(Widget.paper_trail.enabled?).to eq(true)
+          Widget.paper_trail.disable
+          expect(Widget.paper_trail.enabled?).to eq(false)
         end
       end
 
-      describe '#paper_trail_on!' do
-        before { subject.paper_trail_off! }
-
-        it { is_expected.to respond_to(:paper_trail_on!) }
-
-        it "should set the `paper_trail_enabled_for_model?` to `true`" do
-          expect(subject.paper_trail_enabled_for_model?).to be false
-          subject.paper_trail_on!
-          expect(subject.paper_trail_enabled_for_model?).to be true
+      describe ".enable" do
+        it "should set the `paper_trail.enabled?` to `true`" do
+          Widget.paper_trail.disable
+          expect(Widget.paper_trail.enabled?).to eq(false)
+          Widget.paper_trail.enable
+          expect(Widget.paper_trail.enabled?).to eq(true)
         end
       end
     end

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

@@ -17,27 +17,27 @@ end
 
 class BeforeDestroyModifier < CallbackModifier
   has_paper_trail on: []
-  paper_trail_on_destroy :before
+  paper_trail.on_destroy :before
 end
 
 class AfterDestroyModifier < CallbackModifier
   has_paper_trail on: []
-  paper_trail_on_destroy :after
+  paper_trail.on_destroy :after
 end
 
 class NoArgDestroyModifier < CallbackModifier
   has_paper_trail on: []
-  paper_trail_on_destroy
+  paper_trail.on_destroy
 end
 
 class UpdateModifier < CallbackModifier
   has_paper_trail on: []
-  paper_trail_on_update
+  paper_trail.on_update
 end
 
 class CreateModifier < CallbackModifier
   has_paper_trail on: []
-  paper_trail_on_create
+  paper_trail.on_create
 end
 
 class DefaultModifier < CallbackModifier

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

@@ -1,3 +1,3 @@
 class Elephant < Animal
-  paper_trail_off!
+  paper_trail.disable
 end