paper_trail 4.0.0 → 5.1.0

data/spec/models/callback_modifier_spec.rb

@@ -0,0 +1,96 @@
+require "rails_helper"
+
+describe CallbackModifier, type: :model do
+  with_versioning do
+    describe "callback-methods", versioning: true do
+      describe "paper_trail_on_destroy" do
+        it "should add :destroy to paper_trail_options[:on]" do
+          modifier = NoArgDestroyModifier.create!(some_content: FFaker::Lorem.sentence)
+          expect(modifier.paper_trail_options[:on]).to eq [:destroy]
+        end
+
+        context "when :before" do
+          it "should create the version before destroy" do
+            modifier = BeforeDestroyModifier.create!(some_content: FFaker::Lorem.sentence)
+            modifier.test_destroy
+            expect(modifier.versions.last.reify).not_to be_flagged_deleted
+          end
+        end
+
+        context "when :after" do
+          it "should create the version after destroy" do
+            modifier = AfterDestroyModifier.create!(some_content: FFaker::Lorem.sentence)
+            modifier.test_destroy
+            expect(modifier.versions.last.reify).to be_flagged_deleted
+          end
+        end
+
+        context "when no argument" do
+          it "should default to before destroy" do
+            modifier = NoArgDestroyModifier.create!(some_content: FFaker::Lorem.sentence)
+            modifier.test_destroy
+            expect(modifier.versions.last.reify).not_to be_flagged_deleted
+          end
+        end
+      end
+
+      describe "paper_trail_on_update" do
+        it "should add :update to paper_trail_options[:on]" do
+          modifier = UpdateModifier.create!(some_content: FFaker::Lorem.sentence)
+          expect(modifier.paper_trail_options[:on]).to eq [:update]
+        end
+
+        it "should create a version" do
+          modifier = UpdateModifier.create!(some_content: FFaker::Lorem.sentence)
+          modifier.update_attributes! some_content: "modified"
+          expect(modifier.versions.last.event).to eq "update"
+        end
+      end
+
+      describe "paper_trail_on_create" do
+        it "should add :create to paper_trail_options[:on]" do
+          modifier = CreateModifier.create!(some_content: FFaker::Lorem.sentence)
+          expect(modifier.paper_trail_options[:on]).to eq [:create]
+        end
+
+        it "should create a version" do
+          modifier = CreateModifier.create!(some_content: FFaker::Lorem.sentence)
+          expect(modifier.versions.last.event).to eq "create"
+        end
+      end
+
+      context "when no callback-method used" do
+        it "should set paper_trail_options[:on] to [:create, :update, :destroy]" do
+          modifier = DefaultModifier.create!(some_content: FFaker::Lorem.sentence)
+          expect(modifier.paper_trail_options[:on]).to eq [:create, :update, :destroy]
+        end
+
+        it "should default to track destroy" do
+          modifier = DefaultModifier.create!(some_content: FFaker::Lorem.sentence)
+          modifier.destroy
+          expect(modifier.versions.last.event).to eq "destroy"
+        end
+
+        it "should default to track update" do
+          modifier = DefaultModifier.create!(some_content: FFaker::Lorem.sentence)
+          modifier.update_attributes! some_content: "modified"
+          expect(modifier.versions.last.event).to eq "update"
+        end
+
+        it "should default to track create" do
+          modifier = DefaultModifier.create!(some_content: FFaker::Lorem.sentence)
+          expect(modifier.versions.last.event).to eq "create"
+        end
+      end
+
+      context "when only one callback-method" do
+        it "does only track the corresponding event" do
+          modifier = CreateModifier.create!(some_content: FFaker::Lorem.sentence)
+          modifier.update_attributes!(some_content: "modified")
+          modifier.test_destroy
+          expect(modifier.versions.collect(&:event)).to eq ["create"]
+        end
+      end
+    end
+  end
+end

data/spec/models/car_spec.rb

@@ -0,0 +1,13 @@
+require "rails_helper"
+
+describe Car, type: :model do
+  it { is_expected.to be_versioned }
+
+  describe "changeset", versioning: true do
+    it "has the expected keys (see issue 738)" do
+      car = Car.create!(name: "Alice")
+      car.update_attributes(name: "Bob")
+      assert_includes car.versions.last.changeset.keys, "name"
+    end
+  end
+end

data/spec/models/fluxor_spec.rb

@@ -1,7 +1,7 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe Fluxor, :type => :model do
-  describe '`be_versioned` matcher' do
+describe Fluxor, type: :model do
+  describe "`be_versioned` matcher" do
     it { is_expected.to_not be_versioned }
   end
 

data/spec/models/gadget_spec.rb

@@ -1,36 +1,34 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe Gadget, :type => :model do
+describe Gadget, type: :model do
   it { is_expected.to be_versioned }
 
-  let(:gadget) { Gadget.create!(:name => 'Wrench', :brand => 'Acme') }
+  let(:gadget) { Gadget.create!(name: "Wrench", brand: "Acme") }
 
-  describe "updates", :versioning => true do
+  describe "updates", versioning: true do
     it "should generate a version for updates to `name` attribute" do
-      expect { gadget.update_attribute(:name, 'Hammer').to change{gadget.versions.size}.by(1) }
+      expect { gadget.update_attribute(:name, "Hammer").to change { gadget.versions.size }.by(1) }
     end
 
     it "should ignore for updates to `brand` attribute" do
-      expect { gadget.update_attribute(:brand, 'Stanley') }.to_not change{gadget.versions.size}
+      expect { gadget.update_attribute(:brand, "Stanley") }.to_not change { gadget.versions.size }
     end
 
     it "should still generate a version when only the `updated_at` attribute is updated" do
-      expect { gadget.update_attribute(:updated_at, Time.now) }.to change{gadget.versions.size}.by(1)
+      # Plus 1 second because MySQL lacks sub-second resolution
+      expect {
+        gadget.update_attribute(:updated_at, Time.now + 1)
+      }.to change { gadget.versions.size }.by(1)
     end
   end
 
   describe "Methods" do
-    describe "Instance", :versioning => true do
+    describe "Instance", versioning: true do
       describe "private" do
         describe '#changed_notably?' do
-          subject { Gadget.new(:created_at => Time.now) }
+          subject { Gadget.new(created_at: Time.now) }
 
-          # apparently the private methods list in Ruby18 is different than in Ruby19+
-          if RUBY_VERSION >= '1.9'
-            it { expect(subject.private_methods).to include(:changed_notably?) }
-          else
-            it { expect(subject.private_methods).to include('changed_notably?') }
-          end
+          it { expect(subject.private_methods).to include(:changed_notably?) }
 
           context "create events" do
             it { expect(subject.send(:changed_notably?)).to be true }
@@ -41,24 +39,26 @@ describe Gadget, :type => :model do
 
             context "without update timestamps" do
               it "should only acknowledge non-ignored attrs" do
-                subject.name = 'Wrench'
+                subject.name = "Wrench"
                 expect(subject.send(:changed_notably?)).to be true
               end
 
               it "should not acknowledge ignored attr (brand)" do
-                subject.brand = 'Acme'
+                subject.brand = "Acme"
                 expect(subject.send(:changed_notably?)).to be false
               end
             end
 
             context "with update timestamps" do
               it "should only acknowledge non-ignored attrs" do
-                subject.name, subject.updated_at = 'Wrench', Time.now
+                subject.name = "Wrench"
+                subject.updated_at = Time.now
                 expect(subject.send(:changed_notably?)).to be true
               end
 
               it "should not acknowledge ignored attrs and timestamps only" do
-                subject.brand, subject.updated_at = 'Acme', Time.now
+                subject.brand = "Acme"
+                subject.updated_at = Time.now
                 expect(subject.send(:changed_notably?)).to be false
               end
             end

data/spec/models/joined_version_spec.rb

@@ -1,9 +1,9 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe JoinedVersion, :type => :model, :versioning => true do
+describe JoinedVersion, type: :model, versioning: true do
   it { expect(JoinedVersion.superclass).to be PaperTrail::Version }
 
-  let(:widget) { Widget.create!(:name => Faker::Name.name) }
+  let(:widget) { Widget.create!(name: FFaker::Name.name) }
   let(:version) { JoinedVersion.first }
 
   describe "Scopes" do

data/spec/models/json_version_spec.rb

@@ -1,18 +1,29 @@
-if JsonVersion.table_exists?
+require "rails_helper"
 
-  require 'rails_helper'
+# The `json_versions` table tests postgres' `json` data type. So, that
+# table is only created when testing against postgres and ActiveRecord >= 4.
+if JsonVersion.table_exists?
 
-  describe JsonVersion, :type => :model do
+  describe JsonVersion, type: :model do
     it "should include the `VersionConcern` module to get base functionality" do
       expect(JsonVersion).to include(PaperTrail::VersionConcern)
     end
 
     describe "Methods" do
       describe "Class" do
-
         describe '#where_object' do
           it { expect(JsonVersion).to respond_to(:where_object) }
 
+          it "escapes values" do
+            f = Fruit.create(name: "Bobby")
+            expect(
+              f.
+                versions.
+                where_object(name: "Robert'; DROP TABLE Students;--").
+                count
+            ).to eq(0)
+          end
+
           context "invalid arguments" do
             it "should raise an error" do
               expect { JsonVersion.where_object(:foo) }.to raise_error(ArgumentError)
@@ -20,21 +31,21 @@ if JsonVersion.table_exists?
             end
           end
 
-          context "valid arguments", :versioning => true do
+          context "valid arguments", versioning: true do
             let(:fruit_names) { %w(apple orange lemon banana lime coconut strawberry blueberry) }
             let(:fruit) { Fruit.new }
-            let(:name) { 'pomegranate' }
-            let(:color) { Faker::Color.name }
+            let(:name) { "pomegranate" }
+            let(:color) { FFaker::Color.name }
 
             before do
-              fruit.update_attributes!(:name => name)
-              fruit.update_attributes!(:name => fruit_names.sample, :color => color)
-              fruit.update_attributes!(:name => fruit_names.sample, :color => Faker::Color.name)
+              fruit.update_attributes!(name: name)
+              fruit.update_attributes!(name: fruit_names.sample, color: color)
+              fruit.update_attributes!(name: fruit_names.sample, color: FFaker::Color.name)
             end
 
             it "should be able to locate versions according to their `object` contents" do
-              expect(JsonVersion.where_object(:name => name)).to eq([fruit.versions[1]])
-              expect(JsonVersion.where_object(:color => color)).to eq([fruit.versions[2]])
+              expect(JsonVersion.where_object(name: name)).to eq([fruit.versions[1]])
+              expect(JsonVersion.where_object(color: color)).to eq([fruit.versions[2]])
             end
           end
         end
@@ -42,6 +53,16 @@ if JsonVersion.table_exists?
         describe '#where_object_changes' do
           it { expect(JsonVersion).to respond_to(:where_object_changes) }
 
+          it "escapes values" do
+            f = Fruit.create(name: "Bobby")
+            expect(
+              f.
+                versions.
+                where_object_changes(name: "Robert'; DROP TABLE Students;--").
+                count
+            ).to eq(0)
+          end
+
           context "invalid arguments" do
             it "should raise an error" do
               expect { JsonVersion.where_object_changes(:foo) }.to raise_error(ArgumentError)
@@ -49,32 +70,33 @@ if JsonVersion.table_exists?
             end
           end
 
-          context "valid arguments", :versioning => true do
-            let(:fruit_names) { %w(apple orange lemon banana lime strawberry blueberry) }
-            let(:tropical_fruit_names) { %w(coconut pineapple kiwi mango melon) }
-            let(:fruit) { Fruit.new }
-            let(:name) { 'pomegranate' }
-            let(:color) { Faker::Color.name }
+          context "valid arguments", versioning: true do
+            let(:color) { %w(red green) }
+            let(:fruit) { Fruit.create!(name: name[0]) }
+            let(:name) { %w(banana kiwi mango) }
 
             before do
-              fruit.update_attributes!(:name => name)
-              fruit.update_attributes!(:name => tropical_fruit_names.sample, :color => color)
-              fruit.update_attributes!(:name => fruit_names.sample, :color => Faker::Color.name)
+              fruit.update_attributes!(name: name[1], color: color[0])
+              fruit.update_attributes!(name: name[2], color: color[1])
             end
 
-            it "should be able to locate versions according to their `object_changes` contents" do
-              expect(fruit.versions.where_object_changes(:name => name)).to eq(fruit.versions[0..1])
-              expect(fruit.versions.where_object_changes(:color => color)).to eq(fruit.versions[1..2])
+            it "finds versions according to their `object_changes` contents" do
+              expect(
+                fruit.versions.where_object_changes(name: name[0])
+              ).to match_array(fruit.versions[0..1])
+              expect(
+                fruit.versions.where_object_changes(color: color[0])
+              ).to match_array(fruit.versions[1..2])
             end
 
-            it "should be able to handle queries for multiple attributes" do
-              expect(fruit.versions.where_object_changes(:color => color, :name => name)).to eq([fruit.versions[1]])
+            it "finds versions with multiple attributes changed" do
+              expect(
+                fruit.versions.where_object_changes(color: color[0], name: name[0])
+              ).to match_array([fruit.versions[1]])
             end
           end
         end
       end
-
     end
   end
-
 end

data/spec/models/kitchen/banana_spec.rb

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

data/spec/models/not_on_update_spec.rb

@@ -1,7 +1,7 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe NotOnUpdate, :type => :model do
-  describe "#touch_with_version", :versioning => true do
+describe NotOnUpdate, type: :model do
+  describe "#touch_with_version", versioning: true do
     let!(:record) { described_class.create! }
 
     it "should create a version, regardless" do
@@ -12,7 +12,10 @@ describe NotOnUpdate, :type => :model do
 
     it "increments the `:updated_at` timestamp" do
       before = record.updated_at
-      record.touch_with_version
+      # Travel 1 second because MySQL lacks sub-second resolution
+      Timecop.travel(1) do
+        record.touch_with_version
+      end
       expect(record.updated_at).to be > before
     end
   end

data/spec/models/post_with_status_spec.rb

@@ -1,17 +1,27 @@
-require 'rails_helper'
+require "rails_helper"
 
 # This model is in the test suite soley for the purpose of testing ActiveRecord::Enum,
 # which is available in ActiveRecord4+ only
-describe PostWithStatus, :type => :model do
+describe PostWithStatus, type: :model do
   if defined?(ActiveRecord::Enum)
     with_versioning do
-      let(:post) { PostWithStatus.create!(:status => 'draft') }
+      let(:post) { PostWithStatus.create!(status: "draft") }
 
       it "should stash the enum value properly in versions" do
         post.published!
         post.archived!
         expect(post.previous_version.published?).to be true
       end
+
+      context "storing enum object_changes" do
+        subject { post.versions.last }
+
+        it "should stash the enum value properly in versions object_changes" do
+          post.published!
+          post.archived!
+          expect(subject.changeset["status"]).to eql %w(published archived)
+        end
+      end
     end
   end
 end

data/spec/models/skipper_spec.rb

@@ -1,16 +1,45 @@
-require 'rails_helper'
+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) }
+describe Skipper, type: :model do
+  with_versioning do
+    it { is_expected.to be_versioned }
 
-      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 }
+    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
+
+    describe "reify" do
+      context "reifying a with 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) }
+
+        context "without preserve (default)" do
+          it "should have no timestamp" do
+            skipper = Skipper.create!(another_timestamp: t1)
+            skipper.update_attributes!(another_timestamp: t2, name: "Foobar")
+            skipper = skipper.versions.last.reify
+            expect(skipper.another_timestamp).to be(nil)
+          end
+        end
+
+        context "with preserve" do
+          it "should preserve its timestamp" do
+            skipper = Skipper.create!(another_timestamp: t1)
+            skipper.update_attributes!(another_timestamp: t2, name: "Foobar")
+            skipper = skipper.versions.last.reify(unversioned_attributes: :preserve)
+            expect(skipper.another_timestamp).to eq(t2)
+          end
+        end
       end
     end
   end

data/spec/models/thing_spec.rb

@@ -1,10 +1,10 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe Thing, :type => :model do
+describe Thing, type: :model do
   it { is_expected.to be_versioned }
 
-  describe "should not store object_changes", :versioning => true do
-    let(:thing) { Thing.create(:name =>"pencil") }
+  describe "should not store object_changes", versioning: true do
+    let(:thing) { Thing.create(name: "pencil") }
 
     it { expect(thing.versions.last.object_changes).to be_nil }
   end

data/spec/models/truck_spec.rb

@@ -0,0 +1,5 @@
+require "rails_helper"
+
+describe Truck, type: :model do
+  it { is_expected.to_not be_versioned }
+end

data/spec/models/vehicle_spec.rb

@@ -0,0 +1,5 @@
+require "rails_helper"
+
+describe Vehicle, type: :model do
+  it { is_expected.to_not be_versioned }
+end