paper_trail 6.0.2 → 7.0.0

data/lib/paper_trail/version_number.rb

@@ -1,9 +1,13 @@
 module PaperTrail
-  # :nodoc:
+  # The version number of the paper_trail gem. Not to be confused with
+  # `PaperTrail::Version`. Ruby constants are case-sensitive, apparently,
+  # and they are two different modules! It would be nice to remove `VERSION`,
+  # because of this confusion, but it's not worth the breaking change.
+  # People are encouraged to use `PaperTrail.gem_version` instead.
   module VERSION
-    MAJOR = 6
+    MAJOR = 7
     MINOR = 0
-    TINY = 2
+    TINY = 0
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/paper_trail.gemspec

@@ -3,7 +3,7 @@ require "paper_trail/version_number"
 
 Gem::Specification.new do |s|
   s.name = "paper_trail"
-  s.version = PaperTrail::VERSION::STRING.dup # The `dup` is for ruby 1.9.3
+  s.version = PaperTrail::VERSION::STRING
   s.platform = Gem::Platform::RUBY
   s.summary = "Track changes to your models."
   s.description = <<-EOS
@@ -22,7 +22,7 @@ has been destroyed.
   s.require_paths = ["lib"]
 
   s.required_rubygems_version = ">= 1.3.6"
-  s.required_ruby_version = ">= 1.9.3"
+  s.required_ruby_version = ">= 2.1.0"
 
   # Rails does not follow semver, makes breaking changes in minor versions.
   s.add_dependency "activerecord", [">= 4.0", "< 5.2"]
@@ -41,37 +41,10 @@ has been destroyed.
   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"
-
-  # We cannot upgrade rubocop until we drop support for ruby 1.9.3.
-  # Rubocop 0.42 requires ruby >= 2.0. We could add a conditional, as we do
-  # below for rack and pg, but that means our config files (e.g. `.rubocop.yml`
-  # would have to simultaneously be valid in two different versions of rubocop.
-  # That is currently possible, but probably won't be in the future, and is
-  # not worth the effort.) Because of pain points like this, I think we'll
-  # have to drop support for ruby 1.9.3 soon.
-  s.add_development_dependency "rubocop", "~> 0.41.1"
-
+  s.add_development_dependency "rubocop", "~> 0.48.0"
+  s.add_development_dependency "rubocop-rspec", "~> 1.15.0"
   s.add_development_dependency "timecop", "~> 0.8.0"
-
-  if ::Gem.ruby_version < ::Gem::Version.new("2.0.0")
-    s.add_development_dependency "rack", "< 2"
-  end
-
-  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 "sqlite3", "~> 1.2"
-
-    # pg 0.19 requires ruby >= 2.0.0
-    if ::Gem.ruby_version >= ::Gem::Version.new("2.0.0")
-      s.add_development_dependency "pg", "~> 0.19.0"
-    else
-      s.add_development_dependency "pg", [">= 0.17", "< 0.19"]
-    end
-
-    # activerecord >= 4.2.5 may use mysql2 >= 0.4
-    s.add_development_dependency "mysql2", "~> 0.4.2"
-  end
+  s.add_development_dependency "sqlite3", "~> 1.2"
+  s.add_development_dependency "pg", "~> 0.19.0"
+  s.add_development_dependency "mysql2", "~> 0.4.2"
 end

data/spec/controllers/articles_controller_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe ArticlesController, type: :controller do
       it "returns true" do
         assert PaperTrail.enabled?
         post :create, params_wrapper(article: { title: "Doh", content: FFaker::Lorem.sentence })
-        expect(assigns(:article)).to_not be_nil
+        expect(assigns(:article)).not_to be_nil
         assert PaperTrail.enabled_for_controller?
         assert_equal 1, assigns(:article).versions.length
       end

data/spec/generators/install_generator_spec.rb

@@ -2,7 +2,7 @@ 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
+RSpec.describe PaperTrail::InstallGenerator, type: :generator do
   include GeneratorSpec::TestCase
   destination File.expand_path("../tmp", __FILE__)
 
@@ -15,17 +15,19 @@ describe PaperTrail::InstallGenerator, type: :generator do
     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"
-            end
-          end
-        end
-      }
+      expect(destination_root).to(
+        have_structure {
+          directory("db") {
+            directory("migrate") {
+              migration("create_versions") {
+                contains "class CreateVersions"
+                contains "def change"
+                contains "create_table :versions"
+              }
+            }
+          }
+        }
+      )
     end
   end
 
@@ -36,31 +38,35 @@ describe PaperTrail::InstallGenerator, type: :generator do
     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"
-            end
-          end
-        end
-      }
+      expect(destination_root).to(
+        have_structure {
+          directory("db") {
+            directory("migrate") {
+              migration("create_versions") {
+                contains "class CreateVersions"
+                contains "def change"
+                contains "create_table :versions"
+              }
+            }
+          }
+        }
+      )
     end
 
     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"
-            end
-          end
-        end
-      }
+      expect(destination_root).to(
+        have_structure {
+          directory("db") {
+            directory("migrate") {
+              migration("add_object_changes_to_versions") {
+                contains "class AddObjectChangesToVersions"
+                contains "def change"
+                contains "add_column :versions, :object_changes, :text"
+              }
+            }
+          }
+        }
+      )
     end
   end
 end

data/spec/models/animal_spec.rb

@@ -1,35 +1,60 @@
 require "rails_helper"
 
-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 "updates to the `inheritance_column`" do
-      subject { Cat.create!(name: "Leo") }
+describe Animal, type: :model, versioning: true do
+  it "baseline test setup" do
+    expect(Animal.new).to be_versioned
+    expect(Animal.inheritance_column).to eq("species")
+  end
 
-      it "should be allowed" do
-        subject.update_attributes(name: "Spike", species: "Dog")
-        dog = Animal.find(subject.id)
-        expect(dog).to be_instance_of(Dog)
-      end
+  it "works with custom STI inheritance column" do
+    animal = Animal.create(name: "Animal")
+    animal.update_attributes(name: "Animal from the Muppets")
+    animal.update_attributes(name: "Animal Muppet")
+    animal.destroy
+    dog = Dog.create(name: "Snoopy")
+    dog.update_attributes(name: "Scooby")
+    dog.update_attributes(name: "Scooby Doo")
+    dog.destroy
+    cat = Cat.create(name: "Garfield")
+    cat.update_attributes(name: "Garfield (I hate Mondays)")
+    cat.update_attributes(name: "Garfield The Cat")
+    cat.destroy
+    expect(PaperTrail::Version.count).to(eq(12))
+    expect(animal.versions.count).to(eq(4))
+    expect(animal.versions.first.reify).to(be_nil)
+    animal.versions[(1..-1)].each do |v|
+      expect(v.reify.class.name).to(eq("Animal"))
     end
+    dog_versions = PaperTrail::Version.where(item_id: dog.id).order(:created_at)
+    expect(dog_versions.count).to(eq(4))
+    expect(dog_versions.first.reify).to(be_nil)
+    expect(dog_versions.map { |v| v.reify.class.name }).to eq(%w(NilClass Dog Dog Dog))
+    cat_versions = PaperTrail::Version.where(item_id: cat.id).order(:created_at)
+    expect(cat_versions.count).to(eq(4))
+    expect(cat_versions.first.reify).to(be_nil)
+    expect(cat_versions.map { |v| v.reify.class.name }).to eq(%w(NilClass Cat Cat Cat))
+  end
+
+  it "allows the inheritance_column (species) to be updated" do
+    cat = Cat.create!(name: "Leo")
+    cat.update_attributes(name: "Spike", species: "Dog")
+    dog = Animal.find(cat.id)
+    expect(dog).to be_instance_of(Dog)
+  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")
-          callback_cat.destroy
-          expect(callback_cat.versions.collect(&:event)).to eq %w(create update destroy)
-        end
+      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
+      it "does not break reify" do
+        callback_cat.destroy
+        expect { callback_cat.versions.last.reify }.not_to raise_error
       end
     end
   end

data/spec/models/boolit_spec.rb

@@ -5,19 +5,20 @@ 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
+    expect(subject.default_scopes).not_to be_empty
   end
 
   describe "Versioning", versioning: true do
     subject { Boolit.create! }
+
     before { subject.update_attributes!(name: FFaker::Name.name) }
 
-    it "should have versions" do
+    it "has two versions" do
       expect(subject.versions.size).to eq(2)
     end
 
-    it "should be able to be reified and persisted" do
-      expect { subject.versions.last.reify.save! }.to_not raise_error
+    it "can be reified and persisted" do
+      expect { subject.versions.last.reify.save! }.not_to raise_error
     end
 
     context "Instance falls out of default scope" do
@@ -27,8 +28,8 @@ describe Boolit, type: :model do
         expect(Boolit.first).to be_nil
       end
 
-      it "should still be able to be reified and persisted" do
-        expect { subject.paper_trail.previous_version.save! }.to_not raise_error
+      it "still can be reified and persisted" do
+        expect { subject.paper_trail.previous_version.save! }.not_to raise_error
       end
 
       context "with `nil` attributes on the live instance" do
@@ -39,7 +40,7 @@ describe Boolit, type: :model do
         end
         after { PaperTrail.serializer = PaperTrail::Serializers::YAML }
 
-        it "should not overwrite that attribute during the reification process" do
+        it "does not overwrite that attribute during the reification process" do
           expect(subject.paper_trail.previous_version.name).to be_nil
         end
       end

data/spec/models/callback_modifier_spec.rb

@@ -4,13 +4,13 @@ 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
+        it "adds :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
+          it "creates 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
@@ -18,7 +18,7 @@ describe CallbackModifier, type: :model do
         end
 
         context "when :after" do
-          it "should create the version after destroy" do
+          it "creates 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
@@ -26,7 +26,7 @@ describe CallbackModifier, type: :model do
         end
 
         context "when no argument" do
-          it "should default to before destroy" do
+          it "defaults 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
@@ -35,12 +35,12 @@ describe CallbackModifier, type: :model do
       end
 
       describe "paper_trail_on_update" do
-        it "should add :update to paper_trail_options[:on]" do
+        it "adds :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
+        it "creates 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"
@@ -48,36 +48,36 @@ describe CallbackModifier, type: :model do
       end
 
       describe "paper_trail_on_create" do
-        it "should add :create to paper_trail_options[:on]" do
+        it "adds :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
+        it "creates 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
+        it "sets 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]
+          expect(modifier.paper_trail_options[:on]).to eq %i(create update destroy)
         end
 
-        it "should default to track destroy" do
+        it "tracks 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
+        it "tracks 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
+        it "tracks create" do
           modifier = DefaultModifier.create!(some_content: FFaker::Lorem.sentence)
           expect(modifier.versions.last.event).to eq "create"
         end

data/spec/models/document_spec.rb

@@ -0,0 +1,21 @@
+require "rails_helper"
+
+describe Document, type: :model do
+  describe "`have_a_version_with` matcher", versioning: true do
+    it "works with custom versions association" do
+      document = Document.create!(name: "Foo")
+      document.update_attributes!(name: "Bar")
+
+      expect(document).to have_a_version_with(name: "Foo")
+    end
+  end
+
+  describe "`have_a_version_with_changes` matcher", versioning: true do
+    it "works with custom versions association" do
+      document = Document.create!(name: "Foo")
+      document.update_attributes!(name: "Bar")
+
+      expect(document).to have_a_version_with_changes(name: "Bar")
+    end
+  end
+end

data/spec/models/gadget_spec.rb

@@ -6,61 +6,57 @@ describe Gadget, type: :model do
   let(:gadget) { Gadget.create!(name: "Wrench", brand: "Acme") }
 
   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) }
+    it "generates a version for updates to `name` attribute" do
+      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 }
+    it "ignores for updates to `brand` attribute" do
+      expect { gadget.update_attribute(:brand, "Stanley") }.not_to(change { gadget.versions.size })
     end
 
-    it "should still generate a version when only the `updated_at` attribute is updated" do
+    it "still generates a version when only the `updated_at` attribute is updated" do
       # 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)
+      }.to(change { gadget.versions.size }.by(1))
     end
   end
 
-  describe "Methods" do
-    describe "Instance", versioning: true do
-      describe "private" do
-        describe "#changed_notably?" do
-          subject { Gadget.new(created_at: Time.now) }
+  describe "#changed_notably?", versioning: true do
+    subject { Gadget.new(created_at: Time.now) }
 
-          context "create events" do
-            it { expect(subject.paper_trail.changed_notably?).to be true }
-          end
+    context "create events" do
+      it "returns true" do
+        expect(subject.paper_trail.changed_notably?).to eq(true)
+      end
+    end
 
-          context "update events" do
-            before { subject.save! }
+    context "update events" do
+      before { subject.save! }
 
-            context "without update timestamps" do
-              it "should only acknowledge non-ignored attrs" do
-                subject.name = "Wrench"
-                expect(subject.paper_trail.changed_notably?).to be true
-              end
+      context "without update timestamps" do
+        it "only acknowledges non-ignored attrs" do
+          subject.name = "Wrench"
+          expect(subject.paper_trail.changed_notably?).to be true
+        end
 
-              it "should not acknowledge ignored attr (brand)" do
-                subject.brand = "Acme"
-                expect(subject.paper_trail.changed_notably?).to be false
-              end
-            end
+        it "does not acknowledge ignored attr (brand)" do
+          subject.brand = "Acme"
+          expect(subject.paper_trail.changed_notably?).to be false
+        end
+      end
 
-            context "with update timestamps" do
-              it "should only acknowledge non-ignored attrs" do
-                subject.name = "Wrench"
-                subject.updated_at = Time.now
-                expect(subject.paper_trail.changed_notably?).to be true
-              end
+      context "with update timestamps" do
+        it "only acknowledges non-ignored attrs" do
+          subject.name = "Wrench"
+          subject.updated_at = Time.now
+          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.paper_trail.changed_notably?).to be false
-              end
-            end
-          end
+        it "does not acknowledge ignored attrs and timestamps only" do
+          subject.brand = "Acme"
+          subject.updated_at = Time.now
+          expect(subject.paper_trail.changed_notably?).to be false
         end
       end
     end