lsa_tdx_feedback 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cbc671304d3c3452ec0391cac7dbcb0a03cf3ce8ad49eed9381ea4ad91e0ecc
-  data.tar.gz: 6f4df6c28cb3af52851e8c13b249e269f3eefed11cbe091d3b0161b0b3a9d3bd
+  metadata.gz: 2688de4eb43f66ca59ebecee11a93685a13b03b6f28dd49138748503b8266828
+  data.tar.gz: 780e62b78b1a4fca899e8a90dcbf9956189fef71c4008fe5d5b84eec807716a0
 SHA512:
-  metadata.gz: a57274ebc7706e25024df0d1c496a6a2b41f7fa9b13bbfd92a60154a9e39c1343c306a0fbc8165e9237217b41d47cdcffc03cf84395c5dfccefd4ab76ca35ea0
-  data.tar.gz: 717699dfeb877349310d492e04a36f70770a9c456c609358bf963bffbfcd9de0332edf6b74c4022ade130131b2df5c04b10beadbb0cb142264a57ba9ccf178f9
+  metadata.gz: b2934aef5a781f0454893c482f0bdea846c2cf6fed171d5677c0ce55dee93581221eff9c12b6345f5be8f61bc92493b87bb3a7e33a57244eca1eb9065d5f13de
+  data.tar.gz: ad7a6d864c9bee29a5cb311eebf4ad040bd57cd5db2505344fc16f9f4e7ef11344509cd42f6043e2bee3a746698d4d44630f4765d9c9355f841239639f83b5c5

data/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- **Documentation**: Added Rails 8 authentication setup instructions to README
+  - Step-by-step guide for generating Rails 8.1.1's built-in authentication system
+  - Instructions for creating `current_user` helper method to match Devise pattern
+  - Examples for protecting actions and excluding authentication for specific controllers
+  - Documentation on using `allow_unauthenticated_access` for public pages
+
+## [1.0.3] - 2025-12-08
+
+### Fixed
+- **Turbo Drive Compatibility**: Fixed feedback button not working after Turbo navigation
+  - Added proper event listener cleanup to prevent duplicate handlers
+  - Added support for `turbo:load` and `turbo:frame-load` events
+  - Re-initializes feedback functionality on each Turbo navigation
+  - Prevents memory leaks by properly removing old event listeners before attaching new ones
+  - Maintains backward compatibility with traditional page loads
+
 ## [1.0.2] - 2025-01-27
 
 ### Fixed
@@ -16,7 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - **TDX API Integration Issues**: Resolved HTTP 422 errors when creating tickets
-  - Fixed invalid Classification value (changed from 300 to 46)
+  - Fixed invalid Classification value
   - Updated configuration validation to handle both string and integer values for `default_classification`
   - Simplified ticket payload structure to include only essential fields
   - Fixed string interpolation in `build_description` method

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lsa_tdx_feedback (1.0.1)
+    lsa_tdx_feedback (1.0.2)
       httparty (~> 0.22)
       rails (>= 6.0)
       redis (>= 4.0)
@@ -174,7 +174,7 @@ GEM
       stringio
     public_suffix (6.0.2)
     racc (1.8.1)
-    rack (3.2.1)
+    rack (3.2.3)
     rack-session (2.1.1)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)

data/README.md

@@ -238,6 +238,173 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Rails 8 Authentication Setup
+
+If you're using Rails 8.1.1's built-in authentication system, here's how to set it up and create a `current_user` helper method similar to Devise.
+
+### Step 1: Generate the Authentication System
+
+Run the Rails generator:
+
+```bash
+bin/rails generate authentication
+```
+
+This creates:
+
+- User model
+- Session model
+- Current class (for per-request attributes)
+- Controllers (SessionsController, PasswordsController)
+- Views for login/password reset
+- Migrations
+
+### Step 2: Run Migrations
+
+```bash
+bin/rails db:migrate
+```
+
+### Step 3: Add current_user initializer for Rails 8 internal controllers
+Creating an initializer to make current_user available to all controllers, including Rails internals:
+
+```ruby
+# config/initializers/current_user.rb
+# Make current_user available to all controllers, including Rails internal controllers
+# This is needed for gems like lsa_tdx_feedback that call current_user on all controllers
+ActionController::Base.class_eval do
+  helper_method :current_user
+
+  private
+
+  def current_user
+    # Use Current.user if available (set by ApplicationController)
+    return Current.user if Current.user
+
+    # For controllers that don't inherit from ApplicationController,
+    # try to find the session manually
+    return nil unless respond_to?(:cookies, true)
+
+    begin
+      session_id = cookies.signed[:session_id] if cookies.signed
+      return nil unless session_id
+
+      session = Session.find_by(id: session_id)
+      session&.user
+    rescue => e
+      # If anything goes wrong (e.g., database not available), return nil
+      Rails.logger.debug("Error in current_user: #{e.message}") if defined?(Rails.logger)
+      nil
+    end
+  end
+end
+```
+
+This makes `current_user` available in all controllers and views, including Rails internals like ActionController::Base.
+
+### Step 3A: Create an initializer (config/initializers/lsa_tdx_feedback.rb) that skips authentication for the feedback controller, since feedback forms should be public
+
+```ruby
+# Configure lsa_tdx_feedback gem to allow unauthenticated access
+# Feedback forms should be accessible without authentication
+Rails.application.config.to_prepare do
+  if defined?(LsaTdxFeedback::FeedbackController)
+    LsaTdxFeedback::FeedbackController.class_eval do
+      # Skip authentication for feedback submissions
+      # Use raise: false to prevent errors if the before_action doesn't exist
+      skip_before_action :require_authentication, raise: false
+    end
+  end
+rescue => e
+  Rails.logger.warn("Could not configure LsaTdxFeedback: #{e.message}") if defined?(Rails.logger)
+end
+```
+
+and update request_authentication in the Authentication concern ( app/controllers/concerns/authentication.rb ) to use main_app.new_session_path so it works when called from engine controllers.
+
+```ruby
+# Update request_authentication in the Authentication concern to use main_app.new_session_path so it works when called from engine controllers.
+...
+      redirect_to main_app.new_session_path # around line 34 in the Authentication concern
+...
+```
+
+
+### Step 4: Protect Actions (Optional)
+
+To require authentication for specific actions:
+
+```ruby
+class SomeController < ApplicationController
+  before_action :require_authentication
+
+  private
+
+  def require_authentication
+    redirect_to new_session_path unless current_user
+  end
+end
+```
+
+### Excluding Authentication for Specific Controllers
+
+If you need to exclude authentication for specific controllers or actions (e.g., a public home page), use the `allow_unauthenticated_access` method provided by the Authentication concern:
+
+```ruby
+class HomeController < ApplicationController
+  allow_unauthenticated_access only: [:index]
+
+  def index
+  end
+end
+```
+
+This skips authentication only for the `index` action. The Authentication concern uses `skip_before_action :require_authentication` under the hood.
+
+**Alternative options:**
+
+If you want to skip authentication for all actions in the HomeController:
+
+```ruby
+class HomeController < ApplicationController
+  allow_unauthenticated_access
+
+  def index
+  end
+end
+```
+
+Or if you want to skip for multiple specific actions:
+
+```ruby
+class HomeController < ApplicationController
+  allow_unauthenticated_access only: [:index, :show]
+
+  def index
+  end
+end
+```
+
+The `only:` option limits it to specific actions, while omitting it skips authentication for all actions in that controller.
+
+### How It Works
+
+- `Current` is an `ActiveSupport::CurrentAttributes` class that stores per-request attributes
+- After login, `Current.user` is set to the authenticated user
+- `current_user` wraps `Current.user` for Devise-like usage
+- Works with authorization libraries like Pundit that expect `current_user`
+
+### Routes
+
+The generator adds routes like:
+
+- `new_session_path` - login page
+- `session_path` - create/destroy session
+- `new_password_path` - password reset request
+- etc.
+
+After running the generator, you can use `current_user` in controllers and views just like with Devise.
+
 ## TDX API Configuration
 
 ### Required TDX Settings

data/app/assets/javascripts/lsa_tdx_feedback.js

@@ -1,21 +1,33 @@
 /**
  * LsaTdxFeedback JavaScript - Self-contained feedback modal functionality
+ * Turbo Drive compatible
  */
 (function() {
   'use strict';
 
-  // Ensure we don't initialize multiple times
-  if (window.LsaTdxFeedback && window.LsaTdxFeedback.initialized) {
-    return;
-  }
-
   var LsaTdxFeedback = {
     initialized: false,
     modal: null,
     form: null,
+    handlers: {
+      triggerClick: null,
+      closeClick: null,
+      cancelClick: null,
+      backdropClick: null,
+      formSubmit: null,
+      escapeKey: null
+    },
 
     init: function() {
-      if (this.initialized) return;
+      // Clean up existing listeners if already initialized (for Turbo navigation)
+      if (this.initialized) {
+        this.cleanup();
+      }
+
+      // Reset state for re-initialization
+      this.initialized = false;
+      this.modal = null;
+      this.form = null;
 
       // Wait for DOM to be ready
       if (document.readyState === 'loading') {
@@ -27,6 +39,52 @@
       this.initialized = true;
     },
 
+    cleanup: function() {
+      // Remove all event listeners before re-initializing
+      var self = this;
+
+      if (this.handlers.triggerClick) {
+        var triggerBtn = document.getElementById('lsa-tdx-feedback-trigger');
+        if (triggerBtn) {
+          triggerBtn.removeEventListener('click', this.handlers.triggerClick);
+        }
+      }
+
+      if (this.modal) {
+        var closeBtn = this.modal.querySelector('.lsa-tdx-feedback-close-btn');
+        var cancelBtn = this.modal.querySelector('.lsa-tdx-feedback-cancel-btn');
+        var backdrop = this.modal.querySelector('.lsa-tdx-feedback-modal-backdrop');
+
+        if (closeBtn && this.handlers.closeClick) {
+          closeBtn.removeEventListener('click', this.handlers.closeClick);
+        }
+        if (cancelBtn && this.handlers.cancelClick) {
+          cancelBtn.removeEventListener('click', this.handlers.cancelClick);
+        }
+        if (backdrop && this.handlers.backdropClick) {
+          backdrop.removeEventListener('click', this.handlers.backdropClick);
+        }
+      }
+
+      if (this.form && this.handlers.formSubmit) {
+        this.form.removeEventListener('submit', this.handlers.formSubmit);
+      }
+
+      if (this.handlers.escapeKey) {
+        document.removeEventListener('keydown', this.handlers.escapeKey);
+      }
+
+      // Clear handler references
+      this.handlers = {
+        triggerClick: null,
+        closeClick: null,
+        cancelClick: null,
+        backdropClick: null,
+        formSubmit: null,
+        escapeKey: null
+      };
+    },
+
     bindEvents: function() {
       var self = this;
 
@@ -42,10 +100,11 @@
       // Trigger button
       var triggerBtn = document.getElementById('lsa-tdx-feedback-trigger');
       if (triggerBtn) {
-        triggerBtn.addEventListener('click', function(e) {
+        this.handlers.triggerClick = function(e) {
           e.preventDefault();
           self.showModal();
-        });
+        };
+        triggerBtn.addEventListener('click', this.handlers.triggerClick);
       }
 
       // Close buttons
@@ -54,39 +113,44 @@
       var backdrop = this.modal.querySelector('.lsa-tdx-feedback-modal-backdrop');
 
       if (closeBtn) {
-        closeBtn.addEventListener('click', function(e) {
+        this.handlers.closeClick = function(e) {
           e.preventDefault();
           self.hideModal();
-        });
+        };
+        closeBtn.addEventListener('click', this.handlers.closeClick);
       }
 
       if (cancelBtn) {
-        cancelBtn.addEventListener('click', function(e) {
+        this.handlers.cancelClick = function(e) {
           e.preventDefault();
           self.hideModal();
-        });
+        };
+        cancelBtn.addEventListener('click', this.handlers.cancelClick);
       }
 
       if (backdrop) {
-        backdrop.addEventListener('click', function(e) {
+        this.handlers.backdropClick = function(e) {
           if (e.target === backdrop) {
             self.hideModal();
           }
-        });
+        };
+        backdrop.addEventListener('click', this.handlers.backdropClick);
       }
 
       // Form submission
-      this.form.addEventListener('submit', function(e) {
+      this.handlers.formSubmit = function(e) {
         e.preventDefault();
         self.submitFeedback();
-      });
+      };
+      this.form.addEventListener('submit', this.handlers.formSubmit);
 
       // Escape key to close modal
-      document.addEventListener('keydown', function(e) {
-        if (e.key === 'Escape' && self.modal.style.display !== 'none') {
+      this.handlers.escapeKey = function(e) {
+        if (e.key === 'Escape' && self.modal && self.modal.style.display !== 'none') {
           self.hideModal();
         }
-      });
+      };
+      document.addEventListener('keydown', this.handlers.escapeKey);
     },
 
     showModal: function() {
@@ -226,6 +290,26 @@
   // Export to global scope
   window.LsaTdxFeedback = LsaTdxFeedback;
 
-  // Auto-initialize
-  LsaTdxFeedback.init();
+  // Initialize on DOM ready (for traditional page loads)
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', function() {
+      LsaTdxFeedback.init();
+    });
+  } else {
+    // DOM already loaded
+    LsaTdxFeedback.init();
+  }
+
+  // Initialize on Turbo navigation (for Turbo Drive)
+  document.addEventListener('turbo:load', function() {
+    LsaTdxFeedback.init();
+  });
+
+  // Also handle turbo:frame-load for Turbo Frames (optional)
+  document.addEventListener('turbo:frame-load', function(e) {
+    // Only re-initialize if the frame contains our elements
+    if (e.target.querySelector && e.target.querySelector('#lsa-tdx-feedback-trigger')) {
+      LsaTdxFeedback.init();
+    }
+  });
 })();

data/lib/lsa_tdx_feedback/version.rb

@@ -1,3 +1,3 @@
 module LsaTdxFeedback
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lsa_tdx_feedback
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - LSA Rails Team