testimonials 0.7.8 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f77889bc1fe3b99ca3b75dad0936498a35afa29249bceb5c9000ef090b275cfc
-  data.tar.gz: 0bd9fdedb0d9b11be9c4b8ebdea7277d4f45c249723b5c43dc93bb7b2e74cb7b
+  metadata.gz: 746c0b7bc1421a8aadfbbbd7e9d41cb4aabc81ff0c6afa60669e4d9c06e963b0
+  data.tar.gz: 3914ba53cef25fcb6f541e6b4176e1d6135205cb37cdcc05b289125d456f1bbb
 SHA512:
-  metadata.gz: 2b60920030a7e8099116b1d8abd8e31f98fbf9b984f4c3faaebf7fd3449ac232574016c0b0d5c62ea0ecd6647500e2646baf8264c657ed913df98ab7fa71c207
-  data.tar.gz: 3c5b5e7209197b41f28cb90240b3c232123ad91833e14be80031af275becf143f9376316d36857c9de7db844eb8630aa570de8bc09d0a14173a534da4f309980
+  metadata.gz: 55f8694212e3f1395481121efd0f67c8474e9422173ba63e9b05cf66f40320b340301a1be39537cfbeb8ce17292b289d4f73247b2a05742e52f79b1bad6d47ae
+  data.tar.gz: 1a57a1aa934adc3d3b92199d922effc5ec36d66dc9138f819b1b153f754431c5e5bd7bea4f21e65fe51bb725d732e648acf7f389f8168ac277f174e220130b19

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.7.9
+
+- NPS is now optional at install time. `bin/rails generate testimonials:install
+  --skip-nps` leaves out the `testimonials_nps_responses` table and writes
+  `config.nps = false`, so an app that only wants testimonials carries neither
+  the table nor the NPS tab. `bin/rails generate testimonials:nps` adds the
+  table later, mirroring the `testimonials:tenant` upgrade path.
+- The guard is `config.nps`, not table introspection — nothing checks the
+  schema at runtime and nothing touches the database at boot. Consequently
+  `/testimonials/nps_responses` now 404s when `config.nps` is false instead of
+  still serving history; flip the flag back to read old responses. The
+  dashboard nav already hid the tab, so only a typed URL reached it.
+- `testimonials:seed_demo` skips NPS rows when the flow is off, and the
+  `testimonials:tenant` migration skips the NPS table when it isn't there.
+
 ## 0.7.8
 
 - The NPS dashboard now says what the score means. The card carries the band

data/README.md

@@ -33,6 +33,15 @@ bin/rails db:migrate
 The generator writes the initializer, the migration, and mounts the engine at
 `/testimonials`. Nothing renders until the widget is opened.
 
+Don't want NPS? Install without it — no table, no dashboard tab, no prompt:
+
+```bash
+bin/rails generate testimonials:install --skip-nps
+```
+
+Changed your mind later: `bin/rails generate testimonials:nps`, migrate, and
+set `config.nps = true`.
+
 Optional demo data:
 
 ```bash
@@ -242,16 +251,29 @@ throttle would allow it. Detractors (0–6) trigger `on_detractor`, which pairs
 well with [ideasbugs](https://github.com/yshmarov/ideasbugs). Your score and
 every response live at `/testimonials/nps_responses`.
 
+| 1. One question, eleven taps | 2. The reason, optional |
+| --- | --- |
+| ![The NPS prompt: how likely are you to recommend us, scored 0 to 10](https://raw.githubusercontent.com/yshmarov/testimonials/main/docs/screenshots/nps-01-score.jpg) | ![The follow-up asking for the main reason behind the score](https://raw.githubusercontent.com/yshmarov/testimonials/main/docs/screenshots/nps-02-comment.png) |
+| Ten seconds of work, and "Not now" is always there. | The comment is where the actionable half lives. Promoters go straight on to the testimonial form. |
+
 The score is `% promoters − % detractors`, from −100 to +100, and the dashboard
 reads it against the usual benchmarks so nobody has to go and google them:
 below 0 needs work, 0–29 is good, 30–69 is great, 70 and up is world-class. A
 scale under the number shows where you sit, and under 30 responses the card
 says the sample is too thin to read much into.
 
+<img src="https://raw.githubusercontent.com/yshmarov/testimonials/main/docs/screenshots/nps-dashboard.jpg" alt="The NPS dashboard: a score of 41 badged Great, a scale marking where it sits between −100 and +100, promoter/passive/detractor counts, and the collapsed panel explaining the formula and the benchmarks" width="820">
+
 `/testimonials/nps/new` is the same question on its own page — the link for an
 email campaign, where there is no app session to prompt inside of. A promoter
 who scores 9–10 gets the testimonial form right there on the page.
 
+NPS is optional. `config.nps = false` — what `--skip-nps` writes at install —
+turns off the prompt, the public page, the `/api/stats` score and the dashboard
+tab, and `/testimonials/nps_responses` then 404s. Turning it off on an install
+that has the table hides existing responses along with everything else; flip it
+back to read them.
+
 ## The public pages
 
 Two standalone, self-styled pages for people outside the app — drop either link

data/app/controllers/testimonials/nps_responses_controller.rb

@@ -8,6 +8,9 @@ module Testimonials
     layout :testimonials_admin_layout
 
     before_action :require_admin
+    # An install run with --skip-nps has no table behind these pages, and the
+    # nav already hides the tab whenever config.nps is off.
+    before_action :require_nps
     before_action :set_response, only: :show
 
     def index
@@ -31,6 +34,10 @@ module Testimonials
 
     private
 
+    def require_nps
+      head :not_found unless Testimonials.config.nps
+    end
+
     def set_response
       @response = NpsResponse.for_tenant(current_tenant).find(params[:id])
     end

data/app/views/testimonials/nps_responses/index.html.erb

@@ -2,10 +2,10 @@
 
 <div class="page-head">
   <h1><%= t('testimonials.dashboard.nps', default: 'NPS') %></h1>
-  <%# The shareable NPS page, same idea as the testimonial one. This dashboard
-      still reads history when config.nps is off, but that page 404s — so the
-      link needs both switches. %>
-  <% if Testimonials.config.public_collection && Testimonials.config.nps %>
+  <%# The shareable NPS page, same idea as the testimonial one. config.nps is
+      already true here — the controller 404s otherwise — so only the public
+      switch is left to check. %>
+  <% if Testimonials.config.public_collection %>
     <a class="button share-link" href="<%= nps_collection_url %>" target="_blank" rel="noopener"
        title="<%= nps_collection_url %>">
       🔗 <%= t('testimonials.dashboard.nps_page', default: 'Ask for NPS scores') %>

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

@@ -12,8 +12,15 @@ module Testimonials
 
       desc 'Installs testimonials: config initializer, migration, and engine mount.'
 
+      # NPS is the one part of the gem an app can genuinely not want. Skipping
+      # it leaves out the table and writes `config.nps = false`, so nothing
+      # ever reaches a table that isn't there — no runtime introspection, no
+      # boot-time database call. `testimonials:nps` adds it later.
+      class_option :skip_nps, type: :boolean, default: false,
+                              desc: 'Leave out the NPS table and turn the NPS flow off'
+
       def create_initializer
-        copy_file 'initializer.rb', 'config/initializers/testimonials.rb'
+        template 'initializer.rb.tt', 'config/initializers/testimonials.rb'
       end
 
       def create_migration_file
@@ -29,8 +36,12 @@ module Testimonials
         say "\ntestimonials installed. Run `rails db:migrate`, then add", :green
         say '`<%= testimonials_tag %>` before </body> in your layout.'
         say 'Triage testimonials at /testimonials (development only until you set config.authorize_admin).'
-        say 'Optional: run `bin/rails testimonials:seed_demo` for sample testimonials and NPS.'
+        samples = options[:skip_nps] ? 'testimonials' : 'testimonials and NPS'
+        say "Optional: run `bin/rails testimonials:seed_demo` for sample #{samples}."
         say "Collect from outside the app via /testimonials/new.\n"
+        return unless options[:skip_nps]
+
+        say 'Installed without NPS. Add it later with `bin/rails generate testimonials:nps`.', :yellow
       end
 
       private

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

@@ -27,6 +27,7 @@ class CreateTestimonialsTables < ActiveRecord::Migration<%= migration_version %>
     add_index :testimonials_testimonials, %i[tenant status]
     add_index :testimonials_testimonials, %i[tenant status consent_given]
 
+<% unless options[:skip_nps] -%>
     create_table :testimonials_nps_responses do |t|
       t.integer :score, null: false
       t.text :comment
@@ -42,6 +43,7 @@ class CreateTestimonialsTables < ActiveRecord::Migration<%= migration_version %>
     end
     add_index :testimonials_nps_responses, %i[tenant score]
 
+<% end -%>
     create_table :testimonials_prompt_events do |t|
       t.string :kind, null: false
       t.string :action, null: false

data/lib/generators/testimonials/install/templates/{initializer.rb → initializer.rb.tt}

@@ -84,7 +84,15 @@ Testimonials.configure do |config|
   # config.public_api = false
 
   # NPS surveys. Promoters (9–10) are offered the testimonial form right away.
+<% if options[:skip_nps] -%>
+  # Installed with --skip-nps, so there is no testimonials_nps_responses table
+  # and the NPS flow, dashboard tab and public page stay off. To add it later:
+  # `bin/rails generate testimonials:nps && bin/rails db:migrate`, then flip
+  # this to true.
+  config.nps = false
+<% else -%>
   # config.nps = true
+<% end -%>
   # config.nps_reprompt_after = 90.days
 
   # Called with each saved Testimonial or NpsResponse — notify Slack, email…

data/lib/generators/testimonials/nps/nps_generator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Testimonials
+  module Generators
+    # For apps that installed with --skip-nps and later want the 0–10 survey:
+    # creates the testimonials_nps_responses table. A full install already has
+    # it. Additive and safe — nothing reads the table until config.nps is true.
+    #
+    #   bin/rails generate testimonials:nps && bin/rails db:migrate
+    class NpsGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Adds the NPS responses table for an install that skipped it.'
+
+      def create_migration_file
+        migration_template 'create_testimonials_nps_responses.rb.tt',
+                           'db/migrate/create_testimonials_nps_responses.rb'
+      end
+
+      def post_install
+        say "\nNPS table queued. Run `rails db:migrate`, then set", :green
+        say 'config.nps = true in config/initializers/testimonials.rb to turn the flow on.'
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/testimonials/nps/templates/create_testimonials_nps_responses.rb.tt

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class CreateTestimonialsNpsResponses < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :testimonials_nps_responses do |t|
+      t.integer :score, null: false
+      t.text :comment
+      t.string :author_id
+      t.string :name
+      t.string :email
+      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_nps_responses, %i[tenant score]
+  end
+end

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

@@ -3,13 +3,17 @@
 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]
+
+    # An install run with --skip-nps has no NPS table to add the column to.
+    return unless table_exists?(:testimonials_nps_responses)
+
+    add_column :testimonials_nps_responses, :tenant, :string
+    add_index :testimonials_nps_responses, %i[tenant score]
   end
 end

data/lib/testimonials/seeds.rb

@@ -90,7 +90,8 @@ module Testimonials
     def self.load!(tenant: nil)
       {
         testimonials: load_testimonials!(tenant: tenant),
-        nps_responses: load_nps_responses!(tenant: tenant),
+        # An install run with --skip-nps has no table to seed into.
+        nps_responses: (Testimonials.config.nps ? load_nps_responses!(tenant: tenant) : []),
         prompt_events: load_prompt_events!(tenant: tenant)
       }
     end

data/lib/testimonials/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testimonials
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
 platform: ruby
 authors:
 - Yaroslav Shmarov
@@ -97,7 +97,9 @@ files:
 - config/routes.rb
 - 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/install/templates/initializer.rb.tt
+- lib/generators/testimonials/nps/nps_generator.rb
+- lib/generators/testimonials/nps/templates/create_testimonials_nps_responses.rb.tt
 - lib/generators/testimonials/tenant/templates/add_tenant_to_testimonials.rb.tt
 - lib/generators/testimonials/tenant/tenant_generator.rb
 - lib/tasks/testimonials_tasks.rake