paper_trail_manager 0.7.0 → 0.9.0

data/app/views/paper_trail_manager/changes/index.html.erb

@@ -1,35 +1,49 @@
-<h1>Changes</h1>
-
-<p class='changes_feed'><%= link_to 'Changes feed', changes_path(:format => 'atom') %></p>
+<h1><%= t('paper_trail_manager.changes.index.title') %></h1>
 
 <p>
-  Show:
-  <%= ([link_to('All', changes_path)] + change_item_types.map { |type| link_to(type.pluralize, changes_path(:type => type)) }).join(' | ').html_safe %>
+  <%= t('paper_trail_manager.changes.index.show_label') %>
+  <%= ([link_to(t('paper_trail_manager.changes.index.all'), changes_path)] + change_item_types.map { |type| link_to(type.pluralize, changes_path(type: type)) }).join(' | ').html_safe %>
 </p>
 
-<table class='changes_table'>
-  <tfoot>
-    <tr>
-      <td colspan='2'>
-        <%= paginate @versions %>
-      </td>
-    </tr>
-  </tfoot>
-  <thead>
-    <tr class='changes_header'>
-      <th class='change_time'>Time</th>
-      <th class='change_details'>Attribute with previous and current values</th>
-    </tr>
-  </thead>
-  <tbody>
-    <% if @versions.any? %>
-      <% @versions.each do |version| %>
-        <% next unless change_show_allowed?(version) %>
-        <%= render :partial => 'version', :object => version %>
-      <% end %>
-    <% else %>
-      <td rowspan='2'> &mdash; No changes found &mdash; </td>
-    <% end %>
-  </tbody>
-</table>
+<%= form_tag changes_path, method: :get, class: 'changes_date_filter' do %>
+  <%= hidden_field_tag :type, params[:type] if params[:type] %>
+  <%= hidden_field_tag :id, params[:id] if params[:id] %>
+  <label for="from"><%= t('paper_trail_manager.changes.filter.from') %></label>
+  <%= date_field_tag :from, params[:from], id: 'from' %>
+  <label for="to"><%= t('paper_trail_manager.changes.filter.to') %></label>
+  <%= date_field_tag :to, params[:to], id: 'to' %>
+  <%= submit_tag t('paper_trail_manager.changes.filter.submit'), name: nil %>
+  <% if params[:from].present? || params[:to].present? %>
+    <%= link_to t('paper_trail_manager.changes.filter.clear'), changes_path(type: params[:type], id: params[:id]), class: 'clear_filter' %>
+  <% end %>
+<% end %>
 
+<div class="table-responsive">
+  <table class='changes_table table table-bordered'>
+    <tfoot>
+      <tr>
+        <td colspan='2'>
+          <%= paginate @versions %>
+        </td>
+      </tr>
+    </tfoot>
+    <thead>
+      <tr class='changes_header'>
+        <th class='change_time'><%= t('paper_trail_manager.changes.index.time') %></th>
+        <th class='change_details'><%= t('paper_trail_manager.changes.index.details') %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% if @versions.any? %>
+        <% @versions.each do |version| %>
+          <% next unless change_show_allowed?(version) %>
+          <%= render partial: 'version', object: version %>
+        <% end %>
+      <% else %>
+        <tr>
+          <td colspan='2'> &mdash; <%= t('paper_trail_manager.changes.index.no_changes') %> &mdash; </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/paper_trail_manager/changes/show.html.erb

@@ -1,10 +1,13 @@
-<h1>Change <%= @version.id %></h1>
+<h1><%= t('paper_trail_manager.changes.show.title', id: @version.id) %></h1>
 
 <table class='changes_table'>
-  <tr class='changes_header'>
-    <th class='change_time'>Time</th>
-    <th class='change_details'>Attribute with previous and current values</th>
-    <%= render :partial => 'version', :object => @version %>
-  </tr>
+  <thead>
+    <tr class='changes_header'>
+      <th class='change_time'><%= t('paper_trail_manager.changes.index.time') %></th>
+      <th class='change_details'><%= t('paper_trail_manager.changes.index.details') %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <%= render partial: 'version', object: @version %>
+  </tbody>
 </table>
-

data/config/locales/en.yml

@@ -0,0 +1,30 @@
+en:
+  paper_trail_manager:
+    changes:
+      index:
+        title: "Changes"
+        show_label: "Show:"
+        all: "All"
+        no_changes: "No changes found"
+        time: "Time"
+        details: "Attribute with previous and current values"
+      show:
+        title: "Change %{id}"
+      filter:
+        from: "From:"
+        to: "To:"
+        submit: "Filter"
+        clear: "Clear"
+      version:
+        change_id: "Change #%{id}"
+        roll_back: "Roll back"
+        confirm_rollback: "Are you sure?"
+        by: "by"
+    flash:
+      index_denied: "You do not have permission to list changes."
+      show_denied: "You do not have permission to show that change."
+      revert_denied: "You do not have permission to revert this change."
+      not_found: "No such version."
+      rollback_create: "Rolled back newly-created record by destroying it."
+      rollback_update: "Rolled back changes to this record."
+      rollback_failed: "Couldn't rollback. Sorry."

data/gemfiles/rails_6.1_paper_trail_12.0_kaminari.gemfile

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

data/gemfiles/rails_6.1_paper_trail_12.0_will_paginate.gemfile

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

data/gemfiles/rails_7.0_paper_trail_12.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", "~> 12.0"
+gem "kaminari", ">= 1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0_paper_trail_12.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", "~> 12.0"
+gem "will_paginate", "~> 4.0"
+
+gemspec path: "../"

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/generators/paper_trail_manager/install/install_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class PaperTrailManager
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'Install PaperTrailManager: add route and create initializer'
+
+    def add_route
+      route_string = "resources :changes, controller: 'paper_trail_manager/changes'"
+      routes_file = File.join(destination_root, 'config/routes.rb')
+
+      if File.exist?(routes_file) && File.read(routes_file).include?(route_string)
+        say_status :skip, 'Route already exists', :yellow
+      else
+        route route_string
+      end
+    end
+
+    def create_initializer
+      template 'initializer.rb', 'config/initializers/paper_trail_manager.rb'
+    end
+
+    def show_post_install
+      say ''
+      say '✅ PaperTrailManager installed!', :green
+      say ''
+      say 'Next steps:'
+      say '  1. Restart your Rails server'
+      say '  2. Visit /changes to browse your PaperTrail version history'
+      say '  3. Edit config/initializers/paper_trail_manager.rb to customize authorization'
+      say ''
+    end
+  end
+end

data/lib/generators/paper_trail_manager/install/templates/initializer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# PaperTrailManager configuration
+# See: https://github.com/DamageLabs/paper_trail_manager
+
+# Control who can view the changes index.
+# PaperTrailManager.allow_index_when do |controller|
+#   controller.current_user.present?
+# end
+
+# Control who can view individual change details.
+# Defaults to the allow_index rules if not set separately.
+# PaperTrailManager.allow_show_when do |controller, version|
+#   controller.current_user.present?
+# end
+
+# Control who can revert changes.
+# PaperTrailManager.allow_revert_when do |controller, version|
+#   controller.current_user&.admin?
+# end
+
+# Configure how to look up users referenced in PaperTrail's whodunnit column.
+# PaperTrailManager.whodunnit_class = User
+# PaperTrailManager.whodunnit_name_method = :name
+
+# Specify a method to identify items on the index page.
+# PaperTrailManager.item_name_method = :name
+
+# Customize the user path helper (set to nil to disable user links).
+# PaperTrailManager.user_path_method = :user_path
+
+# When embedding inside another Rails engine:
+# PaperTrailManager.base_controller = 'MyEngine::ApplicationController'
+# PaperTrailManager.route_helpers = MyEngine::Engine.routes.url_helpers
+# PaperTrailManager.layout = 'my_engine/application'

data/lib/paper_trail_manager.rb

@@ -14,8 +14,14 @@ rescue LoadError
 end
 
 class PaperTrailManager < Rails::Engine
+  initializer 'paper_trail_manager.i18n' do
+    config.i18n.load_path += Dir[root.join('config', 'locales', '*.yml')]
+  end
+
   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 +56,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.9.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)