paper_trail_manager 0.7.0 → 0.8.0

data/gemfiles/rails_7.0_paper_trail_15.0_kaminari.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 15.0"
+gem "kaminari", ">= 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0_paper_trail_15.0_will_paginate.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 15.0"
+gem "will_paginate", "~> 4.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.1_paper_trail_15.0_kaminari.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 15.0"
+gem "kaminari", ">= 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.1_paper_trail_15.0_will_paginate.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.0"
+gem "sqlite3", "~> 1.7"
+gem "paper_trail", "~> 15.0"
+gem "will_paginate", "~> 4.0"
+
+gemspec path: "../"

data/lib/paper_trail_manager.rb

@@ -15,7 +15,9 @@ end
 
 class PaperTrailManager < Rails::Engine
   initializer 'paper_trail_manager.pagination' do
-    ::ActionView::Base.send(:alias_method, :paginate, :will_paginate) if defined?(WillPaginate)
+    if defined?(WillPaginate)
+      ::ActionView::Base.define_method(:paginate) { |*args, **kwargs, &block| will_paginate(*args, **kwargs, &block) }
+    end
   end
 
   @@whodunnit_name_method = :name
@@ -50,7 +52,7 @@ class PaperTrailManager < Rails::Engine
   end
 
   def self.allow_show?(controller, version)
-    allow_index_block.call controller, version
+    allow_show_block.call controller, version
   end
 
   # Describe when to allow reverts. Call this with a block that accepts

data/paper_trail_manager.gemspec

@@ -5,28 +5,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'paper_trail_manager'
-  spec.version       = '0.7.0'
+  spec.version       = '0.8.0'
   spec.authors       = ['Igal Koshevoy', 'Reid Beels']
-  spec.authors       = ['mail@reidbeels.com']
+  spec.email         = ['mail@reidbeels.com']
   spec.summary       = 'A user interface for `paper_trail` versioning data in Rails applications.'
   spec.description   = 'Browse, subscribe, view and revert changes to records when using Rails and the `paper_trail` gem.'
-  spec.homepage      = 'https://github.com/fusion94/paper_trail_manager'
+  spec.homepage      = 'https://github.com/DamageLabs/paper_trail_manager'
   spec.license       = 'MIT'
-
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-
-  spec.add_dependency 'paper_trail', ['>= 3.0']
-  spec.add_dependency 'rails', ['>= 3.0', '< 7.0']
-
-  spec.add_development_dependency 'appraisal', '~> 1.0'
-  spec.add_development_dependency 'factory_girl_rails', '~> 4.0'
-  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.required_ruby_version = '>= 3.1'
+  spec.add_dependency 'paper_trail', ['>= 12.0']
+  spec.add_dependency 'rails', ['>= 6.1', '< 8.0']
+  spec.add_dependency 'nokogiri', ['>= 1.18.3']
+  spec.add_dependency 'rails-html-sanitizer', ['>= 1.6.1']
+  spec.add_development_dependency 'appraisal', '~> 2.0'
+  spec.add_development_dependency 'factory_bot_rails', '~> 6.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec-activemodel-mocks', '~> 1.0'
-  spec.add_development_dependency 'rspec-html-matchers', '~> 0.9.2'
+  spec.add_development_dependency 'rspec-html-matchers', '~> 0.10'
   spec.add_development_dependency 'rspec-its', '~> 1.0'
-  spec.add_development_dependency 'rspec-rails', '~> 3.0'
-  spec.add_development_dependency 'sqlite3', '>= 1.3.6'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.7'
 end

data/spec/app_template.rb

@@ -2,29 +2,38 @@
 
 gem 'paper_trail_manager', path: __FILE__ + '/../../../'
 
-unless File.exist?('app/assets/config/manifest.js')
-  create_file 'app/assets/config/manifest.js'
-  append_to_file 'app/assets/config/manifest.js', "//= link application.css\n"
-  append_to_file 'app/assets/config/manifest.js', "//= link application.js\n"
-end
+# Remove auto-generated request specs from dummy app
+remove_file 'spec/requests/entities_spec.rb' if File.exist?('spec/requests/entities_spec.rb')
+remove_file 'spec/requests/platforms_spec.rb' if File.exist?('spec/requests/platforms_spec.rb')
 
 generate 'paper_trail:install'
 generate 'resource', 'entity name:string status:string --no-controller-specs --no-helper-specs'
 generate 'resource', 'platform name:string status:string --no-controller-specs --no-helper-specs'
 
-remove_file 'spec/models/entity_spec.rb'
-remove_file 'spec/models/platform_spec.rb'
+# Remove auto-generated spec files that conflict with our factories
+remove_file 'spec/models/entity_spec.rb' if File.exist?('spec/models/entity_spec.rb')
+remove_file 'spec/models/platform_spec.rb' if File.exist?('spec/models/platform_spec.rb')
 
 model_body = <<-MODEL
   has_paper_trail
 
-  validates_presence_of :name
-  validates_presence_of :status
+  validates :name, presence: true
+  validates :status, presence: true
 MODEL
 
 inject_into_class 'app/models/entity.rb', 'Entity', model_body
 inject_into_class 'app/models/platform.rb', 'Platform', model_body
 
-route "resources :changes, :controller => 'paper_trail_manager/changes'"
+route "resources :changes, controller: 'paper_trail_manager/changes'"
+route "root to: 'paper_trail_manager/changes#index'"
+
+# Allow YAML deserialization of ActiveSupport::TimeWithZone (Ruby 3.1+ Psych 4)
+initializer 'permitted_classes.rb', <<~RUBY
+  Rails.application.config.active_record.yaml_column_permitted_classes = [
+    ActiveSupport::TimeWithZone,
+    ActiveSupport::TimeZone,
+    Time
+  ]
+RUBY
 
 rake 'db:migrate db:test:prepare'

data/spec/integration/authorization_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PaperTrailManager, 'authorization integration', versioning: true do
+  let(:entity) { FactoryBot.create(:entity, name: 'Test Entity', status: 'Active') }
+
+  before do
+    entity
+    entity.update(status: 'Updated')
+  end
+
+  after do
+    default = proc { true }
+    PaperTrailManager.allow_index_block = default
+    PaperTrailManager.allow_show_block = default
+    PaperTrailManager.allow_revert_block = default
+  end
+
+  describe 'index' do
+    context 'when not authorized' do
+      before do
+        PaperTrailManager.allow_index_when { |_controller| false }
+      end
+
+      it 'redirects with an error flash' do
+        get changes_path
+        expect(response).to have_http_status(:redirect)
+        expect(flash[:error]).to eq('You do not have permission to list changes.')
+      end
+    end
+  end
+
+  describe 'show' do
+    context 'when not authorized' do
+      before do
+        PaperTrailManager.allow_show_when { |_controller, _version| false }
+      end
+
+      it 'redirects with an error flash' do
+        get change_path(entity.versions.last)
+        expect(response).to have_http_status(:redirect)
+        expect(flash[:error]).to eq('You do not have permission to show that change.')
+      end
+    end
+
+    context 'when change does not exist' do
+      it 'redirects with an error flash' do
+        get change_path(id: 999999)
+        expect(response).to have_http_status(:redirect)
+        expect(flash[:error]).to eq('No such version.')
+      end
+    end
+  end
+
+  describe 'revert' do
+    context 'when not authorized' do
+      before do
+        PaperTrailManager.allow_revert_when { |_controller, _version| false }
+      end
+
+      it 'redirects with an error flash' do
+        put change_path(entity.versions.last)
+        expect(response).to have_http_status(:redirect)
+        expect(flash[:error]).to eq('You do not have permission to revert this change.')
+      end
+    end
+
+    context 'when change does not exist' do
+      it 'redirects with an error flash' do
+        put change_path(id: 999999)
+        expect(response).to have_http_status(:redirect)
+        expect(flash[:error]).to eq('No such version.')
+      end
+    end
+  end
+
+  describe 'filtering by non-existent type' do
+    it 'returns an empty changes list' do
+      get changes_path(type: 'NonExistentModel')
+      expect(response.body).to include('No changes found')
+    end
+  end
+end

data/spec/integration/date_filter_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PaperTrailManager, 'date range filtering', versioning: true do
+  let(:entity) { FactoryBot.create(:entity, name: 'Test Entity', status: 'Active') }
+
+  before do
+    entity
+    entity.update(status: 'Updated')
+  end
+
+  describe 'index with date filters' do
+    context 'with from parameter' do
+      it 'shows changes on or after the date' do
+        get changes_path(from: Date.today.to_s)
+        expect(response).to have_http_status(:ok)
+        expect(response.body).to have_tag('.change_row')
+      end
+
+      it 'returns no changes for future date' do
+        get changes_path(from: (Date.today + 1).to_s)
+        expect(response.body).to include('No changes found')
+      end
+    end
+
+    context 'with to parameter' do
+      it 'shows changes on or before the date' do
+        get changes_path(to: Date.today.to_s)
+        expect(response).to have_http_status(:ok)
+        expect(response.body).to have_tag('.change_row')
+      end
+
+      it 'returns no changes for past date' do
+        get changes_path(to: (Date.today - 1).to_s)
+        expect(response.body).to include('No changes found')
+      end
+    end
+
+    context 'with from and to combined' do
+      it 'shows changes within the range' do
+        get changes_path(from: Date.today.to_s, to: Date.today.to_s)
+        expect(response).to have_http_status(:ok)
+        expect(response.body).to have_tag('.change_row')
+      end
+    end
+
+    context 'combined with type filter' do
+      it 'respects both date and type filters' do
+        get changes_path(from: Date.today.to_s, type: 'Entity')
+        expect(response).to have_http_status(:ok)
+        expect(response.body).to have_tag('.change_item', text: /Entity/)
+      end
+    end
+
+    context 'with invalid date' do
+      it 'ignores invalid from date gracefully' do
+        get changes_path(from: 'not-a-date')
+        expect(response).to have_http_status(:ok)
+        expect(response.body).to have_tag('.change_row')
+      end
+
+      it 'ignores invalid to date gracefully' do
+        get changes_path(to: 'garbage')
+        expect(response).to have_http_status(:ok)
+        expect(response.body).to have_tag('.change_row')
+      end
+    end
+
+    context 'date filter form' do
+      it 'renders date inputs' do
+        get changes_path
+        expect(response.body).to have_tag('input[type="date"][name="from"]')
+        expect(response.body).to have_tag('input[type="date"][name="to"]')
+      end
+
+      it 'preserves date values in form' do
+        get changes_path(from: '2026-01-01', to: '2026-12-31')
+        expect(response.body).to have_tag('input[name="from"][value="2026-01-01"]')
+        expect(response.body).to have_tag('input[name="to"][value="2026-12-31"]')
+      end
+    end
+  end
+end

data/spec/integration/navigation_spec.rb

@@ -4,6 +4,6 @@ require 'spec_helper'
 
 describe 'Navigation' do
   it 'is a valid app' do
-    ::Rails.application.should be_a_kind_of(Rails::Application)
+    expect(::Rails.application).to be_a_kind_of(Rails::Application)
   end
 end

data/spec/integration/paper_trail_manager_spec.rb

@@ -14,11 +14,11 @@ describe PaperTrailManager, versioning: true do
   end
 
   context 'with changes' do
-    let(:reimu) { FactoryGirl.create(:entity, name: 'Miko Hakurei Reimu', status: 'Highly Responsive to Prayers') }
-    let(:flanchan) { FactoryGirl.create(:entity, name: 'Flandre Scarlet', status: 'The Embodiment of Scarlet Devil') }
-    let(:sakuya) { FactoryGirl.create(:entity, name: 'Sakuya Izayoi', status: 'Flowering Night') }
-    let(:kyuu_hachi) { FactoryGirl.create(:platform, name: 'PC-9801', status: 'SUGOI!!1!') }
-    let!(:uinodouzu) { FactoryGirl.create(:platform, name: 'Mikorusofto Uinodouzu', status: 'o-O') }
+    let(:reimu) { FactoryBot.create(:entity, name: 'Miko Hakurei Reimu', status: 'Highly Responsive to Prayers') }
+    let(:flanchan) { FactoryBot.create(:entity, name: 'Flandre Scarlet', status: 'The Embodiment of Scarlet Devil') }
+    let(:sakuya) { FactoryBot.create(:entity, name: 'Sakuya Izayoi', status: 'Flowering Night') }
+    let(:kyuu_hachi) { FactoryBot.create(:platform, name: 'PC-9801', status: 'SUGOI!!1!') }
+    let!(:uinodouzu) { FactoryBot.create(:platform, name: 'Mikorusofto Uinodouzu', status: 'o-O') }
 
     let!(:flanchan_id) { flanchan.id }
 
@@ -161,7 +161,7 @@ describe PaperTrailManager, versioning: true do
           end
 
           it 'rollbacks a delete by restoring the record' do
-            Entity.exists?(flanchan_id).should be_falsey
+            expect(Entity.exists?(flanchan_id)).to be_falsey
 
             put change_path(PaperTrail::Version.where(item_id: flanchan_id, item_type: 'Entity').last)
 

data/spec/integration/response_formats_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PaperTrailManager, 'response formats', versioning: true do
+  let(:entity) { FactoryBot.create(:entity, name: 'Format Test', status: 'Active') }
+
+  before do
+    entity
+    entity.update(status: 'Updated')
+  end
+
+  describe 'JSON format' do
+    context 'index' do
+      it 'returns valid JSON with version data' do
+        get changes_path(format: :json)
+        expect(response.content_type).to include('application/json')
+        json = JSON.parse(response.body)
+        expect(json).to be_an(Array)
+        expect(json.length).to be >= 2
+      end
+
+      it 'respects type filter' do
+        get changes_path(format: :json, type: 'Entity')
+        json = JSON.parse(response.body)
+        json.each do |version|
+          expect(version['item_type']).to eq('Entity')
+        end
+      end
+
+      it 'respects id filter' do
+        get changes_path(format: :json, type: 'Entity', id: entity.id)
+        json = JSON.parse(response.body)
+        json.each do |version|
+          expect(version['item_id']).to eq(entity.id)
+        end
+      end
+    end
+
+    context 'show' do
+      it 'returns valid JSON for a single version' do
+        version = entity.versions.last
+        get change_path(version, format: :json)
+        expect(response.content_type).to include('application/json')
+        json = JSON.parse(response.body)
+        expect(json['id']).to eq(version.id)
+        expect(json['item_type']).to eq('Entity')
+      end
+    end
+  end
+
+  describe 'Atom format' do
+    context 'index' do
+      it 'returns valid XML' do
+        get changes_path(format: :atom)
+        expect(response.content_type).to include('application/atom+xml')
+        expect(response.body).to include('<feed')
+        expect(response.body).to include('<entry>')
+      end
+
+      it 'includes version entries' do
+        get changes_path(format: :atom)
+        expect(response.body).to include('Entity')
+      end
+
+      it 'respects type filter' do
+        get changes_path(format: :atom, type: 'Entity')
+        expect(response.body).to include('Entity')
+        expect(response.body).not_to include('Platform')
+      end
+    end
+  end
+end

data/spec/support/factories.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'factory_girl_rails'
+require 'factory_bot_rails'
 
-FactoryGirl.define do
+FactoryBot.define do
   factory :entity do
     sequence(:name)   { |n| "name_#{n}" }
     sequence(:status) { |n| "status_#{n}" }

data/spec/unit/authorization_spec.rb

@@ -0,0 +1,42 @@
+begin
+  require 'kaminari/core'
+rescue LoadError
+  require 'will_paginate'
+end
+require 'paper_trail_manager'
+
+RSpec.describe PaperTrailManager, 'authorization' do
+  let(:controller) { double('controller') }
+  let(:version) { double('version') }
+
+  after do
+    # Reset blocks to defaults
+    default = proc { true }
+    PaperTrailManager.allow_index_block = default
+    PaperTrailManager.allow_show_block = default
+  end
+
+  describe '.allow_show?' do
+    it 'uses allow_show_block, not allow_index_block' do
+      PaperTrailManager.allow_index_when { |_controller| false }
+      PaperTrailManager.allow_show_when { |_controller, _version| true }
+
+      expect(PaperTrailManager.allow_show?(controller, version)).to be true
+    end
+
+    it 'does not fall through to allow_index_block' do
+      PaperTrailManager.allow_index_when { |_controller| true }
+      PaperTrailManager.allow_show_when { |_controller, _version| false }
+
+      expect(PaperTrailManager.allow_show?(controller, version)).to be false
+    end
+  end
+
+  describe '.allow_index?' do
+    it 'uses allow_index_block' do
+      PaperTrailManager.allow_index_when { |_controller| true }
+
+      expect(PaperTrailManager.allow_index?(controller)).to be true
+    end
+  end
+end

data/spec/unit/changes_helper_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PaperTrailManager::ChangesHelper, versioning: true do
+  # Use a view context to get access to content_tag, h, etc.
+  let(:helper) { ApplicationController.new.view_context }
+
+  describe '#text_or_nil' do
+    it 'returns styled nil for nil values' do
+      result = helper.text_or_nil(nil)
+      expect(result).to include('em')
+      expect(result).to include('nil')
+    end
+
+    it 'returns escaped text for non-nil values' do
+      result = helper.text_or_nil('hello')
+      expect(result).to eq('hello')
+    end
+
+    it 'escapes HTML in values' do
+      result = helper.text_or_nil('<script>alert("xss")</script>')
+      expect(result).not_to include('<script>')
+    end
+  end
+
+  describe '#changes_for' do
+    let(:entity) { FactoryBot.create(:entity, name: 'Test', status: 'Active') }
+
+    context 'for a create event' do
+      it 'returns a hash' do
+        version = entity.versions.first
+        changes = helper.changes_for(version)
+        expect(changes).to be_a(Hash)
+      end
+    end
+
+    context 'for an update event' do
+      before { entity.update(status: 'Updated') }
+
+      it 'returns a hash' do
+        version = entity.versions.last
+        changes = helper.changes_for(version)
+        expect(changes).to be_a(Hash)
+      end
+    end
+
+    context 'for a destroy event' do
+      before { entity.destroy }
+
+      it 'returns changes with previous values' do
+        version = PaperTrail::Version.where(item_type: 'Entity', event: 'destroy').last
+        changes = helper.changes_for(version)
+        expect(changes).to be_a(Hash)
+      end
+    end
+  end
+
+  describe '#change_item_types' do
+    it 'returns a sorted array of versioned model names' do
+      # Ensure models are loaded
+      Entity.new
+      types = helper.change_item_types
+      expect(types).to be_an(Array)
+      expect(types).to include('Entity')
+      expect(types).to eq(types.sort)
+    end
+  end
+
+  describe '#version_reify' do
+    let(:entity) { FactoryBot.create(:entity, name: 'Test', status: 'Active') }
+
+    it 'returns the reified record for an update' do
+      entity.update(status: 'Updated')
+      version = entity.versions.last
+      record = helper.version_reify(version)
+      expect(record).to be_a(Entity)
+      expect(record.status).to eq('Active')
+    end
+  end
+end