Back to Repositories

Testing PaperTrail Version Control Implementation in paper_trail

This test suite evaluates the PaperTrail request functionality in an Articles controller context. It specifically tests the behavior of version tracking when PaperTrail is enabled and disabled, ensuring proper state management during article creation.

Test Coverage Overview

The test suite provides comprehensive coverage of PaperTrail’s request handling functionality.

Key areas tested include:

Version creation when PaperTrail is enabled
Version suppression when PaperTrail is disabled
State management of the PaperTrail.enabled? flag
Article creation with version tracking

Implementation Analysis

The testing approach utilizes RSpec’s controller testing framework to verify PaperTrail’s version tracking behavior. The implementation employs before/after hooks for state management and leverages RSpec’s context blocks to test both enabled and disabled states of PaperTrail.

Technical patterns include:

Controller-level testing with params injection
State verification through assigns
Version count validation

Technical Details

Testing tools and configuration:

RSpec for test framework
FFaker for content generation
Controller specs with type: :controller
PaperTrail configuration hooks
Request context testing

Best Practices Demonstrated

The test suite exemplifies several testing best practices for Rails controller specs.

Notable practices include:

Proper state isolation between tests
Clear context separation
Explicit expectations
Clean setup and teardown
Focused test scenarios

paper-trail-gem/paper_trail

spec/controllers/articles_controller_spec.rb

            
# frozen_string_literal: true

require "spec_helper"

RSpec.describe ArticlesController, type: :controller do
  describe "PaperTrail.request.enabled?" do
    context "when PaperTrail.enabled? == true" do
      before { PaperTrail.enabled = true }

      after { PaperTrail.enabled = false }

      it "returns true" do
        expect(PaperTrail.enabled?).to eq(true)
        post :create, params: { article: { title: "Doh", content: FFaker::Lorem.sentence } }
        expect(assigns(:article)).not_to be_nil
        expect(PaperTrail.request.enabled?).to eq(true)
        expect(assigns(:article).versions.length).to eq(1)
      end
    end

    context "when PaperTrail.enabled? == false" do
      it "returns false" do
        expect(PaperTrail.enabled?).to eq(false)
        post :create, params: { article: { title: "Doh", content: FFaker::Lorem.sentence } }
        expect(PaperTrail.request.enabled?).to eq(false)
        expect(assigns(:article).versions.length).to eq(0)
      end
    end
  end
end