ideasbugs 0.7.7 → 0.8.0

data/app/views/ideasbugs/feedbacks/index.html.erb

@@ -1,99 +1,101 @@
 <% content_for :body_class, 'ib-index' %>
 
-<h1><%= t('ideasbugs.dashboard.title', default: 'IdeasBugs') %></h1>
+<%= render layout: 'ideasbugs/shared/dashboard' do %>
+  <h1><%= t('ideasbugs.dashboard.title', default: 'IdeasBugs') %></h1>
 
-<div class="triage-shell <%= 'has-selected' if @selected_feedback %>">
-  <aside class="triage-sidebar" aria-label="<%= t('ideasbugs.dashboard.feedback', default: 'Feedback') %>">
-    <div class="tabs">
-      <% Ideasbugs::Feedback::STATUSES.each do |status| %>
-        <%= link_to feedbacks_path(status: status, kind: @kind, q: @query),
-                    class: ('active' if status == @status) do %>
-          <%= t("ideasbugs.statuses.#{status}", default: status.humanize) %>
-          <span class="count"><%= @counts.fetch(status, 0) %></span>
+  <div class="triage-shell <%= 'has-selected' if @selected_feedback %>">
+    <aside class="triage-sidebar" aria-label="<%= t('ideasbugs.dashboard.feedback', default: 'Feedback') %>">
+      <div class="tabs">
+        <% Ideasbugs::Feedback::STATUSES.each do |status| %>
+          <%= link_to feedbacks_path(status: status, kind: @kind, q: @query),
+                      class: ('active' if status == @status) do %>
+            <%= t("ideasbugs.statuses.#{status}", default: status.humanize) %>
+            <span class="count"><%= @counts.fetch(status, 0) %></span>
+          <% end %>
         <% end %>
-      <% end %>
-    </div>
+      </div>
 
-    <form class="filters" method="get">
-      <input type="hidden" name="status" value="<%= @status %>">
-      <select name="kind" onchange="this.form.submit()">
-        <option value=""><%= t('ideasbugs.dashboard.all_kinds', default: 'All types') %></option>
-        <% Ideasbugs.config.kinds.each do |kind| %>
-          <option value="<%= kind %>" <%= 'selected' if kind.to_s == @kind %>>
-            <%= t("ideasbugs.kinds.#{kind}", default: kind.to_s.humanize) %>
-          </option>
-        <% end %>
-      </select>
-      <input type="search" name="q" value="<%= @query %>"
-             placeholder="<%= t('ideasbugs.dashboard.search_placeholder', default: 'Search message, author, section…') %>"
-             aria-label="<%= t('ideasbugs.dashboard.search', default: 'Search') %>">
-      <button><%= t('ideasbugs.dashboard.search', default: 'Search') %></button>
-    </form>
+      <form class="filters" method="get">
+        <input type="hidden" name="status" value="<%= @status %>">
+        <select name="kind" onchange="this.form.submit()">
+          <option value=""><%= t('ideasbugs.dashboard.all_kinds', default: 'All types') %></option>
+          <% Ideasbugs.config.kinds.each do |kind| %>
+            <option value="<%= kind %>" <%= 'selected' if kind.to_s == @kind %>>
+              <%= t("ideasbugs.kinds.#{kind}", default: kind.to_s.humanize) %>
+            </option>
+          <% end %>
+        </select>
+        <input type="search" name="q" value="<%= @query %>"
+               placeholder="<%= t('ideasbugs.dashboard.search_placeholder', default: 'Search message, author, section…') %>"
+               aria-label="<%= t('ideasbugs.dashboard.search', default: 'Search') %>">
+        <button><%= t('ideasbugs.dashboard.search', default: 'Search') %></button>
+      </form>
 
-    <div class="feedback-list">
-      <% if @feedbacks.any? %>
-        <% @feedbacks.each do |feedback| %>
-          <%= link_to feedbacks_path(status: @status, kind: @kind, q: @query, page: @page,
-                                     feedback_id: feedback.id),
-                      class: ['feedback-row', ('active' if @selected_feedback&.id == feedback.id)].compact do %>
-            <span class="feedback-main">
-              <span class="feedback-topline">
-                <span class="badge kind-<%= feedback.kind.to_s.parameterize %>">
-                  <%= t("ideasbugs.kinds.#{feedback.kind}", default: feedback.kind.humanize) %>
+      <div class="feedback-list">
+        <% if @feedbacks.any? %>
+          <% @feedbacks.each do |feedback| %>
+            <%= link_to feedbacks_path(status: @status, kind: @kind, q: @query, page: @page,
+                                       feedback_id: feedback.id),
+                        class: ['feedback-row', ('active' if @selected_feedback&.id == feedback.id)].compact do %>
+              <span class="feedback-main">
+                <span class="feedback-topline">
+                  <span class="badge kind-<%= feedback.kind.to_s.parameterize %>">
+                    <%= t("ideasbugs.kinds.#{feedback.kind}", default: feedback.kind.humanize) %>
+                  </span>
+                  <span class="badge status-<%= feedback.status %>">
+                    <%= t("ideasbugs.statuses.#{feedback.status}", default: feedback.status.humanize) %>
+                  </span>
+                  <span class="muted feedback-time" title="<%= feedback.created_at %>">
+                    <%= time_ago_in_words(feedback.created_at) %>
+                  </span>
                 </span>
-                <span class="badge status-<%= feedback.status %>">
-                  <%= t("ideasbugs.statuses.#{feedback.status}", default: feedback.status.humanize) %>
+                <span class="feedback-message"><%= truncate(feedback.message, length: 120) %></span>
+                <span class="muted feedback-meta">
+                  <span>#<%= feedback.id %></span>
+                  <% if @show_section && feedback.section.present? %>
+                    <span class="feedback-section"><%= feedback.section %></span>
+                  <% end %>
+                  <% if feedback.author_label.present? %>
+                    <span><%= feedback.author_label %></span>
+                  <% end %>
                 </span>
-                <span class="muted feedback-time" title="<%= feedback.created_at %>">
-                  <%= time_ago_in_words(feedback.created_at) %>
-                </span>
-              </span>
-              <span class="feedback-message"><%= truncate(feedback.message, length: 120) %></span>
-              <span class="muted feedback-meta">
-                <span>#<%= feedback.id %></span>
-                <% if @show_section && feedback.section.present? %>
-                  <span class="feedback-section"><%= feedback.section %></span>
-                <% end %>
-                <% if feedback.author_label.present? %>
-                  <span><%= feedback.author_label %></span>
-                <% end %>
               </span>
-            </span>
-            <% if feedback.screenshots? %>
-              <span class="muted attachment-count">📎 <%= feedback.screenshots.count %></span>
+              <% if feedback.screenshots? %>
+                <span class="muted attachment-count">📎 <%= feedback.screenshots.count %></span>
+              <% end %>
             <% end %>
           <% end %>
+        <% else %>
+          <div class="empty"><%= t('ideasbugs.dashboard.empty', default: 'Nothing here yet.') %></div>
         <% end %>
-      <% else %>
-        <div class="empty"><%= t('ideasbugs.dashboard.empty', default: 'Nothing here yet.') %></div>
-      <% end %>
-    </div>
-
-    <div class="pager">
-      <% if @page > 1 %>
-        <%= link_to t('ideasbugs.dashboard.newer', default: '← Newer'),
-                    feedbacks_path(status: @status, kind: @kind, q: @query, page: @page - 1) %>
-      <% end %>
-      <% if @more %>
-        <%= link_to t('ideasbugs.dashboard.older', default: 'Older →'),
-                    feedbacks_path(status: @status, kind: @kind, q: @query, page: @page + 1) %>
-      <% end %>
-    </div>
-  </aside>
+      </div>
 
-  <main class="triage-detail" aria-label="<%= t('ideasbugs.dashboard.current_feedback', default: 'Current feedback') %>">
-    <% if @selected_feedback %>
-      <p class="mobile-back">
-        <%= link_to t('ideasbugs.dashboard.back', default: '← All feedback'),
-                    feedbacks_path(status: @status, kind: @kind, q: @query, page: @page) %>
-      </p>
-      <%= render 'feedback_panel', feedback: @selected_feedback %>
-    <% else %>
-      <div class="empty-state">
-        <h2><%= t('ideasbugs.dashboard.select_feedback', default: 'Select feedback') %></h2>
-        <p class="muted"><%= t('ideasbugs.dashboard.select_feedback_hint',
-                               default: 'Open an item from the list to triage it without leaving the queue.') %></p>
+      <div class="pager">
+        <% if @page > 1 %>
+          <%= link_to t('ideasbugs.dashboard.newer', default: '← Newer'),
+                      feedbacks_path(status: @status, kind: @kind, q: @query, page: @page - 1) %>
+        <% end %>
+        <% if @more %>
+          <%= link_to t('ideasbugs.dashboard.older', default: 'Older →'),
+                      feedbacks_path(status: @status, kind: @kind, q: @query, page: @page + 1) %>
+        <% end %>
       </div>
-    <% end %>
-  </main>
-</div>
+    </aside>
+
+    <main class="triage-detail" aria-label="<%= t('ideasbugs.dashboard.current_feedback', default: 'Current feedback') %>">
+      <% if @selected_feedback %>
+        <p class="mobile-back">
+          <%= link_to t('ideasbugs.dashboard.back', default: '← All feedback'),
+                      feedbacks_path(status: @status, kind: @kind, q: @query, page: @page) %>
+        </p>
+        <%= render 'feedback_panel', feedback: @selected_feedback %>
+      <% else %>
+        <div class="empty-state">
+          <h2><%= t('ideasbugs.dashboard.select_feedback', default: 'Select feedback') %></h2>
+          <p class="muted"><%= t('ideasbugs.dashboard.select_feedback_hint',
+                                 default: 'Open an item from the list to triage it without leaving the queue.') %></p>
+        </div>
+      <% end %>
+    </main>
+  </div>
+<% end %>

data/app/views/ideasbugs/feedbacks/show.html.erb

@@ -1,8 +1,10 @@
 <% content_for :body_class, 'ib-show' %>
 
-<div class="breadcrumb">
-  <%= link_to t('ideasbugs.dashboard.title', default: 'IdeasBugs'), root_path %>
-  / #<%= @feedback.id %>
-</div>
+<%= render layout: 'ideasbugs/shared/dashboard' do %>
+  <div class="breadcrumb">
+    <%= link_to t('ideasbugs.dashboard.title', default: 'IdeasBugs'), root_path %>
+    / #<%= @feedback.id %>
+  </div>
 
-<%= render 'feedback_panel', feedback: @feedback %>
+  <%= render 'feedback_panel', feedback: @feedback %>
+<% end %>

data/app/views/ideasbugs/shared/_dashboard.html.erb

@@ -0,0 +1,13 @@
+<%# The dashboard's own shell, rendered by the views rather than the layout.
+    That is deliberate: `config.admin_layout` and `config.base_controller_class`
+    both let a host replace the layout, and a stylesheet declared in a layout the
+    host replaces simply vanishes — the dashboard then renders unstyled.
+    Declaring it here means every layout works, host or gem.
+
+    The `ib-dashboard` wrapper is what scopes dashboard.css (see the comment at
+    the top of that file), so it has to enclose the content, not precede it. %>
+<%= stylesheet_link_tag "#{dashboard_stylesheet_path}?v=#{Ideasbugs::Widget.dashboard_stylesheet_fingerprint}",
+                        'data-turbo-track': 'reload' %>
+<div class="ib-dashboard">
+  <%= yield %>
+</div>

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

@@ -5,12 +5,15 @@
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
-  <%= stylesheet_link_tag "#{dashboard_stylesheet_path}?v=#{Ideasbugs::Widget.dashboard_stylesheet_fingerprint}",
-                          'data-turbo-track': 'reload' %>
+  <%# The dashboard's stylesheet is declared by the views
+      (ideasbugs/shared/_dashboard), not here, so it survives a host replacing
+      this layout via config.admin_layout or config.base_controller_class. %>
 </head>
-<body class="<%= content_for?(:body_class) ? yield(:body_class) : '' %>">
-  <div class="container">
-    <%= yield %>
+<body class="ib-page <%= content_for?(:body_class) ? yield(:body_class) : '' %>">
+  <div class="ib-dashboard">
+    <div class="container">
+      <%= yield %>
+    </div>
   </div>
 </body>
 </html>

data/config/routes.rb

@@ -5,8 +5,12 @@ Ideasbugs::Engine.routes.draw do
   get 'widget.js', to: 'widgets#show', as: :widget
   get 'dashboard.css', to: 'widgets#dashboard_stylesheet', as: :dashboard_stylesheet
 
-  # create is the public widget endpoint; the rest is the triage dashboard.
-  resources :feedbacks, only: %i[create index show update destroy] do
+  # POST goes to SubmissionsController, not to this resource: the widget's write
+  # endpoint is public and the rest is staff-only, and only the staff half
+  # inherits config.base_controller_class. Sharing one controller would put a
+  # host's admin authentication in front of someone filing a report.
+  post 'feedbacks', to: 'submissions#create', as: :submissions
+  resources :feedbacks, only: %i[index show update destroy] do
     # Screenshots stream through the dashboard's own gate, never via public
     # Active Storage blob URLs.
     resources :screenshots, only: :show

data/lib/generators/ideasbugs/install/install_generator.rb

@@ -2,11 +2,13 @@
 
 require 'rails/generators'
 require 'rails/generators/active_record'
+require_relative '../migration_helpers'
 
 module Ideasbugs
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include ActiveRecord::Generators::Migration
+      include MigrationHelpers
 
       source_root File.expand_path('templates', __dir__)
 
@@ -31,12 +33,6 @@ module Ideasbugs
         say 'Optional: run `bin/rails ideasbugs:seed_demo` for sample feedback.'
         say "Browse submissions at /feedback (development only until you set config.authorize_admin).\n"
       end
-
-      private
-
-      def migration_version
-        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      end
     end
   end
 end

data/lib/generators/ideasbugs/install/templates/create_ideasbugs_feedbacks.rb.tt

@@ -2,7 +2,7 @@
 
 class CreateIdeasbugsFeedbacks < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :ideasbugs_feedbacks do |t|
+    create_table :ideasbugs_feedbacks<%= primary_key_type_option %> do |t|
       t.string :kind, null: false, default: 'other'
       t.string :section
       t.text :message, null: false

data/lib/generators/ideasbugs/install/templates/initializer.rb

@@ -11,6 +11,14 @@ Ideasbugs.configure do |config|
   #
   # Render the dashboard inside your app's admin layout. Default: the gem's
   # standalone dashboard layout.
+  # Two ways to put the dashboard inside an admin you already have.
+  #
+  # The whole stack — your layout, helpers, authentication and any request
+  # context your before_actions set up. Only the dashboard inherits it; the
+  # widget's endpoint stays public, so this cannot gate a bug report.
+  # config.base_controller_class = "Admin::BaseController"
+  #
+  # Or the layout alone:
   # config.admin_layout = "admin/application"
 
   # Attribute feedback to a user (optional). Return an object responding to

data/lib/generators/ideasbugs/migration_helpers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Ideasbugs
+  module Generators
+    # Shared bits every migration-writing generator needs.
+    module MigrationHelpers
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      # Follow the host's own key type instead of forcing bigint. An app that
+      # keys its models with uuids has a uuid
+      # `active_storage_attachments.record_id`, so a bigint table here could
+      # never take a screenshot: the foreign key has nowhere to point and
+      # `attach` raises NotNullViolation.
+      #
+      # Same lookup Rails' own Active Storage, Action Text and Action Mailbox
+      # migrations do, so a host that set it once gets consistent tables from
+      # all of them.
+      #
+      # Rendered as a `create_table` option rather than a bare value, because a
+      # template is expanded at generate time: emitting the method name would
+      # put `id: primary_key_type` in the migration, where nothing defines it.
+      def primary_key_type_option
+        config = Rails.configuration.generators
+        type = config.options[config.orm][:primary_key_type]
+        type ? ", id: :#{type}" : ''
+      end
+    end
+  end
+end

data/lib/generators/ideasbugs/tenant/tenant_generator.rb

@@ -2,6 +2,7 @@
 
 require 'rails/generators'
 require 'rails/generators/active_record'
+require_relative '../migration_helpers'
 
 module Ideasbugs
   module Generators
@@ -14,6 +15,7 @@ module Ideasbugs
     #   bin/rails generate ideasbugs:tenant && bin/rails db:migrate
     class TenantGenerator < Rails::Generators::Base
       include ActiveRecord::Generators::Migration
+      include MigrationHelpers
 
       source_root File.expand_path('templates', __dir__)
 
@@ -28,12 +30,6 @@ module Ideasbugs
         say "\ntenant column queued. Run `rails db:migrate`, then set", :green
         say 'config.tenant in config/initializers/ideasbugs.rb to scope per tenant.'
       end
-
-      private
-
-      def migration_version
-        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      end
     end
   end
 end

data/lib/ideasbugs/configuration.rb

@@ -5,6 +5,10 @@ module Ideasbugs
   # works with zero configuration; the hooks below let an app decide who can
   # send feedback, who can read it, and how submissions are attributed.
   class Configuration
+    # The gem's own dashboard layout. Compared against, so DashboardController
+    # can tell "the host left this alone" from "the host chose this".
+    DEFAULT_ADMIN_LAYOUT = 'ideasbugs/application'
+
     # Per-request gate for the widget and the submission endpoint. Return false
     # to hide the widget and reject submissions for this request. Receives the
     # request. Defaults to everyone — feedback collection is meant for real
@@ -20,6 +24,21 @@ module Ideasbugs
     # inside your app's admin shell, e.g. "admin/application".
     attr_accessor :admin_layout
 
+    # The controller the DASHBOARD inherits from, as a String so it resolves
+    # lazily rather than at config time. Default: a plain
+    # 'ActionController::Base', where `authorize_admin` is the only gate.
+    #
+    # Name the controller your own admin already inherits from and the dashboard
+    # adopts that whole stack — layout, helpers, authentication, and any request
+    # context your before_actions set up. `admin_layout` covers only the layout,
+    # which leaves a host layout calling its own helpers to raise NameError under
+    # the engine's isolated namespace.
+    #
+    # Only the dashboard uses it. The widget's endpoint stays on the engine's own
+    # public controller, so an admin base controller here can never demand a
+    # staff session from someone filing a report.
+    attr_accessor :base_controller_class
+
     # Resolve the current user for attribution (optional). Return an object
     # responding to #id, or nil. Receives the request.
     attr_accessor :current_user
@@ -83,7 +102,8 @@ module Ideasbugs
     def initialize
       @enabled = ->(_request) { true }
       @authorize_admin = ->(_request) { Rails.env.development? }
-      @admin_layout = 'ideasbugs/application'
+      @admin_layout = DEFAULT_ADMIN_LAYOUT
+      @base_controller_class = 'ActionController::Base'
       @current_user = ->(_request) {}
       @tenant = ->(_request) {}
       @author_label = ->(user) { user.respond_to?(:email) ? user.email : user&.to_s }