paper_trail_history 0.1.0

data/app/models/paper_trail_history/version_decorator.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module PaperTrailHistory
+  # Decorator for PaperTrail::Version objects providing formatted display methods
+  class VersionDecorator
+    attr_reader :version
+
+    # Delegate common version methods to the underlying version object
+    delegate :id, :event, :item_type, :item_id, :whodunnit, :object, :object_changes,
+             :created_at, :updated_at, :item, :changeset, to: :version
+
+    def initialize(version)
+      @version = version
+    end
+
+    def self.decorate(version)
+      return version if version.is_a?(VersionDecorator)
+
+      new(version)
+    end
+
+    def self.decorate_collection(versions)
+      versions.map { |version| decorate(version) }
+    end
+
+    def formatted_created_at
+      version.created_at.strftime('%B %d, %Y at %I:%M %p')
+    end
+
+    def event_label
+      case version.event
+      when 'create'
+        I18n.t('paper_trail_history.events.created')
+      when 'update'
+        I18n.t('paper_trail_history.events.updated')
+      when 'destroy'
+        I18n.t('paper_trail_history.events.deleted')
+      else
+        version.event.humanize
+      end
+    end
+
+    def event_class
+      case version.event
+      when 'create'
+        'success'
+      when 'update'
+        'warning'
+      when 'destroy'
+        'danger'
+      else
+        'info'
+      end
+    end
+
+    def whodunnit_display
+      version.whodunnit || I18n.t('paper_trail_history.actors.system')
+    end
+
+    def changed_attributes
+      return [] unless changeset
+
+      changeset.map do |attr, (old_val, new_val)|
+        {
+          attribute: attr,
+          old_value: format_value(old_val),
+          new_value: format_value(new_val)
+        }
+      end
+    end
+
+    def can_restore?
+      version.event != 'create'
+    end
+
+    def item_display_name
+      if version.item
+        version.item.try(:name) || version.item.try(:title) || "#{version.item_type} ##{version.item_id}"
+      else
+        "#{version.item_type} ##{version.item_id} (deleted)"
+      end
+    end
+
+    private
+
+    def format_value(value)
+      case value
+      when nil then '(empty)'
+      when '' then '(blank)'
+      when Time then format_time(value)
+      when Date then format_date(value)
+      else value.to_s.truncate(100)
+      end
+    end
+
+    def format_time(time)
+      time.strftime('%B %d, %Y at %I:%M %p')
+    end
+
+    def format_date(date)
+      date.strftime('%B %d, %Y')
+    end
+  end
+end

data/app/models/paper_trail_history/version_service.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module PaperTrailHistory
+  # Service class for querying and managing PaperTrail version records
+  class VersionService
+    def self.for_model(model_name, params = {})
+      trackable_model = TrackableModel.find(model_name)
+      return PaperTrail::Version.none unless trackable_model
+
+      versions = base_versions_for_model(trackable_model)
+      apply_filters(versions, params).order(created_at: :desc)
+    end
+
+    def self.for_record(model_name, item_id, params = {})
+      trackable_model = TrackableModel.find(model_name)
+      return PaperTrail::Version.none unless trackable_model
+
+      versions = base_versions_for_record(trackable_model, item_id)
+      apply_record_filters(versions, params).order(created_at: :desc)
+    end
+
+    def self.restore_version(version_id)
+      version = find_version_across_tables(version_id)
+      return validate_version_for_restore(version) unless version_restorable?(version)
+
+      perform_version_restore(version)
+    rescue StandardError => e
+      { success: false, error: e.message }
+    end
+
+    def self.unique_whodunnits(model_name = nil)
+      if model_name
+        trackable_model = TrackableModel.find(model_name)
+        return [] unless trackable_model
+
+        scope = trackable_model.version_class.where(item_type: trackable_model.item_type_for_versions)
+      else
+        scope = all_version_classes.flat_map(&:all)
+        return scope.map(&:whodunnit).compact.uniq.sort
+      end
+
+      scope.distinct.pluck(:whodunnit).compact.sort
+    end
+
+    def self.available_events(model_name = nil)
+      if model_name
+        trackable_model = TrackableModel.find(model_name)
+        return [] unless trackable_model
+
+        scope = trackable_model.version_class.where(item_type: trackable_model.item_type_for_versions)
+      else
+        scope = all_version_classes.flat_map(&:all)
+        return scope.map(&:event).compact.uniq.sort
+      end
+
+      scope.distinct.pluck(:event).compact.sort
+    end
+
+    def self.find_version_across_tables(version_id)
+      # Try to find the version in all possible version classes
+      all_version_classes.each do |version_class|
+        version = version_class.find_by(id: version_id)
+        return version if version
+      end
+      nil
+    end
+
+    def self.all_version_classes
+      @all_version_classes ||= begin
+        classes = Set.new
+        TrackableModel.all.each do |trackable_model|
+          classes.add(trackable_model.version_class)
+        end
+        classes.to_a
+      end
+    end
+
+    def self.filter_by_event(versions, event)
+      versions.where(event: event)
+    end
+
+    def self.filter_by_whodunnit(versions, whodunnit)
+      versions.where(whodunnit: whodunnit)
+    end
+
+    def self.filter_by_date_range(versions, from_date, to_date)
+      versions = versions.where(created_at: Date.parse(from_date)..) if from_date.present?
+      versions = versions.where(created_at: ..Date.parse(to_date).end_of_day) if to_date.present?
+      versions
+    end
+
+    def self.search_object_changes(versions, search_term)
+      versions.where('object_changes LIKE ? OR object LIKE ?', "%#{search_term}%", "%#{search_term}%")
+    end
+
+    def self.base_versions_for_model(trackable_model)
+      trackable_model.version_class.where(item_type: trackable_model.item_type_for_versions)
+    end
+
+    def self.apply_filters(versions, params)
+      versions = filter_by_event(versions, params[:event]) if params[:event].present?
+      versions = filter_by_whodunnit(versions, params[:whodunnit]) if params[:whodunnit].present?
+      versions = apply_date_range_filter(versions, params) if date_range_params?(params)
+      versions = search_object_changes(versions, params[:search]) if params[:search].present?
+      versions
+    end
+
+    def self.apply_date_range_filter(versions, params)
+      filter_by_date_range(versions, params[:from_date], params[:to_date])
+    end
+
+    def self.date_range_params?(params)
+      params[:from_date].present? || params[:to_date].present?
+    end
+
+    def self.base_versions_for_record(trackable_model, item_id)
+      trackable_model.version_class.where(
+        item_type: trackable_model.item_type_for_versions,
+        item_id: item_id
+      )
+    end
+
+    def self.apply_record_filters(versions, params)
+      versions = filter_by_event(versions, params[:event]) if params[:event].present?
+      versions = apply_date_range_filter(versions, params) if date_range_params?(params)
+      versions
+    end
+
+    def self.version_restorable?(version)
+      version && version.event != 'create'
+    end
+
+    def self.validate_version_for_restore(version)
+      return { success: false, error: I18n.t('paper_trail_history.errors.version_not_found') } unless version
+
+      { success: false, error: I18n.t('paper_trail_history.errors.cannot_restore_create') }
+    end
+
+    def self.perform_version_restore(version)
+      if version.event == 'destroy'
+        restore_destroyed_record(version)
+      else
+        restore_previous_version(version)
+      end
+    end
+
+    def self.restore_destroyed_record(version)
+      restored_item = version.reify
+      restored_item.save!
+      { success: true, item: restored_item, message: I18n.t('paper_trail_history.messages.restore_from_deletion') }
+    end
+
+    def self.restore_previous_version(version)
+      version.reify.save!
+      { success: true, item: version.item, message: I18n.t('paper_trail_history.messages.restore_to_previous') }
+    end
+  end
+end

data/app/views/layouts/paper_trail_history/application.html.erb

@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>Paper Trail History</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag "paper_trail_history/application", media: "all" %>
+  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
+  <link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.0/font/bootstrap-icons.css" rel="stylesheet">
+</head>
+<body>
+  <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
+    <div class="container">
+      <%= link_to "Paper Trail History", root_path, class: "navbar-brand" %>
+      
+      <div class="navbar-nav ms-auto">
+        <%= link_to "All Models", models_path, class: "nav-link" %>
+      </div>
+    </div>
+  </nav>
+
+  <div class="container mt-4">
+    <% if notice %>
+      <div class="alert alert-success alert-dismissible fade show" role="alert">
+        <%= notice %>
+        <button type="button" class="btn-close" data-bs-dismiss="alert"></button>
+      </div>
+    <% end %>
+
+    <% if alert %>
+      <div class="alert alert-danger alert-dismissible fade show" role="alert">
+        <%= alert %>
+        <button type="button" class="btn-close" data-bs-dismiss="alert"></button>
+      </div>
+    <% end %>
+
+    <%= yield %>
+  </div>
+
+  <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
+  <script>
+    // Initialize Bootstrap tooltips - works with both regular apps and Turbo
+    function initTooltips() {
+      // Dispose of existing tooltips first to prevent duplicates
+      document.querySelectorAll('[data-bs-toggle="tooltip"]').forEach(el => {
+        const existingTooltip = bootstrap.Tooltip.getInstance(el);
+        if (existingTooltip) existingTooltip.dispose();
+      });
+      
+      // Initialize new tooltips
+      const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]');
+      [...tooltipTriggerList].map(tooltipTriggerEl => new bootstrap.Tooltip(tooltipTriggerEl));
+    }
+
+    // Initialize on both initial load and Turbo navigation
+    document.addEventListener('DOMContentLoaded', initTooltips);
+    document.addEventListener('turbo:load', initTooltips);
+  </script>
+</body>
+</html>

data/app/views/paper_trail_history/models/index.html.erb

@@ -0,0 +1,65 @@
+<div class="d-flex justify-content-between align-items-center mb-4">
+  <h1>Trackable Models</h1>
+  <span class="badge bg-secondary"><%= @trackable_models.count %> models</span>
+</div>
+
+<% if @trackable_models.any? %>
+  <div class="card">
+    <div class="card-body">
+      <div class="table-responsive">
+        <table class="table table-striped">
+          <thead>
+            <tr>
+              <th><i class="bi bi-database-fill"></i> Model</th>
+              <th>Table Name</th>
+              <th>Version Table</th>
+              <th>Total Versions</th>
+              <th>Actions</th>
+            </tr>
+          </thead>
+          <tbody>
+            <% @trackable_models.each do |model| %>
+              <tr>
+                <td>
+                  <strong><%= model.human_name %></strong>
+                  <br>
+                  <small class="text-muted"><%= model.name %></small>
+                </td>
+                <td>
+                  <code><%= model.table_name %></code>
+                </td>
+                <td>
+                  <code><%= model.version_table_name %></code>
+                  <br>
+                  <small class="text-muted"><%= model.version_class.name %></small>
+                </td>
+                <td>
+                  <span class="badge bg-primary"><%= model.total_versions_count %></span>
+                </td>
+                <td>
+                  <div class="btn-group btn-group-sm" role="group">
+                    <%= link_to model_path(model.name), 
+                        class: "btn btn-outline-secondary", 
+                        data: { bs_toggle: "tooltip", bs_title: "View Model Details" } do %>
+                      <i class="bi bi-eye"></i>
+                    <% end %>
+                    <%= link_to versions_model_path(model.name), 
+                        class: "btn btn-primary", 
+                        data: { bs_toggle: "tooltip", bs_title: "View All Versions" } do %>
+                      <i class="bi bi-clock-history"></i>
+                    <% end %>
+                  </div>
+                </td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </div>
+    </div>
+  </div>
+<% else %>
+  <div class="alert alert-info">
+    <i class="bi bi-info-circle"></i>
+    No trackable models found. Make sure you have models with <code>has_paper_trail</code> configured.
+  </div>
+<% end %>

data/app/views/paper_trail_history/models/show.html.erb

@@ -0,0 +1,49 @@
+<nav aria-label="breadcrumb">
+  <ol class="breadcrumb">
+    <li class="breadcrumb-item"><%= link_to "Models", models_path %></li>
+    <li class="breadcrumb-item active"><%= @trackable_model.human_name %></li>
+  </ol>
+</nav>
+
+<div class="d-flex justify-content-between align-items-center mb-4">
+  <h1><%= @trackable_model.human_name %></h1>
+  <div>
+    <%= link_to "All Versions", versions_model_path(@trackable_model.name), class: "btn btn-primary" %>
+  </div>
+</div>
+
+<div class="row mb-4">
+  <div class="col-md-8">
+    <div class="card">
+      <div class="card-body">
+        <h5 class="card-title">Model Information</h5>
+        <dl class="row">
+          <dt class="col-sm-3">Model Name:</dt>
+          <dd class="col-sm-9"><code><%= @trackable_model.name %></code></dd>
+          
+          <dt class="col-sm-3">Table Name:</dt>
+          <dd class="col-sm-9"><code><%= @trackable_model.table_name %></code></dd>
+          
+          <dt class="col-sm-3">Total Versions:</dt>
+          <dd class="col-sm-9">
+            <span class="badge bg-primary"><%= @trackable_model.total_versions_count %></span>
+          </dd>
+        </dl>
+      </div>
+    </div>
+  </div>
+</div>
+
+<div class="card">
+  <div class="card-header d-flex justify-content-between align-items-center">
+    <h5 class="mb-0">Recent Versions</h5>
+    <%= link_to "View All", versions_model_path(@trackable_model.name), class: "btn btn-sm btn-outline-primary" %>
+  </div>
+  <div class="card-body">
+    <% if @recent_versions.any? %>
+      <%= render "paper_trail_history/shared/versions_table", versions: @recent_versions, show_item_link: true %>
+    <% else %>
+      <p class="text-muted">No versions found for this model.</p>
+    <% end %>
+  </div>
+</div>

data/app/views/paper_trail_history/models/versions.html.erb

@@ -0,0 +1,30 @@
+<nav aria-label="breadcrumb">
+  <ol class="breadcrumb">
+    <li class="breadcrumb-item"><%= link_to "Models", models_path %></li>
+    <li class="breadcrumb-item"><%= link_to @trackable_model.human_name, model_path(@trackable_model.name) %></li>
+    <li class="breadcrumb-item active">All Versions</li>
+  </ol>
+</nav>
+
+<div class="d-flex justify-content-between align-items-center mb-4">
+  <h1>All Versions - <%= @trackable_model.human_name %></h1>
+  <span class="badge bg-secondary"><%= @versions.count %> versions</span>
+</div>
+
+<%= render "paper_trail_history/shared/version_filters", 
+    available_events: @available_events, 
+    available_whodunnits: @available_whodunnits %>
+
+<div class="card">
+  <div class="card-body">
+    <% if @decorated_versions.any? %>
+      <%= render "paper_trail_history/shared/versions_table", versions: @decorated_versions, show_item_link: true %>
+    <% else %>
+      <div class="text-center py-4">
+        <i class="bi bi-inbox display-1 text-muted"></i>
+        <p class="text-muted">No versions found matching your criteria.</p>
+        <%= link_to "Clear Filters", versions_model_path(@trackable_model.name), class: "btn btn-outline-secondary" %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/paper_trail_history/records/show.html.erb

@@ -0,0 +1,57 @@
+<nav aria-label="breadcrumb">
+  <ol class="breadcrumb">
+    <li class="breadcrumb-item"><%= link_to "Models", models_path %></li>
+    <li class="breadcrumb-item"><%= link_to @trackable_model.human_name, model_path(@trackable_model.name) %></li>
+    <li class="breadcrumb-item active">Record #<%= @record_id %></li>
+  </ol>
+</nav>
+
+<div class="d-flex justify-content-between align-items-center mb-4">
+  <h1>
+    <%= @trackable_model.human_name %> #<%= @record_id %>
+    <% if @record.nil? %>
+      <span class="badge bg-danger">Deleted</span>
+    <% end %>
+  </h1>
+  <div>
+    <%= link_to "All Versions", versions_model_record_path(@trackable_model.name, @record_id), class: "btn btn-primary" %>
+  </div>
+</div>
+
+<% if @record %>
+  <div class="row mb-4">
+    <div class="col-md-8">
+      <div class="card">
+        <div class="card-body">
+          <h5 class="card-title">Current Record</h5>
+          <dl class="row">
+            <% @record.attributes.each do |attr, value| %>
+              <dt class="col-sm-3"><%= attr.humanize %>:</dt>
+              <dd class="col-sm-9">
+                <% if value.nil? %>
+                  <em class="text-muted">(empty)</em>
+                <% else %>
+                  <%= truncate(value.to_s, length: 100) %>
+                <% end %>
+              </dd>
+            <% end %>
+          </dl>
+        </div>
+      </div>
+    </div>
+  </div>
+<% end %>
+
+<div class="card">
+  <div class="card-header d-flex justify-content-between align-items-center">
+    <h5 class="mb-0">Version History</h5>
+    <%= link_to "View All", versions_model_record_path(@trackable_model.name, @record_id), class: "btn btn-sm btn-outline-primary" %>
+  </div>
+  <div class="card-body">
+    <% if @recent_versions.any? %>
+      <%= render "paper_trail_history/shared/versions_table", versions: @recent_versions %>
+    <% else %>
+      <p class="text-muted">No versions found for this record.</p>
+    <% end %>
+  </div>
+</div>

data/app/views/paper_trail_history/records/versions.html.erb

@@ -0,0 +1,36 @@
+<nav aria-label="breadcrumb">
+  <ol class="breadcrumb">
+    <li class="breadcrumb-item"><%= link_to "Models", models_path %></li>
+    <li class="breadcrumb-item"><%= link_to @trackable_model.human_name, model_path(@trackable_model.name) %></li>
+    <li class="breadcrumb-item"><%= link_to "Record ##{@record_id}", model_record_path(@trackable_model.name, @record_id) %></li>
+    <li class="breadcrumb-item active">All Versions</li>
+  </ol>
+</nav>
+
+<div class="d-flex justify-content-between align-items-center mb-4">
+  <h1>
+    All Versions - <%= @trackable_model.human_name %> #<%= @record_id %>
+    <% if @record.nil? %>
+      <span class="badge bg-danger">Deleted</span>
+    <% end %>
+  </h1>
+  <span class="badge bg-secondary"><%= @versions.count %> versions</span>
+</div>
+
+<%= render "paper_trail_history/shared/version_filters", 
+    available_events: @available_events, 
+    available_whodunnits: nil %>
+
+<div class="card">
+  <div class="card-body">
+    <% if @decorated_versions.any? %>
+      <%= render "paper_trail_history/shared/versions_table", versions: @decorated_versions %>
+    <% else %>
+      <div class="text-center py-4">
+        <i class="bi bi-inbox display-1 text-muted"></i>
+        <p class="text-muted">No versions found matching your criteria.</p>
+        <%= link_to "Clear Filters", versions_model_record_path(@trackable_model.name, @record_id), class: "btn btn-outline-secondary" %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/paper_trail_history/shared/_version_filters.html.erb

@@ -0,0 +1,54 @@
+<div class="card mb-4">
+  <div class="card-header">
+    <h6 class="mb-0">
+      <i class="bi bi-funnel"></i>
+      Filters
+      <button class="btn btn-sm btn-outline-secondary ms-2" type="button" data-bs-toggle="collapse" data-bs-target="#filterCollapse">
+        Toggle
+      </button>
+    </h6>
+  </div>
+  <div class="collapse" id="filterCollapse">
+    <div class="card-body">
+      <%= form_with url: request.path, method: :get, local: true, class: "row g-3" do |f| %>
+        <div class="col-md-3">
+          <%= f.label :event, class: "form-label" %>
+          <%= f.select :event, 
+              options_for_select([["All Events", ""]] + available_events.map { |e| [e.humanize, e] }, params[:event]),
+              {}, { class: "form-select" } %>
+        </div>
+        
+        <% if available_whodunnits %>
+          <div class="col-md-3">
+            <%= f.label :whodunnit, "Who", class: "form-label" %>
+            <%= f.select :whodunnit,
+                options_for_select([["Anyone", ""]] + available_whodunnits.map { |w| [w || "System", w] }, params[:whodunnit]),
+                {}, { class: "form-select" } %>
+          </div>
+        <% end %>
+        
+        <div class="col-md-2">
+          <%= f.label :from_date, "From Date", class: "form-label" %>
+          <%= f.date_field :from_date, value: params[:from_date], class: "form-control" %>
+        </div>
+        
+        <div class="col-md-2">
+          <%= f.label :to_date, "To Date", class: "form-label" %>
+          <%= f.date_field :to_date, value: params[:to_date], class: "form-control" %>
+        </div>
+        
+        <div class="col-md-2">
+          <%= f.label :search, "Search Changes", class: "form-label" %>
+          <%= f.text_field :search, value: params[:search], class: "form-control", placeholder: "Search..." %>
+        </div>
+        
+        <div class="col-12">
+          <div class="d-flex gap-2">
+            <%= f.submit "Apply Filters", class: "btn btn-primary" %>
+            <%= link_to "Clear", request.path, class: "btn btn-outline-secondary" %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/paper_trail_history/shared/_versions_table.html.erb

@@ -0,0 +1,60 @@
+<div class="table-responsive">
+  <table class="table table-striped">
+    <thead>
+      <tr>
+        <th>Version</th>
+        <th>Event</th>
+        <th>When</th>
+        <th>Who</th>
+        <% if local_assigns[:show_item_link] %>
+          <th>Item</th>
+        <% end %>
+        <th>Actions</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% versions.each do |decorated_version| %>
+        <tr>
+          <td>
+            <%= link_to "##{decorated_version.version.id}", 
+                version_path(decorated_version.version.id), 
+                class: "text-decoration-none" %>
+          </td>
+          <td>
+            <span class="badge bg-<%= decorated_version.event_class %>">
+              <i class="bi bi-<%= decorated_version.event == 'create' ? 'plus' : decorated_version.event == 'update' ? 'pencil' : 'trash' %>"></i>
+              <%= decorated_version.event_label %>
+            </span>
+          </td>
+          <td>
+            <small><%= decorated_version.formatted_created_at %></small>
+          </td>
+          <td>
+            <small><%= decorated_version.whodunnit_display %></small>
+          </td>
+          <% if local_assigns[:show_item_link] %>
+            <td>
+              <%= link_to decorated_version.item_display_name,
+                  model_record_path(decorated_version.version.item_type, decorated_version.version.item_id),
+                  class: "text-decoration-none" %>
+            </td>
+          <% end %>
+          <td>
+            <div class="btn-group btn-group-sm">
+              <%= link_to "View", version_path(decorated_version.version.id), class: "btn btn-outline-primary btn-sm" %>
+              <% if decorated_version.can_restore? %>
+                <%= link_to "Restore", 
+                    restore_version_path(decorated_version.version.id), 
+                    method: :patch,
+                    data: { 
+                      confirm: "Are you sure you want to restore this version?" 
+                    },
+                    class: "btn btn-outline-warning btn-sm" %>
+              <% end %>
+            </div>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>