paper_trail 7.0.3 → 7.1.0

data/spec/dummy_app/app/models/document.rb

@@ -0,0 +1,8 @@
+# Demonstrates a "custom versions association name". Instead of the assication
+# being named `versions`, it will be named `paper_trail_versions`.
+class Document < ActiveRecord::Base
+  has_paper_trail(
+    versions: :paper_trail_versions,
+    on: %i[create update]
+  )
+end

data/spec/dummy_app/app/models/legacy_widget.rb

@@ -0,0 +1,6 @@
+# The `legacy_widgets` table has a `version` column that would conflict with our
+# `version` method. It is configured to define a method named `custom_version`
+# instead.
+class LegacyWidget < ActiveRecord::Base
+  has_paper_trail ignore: :version, version: "custom_version"
+end

data/spec/dummy_app/app/models/translation.rb

@@ -0,0 +1,11 @@
+# Demonstrates the `if` and `unless` configuration options.
+class Translation < ActiveRecord::Base
+  # Has a `type` column, but it's not used for STI.
+  # TODO: rename column
+  self.inheritance_column = nil
+
+  has_paper_trail(
+    if: proc { |t| t.language_code == "US" },
+    unless: proc { |t| t.type == "DRAFT" }
+  )
+end

data/spec/models/article_spec.rb

@@ -0,0 +1,186 @@
+require "spec_helper"
+
+RSpec.describe Article, type: :model, versioning: true do
+  describe ".create" do
+    it "also creates a version record" do
+      expect { described_class.create }.to(
+        change { PaperTrail::Version.count }.by(+1)
+      )
+    end
+  end
+
+  context "which updates an ignored column" do
+    it "not change the number of versions" do
+      article = described_class.create
+      article.update_attributes(title: "My first title")
+      expect(PaperTrail::Version.count).to(eq(1))
+    end
+  end
+
+  context "which updates an ignored column with truly Proc" do
+    it "not change the number of versions" do
+      article = described_class.create
+      article.update_attributes(abstract: "ignore abstract")
+      expect(PaperTrail::Version.count).to(eq(1))
+    end
+  end
+
+  context "which updates an ignored column with falsy Proc" do
+    it "change the number of versions" do
+      article = described_class.create
+      article.update_attributes(abstract: "do not ignore abstract!")
+      expect(PaperTrail::Version.count).to(eq(2))
+    end
+  end
+
+  context "which updates an ignored column, ignored with truly Proc and a selected column" do
+    it "change the number of versions" do
+      article = described_class.create
+      article.update_attributes(
+        title: "My first title",
+        content: "Some text here.",
+        abstract: "ignore abstract"
+      )
+      expect(PaperTrail::Version.count).to(eq(2))
+      expect(article.versions.size).to(eq(2))
+    end
+
+    it "have stored only non-ignored attributes" do
+      article = described_class.create
+      article.update_attributes(
+        title: "My first title",
+        content: "Some text here.",
+        abstract: "ignore abstract"
+      )
+      expected = { "content" => [nil, "Some text here."] }
+      expect(article.versions.last.changeset).to(eq(expected))
+    end
+  end
+
+  context "which updates an ignored column, ignored with falsy Proc and a selected column" do
+    it "change the number of versions" do
+      article = described_class.create
+      article.update_attributes(
+        title: "My first title",
+        content: "Some text here.",
+        abstract: "do not ignore abstract"
+      )
+      expect(PaperTrail::Version.count).to(eq(2))
+      expect(article.versions.size).to(eq(2))
+    end
+
+    it "stores only non-ignored attributes" do
+      article = described_class.create
+      article.update_attributes(
+        title: "My first title",
+        content: "Some text here.",
+        abstract: "do not ignore abstract"
+      )
+      expected = {
+        "content" => [nil, "Some text here."],
+        "abstract" => [nil, "do not ignore abstract"]
+      }
+      expect(article.versions.last.changeset).to(eq(expected))
+    end
+  end
+
+  context "which updates a selected column" do
+    it "change the number of versions" do
+      article = described_class.create
+      article.update_attributes(content: "Some text here.")
+      expect(PaperTrail::Version.count).to(eq(2))
+      expect(article.versions.size).to(eq(2))
+    end
+  end
+
+  context "which updates a non-ignored and non-selected column" do
+    it "not change the number of versions" do
+      article = described_class.create
+      article.update_attributes(abstract: "Other abstract")
+      expect(PaperTrail::Version.count).to(eq(1))
+    end
+  end
+
+  context "which updates a skipped column" do
+    it "not change the number of versions" do
+      article = described_class.create
+      article.update_attributes(file_upload: "Your data goes here")
+      expect(PaperTrail::Version.count).to(eq(1))
+    end
+  end
+
+  context "which updates a skipped column and a selected column" do
+    it "change the number of versions" do
+      article = described_class.create
+      article.update_attributes(
+        file_upload: "Your data goes here",
+        content: "Some text here."
+      )
+      expect(PaperTrail::Version.count).to(eq(2))
+    end
+
+    it "show the new version in the model's `versions` association" do
+      article = described_class.create
+      article.update_attributes(
+        file_upload: "Your data goes here",
+        content: "Some text here."
+      )
+      expect(article.versions.size).to(eq(2))
+    end
+
+    it "have stored only non-skipped attributes" do
+      article = described_class.create
+      article.update_attributes(
+        file_upload: "Your data goes here",
+        content: "Some text here."
+      )
+      expect(
+        article.versions.last.changeset
+      ).to(eq("content" => [nil, "Some text here."]))
+    end
+
+    context "and when updated again" do
+      it "have removed the skipped attributes when saving the previous version" do
+        article = described_class.create
+        article.update_attributes(
+          file_upload: "Your data goes here",
+          content: "Some text here."
+        )
+        article.update_attributes(
+          file_upload: "More data goes here",
+          content: "More text here."
+        )
+        old_article = article.versions.last
+        expect(
+          PaperTrail.serializer.load(old_article.object)["file_upload"]
+        ).to(be_nil)
+      end
+
+      it "have kept the non-skipped attributes in the previous version" do
+        article = described_class.create
+        article.update_attributes(
+          file_upload: "Your data goes here",
+          content: "Some text here."
+        )
+        article.update_attributes(
+          file_upload: "More data goes here",
+          content: "More text here."
+        )
+        old_article = article.versions.last
+        expect(
+          PaperTrail.serializer.load(old_article.object)["content"]
+        ).to(eq("Some text here."))
+      end
+    end
+  end
+
+  context "#destroy" do
+    it "creates a version record" do
+      article = described_class.create
+      article.destroy
+      expect(PaperTrail::Version.count).to(eq(2))
+      expect(article.versions.size).to(eq(2))
+      expect(article.versions.map(&:event)).to(match_array(%w[create destroy]))
+    end
+  end
+end

data/spec/models/document_spec.rb

@@ -1,21 +1,57 @@
 require "spec_helper"
 
-RSpec.describe Document, type: :model do
-  describe "`have_a_version_with` matcher", versioning: true do
+RSpec.describe Document, type: :model, versioning: true do
+  describe "have_a_version_with matcher" 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
+  describe "have_a_version_with_changes matcher" 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
+
+  describe "#paper_trail.next_version" do
+    it "returns the expected document" do
+      doc = Document.create
+      doc.update_attributes(name: "Doc 1")
+      reified = doc.paper_trail_versions.last.reify
+      expect(doc.name).to(eq(reified.paper_trail.next_version.name))
+    end
+  end
+
+  describe "#paper_trail.previous_version" do
+    it "returns the expected document" do
+      doc = Document.create
+      doc.update_attributes(name: "Doc 1")
+      doc.update_attributes(name: "Doc 2")
+      expect(doc.paper_trail_versions.length).to(eq(3))
+      expect(doc.paper_trail.previous_version.name).to(eq("Doc 1"))
+    end
+  end
+
+  describe "#paper_trail_versions" do
+    it "returns the expected version records" do
+      doc = Document.create
+      doc.update_attributes(name: "Doc 1")
+      expect(doc.paper_trail_versions.length).to(eq(2))
+      expect(doc.paper_trail_versions.map(&:event)).to(
+        match_array(%w[create update])
+      )
+    end
+  end
+
+  describe "#versions" do
+    it "does not respond to versions method" do
+      doc = Document.create
+      doc.update_attributes(name: "Doc 1")
+      expect(doc).not_to respond_to(:versions)
+    end
+  end
 end