paper_trail_manager 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 35fba5ebc680f50b0e7ce1caaf6078516a961172
-  data.tar.gz: 683db80277392f81fdc645725e4461b5ab0c168b
+SHA256:
+  metadata.gz: 007f0fa99ee11e2fdd0d615ec29d66e74788062b3a8e479091c31427d54add6c
+  data.tar.gz: a71dfd4c73909f185c580a11eae304ac0fb75e8c16fe92fe890ddeb90d7ace71
 SHA512:
-  metadata.gz: ce56dc3af2eda372dd4d48c0ca627938cc8d8ff6e56110039debc108fe21af56b37f419a11d04ab1165102020cd7defd12324fee3fe6087d71a88fdc2f5d48b6
-  data.tar.gz: 20802255bfba5b797940ba22da1c6adda96ebdbe628290e71bd1ca80e9c79e643d32b34eb56fde02afe53625bb63eb6ab90342759cfb96563e1d7e9c0224a69a
+  metadata.gz: b019f63c912f3627025427264b6b48be3347e8fe9ec1145ee1b97347e807e0d5642ff6c06ec5085635d6fe5d18354397865bc85734ade8c015284fa484287220
+  data.tar.gz: 0f60e85a369b84075a088f2e2cbca20d85895c7ff42c38fcb7d1595f7e503954bd5ea3c19cfa8b393b433ab003e4309f367caeb03dc3997e2e7f913fda167220

data/.github/workflows/test.yml

@@ -0,0 +1,54 @@
+name: Tests
+
+on:
+  pull_request:
+    types:
+       - opened
+       - reopened
+       - synchronize
+       - ready_for_review
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.1'
+          - '3.2'
+          - '3.3'
+        gemfile:
+          - gemfiles/rails_7.0_paper_trail_12.0_kaminari.gemfile
+          - gemfiles/rails_7.0_paper_trail_12.0_will_paginate.gemfile
+          - gemfiles/rails_7.0_paper_trail_15.0_kaminari.gemfile
+          - gemfiles/rails_7.0_paper_trail_15.0_will_paginate.gemfile
+          - gemfiles/rails_7.1_paper_trail_15.0_kaminari.gemfile
+          - gemfiles/rails_7.1_paper_trail_15.0_will_paginate.gemfile
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install System Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y sqlite3 libsqlite3-dev
+      - name: bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Generate host app for testing
+        run: bundle exec rake generate_spec_app
+      - name: Run RSpec
+        run: |
+          bundle exec rake spec

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -12,4 +11,6 @@ Gemfile.lock
 *.o
 *.a
 mkmf.log
-*.gemfile.lock
+spec/dummy
+Gemfile.lock
+gemfiles/*.lock

data/.rubocop.yml

@@ -0,0 +1,33 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'spec/dummy/**/*'
+
+Rails:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/Appraisals

@@ -1,20 +1,23 @@
-RAILS_VERSIONS = ["3.2.0", "4.0.0", "4.1.0", "4.2.2"]
-PAPER_TRAIL_VERSIONS = ["3.0", "4.0"]
+# frozen_string_literal: true
 
-RAILS_VERSIONS.each do |rails_version|
-  PAPER_TRAIL_VERSIONS.each do |paper_trail_version|
+{
+  '6.1' => %w[12.0],
+  '7.0' => %w[12.0 15.0],
+  '7.1' => %w[15.0]
+}.each do |rails_version, paper_trail_versions|
+  paper_trail_versions.each do |paper_trail_version|
     appraise "rails-#{rails_version}-paper_trail-#{paper_trail_version}-will-paginate" do
-      gem "rails", "~> #{rails_version}"
-      gem "paper_trail", "~> #{paper_trail_version}"
-      gem "will_paginate", "~> 3.0"
-      gem "test-unit", "~> 3.0" if rails_version == "3.2.0"
+      gem 'rails', "~> #{rails_version}.0"
+      gem 'sqlite3', '~> 1.7'
+      gem 'paper_trail', "~> #{paper_trail_version}"
+      gem 'will_paginate', '~> 4.0'
     end
 
     appraise "rails-#{rails_version}-paper_trail-#{paper_trail_version}-kaminari" do
-      gem "rails", "~> #{rails_version}"
-      gem "paper_trail", "~> #{paper_trail_version}"
-      gem "kaminari", "~> 0.16"
-      gem "test-unit", "~> 3.0" if rails_version == "3.2.0"
+      gem 'rails', "~> #{rails_version}.0"
+      gem 'sqlite3', '~> 1.7'
+      gem 'paper_trail', "~> #{paper_trail_version}"
+      gem 'kaminari', '>= 1.0'
     end
   end
 end

data/CHANGES.md

@@ -1,6 +1,30 @@
 Changes to `paper_trail_manager`
 ================================
 
+* 0.8.0
+    * Fix `allow_show?` calling `allow_index_block` instead of `allow_show_block` — `allow_show_when` configuration was previously silently ignored (security fix)
+    * Fix gemspec `authors` field being overwritten by misplaced `email` assignment
+    * Fix `PER_PAGE` constant (50) not being used as default pagination
+    * Fix broken HTML structure in show view (nested `<tr>` tags) and index view (unwrapped `<td>`)
+    * Add date range filtering to changes index via `from` and `to` query parameters
+    * Add date filter UI with date inputs, filter button, and clear link
+    * Add authorization integration tests (unauthorized index/show/revert, non-existent records)
+    * Add unit tests for ChangesHelper methods (text_or_nil, changes_for, change_item_types, version_reify)
+    * Add specs for JSON and Atom response formats with filter coverage
+    * Add date range filter tests
+    * Drop support for Rails < 7.0
+    * Drop Rails 6.1 from CI matrix (incompatible with Ruby 3.1+)
+    * Fix `rails new` asset pipeline error in CI for Rails 7.0/7.1
+    * Fix `Psych::DisallowedClass` error on revert tests (Ruby 3.1+ YAML deserialization)
+    * Add support for Ruby 3.1, 3.2, and 3.3
+    * Add support for PaperTrail 12.x and 15.x
+
+* 0.7.0
+    * Add support for Rails 5 and 6
+    * Add support for paper_trail 5.x – 10.x
+    * Drop support for Rails < 4.1
+    * Drop support for Ruby < 2.5
+
 * 0.6.0
     * Add support for linking changes to user records via `PaperTrailManager.whodunnit_name_method` and `PaperTrailManager.user_path_method`
     * Add new `PaperTrailManager.item_name_method` configuration option

data/Gemfile

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in paper_trail_manager.gemspec
 gemspec
-

data/README.md

@@ -1,109 +1,173 @@
-[![Build Status](https://secure.travis-ci.org/fusion94/paper_trail_manager.png)](http://travis-ci.org/fusion94/paper_trail_manager)
-
 # PaperTrailManager
 
-Browse, subscribe, view and revert changes to records when using Ruby on Rails 3 and the `paper_trail` gem.
+[![CI](https://github.com/DamageLabs/paper_trail_manager/actions/workflows/test.yml/badge.svg)](https://github.com/DamageLabs/paper_trail_manager/actions/workflows/test.yml)
+[![Gem Version](https://badge.fury.io/rb/paper_trail_manager.svg)](https://rubygems.org/gems/paper_trail_manager)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Ruby](https://img.shields.io/badge/Ruby-3.1%2B-red.svg)](https://www.ruby-lang.org/)
+[![Rails](https://img.shields.io/badge/Rails-7.0%2B-red.svg)](https://rubyonrails.org/)
+
+Browse, view, and revert changes to records in Ruby on Rails applications using the [paper_trail](https://github.com/paper-trail-gem/paper_trail) gem.
+
+## Requirements
 
-This software has been in use for a year at http://calagator.org and http://epdx.org. It works well. It has reasonable tests. However, it could definitely use more work.
+- **Ruby** >= 3.1
+- **Rails** >= 7.0, < 8.0
+- **PaperTrail** >= 12.0
+- A pagination library: [will_paginate](https://github.com/mislav/will_paginate) or [Kaminari](https://github.com/kaminari/kaminari)
 
 ## Installation
 
-If you have a Ruby on Rails 3 or 4 application where you're using the `paper_trail` gem to track changes to your records, you can make use of this like:
+Add to your `Gemfile`:
+
+```ruby
+gem 'paper_trail_manager'
+```
+
+If you don't already use a pagination library, add one:
+
+```ruby
+gem 'kaminari'
+# or
+gem 'will_paginate'
+```
+
+Install:
+
+```sh
+bundle install
+```
+
+Add the route to `config/routes.rb`:
+
+```ruby
+resources :changes, controller: 'paper_trail_manager/changes'
+```
 
-Add the following line to your `Gemfile`:
+Restart your server and visit `/changes` to browse, view, and revert your changes.
 
-    gem 'paper_trail_manager'
+## Configuration
 
-PaperTrailManager will use your existing paging library ([will_paginate](https://github.com/mislav/will_paginate) or [Kaminari](https://github.com/amatsuda/kaminari)).  If you don't currently use one in your app, add one of the following lines to your `Gemfile`:
+Create an initializer (e.g. `config/initializers/paper_trail_manager.rb`) to customize behavior.
 
-    gem 'kaminari'
-    #or
-    gem 'will_paginate'
+### Authorization
 
-Install the libary:
+Control access to the index, show, and revert actions independently:
 
-    bundle install
+```ruby
+# Control who can view the changes index
+PaperTrailManager.allow_index_when do |controller|
+  controller.current_user.present?
+end
 
-Add the following line to your `config/routes.rb`:
+# Control who can view individual change details (defaults to allow_index rules)
+PaperTrailManager.allow_show_when do |controller, version|
+  controller.current_user&.admin? || version.whodunnit == controller.current_user&.id&.to_s
+end
 
-    resources :changes, :controller => 'paper_trail_manager/changes'
+# Control who can revert changes
+PaperTrailManager.allow_revert_when do |controller, version|
+  controller.current_user&.admin?
+end
+```
 
-Restart the server and go to the `/changes` URI to browse, subscribe, view and revert your changes. The top-level URL will look something like this:
+> **Note:** If you only call `allow_index_when`, the same block is used as the default for `allow_show_when`. Call `allow_show_when` separately to override show authorization independently.
 
-    http://localhost:3000/changes
+### Whodunnit
 
-### Configuration
+Configure how to look up users referenced in PaperTrail's `whodunnit` column:
 
-Several aspects of PaperTrailManager may be optionally configured
-by creating an initializer in your application
-(e.g. `config/initializers/paper_trail_manager.rb`).
+```ruby
+PaperTrailManager.whodunnit_class = User
+PaperTrailManager.whodunnit_name_method = :nicename  # defaults to :name
+```
 
-To specify when reverts are allowed:
+### Item Names
 
-    PaperTrailManager.allow_revert_when do |controller, version|
-      controller.current_user and controller.current_user.admin?
-    end
+Specify a method to identify items on the index page:
 
-To specify how to look up users/memebers/etc specified in Paper Trail's 'whodunnit' column:
+```ruby
+PaperTrailManager.item_name_method = :nicename
+```
 
-    PaperTrailManager.whodunnit_class = User
-    PaperTrailManager.whodunnit_name_method = :nicename   # defaults to :name
+### User Links
 
-To specify a method to call to identify an item on an index page:
+Customize (or disable) the user path helper:
 
-    PaperTrailManager.item_name_method = :nicename
+```ruby
+PaperTrailManager.user_path_method = :admin_path  # defaults to :user_path
+PaperTrailManager.user_path_method = nil           # no user link
+```
 
-And for linking (or not) to the user with a custom path helper:
+### Pagination
 
-    PaperTrailManager.user_path_method = :admin_path # defaults to :user_path
-    PaperTrailManager.user_path_method = nil # no "show user" page in app
+The index page defaults to 50 items per page. Override via query parameter:
 
-When including PaperTrailManager within another Rails engine, you may need to
-override PaperTrailManager::ChangesController's parent class to reference the
-engine's ApplicationController configure it to use your engine's url helpers:
+```
+/changes?per_page=25
+```
 
-    PaperTrailManager.base_controller = "MyEngine::ApplicationController"
-    PaperTrailManager.route_helpers = MyEngine::Engine.routes.url_helpers
+### Engine Integration
 
-You can also specify the layout:
+When embedding PaperTrailManager inside another Rails engine:
 
-    PaperTrailManager.layout = 'my_engine/application'
+```ruby
+PaperTrailManager.base_controller = "MyEngine::ApplicationController"
+PaperTrailManager.route_helpers = MyEngine::Engine.routes.url_helpers
+PaperTrailManager.layout = 'my_engine/application'
+```
 
 ## Development
 
 Setup:
 
-* Clone the repository
-* Go into the directory
-* Run `bundle` to install the development dependencies
+```sh
+git clone https://github.com/DamageLabs/paper_trail_manager.git
+cd paper_trail_manager
+bundle install
+```
 
 Running tests:
 
-* Run `appraisal rake` to run the tests against all supported gem combinations. Note that the first time tests are run, gems will need to be downloaded for each individual version of Rails this app is tested against, which may take a while.
-
-Adding support for new Rails versions:
-
-* This repo uses the [Appraisal](https://github.com/thoughtbot/appraisal) gem, to add a new rails version modify the Appraisals file
-  - Add both a 'will_paginate' and a 'kaminari' version like so:
-  ```
-  appraise "rails-5.0-will-paginate" do
-    gem "rails", "5.0.0"
-    gem "will_paginate", "~> 3.0"
-  end
-  appraise "rails-5.0-will-kaminari" do
-    gem "rails", "5.0.0"
-    gem "kaminari", "~> 0.16"
-  end
-  ```
-* Run `appraisal generate`
-* Run `appraisal install`
-* Fix whatever breaks.
-* Please contribute your fixes with a Github pull request.
+```sh
+appraisal rake
+```
+
+The first run downloads gems for each Rails version in the test matrix, which may take a while.
+
+### Test Matrix
+
+Tests run against multiple combinations via [Appraisal](https://github.com/thoughtbot/appraisal):
+
+| Rails | PaperTrail | Pagination |
+|-------|-----------|------------|
+| 7.0   | 12.0      | kaminari, will_paginate |
+| 7.0   | 15.0      | kaminari, will_paginate |
+| 7.1   | 15.0      | kaminari, will_paginate |
+
+CI runs each combination across Ruby 3.1, 3.2, and 3.3 (18 jobs total).
+
+### Adding Support for New Versions
+
+1. Update the `Appraisals` file with new version combinations
+2. Run `appraisal generate && appraisal install`
+3. Fix any breaking changes
+4. Submit a pull request
+
+## Recent Changes (0.8.0)
+
+- **Security fix:** `allow_show?` now correctly delegates to `allow_show_block` (was incorrectly using `allow_index_block`)
+- **Bug fix:** Gemspec `authors` field was being overwritten by `email`
+- **Bug fix:** `PER_PAGE` constant (50) now used as pagination default
+- **CI:** Dropped Rails 6.1 (incompatible with Ruby 3.1+), fixed Psych deserialization, added asset pipeline skip
+- **Tests:** Added unit tests for authorization block delegation
+- Modernized for Ruby 3.1–3.3 and Rails 7.0–7.1
+
+See [CHANGES.md](CHANGES.md) for full history.
 
 ## License
 
-This program is provided under an MIT open source license, read the [LICENSE.txt](http://github.com/igal/paper_trail_manager/blob/master/LICENSE.txt) file for details.
+MIT — see [LICENSE.txt](LICENSE.txt) for details.
 
-## To Note:
+## History
 
-This project was originally devloped by [Igal Koshevoy](http://github.com/igal). Unfortunately @igal passed away on April 9th, 2013 and I took over the project afterwords.
+This project was originally developed by [Igal Koshevoy](https://github.com/igal). Igal passed away on April 9th, 2013, and [Tony Guntharp](https://github.com/fusion94) took over maintenance of the project.

data/Rakefile

@@ -1,18 +1,23 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 require 'rubygems'
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 Bundler::GemHelper.install_tasks
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
+
+app_rakefile_path = File.expand_path('spec/dummy/Rakefile', __dir__)
+
+if File.exist?(app_rakefile_path)
+  APP_RAKEFILE = app_rakefile_path
+  load 'rails/tasks/engine.rake'
+end
 
 require 'rake'
 require 'rdoc/task'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
-task :default => ["db:create", "db:migrate", "spec"]
+task default: ['db:create', 'db:migrate', 'spec']
 
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -22,3 +27,12 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+task :generate_spec_app do
+  sh 'rm -rf spec/dummy'
+  sh 'rails new spec/dummy --skip-bootsnap --skip-bundle \
+    --skip-git --skip-action-mailer --skip-puma --skip-test \
+    --skip-spring --skip-hotwire --skip-jbuilder \
+    --skip-action-mailbox --skip-action-text --skip-active-storage \
+    --skip-asset-pipeline \
+    --template=spec/app_template.rb'
+end