i18n_feedback 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fcc717fd98e35452b32dced0c863804d92a13c6c50986004c74ffad64189ca
-  data.tar.gz: 00fa165a3e61bd18e773458cc00c7e38d324e3b00387b1eb0b78269738b73369
+  metadata.gz: f4dee71413e641b59a88d1116ac134410395055d31f097d83800155feead9fc8
+  data.tar.gz: 4e41cd76dd83acbdd77ff95ece48bed916040bdf0e6227e78aa6090f8c28025b
 SHA512:
-  metadata.gz: 8b2dcf16cb6edcec67828d8294cf670205c5b61b591cbeded1eb6605519a0a16b485d644c8b60d7b24d3134088396a22657a653acdeac7dc95b2aeeae64ea1ff
-  data.tar.gz: 8a60071cfafc8fd341723f4d92f132caa2b71953de672bb3f508b2923315e698ccdac7431acf5f07724c330cb2a70223abb34d560b65e61aa40350875c754b18
+  metadata.gz: 9483d2a561d1edb370685c85ac3dfaa5030532c58102aeb923926ea180de687d738e9e7deccbf8a6689f617f4ae7da7a20750272a5306419d60389d574c5b4f4
+  data.tar.gz: d50924f6b93eec7fe93bb5e5baa8a7a53a43e8fdcf864b571531646d3f47f8554dff87e6766289ce0589830f0d354176759ea85ebadbff6722396664aec632b9

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [0.4.0]
+
+- Add a `config.on_submit` hook, called with each saved suggestion right after
+  it's stored — notify Slack, send an email, open a ticket. Runs inline after
+  save, so keep it fast or hand off to a job.
+
 ## [0.3.1]
 
 - Fix the widget showing raw key markers (e.g. `⟦i18n_feedback.title⟧`) in its own

data/README.md

@@ -234,6 +234,16 @@ end
 Each row stores `translation_key`, `locale`, `old_value`, `proposed_value`,
 `comment`, `page_url`, and optional `author_id` / `author_label`.
 
+### Getting notified
+
+To be pinged when a suggestion comes in, set `on_submit`. It's called with the
+saved `Suggestion` right after it's stored — notify Slack, send an email, open a
+ticket. It runs inline in the request, so keep it fast or hand off to a job:
+
+```ruby
+config.on_submit = ->(suggestion) { SuggestionMailer.with(suggestion:).created.deliver_later }
+```
+
 ## Security
 
 - The tool is gated **on the server** for every marker, endpoint, and injection.

data/app/controllers/i18n_feedback/suggestions_controller.rb

@@ -18,6 +18,7 @@ module I18nFeedback
       attribute_author(suggestion)
 
       if suggestion.save
+        I18nFeedback.config.on_submit.call(suggestion)
         head :created
       else
         render json: { errors: suggestion.errors.full_messages }, status: :unprocessable_entity

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

@@ -36,4 +36,9 @@ I18nFeedback.configure do |config|
   # Keep this in sync with the `mount` line in config/routes.rb.
   #
   # config.mount_path = "/i18n_feedback"
+
+  # Called with each saved suggestion — notify Slack, send an email, open a
+  # ticket. Runs inline after save, so keep it fast or hand off to a job.
+  #
+  # config.on_submit = ->(suggestion) { SuggestionMailer.with(suggestion:).created.deliver_later }
 end

data/lib/i18n_feedback/configuration.rb

@@ -48,6 +48,10 @@ module I18nFeedback
     # suggest mode without the parameter.
     attr_accessor :toggle_param
 
+    # Called with each saved suggestion — notify Slack, send an email, open a
+    # ticket. Runs inline after save; keep it fast or hand off to a job.
+    attr_accessor :on_submit
+
     def initialize
       @enabled_environments = %w[development staging]
       @enabled = ->(_request) { true }
@@ -59,6 +63,7 @@ module I18nFeedback
       @show_pill = true
       @pill_label = nil
       @toggle_param = 'i18n_feedback'
+      @on_submit = ->(_suggestion) {}
     end
 
     def environment_enabled?

data/lib/i18n_feedback/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nFeedback
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n_feedback
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Yaroslav Shmarov