RubyGems - testimonials - Versions diffs - 0.4.2 → 0.5.1 - Mend

testimonials 0.4.2 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +30 -0
data/README.md +41 -0
data/app/controllers/testimonials/api/stats_controller.rb +2 -2
data/app/controllers/testimonials/api/testimonials_controller.rb +1 -1
data/app/controllers/testimonials/application_controller.rb +9 -0
data/app/controllers/testimonials/collection_controller.rb +5 -2
data/app/controllers/testimonials/events_controller.rb +1 -1
data/app/controllers/testimonials/media_controller.rb +3 -1
data/app/controllers/testimonials/nps_controller.rb +3 -1
data/app/controllers/testimonials/nps_responses_controller.rb +7 -6
data/app/controllers/testimonials/testimonials_controller.rb +14 -5
data/app/helpers/testimonials/widget_helper.rb +7 -3
data/app/models/testimonials/nps_response.rb +1 -0
data/app/models/testimonials/prompt_event.rb +9 -6
data/app/models/testimonials/testimonial.rb +5 -0
data/lib/generators/testimonials/install/templates/create_testimonials_tables.rb.tt +8 -4
data/lib/generators/testimonials/install/templates/initializer.rb +13 -0
data/lib/generators/testimonials/tenant/templates/add_tenant_to_testimonials.rb.tt +15 -0
data/lib/generators/testimonials/tenant/tenant_generator.rb +40 -0
data/lib/testimonials/configuration.rb +10 -0
data/lib/testimonials/engine.rb +8 -0
data/lib/testimonials/has_testimonials.rb +29 -0
data/lib/testimonials/version.rb +1 -1
data/lib/testimonials/widget.js +7 -1
data/lib/testimonials.rb +29 -0
metadata +4 -1

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f32069743e1abbbe0f5ce913e32e0c37f1e23230c0f5d59bb903dd9189761153
-  data.tar.gz: fbae328897d5aea39f1896e55324df8182f08bae09e7907a30510dfd3026c82d
+  metadata.gz: 49da88f23d3967043d08ff98641b737b357b67b1bffc65cf4ac2f5e9ffad181c
+  data.tar.gz: '091174dcf7d158e560f6c047593ef9d8b9dd7c1a4be3461f4cde4d1923c9ea84'
 SHA512:
-  metadata.gz: c9345c6257864c1531782f4a7cdd1fd136118aab23898e57ae28723b13a27107f657d865b77947c0ac26de7ed06b143ce8cb2ffd0463a6cfc57c08f28cf90085
-  data.tar.gz: 27d79110f0b6e043373e0e2989f7f1947810d2c52a1c6e21b5f71e759739c9762f668e6e05f0bbb8a9e9879e38dcb4b61de8d3d276d626a89b1440e4c3af6e35
+  metadata.gz: e45f348b081c38c7e85bcad7fa2823594c75100e4ace6be42390e793f7438e748a4048a0a753d5f246222333fc241ddd227e8059e6e94ea0f63c11899269335d
+  data.tar.gz: 17c9adb10e7922c9d32fc7931e809c3f398983571f109e1705e6f224f22328463d1d06ff8e7416ed210a802a841822bfa3d84d3f060f7cc9b01c7d1897d8aaa6

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,35 @@
 # Changelog
+## 0.5.1
+- The widget's injected stylesheet now refreshes when its content changes
+  instead of once-and-never-again — so a shipped widget update takes effect on
+  the next Turbo visit instead of needing a full page reload (Turbo keeps
+  `<head>` across visits, which could otherwise pin old CSS while fresh
+  widget.js runs). Backported from livechat 0.4.5.
+## 0.5.0
+- **Multi-tenancy.** Scope testimonials to a tenant — each Organization (or
+  Product, Course, Store) with its own collection, dashboard, widget, and read
+  API — 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 write is stamped and every read — dashboard,
+  `/api/testimonials`, `/api/stats`, NPS, the public collection page, media —
+  is scoped to the resolved tenant. Authorization composes: `authorize_admin`
+  says who's an admin, `tenant` says which tenant, so an org admin sees only
+  their own. "One review per user" becomes one per user *per tenant*, and a
+  cross-tenant id 404s instead of leaking.
+- Optional `has_testimonials` model concern (veneer over the string key, no
+  new coupling): `organization.testimonials.approved`,
+  `organization.testimonials_nps` — plus `Testimonials.for(record)` /
+  `.nps_for(record)`.
+- **Single-tenant apps are unchanged** — `config.tenant` defaults to nil, one
+  global collection. Upgrading: the `tenant` column is additive and nullable;
+  run `bin/rails generate testimonials:tenant && bin/rails db:migrate` (fresh
+  installs already include it). Existing rows keep a nil tenant.
 ## 0.4.2
 - Uploaded videos now get a poster frame too (grabbed from the file

data/README.md CHANGED Viewed

@@ -177,6 +177,47 @@ quick-approve, inline video playback, feature toggle, and a “Best line” pick
 the customer's words are never editable, but you choose the pull-quote.
 Gated by `config.authorize_admin` (development-only until you set it).
+## Multi-tenancy
+Scope testimonials to a tenant — each Organization (or Product, Course, Store)
+with its own collection, dashboard, widget, and read API — 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 an
+Organization is; it just stamps the key on each submission and scopes every
+read (dashboard, `/api/testimonials`, `/api/stats`, NPS, the public collection
+page) to it. `nil` (the default) is a single global collection — 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 an org admin sees only
+their own tenant's dashboard and API. "One review per user" becomes one per
+user **per tenant**.
+Optional model sugar — a veneer over the string key, not a new coupling:
+```ruby
+class Organization < ApplicationRecord
+  has_testimonials                     # keyed by to_gid.to_s (match config.tenant)
+end
+organization.testimonials.approved     # a normal Active Record relation
+organization.testimonials_nps          # NPS responses for this tenant
+```
+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_testimonials(key: ->(o){ o.subdomain })` and the same in `config.tenant`.
+**Upgrading an existing install:** the `tenant` column is additive and
+nullable. Run `bin/rails generate testimonials:tenant && bin/rails db:migrate`
+(a fresh install already includes it). Existing rows keep a `nil` tenant — the
+global collection — so nothing changes until you set `config.tenant`.
 ## Testing
 ```bash

data/app/controllers/testimonials/api/stats_controller.rb CHANGED Viewed

@@ -5,14 +5,14 @@ module Testimonials
     # Powers rating badges: "★ 4.9 from 87 reviews".
     class StatsController < BaseController
       def show
-        scope = Testimonial.publishable
+        scope = Testimonial.for_tenant(current_tenant).publishable
         rated = scope.where.not(rating: nil)
         render json: {
           count: scope.count,
           average_rating: rated.average(:rating)&.to_f&.round(2),
           ratings_count: rated.count,
-          nps_score: (NpsResponse.score if Testimonials.config.nps)
+          nps_score: (NpsResponse.score(NpsResponse.for_tenant(current_tenant)) if Testimonials.config.nps)
         }
       end
     end

data/app/controllers/testimonials/api/testimonials_controller.rb CHANGED Viewed

@@ -6,7 +6,7 @@ module Testimonials
       MAX_LIMIT = 100
       def index
-        scope = Testimonial.publishable.featured_first
+        scope = Testimonial.for_tenant(current_tenant).publishable.featured_first
         scope = scope.where(featured: true) if params[:featured].present?
         scope = scope.where(kind: params[:kind]) if Testimonial::KINDS.include?(params[:kind])
         scope = scope.where(rating: params[:min_rating].to_i..) if params[:min_rating].present?

data/app/controllers/testimonials/application_controller.rb CHANGED Viewed

@@ -16,6 +16,15 @@ module Testimonials
       current_author.respond_to?(:id) ? current_author.id : nil
     end
+    # The tenant for this request (nil = the single global collection). Every
+    # read and write in the engine scopes to it, so a resolved-tenant admin
+    # only ever sees and writes their own tenant's records.
+    def current_tenant
+      return @current_tenant if defined?(@current_tenant)
+      @current_tenant = Testimonials.tenant(request)
+    end
     def require_enabled
       head :forbidden unless Testimonials.enabled?(request)
     end

data/app/controllers/testimonials/collection_controller.rb CHANGED Viewed

@@ -11,8 +11,11 @@ module Testimonials
       head :not_found and return unless Testimonials.config.public_collection
       head :forbidden and return unless Testimonials.enabled?(request)
-      # A signed-in visitor edits their existing review instead of adding one.
-      @existing = current_author_id && Testimonial.where(author_id: current_author_id.to_s).newest_first.first
+      # A signed-in visitor edits their existing review (in this tenant)
+      # instead of adding one.
+      @existing = current_author_id &&
+                  Testimonial.for_tenant(current_tenant)
+                             .where(author_id: current_author_id.to_s).newest_first.first
     end
   end
 end

data/app/controllers/testimonials/events_controller.rb CHANGED Viewed

@@ -17,7 +17,7 @@ module Testimonials
       head :unprocessable_entity and return unless PromptEvent::KINDS.include?(kind) &&
                                                    CLIENT_ACTIONS.include?(action)
-      PromptEvent.record!(kind: kind, action: action,
+      PromptEvent.record!(kind: kind, action: action, tenant: current_tenant,
                           author_id: current_author_id, visitor_token: ensure_visitor_token)
       head :no_content
     end

data/app/controllers/testimonials/media_controller.rb CHANGED Viewed

@@ -37,8 +37,10 @@ module Testimonials
       params[:download].present? ? 'attachment' : 'inline'
     end
+    # Scoped to the tenant, so a cross-tenant id can never reach another
+    # tenant's media — it simply isn't found.
     def set_testimonial
-      @testimonial = Testimonial.find(params[:id])
+      @testimonial = Testimonial.for_tenant(current_tenant).find(params[:id])
     end
     def authorize_media

data/app/controllers/testimonials/nps_controller.rb CHANGED Viewed

@@ -12,11 +12,12 @@ module Testimonials
     def create
       nps = NpsResponse.new(nps_params)
       nps.locale = I18n.locale.to_s
+      nps.tenant = current_tenant
       nps.user_agent = request.user_agent
       attribute_author(nps)
       if nps.save
-        PromptEvent.record!(kind: 'nps', action: 'submitted',
+        PromptEvent.record!(kind: 'nps', action: 'submitted', tenant: current_tenant,
                             author_id: current_author_id, visitor_token: ensure_visitor_token)
         notify_host(nps)
         notify_detractor(nps) if nps.detractor?
@@ -51,6 +52,7 @@ module Testimonials
     def offer_testimonial?(nps)
       nps.promoter? && PromptEvent.eligible?(
         kind: 'testimonial',
+        tenant: current_tenant,
         author_id: current_author_id,
         visitor_token: cookies[:testimonials_vid]
       )

data/app/controllers/testimonials/nps_responses_controller.rb CHANGED Viewed

@@ -10,14 +10,15 @@ module Testimonials
     before_action :require_admin
     def index
-      @score = NpsResponse.score
-      @total = NpsResponse.count
-      @promoters = NpsResponse.where(score: 9..10).count
-      @passives = NpsResponse.where(score: 7..8).count
-      @detractors = NpsResponse.where(score: 0..6).count
+      scope = NpsResponse.for_tenant(current_tenant)
+      @score = NpsResponse.score(scope)
+      @total = scope.count
+      @promoters = scope.where(score: 9..10).count
+      @passives = scope.where(score: 7..8).count
+      @detractors = scope.where(score: 0..6).count
       @page = [params[:page].to_i, 1].max
-      @responses = NpsResponse.newest_first.offset((@page - 1) * PER_PAGE).limit(PER_PAGE + 1).to_a
+      @responses = scope.newest_first.offset((@page - 1) * PER_PAGE).limit(PER_PAGE + 1).to_a
       @more = @responses.size > PER_PAGE
       @responses = @responses.first(PER_PAGE)
     end

data/app/controllers/testimonials/testimonials_controller.rb CHANGED Viewed

@@ -23,9 +23,9 @@ module Testimonials
       @status = Testimonial::STATUSES.include?(params[:status]) ? params[:status] : 'pending'
       @kind = Testimonial::KINDS.include?(params[:kind]) ? params[:kind] : nil
       @query = params[:q].to_s.strip.presence
-      @counts = Testimonial.group(:status).count
+      @counts = tenant_scope.group(:status).count
-      scope = Testimonial.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
@@ -70,7 +70,13 @@ module Testimonials
     private
     def set_testimonial
-      @testimonial = Testimonial.find(params[:id])
+      @testimonial = tenant_scope.find(params[:id])
+    end
+    # Every dashboard query starts here, so an admin can only ever load,
+    # triage, or delete records in their own tenant — a cross-tenant id 404s.
+    def tenant_scope
+      Testimonial.for_tenant(current_tenant)
     end
     def admin_params
@@ -106,15 +112,18 @@ module Testimonials
       testimonial.source = 'widget' unless Testimonial::SOURCES.include?(testimonial.source)
       testimonial.consent_text = Testimonials.consent_text_for(testimonial.consent_given?)
       testimonial.locale = I18n.locale.to_s
+      testimonial.tenant = current_tenant
       testimonial.user_agent = request.user_agent
       attribute_author(testimonial)
       testimonial
     end
+    # One review per signed-in user, *per tenant*: the same person can leave a
+    # separate review in each tenant, but only one within any single tenant.
     def existing_testimonial
       return if current_author_id.blank?
-      Testimonial.where(author_id: current_author_id.to_s).newest_first.first
+      tenant_scope.where(author_id: current_author_id.to_s).newest_first.first
     end
     # A fresh upload makes it a video review; on an edit without a new
@@ -190,7 +199,7 @@ module Testimonials
     end
     def record_submission
-      PromptEvent.record!(kind: 'testimonial', action: 'submitted',
+      PromptEvent.record!(kind: 'testimonial', action: 'submitted', tenant: current_tenant,
                           author_id: current_author_id, visitor_token: ensure_visitor_token)
     end

data/app/helpers/testimonials/widget_helper.rb CHANGED Viewed

@@ -52,14 +52,17 @@ module Testimonials
       @testimonials_author = Testimonials.config.current_user.call(request)
     end
-    # One review per signed-in user: this is the record the widget opens
-    # pre-filled, and the one the create endpoint updates in place.
+    # One review per signed-in user (per tenant): this is the record the widget
+    # opens pre-filled, and the one the create endpoint updates in place.
     def testimonials_existing_testimonial
       return @testimonials_existing_testimonial if defined?(@testimonials_existing_testimonial)
       author = testimonials_author
       @testimonials_existing_testimonial =
-        author.respond_to?(:id) ? Testimonial.where(author_id: author.id.to_s).newest_first.first : nil
+        if author.respond_to?(:id)
+          Testimonial.for_tenant(Testimonials.tenant(request))
+                     .where(author_id: author.id.to_s).newest_first.first
+        end
     end
     # A prompt requested via testimonial_prompt! rides the flash, so it survives
@@ -73,6 +76,7 @@ module Testimonials
       author = testimonials_author
       return unless Testimonials::PromptEvent.eligible?(
         kind: kind,
+        tenant: Testimonials.tenant(request),
         author_id: author.respond_to?(:id) ? author.id : nil,
         visitor_token: cookies[:testimonials_vid]
       )

data/app/models/testimonials/nps_response.rb CHANGED Viewed

@@ -5,6 +5,7 @@ module Testimonials
   class NpsResponse < ApplicationRecord
     validates :score, presence: true, inclusion: { in: 0..10 }
+    scope :for_tenant, ->(tenant) { where(tenant: tenant.presence) }
     scope :newest_first, -> { order(id: :desc) }
     def promoter? = score >= 9

data/app/models/testimonials/prompt_event.rb CHANGED Viewed

@@ -20,20 +20,22 @@ module Testimonials
     validates :action, inclusion: { in: ACTIONS }
     class << self
-      def record!(kind:, action:, author_id: nil, visitor_token: nil)
+      def record!(kind:, action:, author_id: nil, visitor_token: nil, tenant: nil)
         return if author_id.blank? && visitor_token.blank?
-        create!(kind: kind.to_s, action: action.to_s,
+        create!(kind: kind.to_s, action: action.to_s, tenant: tenant.presence,
                 author_id: author_id.presence, visitor_token: visitor_token.presence)
       end
-      def eligible?(kind:, author_id: nil, visitor_token: nil)
+      # Throttling is per-tenant: a user prompted in one tenant is still
+      # eligible in another, so each collection can ask independently.
+      def eligible?(kind:, author_id: nil, visitor_token: nil, tenant: nil)
         kind = kind.to_s
         return false unless KINDS.include?(kind)
         # No identity, no history: a brand-new visitor is always eligible.
         return true if author_id.blank? && visitor_token.blank?
-        history = subject(author_id, visitor_token).where(kind: kind)
+        history = subject(author_id, visitor_token, tenant).where(kind: kind)
         config = Testimonials.config
         return false if submitted_recently?(history, kind, config)
@@ -45,8 +47,9 @@ module Testimonials
       private
-      def subject(author_id, visitor_token)
-        author_id.present? ? where(author_id: author_id.to_s) : where(visitor_token: visitor_token)
+      def subject(author_id, visitor_token, tenant = nil)
+        scope = where(tenant: tenant.presence)
+        author_id.present? ? scope.where(author_id: author_id.to_s) : scope.where(visitor_token: visitor_token)
       end
       def submitted_recently?(history, kind, config)

data/app/models/testimonials/testimonial.rb CHANGED Viewed

@@ -21,6 +21,11 @@ module Testimonials
     validates :body, presence: true, if: -> { kind == 'text' }
     validates :rating, inclusion: { in: 1..5 }, allow_nil: true
+    # Multi-tenancy: everything is scoped to an opaque tenant key (nil = the
+    # single global collection). Loose-coupled like author_id — a string, no
+    # FK into the host's tables. See Testimonials.config.tenant.
+    scope :for_tenant, ->(tenant) { where(tenant: tenant.presence) }
     scope :newest_first, -> { order(id: :desc) }
     scope :approved, -> { where(status: 'approved') }
     # What the read API serves: approved by an admin AND consented by the

data/lib/generators/testimonials/install/templates/create_testimonials_tables.rb.tt CHANGED Viewed

@@ -19,11 +19,13 @@ class CreateTestimonialsTables < ActiveRecord::Migration<%= migration_version %>
       t.string :page_url
       t.string :user_agent
       t.string :locale
+      t.string :tenant # opaque per-tenant key; nil = single global collection
       t.timestamps
     end
     add_index :testimonials_testimonials, :status
-    add_index :testimonials_testimonials, %i[status consent_given]
+    add_index :testimonials_testimonials, %i[tenant status]
+    add_index :testimonials_testimonials, %i[tenant status consent_given]
     create_table :testimonials_nps_responses do |t|
       t.integer :score, null: false
@@ -34,20 +36,22 @@ class CreateTestimonialsTables < ActiveRecord::Migration<%= migration_version %>
       t.string :page_url
       t.string :user_agent
       t.string :locale
+      t.string :tenant
       t.timestamps
     end
-    add_index :testimonials_nps_responses, :score
+    add_index :testimonials_nps_responses, %i[tenant score]
     create_table :testimonials_prompt_events do |t|
       t.string :kind, null: false
       t.string :action, null: false
       t.string :author_id
       t.string :visitor_token
+      t.string :tenant
       t.timestamps
     end
-    add_index :testimonials_prompt_events, %i[author_id kind]
-    add_index :testimonials_prompt_events, %i[visitor_token kind]
+    add_index :testimonials_prompt_events, %i[tenant author_id kind]
+    add_index :testimonials_prompt_events, %i[tenant visitor_token kind]
   end
 end

data/lib/generators/testimonials/install/templates/initializer.rb CHANGED Viewed

@@ -27,6 +27,19 @@ Testimonials.configure do |config|
   # Attribution stored with a signed-in user's submission.
   # config.user_display = ->(user) { { name: user.name, email: user.email } }
+  # Multi-tenancy (optional). Scope testimonials, NPS, the dashboard and the
+  # read API to a tenant — each Organization/Product/Store its own collection.
+  # Return an opaque key (nil = one global collection, the default). A
+  # GlobalID is the recommended key and matches the `has_testimonials` 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 dashboard.
+  # config.tenant = ->(request) { Current.organization&.to_gid&.to_s }
+  #
+  # Then, optionally, `has_testimonials` for `organization.testimonials`:
+  #   class Organization < ApplicationRecord
+  #     has_testimonials
+  #   end
   # Guiding prompts shown above the message field (not form fields).
   # Default nil = the gem's built-in localized questions. Override with
   # literal strings, or a lambda for host-side i18n. [] hides the section.

data/lib/generators/testimonials/tenant/templates/add_tenant_to_testimonials.rb.tt ADDED Viewed

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+class AddTenantToTestimonials < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :testimonials_testimonials, :tenant, :string
+    add_column :testimonials_nps_responses, :tenant, :string
+    add_column :testimonials_prompt_events, :tenant, :string
+    add_index :testimonials_testimonials, %i[tenant status]
+    add_index :testimonials_testimonials, %i[tenant status consent_given]
+    add_index :testimonials_nps_responses, %i[tenant score]
+    add_index :testimonials_prompt_events, %i[tenant author_id kind]
+    add_index :testimonials_prompt_events, %i[tenant visitor_token kind]
+  end
+end

data/lib/generators/testimonials/tenant/tenant_generator.rb ADDED Viewed

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/active_record'
+module Testimonials
+  module Generators
+    # For apps that installed testimonials before multi-tenancy: adds the
+    # nullable `tenant` column (and its indexes) to the three tables. A fresh
+    # install already gets these 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 collection), so nothing changes until you
+    # set config.tenant.
+    #
+    #   bin/rails generate testimonials: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 existing testimonials tables (multi-tenancy upgrade).'
+      def create_migration_file
+        migration_template 'add_tenant_to_testimonials.rb.tt',
+                           'db/migrate/add_tenant_to_testimonials.rb'
+      end
+      def post_install
+        say "\ntenant column queued. Run `rails db:migrate`, then set", :green
+        say 'config.tenant in config/initializers/testimonials.rb to scope per tenant.'
+      end
+      private
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/testimonials/configuration.rb CHANGED Viewed

@@ -21,6 +21,15 @@ module Testimonials
     # 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 collection: today's behavior, unchanged.
+    # Testimonials, NPS, the dashboard and the read API all scope to whatever
+    # this returns. The recommended key is a GlobalID (`record.to_gid.to_s`),
+    # which also matches the `has_testimonials` model concern.
+    attr_accessor :tenant
     # Turn a resolved user into the attribution stored with a submission.
     # Return a hash with :name, :email, and optionally :title_company.
     # Receives whatever #current_user returned.
@@ -90,6 +99,7 @@ module Testimonials
       @enabled = ->(_request) { true }
       @authorize_admin = ->(_request) { Rails.env.development? }
       @current_user = ->(_request) {}
+      @tenant = ->(_request) {}
       @user_display = lambda { |user|
         { name: user.try(:name), email: user.try(:email) }
       }

data/lib/testimonials/engine.rb CHANGED Viewed

@@ -12,5 +12,13 @@ module Testimonials
         include Testimonials::PromptHelper
       end
     end
+    # Make the optional `has_testimonials` model macro available on every
+    # Active Record model, without requiring the host to include anything.
+    initializer 'testimonials.model' do
+      ActiveSupport.on_load(:active_record) do
+        extend Testimonials::HasTestimonials
+      end
+    end
   end
 end

data/lib/testimonials/has_testimonials.rb ADDED Viewed

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Testimonials
+  # Optional sugar for multi-tenant apps. `has_testimonials` on a host model
+  # gives it `.testimonials` (and `.testimonials_nps`) relations, keyed by the
+  # record's GlobalID — the documented tenant convention:
+  #
+  #   class Organization < ApplicationRecord
+  #     has_testimonials
+  #   end
+  #   organization.testimonials.approved   # a normal Active Record relation
+  #
+  # It's a pure veneer over `Testimonial.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.org.to_gid.to_s }`.
+  # Key by something else? Pass a matching resolver: `has_testimonials(key:
+  # ->(org){ org.subdomain })` — and use the same in `config.tenant`.
+  module HasTestimonials
+    def has_testimonials(as: :testimonials, key: nil) # rubocop:disable Naming/PredicatePrefix
+      resolver = key || ->(record) { record.to_gid.to_s }
+      define_method(as) { Testimonials::Testimonial.for_tenant(resolver.call(self)) }
+      define_method(:"#{as}_nps") { Testimonials::NpsResponse.for_tenant(resolver.call(self)) }
+    end
+  end
+end

data/lib/testimonials/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Testimonials
-  VERSION = '0.4.2'
+  VERSION = '0.5.1'
 end

data/lib/testimonials/widget.js CHANGED Viewed

@@ -1052,7 +1052,6 @@
   // --- styles -------------------------------------------------------------------
   function injectStyles() {
-    if (document.getElementById("tml-styles")) return;
     var css = [
       "#tml-overlay{position:fixed;inset:0;z-index:" + Z + ";background:rgba(0,0,0,.45);",
       "display:flex;align-items:center;justify-content:center;padding:16px}",
@@ -1154,6 +1153,13 @@
       "#tml-dialog .tml-actions{padding-bottom:calc(0px + env(safe-area-inset-bottom))}",
       "}"
     ].join("");
+    // Re-inject only when the CSS changed. Turbo keeps <head> across visits, so
+    // a stale <style> would otherwise pin old CSS after a shipped update, even
+    // while fresh widget.js runs — as self-freshening as the fingerprinted URL.
+    var existing = document.getElementById("tml-styles");
+    if (existing && existing.textContent === css) return;
+    if (existing) existing.remove();
     var style = document.createElement("style");
     style.id = "tml-styles";
     style.textContent = css;

data/lib/testimonials.rb CHANGED Viewed

@@ -4,6 +4,7 @@ require 'testimonials/version'
 require 'testimonials/configuration'
 require 'testimonials/widget'
 require 'testimonials/prompt_helper'
+require 'testimonials/has_testimonials'
 require 'testimonials/engine'
 # Testimonials, reviews and NPS for Rails. An iOS-style in-app widget collects
@@ -38,6 +39,26 @@ module Testimonials
       config.app_name.presence || rails_app_name
     end
+    # The tenant key for this request, or nil for the single global collection.
+    # Normalized to a string so `where(tenant:)` is consistent whether the
+    # resolver returns a GlobalID, an integer id, or a slug. Blank resolves to
+    # nil — an app that only sometimes has a tenant falls back to global.
+    def tenant(request)
+      config.tenant.call(request).presence&.to_s
+    end
+    # Testimonials belonging to a host record, keyed by its GlobalID — the
+    # documented tenant convention. Sugar for `Testimonial.for_tenant(...)`;
+    # the `has_testimonials` model concern is built on this.
+    def for(record)
+      Testimonial.for_tenant(tenant_key_for(record))
+    end
+    # The NPS responses belonging to a host record, same keying as `.for`.
+    def nps_for(record)
+      NpsResponse.for_tenant(tenant_key_for(record))
+    end
     # The guiding questions for the current locale, with %{app} filled in.
     # I18n leaves the token alone when no interpolation values are passed,
     # so a plain gsub covers built-in, literal, and lambda-provided strings
@@ -70,6 +91,14 @@ module Testimonials
     private
+    # A host record's tenant key: its GlobalID string. Kept in one place so
+    # `.for`, `.nps_for` and the `has_testimonials` concern agree — and so a
+    # host wiring `config.tenant = ->(r){ Current.org.to_gid.to_s }` lines up
+    # with `organization.testimonials`.
+    def tenant_key_for(record)
+      record.respond_to?(:to_gid) ? record.to_gid.to_s : record.to_s
+    end
     # The application's module name, verbatim ("EthicsPortal", "SupeRails") —
     # no inflection games. Set config.app_name for anything fancier.
     def rails_app_name

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testimonials
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Yaroslav Shmarov
@@ -94,10 +94,13 @@ files:
 - lib/generators/testimonials/install/install_generator.rb
 - lib/generators/testimonials/install/templates/create_testimonials_tables.rb.tt
 - lib/generators/testimonials/install/templates/initializer.rb
+- lib/generators/testimonials/tenant/templates/add_tenant_to_testimonials.rb.tt
+- lib/generators/testimonials/tenant/tenant_generator.rb
 - lib/testimonials.rb
 - lib/testimonials/configuration.rb
 - lib/testimonials/dashboard.js
 - lib/testimonials/engine.rb
+- lib/testimonials/has_testimonials.rb
 - lib/testimonials/prompt_helper.rb
 - lib/testimonials/version.rb
 - lib/testimonials/widget.js