paper_trail 4.2.0 → 5.0.0

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,32 +1,32 @@
-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') }
+    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')
+        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
+        it "does not break reify" do
           callback_cat.destroy
           expect { callback_cat.versions.last.reify }.not_to raise_error
         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 }
 

data/spec/models/callback_modifier_spec.rb

@@ -1,94 +1,94 @@
-require 'rails_helper'
+require "rails_helper"
 
-describe CallbackModifier, :type => :model do
+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 => Faker::Lorem.sentence)
+    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 => Faker::Lorem.sentence)
+        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 => Faker::Lorem.sentence)
+        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 after destroy' do
-            modifier = NoArgDestroyModifier.create!(:some_content => Faker::Lorem.sentence)
+        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).to be_flagged_deleted
+            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 => Faker::Lorem.sentence)
+      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 => Faker::Lorem.sentence)
-          modifier.update_attributes! :some_content => 'modified'
-          expect(modifier.versions.last.event).to eq 'update'
+        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 => Faker::Lorem.sentence)
+      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 => Faker::Lorem.sentence)
-          expect(modifier.versions.last.event).to eq 'create'
+        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 => Faker::Lorem.sentence)
+      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 => Faker::Lorem.sentence)
+        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'
+          expect(modifier.versions.last.event).to eq "destroy"
         end
 
-        it 'should default to track update' do
-          modifier = DefaultModifier.create!(:some_content => Faker::Lorem.sentence)
-          modifier.update_attributes! :some_content => 'modified'
-          expect(modifier.versions.last.event).to eq 'update'
+        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 => Faker::Lorem.sentence)
-          expect(modifier.versions.last.event).to eq 'create'
+        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 => Faker::Lorem.sentence)
-          modifier.update_attributes!(:some_content => 'modified')
+      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']
+          expect(modifier.versions.collect(&:event)).to eq ["create"]
         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