paper_trail_manager 0.6.0 → 0.8.0

data/paper_trail_manager.gemspec

@@ -1,31 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "paper_trail_manager"
-  spec.version       = "0.6.0"
-  spec.authors       = ["Igal Koshevoy", "Reid Beels"]
-  spec.authors       = ["mail@reidbeels.com"]
-  spec.summary       = "A user interface for `paper_trail` versioning data in Ruby on Rails 3 applications."
-  spec.description   = "Browse, subscribe, view and revert changes to records when using Ruby on Rails 3 and the `paper_trail` gem."
-  spec.homepage      = "https://github.com/fusion94/paper_trail_manager"
-  spec.license       = "MIT"
-
+  spec.name          = 'paper_trail_manager'
+  spec.version       = '0.8.0'
+  spec.authors       = ['Igal Koshevoy', 'Reid Beels']
+  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/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 "rails", [">= 3.0", "< 5.0"]
-  spec.add_dependency "paper_trail", [">= 3.0", "< 5.0"]
-
-  spec.add_development_dependency "rake", "~> 10.4"
-  spec.add_development_dependency "sqlite3", "~> 1.3"
-  spec.add_development_dependency "factory_girl_rails", "~> 4.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.0"
-  spec.add_development_dependency "rspec-activemodel-mocks", "~> 1.0"
-  spec.add_development_dependency "rspec-its", "~> 1.0"
-  spec.add_development_dependency "appraisal", "~> 1.0"
+  spec.require_paths = ['lib']
+  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.10'
+  spec.add_development_dependency 'rspec-its', '~> 1.0'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.7'
 end
-

data/spec/app_template.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+gem 'paper_trail_manager', path: __FILE__ + '/../../../'
+
+# 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 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 :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 "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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe "Navigation" do
-  it "should be a valid app" do
-    ::Rails.application.should be_a_kind_of(Rails::Application)
+describe 'Navigation' do
+  it 'is a valid app' do
+    expect(::Rails.application).to be_a_kind_of(Rails::Application)
   end
 end

data/spec/integration/paper_trail_manager_spec.rb

@@ -1,72 +1,55 @@
-require 'spec_helper'
-
-describe PaperTrailManager, :versioning => true do
-  def version
-    return assigns[:version]
-  end
-
-  def versions
-    return assigns[:versions]
-  end
-
-  def item_types
-    return versions.map(&:item_type).uniq.sort
-  end
-
-  def populate
-      @reimu = FactoryGirl.create(:entity, :name => "Miko Hakurei Reimu", :status => "Highly Responsive to Prayers")
-      @reimu.update_attributes(:name => "Hakurei Reimu", :status => "Phantasmagoria of Dimensional Dream")
-      @reimu.update_attributes(:status => "Perfect Cherry Blossom")
+# frozen_string_literal: true
 
-      @sakuya = FactoryGirl.create(:entity, :name => "Sakuya Izayoi", :status => "Flowering Night")
-
-      @flanchan = FactoryGirl.create(:entity, :name => "Flandre Scarlet", :status => "The Embodiment of Scarlet Devil")
-      @flanchan.destroy
-
-      @kyuu_hachi = FactoryGirl.create(:platform, :name => "PC-9801", :status => "SUGOI!!1!")
-      @kyuu_hachi.update_attributes(:status => "Kimochi warui.")
-      @kyuu_hachi.destroy
-
-      @uinodouzu = FactoryGirl.create(:platform, :name => "Mikorusofto Uinodouzu", :status => 'o-O')
-  end
+require 'spec_helper'
 
-  context "without changes" do
-    context "index" do
-      it "should have no changes by default" do
-        get "/changes"
+describe PaperTrailManager, versioning: true do
+  context 'without changes' do
+    context 'when fetching the index' do
+      it 'has no changes by default' do
+        get '/changes'
 
-        assigns[:versions].should be_empty
+        expect(response.body).to include('No changes found')
       end
     end
   end
 
-  context "with changes" do
-    before do
-      populate
-    end
+  context 'with changes' do
+    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 }
 
-    after do
-      Entity.destroy_all
-      Platform.destroy_all
-      PaperTrail::Version.destroy_all
+    before do
+      sakuya
+      reimu.update(name: 'Hakurei Reimu', status: 'Phantasmagoria of Dimensional Dream')
+      reimu.update(status: 'Perfect Cherry Blossom')
+      flanchan.destroy
+      kyuu_hachi.update(status: 'Kimochi warui.')
+      kyuu_hachi.destroy
+      uinodouzu
     end
 
-    context "index" do
-      context "when getting all changes" do
-        context "and authorized" do
-          context "and getting default index" do
+    describe 'index' do
+      context 'when getting all changes' do
+        context 'with authorization' do
+          context 'when getting default index' do
             before { get changes_path }
 
-            it "should have all changes" do
-              versions.size.should == 10
+            it 'has all changes' do
+              expect(response.body).to have_tag('.change_row', count: 10)
             end
 
-            it "should have changes for all changed item types" do
-              item_types.should == ["Entity", "Platform"]
+            it 'has changes for all changed item types' do
+              expect(response.body).to have_tag('.change_item', text: /Entity/)
+              expect(response.body).to have_tag('.change_item', text: /Platform/)
             end
 
-            it "should order changes with newest and highest id at the top" do
-              versions.map(&:id).should == versions.sort_by { |o| [o.created_at, o.id] }.reverse.map(&:id)
+            it 'orders changes with newest and highest id at the top' do
+              ids = response.body.scan(/Change #(\d+)/).flatten.map(&:to_i)
+              expect(ids).to eq ids.sort.reverse
             end
           end
         end
@@ -77,16 +60,17 @@ describe PaperTrailManager, :versioning => true do
         # end
       end
 
-      context "when getting changes for a specific type" do
-        context "that exists" do
-          before { get changes_path(:type => "Entity") }
+      context 'when getting changes for a specific type' do
+        context 'when changes exist' do
+          before { get changes_path(type: 'Entity') }
 
-          it "should show a subset of the changes" do
-            versions.size.should == 6
+          it 'shows a subset of the changes' do
+            expect(response.body).to have_tag('.change_row', count: 6)
           end
 
-          it "should have changes only for that type" do
-            item_types.should == ["Entity"]
+          it 'has changes only for that type' do
+            expect(response.body).to have_tag('.change_item', text: /Entity/)
+            expect(response.body).not_to have_tag('.change_item', text: /Platform/)
           end
         end
 
@@ -96,20 +80,21 @@ describe PaperTrailManager, :versioning => true do
         # end
       end
 
-      context "when getting changes for a specific record" do
-        context "that exists" do
-          before { get changes_path(:type => "Entity", :id => @reimu.id) }
+      context 'when getting changes for a specific record' do
+        context 'when changes exist' do
+          before { get changes_path(type: 'Entity', id: reimu.id) }
 
-          it "should show a subset of the changes" do
-            versions.size.should == 3
+          it 'shows a subset of the changes' do
+            expect(response.body).to have_tag('.change_row', count: 3)
           end
 
-          it "should have changes only for that type" do
-            item_types.should == ["Entity"]
+          it 'has changes only for that type' do
+            expect(response.body).to have_tag('.change_item', text: /Entity/)
+            expect(response.body).not_to have_tag('.change_item', text: /Platform/)
           end
 
-          it "should have changes only for that record" do
-            versions.map(&:item_id).uniq.should == [@reimu.id]
+          it 'has changes only for that record' do
+            expect(response.body.scan(%r{/entities/(#{reimu.id})}).flatten.uniq).to eq [reimu.id.to_s]
           end
         end
 
@@ -120,24 +105,25 @@ describe PaperTrailManager, :versioning => true do
       end
     end
 
-    context "show a change" do
-      context "that exists" do
-        context "when authorized" do
+    describe 'showing a change' do
+      context 'when the change exists' do
+        context 'when authorized' do
+          let(:version) { reimu.versions.last }
+
           before do
-            @version = @reimu.versions.last
-            get change_path(@version)
+            get change_path(version)
           end
 
-          it "should show the requested change" do
-            version.should == @version
+          it 'shows the requested change' do
+            expect(response.body).to have_tag('.change_id', text: "Change ##{version.id}")
           end
 
-          it "should show a change with the right event" do
-            version.event.should == "update"
+          it 'shows a change with the right event' do
+            expect(response.body).to have_tag('.change_event_update')
           end
 
-          it "should be associated with the expected record" do
-            version.item.should == @reimu
+          it 'is associated with the expected record' do
+            expect(response.body).to have_tag('.change_item', text: "Entity #{reimu.id}")
           end
         end
 
@@ -152,50 +138,48 @@ describe PaperTrailManager, :versioning => true do
       #   it "should display an error that the change doesn't exist"
       # end
     end
-  end
-
-  context "when rolling back changes" do
-    context "that that exist" do
-      before(:each) { populate }
 
-      context "when authorized" do
-        it "should rollback a newly-created record by deleting it" do
-          Entity.exists?(@reimu.id).should be_truthy
+    describe 'rolling back changes' do
+      context 'when changes exist' do
+        context 'when authorized' do
+          it 'rollbacks a newly-created record by deleting it' do
+            expect(Entity).to exist(reimu.id)
 
-          put change_path(@reimu.versions.first)
+            put change_path(reimu.versions.first)
 
-          Entity.exists?(@reimu.id).should be_falsey
-        end
+            expect(Entity).not_to exist(reimu.id)
+          end
 
-        it "should rollback an edit by reverting to the previous state" do
-          @reimu.reload
-          @reimu.status.should == "Perfect Cherry Blossom"
+          it 'rollbacks an edit by reverting to the previous state' do
+            reimu.reload
+            expect(reimu.status).to eq 'Perfect Cherry Blossom'
 
-          put change_path(@reimu.versions.last)
+            put change_path(reimu.versions.last)
 
-          @reimu.reload
-          @reimu.status.should == "Phantasmagoria of Dimensional Dream"
-        end
+            reimu.reload
+            expect(reimu.status).to eq 'Phantasmagoria of Dimensional Dream'
+          end
 
-        it "should rollback a delete by restoring the record" do
-          Entity.exists?(@flanchan.id).should be_falsey
+          it 'rollbacks a delete by restoring the record' do
+            expect(Entity.exists?(flanchan_id)).to be_falsey
 
-          put change_path(PaperTrail::Version.where(:item_id => @flanchan.id, :item_type => "Entity").last)
+            put change_path(PaperTrail::Version.where(item_id: flanchan_id, item_type: 'Entity').last)
 
-          flanchan = Entity.find(@flanchan.id)
-          flanchan.status.should == "The Embodiment of Scarlet Devil"
+            found = Entity.find(flanchan_id)
+            expect(found.status).to eq 'The Embodiment of Scarlet Devil'
+          end
         end
+
+        # TODO
+        # context "when not authorized" do
+        #   it "should display an error if user is not allowed to revert that change"
+        # end
       end
 
       # TODO
-      # context "when not authorized" do
-      #   it "should display an error if user is not allowed to revert that change"
+      # context "that don't exist" do
+      #   it "should display an error that the change doesn't exist"
       # end
     end
-
-    # TODO
-    # context "that don't exist" do
-    #   it "should display an error that the change doesn't exist"
-    # end
   end
 end

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/rails_helper.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path("../dummy/config/environment", __FILE__)
-require "rspec/rails"
-require "rspec/active_model/mocks"
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('dummy/config/environment', __dir__)
+require 'rspec/rails'
+require 'rspec/active_model/mocks'
 
 RSpec.configure do |config|
   # If you're not using ActiveRecord, or you'd prefer not to run each of your