easy-admin-rails 0.1.11 → 0.1.13

data/app/concerns/easy_admin/resource_versions.rb

@@ -0,0 +1,306 @@
+module EasyAdmin
+  module ResourceVersions
+    extend ActiveSupport::Concern
+
+    DEFAULT_VERSIONS_PER_PAGE = 10
+    MAX_VERSIONS_PER_PAGE = 50
+
+    included do
+      # Include in controllers that need version functionality
+    end
+
+    # Load versions for a specific record with pagination and turbo compatibility
+    def load_record_versions(page: 1, per_page: DEFAULT_VERSIONS_PER_PAGE)
+      return OpenStruct.new(items: [], total_count: 0, has_more: false, current_page: 1) unless record_has_versions?(@record)
+
+      per_page = [per_page.to_i, MAX_VERSIONS_PER_PAGE].min
+      per_page = DEFAULT_VERSIONS_PER_PAGE if per_page <= 0
+      page = [page.to_i, 1].max
+
+      # Use pagy for consistent pagination across the app
+      pagy, versions = pagy(@record.versions.reorder(id: :desc).includes(:item), 
+                           items: per_page,
+                           limit: per_page,
+                           page: page,
+                           overflow: :last_page)
+
+      OpenStruct.new(
+        items: versions,
+        pagy: pagy,
+        total_count: pagy.count,
+        has_more: pagy.next.present?,
+        current_page: pagy.page,
+        per_page: pagy.vars[:items],
+        total_pages: pagy.last
+      )
+    end
+
+    # Check if a record has version support
+    def record_has_versions?(record)
+      return false unless record
+      return false unless defined?(PaperTrail)
+      
+      record.respond_to?(:versions) && record.class.respond_to?(:paper_trail) rescue false
+    end
+
+    # Get version statistics for a record
+    def version_statistics(record)
+      return {} unless record_has_versions?(record)
+      
+      versions = record.versions
+      
+      {
+        total_versions: versions.count,
+        create_count: versions.where(event: 'create').count,
+        update_count: versions.where(event: 'update').count,
+        destroy_count: versions.where(event: 'destroy').count,
+        first_version_at: versions.order(:created_at).first&.created_at,
+        last_version_at: versions.order(:created_at).last&.created_at,
+        unique_users: versions.where.not(whodunnit: nil).distinct.count(:whodunnit)
+      }
+    end
+
+    # Turbo-compatible version loading action
+    def versions
+      result = load_record_versions(
+        page: params[:page] || 1,
+        per_page: params[:per_page] || DEFAULT_VERSIONS_PER_PAGE
+      )
+
+      respond_to do |format|
+        format.html do
+          if turbo_frame_request?
+            # For lazy loading turbo frame (versions-timeline)
+            render plain: EasyAdmin::Versions::TimelineComponent.new(
+              versions: result.items,
+              turbo_frame_id: "versions-timeline",
+              resource_class: @resource_class,
+              record: @record
+            ).call
+          else
+            # Regular page load - redirect or render full page
+            redirect_to easy_admin.resource_path(@resource_class.route_key, @record, anchor: "versions")
+          end
+        end
+        
+        format.turbo_stream do
+          if params[:append] == "true"
+            # Infinite scroll - append more versions
+            render turbo_stream: [
+              turbo_stream.append("versions-container", 
+                EasyAdmin::Versions::TimelineComponent.new(
+                  versions: result.items
+                ).call
+              ),
+              turbo_stream.replace("versions-pagination", 
+                EasyAdmin::Versions::PaginationComponent.new(
+                  pagy: result.pagy,
+                  resource_class: @resource_class,
+                  record: @record
+                ).call
+              )
+            ]
+          else
+            # Replace entire versions section
+            render turbo_stream: turbo_stream.replace("versions-section",
+              EasyAdmin::Versions::HistoryComponent.new(
+                record: @record,
+                resource_class: @resource_class,
+                versions_result: result
+              ).call
+            )
+          end
+        end
+      end
+    end
+
+    # Revert a record to a specific version with turbo response
+    def revert_version
+      version_id = params[:version_id]
+      version = @record.versions.find_by(id: version_id)
+      
+      unless version
+        respond_to do |format|
+          format.turbo_stream do
+            render turbo_stream: turbo_stream.update("notifications",
+              EasyAdmin::NotificationComponent.new(
+                type: :error,
+                message: "Version not found",
+                title: "Error"
+              ).call
+            )
+          end
+          format.html do
+            redirect_to easy_admin.resource_path(@resource_class.route_key, @record),
+                       alert: "Version not found"
+          end
+        end
+        return
+      end
+
+      result = revert_to_version(@record, version_id, current_user: current_admin_user)
+      
+      respond_to do |format|
+        if result[:success]
+          format.turbo_stream do
+            render turbo_stream: [
+              turbo_stream.update("notifications",
+                EasyAdmin::NotificationComponent.new(
+                  type: :success,
+                  message: result[:message],
+                  title: "Success"
+                ).call
+              ),
+              # Refresh the versions section
+              turbo_stream.replace("versions-section",
+                EasyAdmin::Versions::HistoryComponent.new(
+                  record: @record.reload,
+                  resource_class: @resource_class
+                ).call
+              ),
+              # Update the main record display if on show page
+              turbo_stream.replace("record-content", 
+                render_record_content(@record.reload)
+              )
+            ]
+          end
+          format.html do
+            redirect_to easy_admin.resource_path(@resource_class.route_key, @record),
+                       notice: result[:message]
+          end
+        else
+          format.turbo_stream do
+            render turbo_stream: turbo_stream.update("notifications",
+              EasyAdmin::NotificationComponent.new(
+                type: :error,
+                message: result[:error],
+                title: "Error"
+              ).call
+            )
+          end
+          format.html do
+            redirect_to easy_admin.resource_path(@resource_class.route_key, @record),
+                       alert: result[:error]
+          end
+        end
+      end
+    end
+
+    # Show detailed diff modal for a version
+    def version_diff
+      version = @record.versions.find_by(id: params[:version_id])
+      
+      unless version
+        respond_to do |format|
+          format.html do
+            render plain: EasyAdmin::Versions::ErrorComponent.new(
+              message: "Version not found"
+            ).call
+          end
+        end
+        return
+      end
+
+      respond_to do |format|
+        format.html do
+          render plain: EasyAdmin::Versions::DiffModalComponent.new(
+            version: version,
+            record: @record,
+            resource_class: @resource_class
+          ).call
+        end
+      end
+    end
+
+    private
+
+    # Revert a record to a specific version
+    def revert_to_version(record, version_id, current_user: nil)
+      return { success: false, error: "Versioning not available" } unless record_has_versions?(record)
+      
+      version = record.versions.find_by(id: version_id)
+      return { success: false, error: "Version not found" } unless version
+      
+      begin
+        # Set whodunnit for the revert action
+        PaperTrail.request.whodunnit = current_user&.email if current_user
+        
+        # Parse version object manually with safe YAML loading
+        old_attributes = parse_version_object_safely(version.object)
+        return { success: false, error: "Cannot reify this version" } unless old_attributes.is_a?(Hash)
+        
+        # Filter out attributes that shouldn't be reverted
+        filtered_attributes = old_attributes.except('id', 'created_at', 'updated_at')
+        
+        if record.update(filtered_attributes)
+          {
+            success: true,
+            message: "Successfully reverted to version ##{version_id}",
+            reverted_version: version,
+            new_version: record.versions.last
+          }
+        else
+          {
+            success: false,
+            error: "Failed to revert: #{record.errors.full_messages.join(', ')}",
+            validation_errors: record.errors
+          }
+        end
+      rescue => e
+        {
+          success: false,
+          error: "Error during revert: #{e.message}"
+        }
+      ensure
+        PaperTrail.request.whodunnit = nil
+      end
+    end
+
+    # Helper to render record content (override in controller if needed)
+    def render_record_content(record)
+      # This should be implemented in the controller that includes this concern
+      # to return the appropriate component for the record display
+      ""
+    end
+
+    private
+
+    # Safe YAML parsing for version objects with proper class permissions
+    def parse_version_object_safely(object_yaml)
+      return {} if object_yaml.blank?
+      
+      YAML.safe_load(
+        object_yaml, 
+        permitted_classes: [Time, Date, DateTime, ActiveSupport::TimeWithZone, ActiveSupport::TimeZone, Symbol],
+        aliases: true
+      )
+    rescue Psych::DisallowedClass, Psych::BadAlias
+      begin
+        YAML.unsafe_load(object_yaml)
+      rescue
+        extract_basic_attributes_from_yaml(object_yaml)
+      end
+    rescue => e
+      Rails.logger.warn "Failed to parse version object for revert: #{e.message}"
+      {}
+    end
+
+    # Fallback method to extract basic attributes from YAML string
+    def extract_basic_attributes_from_yaml(yaml_string)
+      attributes = {}
+      
+      yaml_string.scan(/^(\w+):\s*(.+)$/).each do |key, value|
+        # Skip complex objects
+        next if value.include?('!ruby/object')
+        
+        # Clean up the value
+        cleaned_value = value.strip.gsub(/^["']|["']$/, '')
+        attributes[key] = cleaned_value unless cleaned_value.empty?
+      end
+      
+      attributes
+    rescue
+      {}
+    end
+  end
+end

data/app/controllers/easy_admin/application_controller.rb

@@ -8,6 +8,7 @@ module EasyAdmin
     before_action :authenticate_easy_admin_admin_user!
     before_action :set_active_storage_url_options
     before_action :set_feature_toggles
+    before_action :set_paper_trail_whodunnit
     
     protected
     
@@ -61,6 +62,13 @@ module EasyAdmin
       descriptions[feature_name.to_s] || "Toggle #{feature_name.humanize.downcase}"
     end
     
+    # Set Paper Trail whodunnit to track which admin user made changes
+    def set_paper_trail_whodunnit
+      if defined?(PaperTrail) && current_admin_user
+        PaperTrail.request.whodunnit = current_admin_user.email
+      end
+    end
+
     helper_method :current_admin_user, :admin_user_signed_in?
   end
 end

data/app/controllers/easy_admin/resources_controller.rb

@@ -1,7 +1,9 @@
 module EasyAdmin
   class ResourcesController < ApplicationController
+    include EasyAdmin::ResourceVersions
+    
     before_action :load_resource_class
-    before_action :load_record, only: [:show, :edit, :update, :destroy, :edit_field, :update_field, :belongs_to_reattach, :belongs_to_edit_attached, :update_belongs_to_attached]
+    before_action :load_record, only: [:show, :edit, :update, :destroy, :edit_field, :update_field, :belongs_to_reattach, :belongs_to_edit_attached, :update_belongs_to_attached, :versions, :revert_version, :version_diff]
 
     def index
       # Set up data needed for both HTML and turbo stream

data/app/javascript/controllers/modal_controller.js

@@ -0,0 +1,38 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    // Disable body scroll when modal opens
+    document.body.style.overflow = 'hidden'
+    
+    // Focus trap - focus the modal
+    this.element.focus()
+  }
+
+  disconnect() {
+    // Re-enable body scroll when modal closes
+    document.body.style.overflow = ''
+  }
+
+  close() {
+    // Clear the modal turbo frame
+    const modalFrame = document.getElementById("modal")
+    if (modalFrame) {
+      modalFrame.innerHTML = ""
+    }
+  }
+
+  handleOutsideClick(event) {
+    // Close modal if clicking outside the modal container
+    if (event.target === this.element) {
+      this.close()
+    }
+  }
+
+  // Handle escape key
+  keydown(event) {
+    if (event.key === "Escape") {
+      this.close()
+    }
+  }
+}

data/app/javascript/easy_admin/controllers/version_revert_controller.js

@@ -0,0 +1,108 @@
+import { Controller } from "@hotwired/stimulus"
+import { FetchRequest } from "@rails/request.js"
+import Swal from "sweetalert2"
+
+export default class extends Controller {
+  static values = { 
+    versionId: Number,
+    resourceId: String,
+    resourceName: String
+  }
+
+  confirm(event) {
+    event.preventDefault()
+    
+    Swal.fire({
+      title: 'Revert to Version?',
+      html: `Are you sure you want to revert to version <strong>#${this.versionIdValue}</strong>?<br><br>This will restore the old data and create a new version entry.`,
+      icon: 'question',
+      showCancelButton: true,
+      confirmButtonText: 'Yes, Revert',
+      cancelButtonText: 'Cancel',
+      reverseButtons: true,
+      focusCancel: true,
+      ...this.getAdminPanelStyles()
+    }).then((result) => {
+      if (result.isConfirmed) {
+        this.performRevert()
+      }
+    })
+  }
+
+  async performRevert() {
+    const url = `/admin/${this.resourceNameValue}/${this.resourceIdValue}/versions/${this.versionIdValue}/revert`
+    
+    // Show loading indicator
+    Swal.fire({
+      title: 'Reverting...',
+      text: `Restoring version #${this.versionIdValue}`,
+      allowOutsideClick: false,
+      allowEscapeKey: false,
+      showConfirmButton: false,
+      didOpen: () => {
+        Swal.showLoading()
+      },
+      ...this.getAdminPanelStyles()
+    })
+    
+    try {
+      const request = new FetchRequest("post", url, {
+        headers: {
+          "X-CSRF-Token": document.querySelector('meta[name="csrf-token"]').content,
+          "Accept": "text/vnd.turbo-stream.html"
+        }
+      })
+      
+      const response = await request.perform()
+      
+      if (response.ok) {
+        // Show success message then reload
+        Swal.fire({
+          title: 'Success!',
+          text: `Reverted to version #${this.versionIdValue}`,
+          icon: 'success',
+          timer: 1500,
+          showConfirmButton: false,
+          ...this.getAdminPanelStyles()
+        }).then(() => {
+          window.location.reload()
+        })
+      } else {
+        console.error("Revert failed:", response.statusText)
+        this.showError("Failed to revert. Please try again.")
+      }
+    } catch (error) {
+      console.error("Revert error:", error)
+      this.showError("An error occurred while reverting. Please try again.")
+    }
+  }
+
+  showError(message) {
+    Swal.fire({
+      title: 'Error',
+      text: message,
+      icon: 'error',
+      confirmButtonText: 'OK',
+      ...this.getAdminPanelStyles()
+    })
+  }
+
+  getAdminPanelStyles() {
+    return {
+      buttonsStyling: false,
+      customClass: {
+        popup: 'easy-admin-swal-popup',
+        title: 'easy-admin-swal-title', 
+        htmlContainer: 'easy-admin-swal-content',
+        confirmButton: 'easy-admin-swal-confirm-button',
+        cancelButton: 'easy-admin-swal-cancel-button',
+        actions: 'easy-admin-swal-actions'
+      },
+      background: '#ffffff',
+      backdrop: 'rgba(0, 0, 0, 0.4)',
+      width: '28rem',
+      padding: '0',
+      borderRadius: '0.75rem'
+    }
+  }
+}

data/app/javascript/easy_admin/controllers.js

@@ -25,6 +25,7 @@ import ContextMenuController from './controllers/context_menu_controller'
 import RowModalController from './controllers/row_modal_controller'
 import RowActionController from './controllers/row_action_controller'
 import JsoneditorController from './controllers/jsoneditor_controller'
+import VersionRevertController from './controllers/version_revert_controller'
 
 // Register controllers
 application.register('sidebar', SidebarController)
@@ -51,4 +52,5 @@ application.register('confirmation-modal', ConfirmationModalController)
 application.register('context-menu', ContextMenuController)
 application.register('row-modal', RowModalController)
 application.register('row-action', RowActionController)
-application.register('jsoneditor', JsoneditorController)
+application.register('jsoneditor', JsoneditorController)
+application.register('version-revert', VersionRevertController)

data/config/routes.rb

@@ -66,5 +66,10 @@ EasyAdmin::Engine.routes.draw do
     get '/:id/metrics/:metric_id', to: 'resources#metric', as: 'resource_metric'
     get '/:id/charts/:chart_id', to: 'resources#chart', as: 'resource_chart'
     get '/:id/tabs/:tab_name', to: 'resources#tab_content', as: 'resource_tab_content'
+    
+    # Version management routes
+    get '/:id/versions', to: 'resources#versions', as: 'resource_versions'
+    post '/:id/versions/:version_id/revert', to: 'resources#revert_version', as: 'revert_resource_version'
+    get '/:id/versions/:version_id/diff', to: 'resources#version_diff', as: 'resource_version_diff'
   end
 end

data/lib/easy-admin-rails.rb

@@ -4,6 +4,7 @@ require "ostruct"
 require "easy_admin/version"
 require "easy_admin/configuration"
 require "easy_admin/resource_registry"
+require "easy_admin/versioning"
 require "easy_admin/resource"
 require "easy_admin/dashboard_registry"
 require "easy_admin/dashboard"

data/lib/easy_admin/resource.rb

@@ -1,5 +1,7 @@
 module EasyAdmin
   class Resource
+    include EasyAdmin::Versioning
+    
     class_attribute :model_class_name, :resource_name, :fields_config, :form_tabs_config, :show_layout_config, :scopes_config, :pagination_config, :includes_config, :batch_actions_config, :batch_actions_enabled, :row_actions_config, :custom_title
     
     def self.inherited(subclass)
@@ -822,5 +824,18 @@ module EasyAdmin
     def self.param_key
       resource_name.underscore
     end
+    
+    # Versioning DSL - Simple API for enabling version viewing
+    def self.versioning(enabled = true, **options)
+      if enabled
+        enable_versioning(options)
+      else
+        self.versioning_enabled = false
+      end
+    end
+    
+    def self.has_versioning?
+      model_has_versions?
+    end
   end
 end

data/lib/easy_admin/version.rb

@@ -1,3 +1,3 @@
 module EasyAdmin
-  VERSION = "0.1.11"
+  VERSION = "0.1.13"
 end

data/lib/easy_admin/versioning.rb

@@ -0,0 +1,43 @@
+module EasyAdmin
+  module Versioning
+    extend ActiveSupport::Concern
+    
+    included do
+      class_attribute :versioning_enabled, default: false
+      class_attribute :versioning_options, default: {}
+    end
+    
+    class_methods do
+      def enable_versioning(options = {})
+        self.versioning_enabled = true
+        self.versioning_options = options
+      end
+      
+      def versioning_enabled?
+        versioning_enabled && defined?(PaperTrail)
+      end
+      
+      def versioning_config
+        return nil unless versioning_enabled?
+        
+        {
+          enabled: true,
+          diff_display: versioning_options[:diff_display] || :inline,
+          show_whodunnit: versioning_options[:show_whodunnit] != false,
+          show_metadata: versioning_options[:show_metadata] != false,
+          limit: versioning_options[:limit] || 50 # Default to showing last 50 versions
+        }
+      end
+      
+      # Check if a model has versioning available
+      def model_has_versions?
+        return false unless versioning_enabled?
+        
+        # Check if the model has paper_trail and instances respond to versions
+        model_class.respond_to?(:paper_trail) && model_class.new.respond_to?(:versions)
+      rescue
+        false
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy-admin-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Slaurmagan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-02 00:00:00.000000000 Z
+date: 2025-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -195,6 +195,7 @@ files:
 - app/assets/config/easy_admin_manifest.js
 - app/assets/images/jsoneditor-icons.svg
 - app/assets/stylesheets/easy_admin/application.tailwind.css
+- app/assets/stylesheets/easy_admin/swal_customizations.css
 - app/components/easy_admin/base_component.rb
 - app/components/easy_admin/batch_action_bar_component.rb
 - app/components/easy_admin/batch_action_form_component.rb
@@ -283,6 +284,12 @@ files:
 - app/components/easy_admin/sidebar_component.rb
 - app/components/easy_admin/turbo/response_component.rb
 - app/components/easy_admin/turbo/stream_component.rb
+- app/components/easy_admin/versions/diff_component.rb
+- app/components/easy_admin/versions/diff_modal_component.rb
+- app/components/easy_admin/versions/history_component.rb
+- app/components/easy_admin/versions/pagination_component.rb
+- app/components/easy_admin/versions/timeline_component.rb
+- app/concerns/easy_admin/resource_versions.rb
 - app/controllers/easy_admin/application_controller.rb
 - app/controllers/easy_admin/batch_actions_controller.rb
 - app/controllers/easy_admin/confirmation_modal_controller.rb
@@ -299,6 +306,7 @@ files:
 - app/helpers/easy_admin/fields_helper.rb
 - app/helpers/easy_admin/pagy_helper.rb
 - app/helpers/easy_admin/resources_helper.rb
+- app/javascript/controllers/modal_controller.js
 - app/javascript/easy_admin.base.js
 - app/javascript/easy_admin/application.js
 - app/javascript/easy_admin/controllers.js
@@ -332,6 +340,7 @@ files:
 - app/javascript/easy_admin/controllers/table_row_controller.js
 - app/javascript/easy_admin/controllers/toggle_switch_controller.js
 - app/javascript/easy_admin/controllers/turbo_stream_redirect.js
+- app/javascript/easy_admin/controllers/version_revert_controller.js
 - app/models/easy_admin/admin_user.rb
 - app/models/easy_admin/application_record.rb
 - app/views/easy_admin/dashboard/index.html.erb
@@ -370,6 +379,7 @@ files:
 - lib/easy_admin/resource_registry.rb
 - lib/easy_admin/types/json_type.rb
 - lib/easy_admin/version.rb
+- lib/easy_admin/versioning.rb
 - lib/generators/easy_admin/auth_generator.rb
 - lib/generators/easy_admin/card/card_generator.rb
 - lib/generators/easy_admin/card/templates/card_component.rb.erb