ideasbugs 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8959223a89b198251b3fe0697330ebe2fe2054bfa8c0a258bb3ef9470d3f171b
-  data.tar.gz: fb7b3d95aac04d6e70942377b714771cd33ac10732d29833405446425c1ab8f2
+  metadata.gz: 6658dd5686d24377bb3d968e620282473b8b4769a02f11cfcc4ef5fbf2ba4ae9
+  data.tar.gz: a12d3f136d6c693f020a56b703b1c3bd050527e2045585dc1a080197977827bb
 SHA512:
-  metadata.gz: 304eb89d1bd1529e54356e8eaa647f004c85f7cc5eddf040fa746cc3c5a5a654a26da06235fd57d1010da3c477fbf7d45fb143d99775c73f38af02971c372b85
-  data.tar.gz: e54f393078ca2e69afc9ecba2b81bb44849ce91c69501c14e84af4c820daa586bf421079f75c66b601086eee99be505832950804631d0f1624a0edaa4e58ac1a
+  metadata.gz: b002bc9672adf86e27a2b59e62c88b745d4b6a1449777f78308627abc8894d92b9538191ff562e9b3cf271fed9adaa3ec0425ba05b9148505f3bab963112c59d
+  data.tar.gz: f05923a9dd619623f615c756261100e0c726b6a80e592dd1dc9ada985226f88e76ed12a5333eb67d375e4478e94e1f40a160df4f46b44bebc779b592e55e1a93

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.6.0 (2026-07-26)
+
+- **Multi-tenancy.** Give each customer/tenant its own board — its own widget
+  submissions and its own triage dashboard — via one resolver:
+  `config.tenant = ->(request) { Current.organization&.to_gid&.to_s }`. The key
+  is an opaque string (GlobalID, id, subdomain, slug); the gem takes no foreign
+  key into your models, exactly like author attribution. Every submission is
+  stamped and the dashboard (plus screenshot access) scopes to the resolved
+  tenant. Authorization composes: `authorize_admin` says who's an admin,
+  `tenant` says which tenant, so a customer's admin sees only their own — and a
+  cross-tenant id 404s instead of leaking.
+- Optional `has_feedback` model concern (veneer over the string key, no new
+  coupling): `customer.feedback.open` — plus `Ideasbugs.for(record)`.
+- **Single-tenant apps are unchanged** — `config.tenant` defaults to nil, one
+  global board. Upgrading: the `tenant` column is additive and nullable; run
+  `bin/rails generate ideasbugs:tenant && bin/rails db:migrate` (fresh installs
+  already include it). Existing rows keep a nil tenant.
+
+## 0.5.5 (2026-07-25)
+
+- The dashboard's **Section** column now only appears when it carries
+  information — when sections are configured (`config.sections`) or some
+  record already has one. Apps that don't use sections no longer see a
+  permanently blank column.
+
 ## 0.5.4 (2026-07-25)
 
 - Docs: show how to wire current_user with Rails 8's built-in authentication

data/README.md

@@ -302,10 +302,48 @@ end
 ```
 
 Each row stores `kind`, `section`, `message`, `status` (`open`, `in_review`,
-`resolved`), `page_url`, `user_agent`, and optional `author_id` /
-`author_label`. Screenshots are Active Storage attachments
+`resolved`), `page_url`, `user_agent`, an optional `tenant`, and optional
+`author_id` / `author_label`. Screenshots are Active Storage attachments
 (`feedback.screenshots`).
 
+## Multi-tenancy
+
+Give each customer/tenant its own board — its own widget submissions and its
+own triage dashboard — with one resolver:
+
+```ruby
+config.tenant = ->(request) { Current.organization&.to_gid&.to_s }
+```
+
+Return an **opaque key** — a GlobalID, an id, a subdomain, a slug. The gem
+never takes a foreign key into your models and never needs to know what a
+Customer is; it just stamps the key on each submission and scopes the dashboard
+(and screenshot access) to it. `nil` (the default) is a single global board —
+single-tenant apps need none of this and keep working unchanged.
+
+Authorization composes: your `authorize_admin` says *who* is an admin, the
+`tenant` resolver says *which* tenant they're in, so a customer's admin sees
+only their own board — and a cross-tenant id 404s.
+
+Optional model sugar — a veneer over the string key, not a new coupling:
+
+```ruby
+class Customer < ApplicationRecord
+  has_feedback                       # keyed by to_gid.to_s (match config.tenant)
+end
+
+customer.feedback.open               # a normal Active Record relation
+```
+
+Apps that skip the concern still get full multi-tenancy from the resolver
+alone. Key by something other than GlobalID? Pass a matching resolver to both:
+`has_feedback(key: ->(c){ c.subdomain })` and the same in `config.tenant`.
+
+**Upgrading an existing install:** the `tenant` column is additive and
+nullable. Run `bin/rails generate ideasbugs:tenant && bin/rails db:migrate`
+(a fresh install already includes it). Existing rows keep a `nil` tenant — the
+global board — so nothing changes until you set `config.tenant`.
+
 ## Security
 
 - Submission and dashboard access are both gated **on the server** for every

data/app/controllers/ideasbugs/application_controller.rb

@@ -11,5 +11,14 @@ module Ideasbugs
 
       @current_author = Ideasbugs.config.current_user.call(request)
     end
+
+    # The tenant for this request (nil = the single global board). Every read
+    # and write scopes to it, so a resolved-tenant admin only ever sees and
+    # writes their own tenant's feedback.
+    def current_tenant
+      return @current_tenant if defined?(@current_tenant)
+
+      @current_tenant = Ideasbugs.tenant(request)
+    end
   end
 end

data/app/controllers/ideasbugs/feedbacks_controller.rb

@@ -26,15 +26,20 @@ module Ideasbugs
       @status = Feedback::STATUSES.include?(params[:status]) ? params[:status] : 'open'
       @kind = Ideasbugs.config.kinds.map(&:to_s).include?(params[:kind]) ? params[:kind] : nil
       @query = params[:q].to_s.strip.presence
-      @counts = Feedback.group(:status).count
+      @counts = tenant_scope.group(:status).count
 
-      scope = Feedback.where(status: @status)
+      scope = tenant_scope.where(status: @status)
       scope = scope.where(kind: @kind) if @kind
       scope = search(scope) if @query
       @page = [params[:page].to_i, 1].max
       @feedbacks = scope.newest_first.offset((@page - 1) * PER_PAGE).limit(PER_PAGE + 1).to_a
       @more = @feedbacks.size > PER_PAGE
       @feedbacks = @feedbacks.first(PER_PAGE)
+
+      # Only surface the Section column when it can carry information: the host
+      # configured sections, or some record already has one (e.g. sections were
+      # configured historically). Otherwise it's a permanently blank column.
+      @show_section = Ideasbugs.config.sections.any? || @feedbacks.any? { |f| f.section.present? }
     end
 
     def show; end
@@ -42,6 +47,7 @@ module Ideasbugs
     def create
       feedback = Feedback.new(feedback_params)
       feedback.user_agent = request.user_agent
+      feedback.tenant = current_tenant
       attribute_author(feedback)
 
       error = attach_screenshots(feedback)
@@ -80,7 +86,13 @@ module Ideasbugs
     end
 
     def set_feedback
-      @feedback = Feedback.find(params[:id])
+      @feedback = tenant_scope.find(params[:id])
+    end
+
+    # Every dashboard query starts here, so an admin can only ever load,
+    # triage, or delete feedback in their own tenant — a cross-tenant id 404s.
+    def tenant_scope
+      Feedback.for_tenant(current_tenant)
     end
 
     # Case-insensitive match on the free-text columns. LOWER() keeps it

data/app/controllers/ideasbugs/screenshots_controller.rb

@@ -10,7 +10,8 @@ module Ideasbugs
     before_action :require_admin
 
     def show
-      screenshot = Feedback.find(params[:feedback_id]).screenshots.find(params[:id])
+      screenshot = Feedback.for_tenant(current_tenant)
+                           .find(params[:feedback_id]).screenshots.find(params[:id])
 
       send_data screenshot.download,
                 filename: screenshot.filename.to_s,

data/app/models/ideasbugs/feedback.rb

@@ -17,6 +17,11 @@ module Ideasbugs
               presence: true,
               inclusion: { in: ->(_) { Ideasbugs.config.kinds.map(&:to_s) } }
 
+    # Multi-tenancy: everything is scoped to an opaque tenant key (nil = the
+    # single global board). Loose-coupled like author_id — a string, no FK
+    # into the host's tables. See Ideasbugs.config.tenant.
+    scope :for_tenant, ->(tenant) { where(tenant: tenant.presence) }
+
     scope :newest_first, -> { order(id: :desc) }
 
     STATUSES.each do |status|

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

@@ -33,7 +33,9 @@
         <tr>
           <th><%= t('ideasbugs.kind', default: 'Type') %></th>
           <th><%= t('ideasbugs.dashboard.message', default: 'Message') %></th>
-          <th><%= t('ideasbugs.section', default: 'Section') %></th>
+          <% if @show_section %>
+            <th><%= t('ideasbugs.section', default: 'Section') %></th>
+          <% end %>
           <th><%= t('ideasbugs.dashboard.from', default: 'From') %></th>
           <th><%= t('ideasbugs.dashboard.filed', default: 'Filed') %></th>
         </tr>
@@ -52,7 +54,9 @@
                 <div class="muted">📎 <%= feedback.screenshots.count %></div>
               <% end %>
             </td>
-            <td><%= feedback.section %></td>
+            <% if @show_section %>
+              <td><%= feedback.section %></td>
+            <% end %>
             <td><%= feedback.author_label %></td>
             <td class="muted" title="<%= feedback.created_at %>">
               <%= time_ago_in_words(feedback.created_at) %>

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

@@ -11,11 +11,13 @@ class CreateIdeasbugsFeedbacks < ActiveRecord::Migration<%= migration_version %>
       t.string :user_agent
       t.string :author_id
       t.string :author_label
+      t.string :tenant # opaque per-tenant key; nil = single global board
 
       t.timestamps
     end
 
     add_index :ideasbugs_feedbacks, :status
     add_index :ideasbugs_feedbacks, :kind
+    add_index :ideasbugs_feedbacks, %i[tenant status]
   end
 end

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

@@ -23,6 +23,19 @@ Ideasbugs.configure do |config|
   # Label stored for the author and shown in the dashboard.
   # config.author_label = ->(user) { user.try(:email) }
 
+  # Multi-tenancy (optional). Give each customer/tenant its own board — its own
+  # widget submissions and its own triage dashboard. Return an opaque key
+  # (nil = one global board, the default). A GlobalID is the recommended key
+  # and matches the `has_feedback` model concern; an id, subdomain or slug work
+  # too. The gem never needs to know what your tenant is. An admin then sees
+  # only their tenant's board.
+  # config.tenant = ->(request) { Current.organization&.to_gid&.to_s }
+  #
+  # Then, optionally, `has_feedback` for `customer.feedback`:
+  #   class Customer < ApplicationRecord
+  #     has_feedback
+  #   end
+
   # Feedback types users can pick from. Labels come from I18n
   # (ideasbugs.kinds.<kind>).
   # config.kinds = %w[bug feature other]

data/lib/generators/ideasbugs/tenant/templates/add_tenant_to_ideasbugs_feedbacks.rb.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddTenantToIdeasbugsFeedbacks < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :ideasbugs_feedbacks, :tenant, :string
+    add_index :ideasbugs_feedbacks, %i[tenant status]
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Ideasbugs
+  module Generators
+    # For apps that installed ideasbugs before multi-tenancy: adds the nullable
+    # `tenant` column (and its index) to ideasbugs_feedbacks. A fresh install
+    # already gets it via the install generator — run this one only to upgrade
+    # an existing install. Additive and safe: existing rows keep a nil tenant
+    # (the single global board), so nothing changes until you set config.tenant.
+    #
+    #   bin/rails generate ideasbugs:tenant && bin/rails db:migrate
+    class TenantGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Adds the tenant column to ideasbugs_feedbacks (multi-tenancy upgrade).'
+
+      def create_migration_file
+        migration_template 'add_tenant_to_ideasbugs_feedbacks.rb.tt',
+                           'db/migrate/add_tenant_to_ideasbugs_feedbacks.rb'
+      end
+
+      def post_install
+        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

@@ -20,6 +20,15 @@ module Ideasbugs
     # responding to #id, or nil. Receives the request.
     attr_accessor :current_user
 
+    # Resolve the current tenant (optional, for multi-tenant apps). Return an
+    # opaque key — a GlobalID, an id, a subdomain, a slug — or nil. Receives
+    # the request; shaped exactly like current_user/authorize_admin. nil (the
+    # default) is a single, global board: today's behavior, unchanged. Each
+    # submission is stamped with it and the dashboard scopes to it, so every
+    # tenant gets its own board. The recommended key is a GlobalID
+    # (`record.to_gid.to_s`), which also matches the `has_feedback` concern.
+    attr_accessor :tenant
+
     # Turn a resolved user into a short label stored alongside the feedback and
     # shown in the dashboard. Receives whatever #current_user returned.
     attr_accessor :author_label
@@ -67,6 +76,7 @@ module Ideasbugs
       @enabled = ->(_request) { true }
       @authorize_admin = ->(_request) { Rails.env.development? }
       @current_user = ->(_request) {}
+      @tenant = ->(_request) {}
       @author_label = ->(user) { user.respond_to?(:email) ? user.email : user&.to_s }
       @kinds = %w[bug feature other]
       @sections = []

data/lib/ideasbugs/engine.rb

@@ -9,5 +9,13 @@ module Ideasbugs
         include Ideasbugs::WidgetHelper
       end
     end
+
+    # Make the optional `has_feedback` model macro available on every Active
+    # Record model, without requiring the host to include anything.
+    initializer 'ideasbugs.model' do
+      ActiveSupport.on_load(:active_record) do
+        extend Ideasbugs::HasFeedback
+      end
+    end
   end
 end

data/lib/ideasbugs/has_feedback.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Ideasbugs
+  # Optional sugar for multi-tenant apps. `has_feedback` on a host model gives
+  # it a `.feedback` relation, keyed by the record's GlobalID — the documented
+  # tenant convention:
+  #
+  #   class Customer < ApplicationRecord
+  #     has_feedback
+  #   end
+  #   customer.feedback.open   # a normal Active Record relation
+  #
+  # It's a pure veneer over `Feedback.for_tenant(...)` — no association, no
+  # foreign key, no `owner_type` class-name coupling. Apps that don't want it
+  # still get full multi-tenancy through `config.tenant` alone.
+  #
+  # The write side lines up automatically when the tenant resolver produces the
+  # same GlobalID key, e.g. `config.tenant = ->(r){ Current.customer.to_gid.to_s }`.
+  # Key by something else? Pass a matching resolver: `has_feedback(key:
+  # ->(c){ c.subdomain })` — and use the same in `config.tenant`.
+  module HasFeedback
+    def has_feedback(as: :feedback, key: nil) # rubocop:disable Naming/PredicatePrefix
+      resolver = key || ->(record) { record.to_gid.to_s }
+
+      define_method(as) { Ideasbugs::Feedback.for_tenant(resolver.call(self)) }
+    end
+  end
+end

data/lib/ideasbugs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ideasbugs
-  VERSION = '0.5.4'
+  VERSION = '0.6.0'
 end

data/lib/ideasbugs.rb

@@ -3,6 +3,7 @@
 require 'ideasbugs/version'
 require 'ideasbugs/configuration'
 require 'ideasbugs/widget'
+require 'ideasbugs/has_feedback'
 require 'ideasbugs/engine'
 
 # In-app product feedback collection for Rails. A drop-in widget lets users
@@ -30,5 +31,29 @@ module Ideasbugs
     def admin?(request)
       !!config.authorize_admin.call(request)
     end
+
+    # The tenant key for this request, or nil for the single global board.
+    # Normalized to a string so `where(tenant:)` is consistent whether the
+    # resolver returns a GlobalID, an integer id, or a slug; blank becomes nil.
+    def tenant(request)
+      config.tenant.call(request).presence&.to_s
+    end
+
+    # The feedback belonging to a host record, keyed by its GlobalID — the
+    # documented tenant convention. Sugar for `Feedback.for_tenant(...)`; the
+    # `has_feedback` model concern is built on this.
+    def for(record)
+      Feedback.for_tenant(tenant_key_for(record))
+    end
+
+    private
+
+    # A host record's tenant key: its GlobalID string. Kept in one place so
+    # `.for` and `has_feedback` agree — and so a host wiring
+    # `config.tenant = ->(r){ Current.org.to_gid.to_s }` lines up with
+    # `organization.feedback`.
+    def tenant_key_for(record)
+      record.respond_to?(:to_gid) ? record.to_gid.to_s : record.to_s
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ideasbugs
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Yaroslav Shmarov
@@ -78,9 +78,12 @@ files:
 - lib/generators/ideasbugs/install/install_generator.rb
 - lib/generators/ideasbugs/install/templates/create_ideasbugs_feedbacks.rb.tt
 - lib/generators/ideasbugs/install/templates/initializer.rb
+- lib/generators/ideasbugs/tenant/templates/add_tenant_to_ideasbugs_feedbacks.rb.tt
+- lib/generators/ideasbugs/tenant/tenant_generator.rb
 - lib/ideasbugs.rb
 - lib/ideasbugs/configuration.rb
 - lib/ideasbugs/engine.rb
+- lib/ideasbugs/has_feedback.rb
 - lib/ideasbugs/version.rb
 - lib/ideasbugs/widget.js
 - lib/ideasbugs/widget.rb