paper_trail_manager 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 007f0fa99ee11e2fdd0d615ec29d66e74788062b3a8e479091c31427d54add6c
-  data.tar.gz: a71dfd4c73909f185c580a11eae304ac0fb75e8c16fe92fe890ddeb90d7ace71
+  metadata.gz: 5f28e3a746ba34c98e03d86d36e05e5588ceeed50ad478f9736084722950d08d
+  data.tar.gz: 6d0746fb02ce9a984387078763c77b54580bb6efa63b2ed0ca72117a7e6fd083
 SHA512:
-  metadata.gz: b019f63c912f3627025427264b6b48be3347e8fe9ec1145ee1b97347e807e0d5642ff6c06ec5085635d6fe5d18354397865bc85734ade8c015284fa484287220
-  data.tar.gz: 0f60e85a369b84075a088f2e2cbca20d85895c7ff42c38fcb7d1595f7e503954bd5ea3c19cfa8b393b433ab003e4309f367caeb03dc3997e2e7f913fda167220
+  metadata.gz: 43f7cac000943029af95ee1c1b3544708afb6bf2ac47d61c0e56aea025d15c32d9b9d1d2fdd1a3f730b0d2c78e120f7c79cc02a9c075fa37e3db875fe0a0ad46
+  data.tar.gz: 30f45eb5c5b25386daaea0f89fad1405045ca80dd67d27fb1082061139614e5d0fe327ef3c3f2425f62fe7f94d83296d8e8a64ba1583f8985dfdce8da6460e85

data/.gitignore

@@ -14,3 +14,4 @@ mkmf.log
 spec/dummy
 Gemfile.lock
 gemfiles/*.lock
+*.gem

data/{CHANGES.md → CHANGELOG.md}

@@ -1,6 +1,23 @@
 Changes to `paper_trail_manager`
 ================================
 
+* 1.0.0
+    * Ship default stylesheet for changes views (table formatting, event color coding, diff highlighting, rollback button, date filter form)
+    * Include via `stylesheet_link_tag` or `require` in application.css
+    * Low-specificity selectors for easy overriding by host apps
+    * Add `.gitignore` for `.gem` build artifacts
+
+* 0.9.0
+    * 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 Rails install generator (`rails generate paper_trail_manager:install`)
+    * Add I18n support for all UI strings (30 translation keys, default English locale)
+    * 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
+    * Host apps can override any translation key in their own locale files
+    * Test count: 19 → 50
+
 * 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

data/README.md

@@ -45,6 +45,22 @@ resources :changes, controller: 'paper_trail_manager/changes'
 
 Restart your server and visit `/changes` to browse, view, and revert your changes.
 
+### Stylesheet (optional)
+
+A default stylesheet is included. Add to your layout or application CSS:
+
+```erb
+<%= stylesheet_link_tag 'paper_trail_manager/changes' %>
+```
+
+Or require it in `app/assets/stylesheets/application.css`:
+
+```css
+/*= require paper_trail_manager/changes */
+```
+
+The styles are low-specificity and easy to override in your own stylesheet.
+
 ## Configuration
 
 Create an initializer (e.g. `config/initializers/paper_trail_manager.rb`) to customize behavior.
@@ -162,7 +178,7 @@ CI runs each combination across Ruby 3.1, 3.2, and 3.3 (18 jobs total).
 - **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.
+See [CHANGELOG.md](CHANGELOG.md) for full history.
 
 ## License
 

data/app/assets/stylesheets/paper_trail_manager/changes.css

@@ -0,0 +1,256 @@
+/*
+ * PaperTrailManager — Default Stylesheet
+ *
+ * Include in your layout:
+ *   <%= stylesheet_link_tag 'paper_trail_manager/changes' %>
+ *
+ * Or import in your application.css:
+ *   *= require paper_trail_manager/changes
+ *
+ * Override any styles in your own stylesheet — these are intentionally
+ * low-specificity so your app's styles take precedence.
+ */
+
+/* ── Table ────────────────────────────────────────────────── */
+
+.changes_table {
+  width: 100%;
+  border-collapse: collapse;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
+  font-size: 14px;
+  line-height: 1.5;
+}
+
+.changes_table thead {
+  border-bottom: 2px solid #dee2e6;
+}
+
+.changes_table th {
+  padding: 10px 12px;
+  text-align: left;
+  font-weight: 600;
+  color: #495057;
+  background-color: #f8f9fa;
+}
+
+.changes_table td {
+  padding: 10px 12px;
+  vertical-align: top;
+  border-bottom: 1px solid #e9ecef;
+}
+
+.changes_table tfoot td {
+  padding: 12px;
+  border-bottom: none;
+}
+
+/* ── Change Row ───────────────────────────────────────────── */
+
+.change_row {
+  transition: background-color 0.15s ease;
+}
+
+.change_row:hover {
+  background-color: #f8f9fa;
+}
+
+/* Event-specific row colors */
+.change_event_create {
+  border-left: 3px solid #28a745;
+}
+
+.change_event_update {
+  border-left: 3px solid #007bff;
+}
+
+.change_event_destroy {
+  border-left: 3px solid #dc3545;
+}
+
+/* ── Time Column ──────────────────────────────────────────── */
+
+.change_time {
+  width: 140px;
+  white-space: nowrap;
+}
+
+.change_id {
+  display: block;
+  font-size: 12px;
+  color: #868e96;
+  margin-bottom: 2px;
+}
+
+.change_time .date {
+  font-weight: 500;
+  color: #343a40;
+}
+
+.change_time .time {
+  font-size: 13px;
+  color: #868e96;
+}
+
+/* ── Details Column ───────────────────────────────────────── */
+
+.change_details_description {
+  margin: 0 0 8px 0;
+}
+
+.change_details_description .event {
+  display: inline-block;
+  padding: 2px 8px;
+  border-radius: 3px;
+  font-size: 12px;
+  font-weight: 600;
+  text-transform: uppercase;
+  letter-spacing: 0.5px;
+  margin-right: 4px;
+}
+
+.change_event_create .event {
+  background-color: #d4edda;
+  color: #155724;
+}
+
+.change_event_update .event {
+  background-color: #cce5ff;
+  color: #004085;
+}
+
+.change_event_destroy .event {
+  background-color: #f8d7da;
+  color: #721c24;
+}
+
+.change_item {
+  color: #007bff;
+  text-decoration: none;
+}
+
+.change_item:hover {
+  text-decoration: underline;
+}
+
+/* ── Diff Table ───────────────────────────────────────────── */
+
+.change_details_table {
+  width: 100%;
+  border-collapse: collapse;
+  font-size: 13px;
+  margin-top: 6px;
+  background-color: #f8f9fa;
+  border-radius: 4px;
+  overflow: hidden;
+}
+
+.change_details_table td {
+  padding: 4px 8px;
+  border-bottom: 1px solid #e9ecef;
+}
+
+.change_detail_key {
+  font-weight: 500;
+  color: #495057;
+  width: 20%;
+  white-space: nowrap;
+}
+
+.change_detail_value.previous {
+  color: #dc3545;
+  background-color: #fff5f5;
+  word-break: break-word;
+}
+
+.change_detail_value.current {
+  color: #28a745;
+  background-color: #f0fff4;
+  word-break: break-word;
+}
+
+.change_detail_spacer {
+  text-align: center;
+  width: 30px;
+  color: #868e96;
+}
+
+.change_details_table .even {
+  background-color: #f8f9fa;
+}
+
+.change_details_table .odd {
+  background-color: #ffffff;
+}
+
+/* ── Rollback Button ──────────────────────────────────────── */
+
+.rollback {
+  display: inline-block;
+  padding: 3px 10px;
+  font-size: 12px;
+  font-weight: 500;
+  color: #856404;
+  background-color: #fff3cd;
+  border: 1px solid #ffc107;
+  border-radius: 3px;
+  cursor: pointer;
+  margin-left: 8px;
+  transition: background-color 0.15s ease;
+}
+
+.rollback:hover {
+  background-color: #ffc107;
+  color: #533f03;
+}
+
+/* ── Date Filter Form ─────────────────────────────────────── */
+
+.changes_date_filter {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  margin-bottom: 16px;
+  flex-wrap: wrap;
+}
+
+.changes_date_filter label {
+  font-size: 13px;
+  font-weight: 500;
+  color: #495057;
+}
+
+.changes_date_filter input[type="date"] {
+  padding: 4px 8px;
+  border: 1px solid #ced4da;
+  border-radius: 4px;
+  font-size: 13px;
+}
+
+.changes_date_filter input[type="submit"] {
+  padding: 4px 12px;
+  font-size: 13px;
+  font-weight: 500;
+  color: #fff;
+  background-color: #007bff;
+  border: 1px solid #007bff;
+  border-radius: 4px;
+  cursor: pointer;
+}
+
+.changes_date_filter input[type="submit"]:hover {
+  background-color: #0056b3;
+}
+
+.clear_filter {
+  font-size: 13px;
+  color: #868e96;
+}
+
+/* ── Empty State ──────────────────────────────────────────── */
+
+.changes_table tbody td[colspan] {
+  text-align: center;
+  color: #868e96;
+  padding: 24px;
+  font-style: italic;
+}

data/app/controllers/paper_trail_manager/changes_controller.rb

@@ -15,7 +15,7 @@ class PaperTrailManager
     # List changes
     def index
       unless change_index_allowed?
-        flash[:error] = 'You do not have permission to list changes.'
+        flash[:error] = t('paper_trail_manager.flash.index_denied')
         return(redirect_to root_url)
       end
 
@@ -54,12 +54,12 @@ class PaperTrailManager
       begin
         @version = PaperTrail::Version.find(params[:id])
       rescue ActiveRecord::RecordNotFound
-        flash[:error] = 'No such version.'
+        flash[:error] = t('paper_trail_manager.flash.not_found')
         return(redirect_to action: :index)
       end
 
       unless change_show_allowed?(@version)
-        flash[:error] = 'You do not have permission to show that change.'
+        flash[:error] = t('paper_trail_manager.flash.show_denied')
         return(redirect_to action: :index)
       end
 
@@ -74,12 +74,12 @@ class PaperTrailManager
       begin
         @version = PaperTrail::Version.find(params[:id])
       rescue ActiveRecord::RecordNotFound
-        flash[:error] = 'No such version.'
+        flash[:error] = t('paper_trail_manager.flash.not_found')
         return(redirect_to(changes_path))
       end
 
       unless change_revert_allowed?(@version)
-        flash[:error] = 'You do not have permission to revert this change.'
+        flash[:error] = t('paper_trail_manager.flash.revert_denied')
         return(redirect_to changes_path)
       end
 
@@ -93,14 +93,14 @@ class PaperTrailManager
 
       if @result
         if @version.event == 'create'
-          flash[:notice] = 'Rolled back newly-created record by destroying it.'
+          flash[:notice] = t('paper_trail_manager.flash.rollback_create')
           redirect_to changes_path
         else
-          flash[:notice] = 'Rolled back changes to this record.'
+          flash[:notice] = t('paper_trail_manager.flash.rollback_update')
           redirect_to change_item_url(@version)
         end
       else
-        flash[:error] = "Couldn't rollback. Sorry."
+        flash[:error] = t('paper_trail_manager.flash.rollback_failed')
         redirect_to changes_path
       end
     end

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

@@ -1,6 +1,6 @@
 <tr class='change_row <%= "change_event_#{version.event} #{version.event} #{version.event}, #{version.item_type.downcase}" %>'>
   <td class='change_time'>
-    <span class='change_id'>Change #<%= version.id %></span>
+    <span class='change_id'><%= t('paper_trail_manager.changes.version.change_id', id: version.id) %></span>
     <div class='date'> <%= version.created_at.strftime('%Y-%m-%d') %> </div>
     <div class='time'> <%= version.created_at.strftime('%H:%M:%S') %> </div>
   </td>
@@ -11,16 +11,16 @@
       <% if PaperTrailManager.whodunnit_class && version.whodunnit %>
         <% if user = PaperTrailManager.whodunnit_class.find(version.whodunnit) rescue nil %>
           <% if PaperTrailManager.user_path_method && user %>
-            by <%= link_to(h(user.send(PaperTrailManager.whodunnit_name_method)), send(:user_path_method, user)) %>
+            <%= t('paper_trail_manager.changes.version.by') %> <%= link_to(h(user.send(PaperTrailManager.whodunnit_name_method)), send(:user_path_method, user)) %>
           <% else %>
-            by <%= h(user.send(PaperTrailManager.whodunnit_name_method)) %>
+            <%= t('paper_trail_manager.changes.version.by') %> <%= h(user.send(PaperTrailManager.whodunnit_name_method)) %>
           <% end %>
         <% else %>
-          by <%= version.whodunnit %>
+          <%= t('paper_trail_manager.changes.version.by') %> <%= version.whodunnit %>
         <% end %>
       <% end %>
       <% if change_revert_allowed?(version) %>
-        <%= button_to 'Roll back', change_path(version), method: :put, class: 'rollback', form: { data: { turbo_confirm: 'Are you sure?' } } %>
+        <%= button_to t('paper_trail_manager.changes.version.roll_back'), change_path(version), method: :put, class: 'rollback', form: { data: { turbo_confirm: t('paper_trail_manager.changes.version.confirm_rollback') } } %>
       <% end %>
     </p>
     <% if version.event == 'update' or version.event == 'create' %>

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

@@ -1,22 +1,23 @@
-<h1>Changes</h1>
+<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>
 
 <%= 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">From:</label>
+  <label for="from"><%= t('paper_trail_manager.changes.filter.from') %></label>
   <%= date_field_tag :from, params[:from], id: 'from' %>
-  <label for="to">To:</label>
+  <label for="to"><%= t('paper_trail_manager.changes.filter.to') %></label>
   <%= date_field_tag :to, params[:to], id: 'to' %>
-  <%= submit_tag 'Filter', name: nil %>
+  <%= submit_tag t('paper_trail_manager.changes.filter.submit'), name: nil %>
   <% if params[:from].present? || params[:to].present? %>
-    <%= link_to 'Clear', changes_path(type: params[:type], id: params[:id]), class: 'clear_filter' %>
+    <%= 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>
@@ -28,8 +29,8 @@
     </tfoot>
     <thead>
       <tr class='changes_header'>
-        <th class='change_time'>Time</th>
-        <th class='change_details'>Attribute with previous and current values</th>
+        <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>
@@ -40,7 +41,7 @@
         <% end %>
       <% else %>
         <tr>
-          <td colspan='2'> &mdash; No changes found &mdash; </td>
+          <td colspan='2'> &mdash; <%= t('paper_trail_manager.changes.index.no_changes') %> &mdash; </td>
         </tr>
       <% end %>
     </tbody>

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

@@ -1,10 +1,10 @@
-<h1>Change <%= @version.id %></h1>
+<h1><%= t('paper_trail_manager.changes.show.title', id: @version.id) %></h1>
 
 <table class='changes_table'>
   <thead>
     <tr class='changes_header'>
-      <th class='change_time'>Time</th>
-      <th class='change_details'>Attribute with previous and current values</th>
+      <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>

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/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,6 +14,10 @@ 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
     if defined?(WillPaginate)
       ::ActionView::Base.define_method(:paginate) { |*args, **kwargs, &block| will_paginate(*args, **kwargs, &block) }

data/paper_trail_manager.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'paper_trail_manager'
-  spec.version       = '0.8.0'
+  spec.version       = '1.0.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.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail_manager
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Igal Koshevoy
@@ -197,17 +197,19 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - Appraisals
-- CHANGES.md
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/stylesheets/paper_trail_manager/changes.css
 - app/controllers/paper_trail_manager/changes_controller.rb
 - app/helpers/paper_trail_manager/changes_helper.rb
 - app/views/paper_trail_manager/changes/_version.html.erb
 - app/views/paper_trail_manager/changes/index.atom.builder
 - app/views/paper_trail_manager/changes/index.html.erb
 - app/views/paper_trail_manager/changes/show.html.erb
+- config/locales/en.yml
 - gemfiles/rails_6.1_paper_trail_12.0_kaminari.gemfile
 - gemfiles/rails_6.1_paper_trail_12.0_will_paginate.gemfile
 - gemfiles/rails_7.0_paper_trail_12.0_kaminari.gemfile
@@ -216,6 +218,8 @@ files:
 - 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
+- lib/generators/paper_trail_manager/install/install_generator.rb
+- lib/generators/paper_trail_manager/install/templates/initializer.rb
 - lib/paper_trail_manager.rb
 - paper_trail_manager.gemspec
 - spec/app_template.rb