i18n_feedback 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fdbfd25f140436e323ceb8eec7f22aaa1aa52d4e9979cb0e6cddf4020bf53a9
-  data.tar.gz: a6e68e6e68cc021427164c95f671a012c78c31855aa9d1fef5c8cea528577ca1
+  metadata.gz: ef2003dd6566b01a576e74b7db0ef2e277e71a642c18e571683e8509db7af1b6
+  data.tar.gz: ea5121783f2dec044550682d9be5cbcdf5c1f8990bef886ec7a04ac414463f26
 SHA512:
-  metadata.gz: 822a81c0d8e8d08c2d6e03a9208e899a2a5a6649bbafe347b3e56c3ab6c430bfb059e05ec03abde8307c2a9692f08c64d5f9b7a0c94fe8c10eefead0385ca845
-  data.tar.gz: cd0d806e70019c47b00572bf16e64a13b6435337f36affc6a9f283df8949f56d575fcfe0d35b147d558112990c1e07a0ef9dda3b98808bede245fbd3feed2b8e
+  metadata.gz: 02fba91e18f211348b3c99a23de1c0ca6b4bdc22c63a7cf7833c537cfc2a671e9802e76ff2385687135b410d574d70a5ae57f38a8e770d0bc70b351946f85d7e
+  data.tar.gz: e30815c01401a293b4226e2fd9f6cfbc39dbb660924520c3325fef0954f786791346f8160d06b96b5f479d0d8f034b4c4bdb80ce1f33cbfb68f4d56bd4beeb3f

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## [Unreleased]
 
+## [0.6.0]
+
+- Ship `i18n_feedback.start` / `i18n_feedback.stop` labels in every bundled
+  language, for hosts that drive suggest mode from their own menu/link instead
+  of the floating pill. Because the `i18n_feedback.*` scope is exempt from
+  key-marking, these are safe to render with `t(...)` — no plain-literal
+  workaround needed. See the "Toggling suggest mode from your own link" README
+  section for a full HTML example.
+
 ## [0.5.0]
 
 - Add a `status` to each suggestion — a string-backed Active Record enum with

data/README.md

@@ -136,16 +136,20 @@ config.show_pill = false # optional
 A one-way "turn it on" link is just the toggle parameter:
 
 ```erb
-<%= link_to "Proofread translations", "?i18n_feedback=true" %>
+<%= link_to t("i18n_feedback.start"), "?i18n_feedback=true" %>
 ```
 
 For a single control that flips both ways, read the current state from the
-`i18n_feedback` cookie and point at the opposite state:
+`i18n_feedback` cookie and point at the opposite state. The gem ships `start`
+and `stop` labels under the `i18n_feedback.*` scope in every bundled language,
+so a localized toggle needs no keys of your own:
 
 ```erb
-<% on = cookies[:i18n_feedback].present? %>
-<%= link_to (on ? "Disable translations editing" : "Enable translations editing"),
-            "?i18n_feedback=#{!on}" %>
+<% if I18nFeedback.available?(request) %>
+  <% suggesting = cookies[:i18n_feedback].present? %>
+  <%= link_to (suggesting ? t("i18n_feedback.stop") : t("i18n_feedback.start")),
+              "?#{I18nFeedback.config.toggle_param}=#{!suggesting}" %>
+<% end %>
 ```
 
 Good to know:
@@ -158,8 +162,10 @@ Good to know:
   ordinary navigation during proofreading (so a stray click can't leave the page
   mid-edit), but any link carrying the toggle parameter is exempt — so a "Disable"
   item in your nav always gets you out.
-- **Don't** run the label through `I18n.t`: the tool would then mark its own
-  control as an editable string. Keep the label a plain literal.
+- The `i18n_feedback.*` keys are **safe to run through `I18n.t`** — that scope is
+  exempt from key-marking, so the tool never flags its own controls as editable.
+  Use the bundled `i18n_feedback.start` / `i18n_feedback.stop` labels (or your own
+  keys); either way, no plain-literal workaround is needed.
 
 ### Gating examples
 

data/config/locales/i18n_feedback.ar.yml

@@ -1,6 +1,8 @@
 ar:
   i18n_feedback:
     pill: "اقترح تعديلات"
+    start: "اقترح تعديلات"
+    stop: "إيقاف الاقتراح"
     pill_active: "وضع الاقتراح — اضغط للخروج (Esc)"
     title: "اقترح تصحيحًا للترجمة"
     current_text: "النص الحالي"

data/config/locales/i18n_feedback.bn.yml

@@ -1,6 +1,8 @@
 bn:
   i18n_feedback:
     pill: "সম্পাদনা প্রস্তাব করুন"
+    start: "সম্পাদনা প্রস্তাব করুন"
+    stop: "প্রস্তাব দেওয়া বন্ধ করুন"
     pill_active: "প্রস্তাব চলছে — বের হতে ট্যাপ করুন (Esc)"
     title: "অনুবাদ সংশোধন প্রস্তাব করুন"
     current_text: "বর্তমান লেখা"

data/config/locales/i18n_feedback.de.yml

@@ -1,6 +1,8 @@
 de:
   i18n_feedback:
     pill: "Änderungen vorschlagen"
+    start: "Änderungen vorschlagen"
+    stop: "Vorschläge beenden"
     pill_active: "Vorschlagsmodus — zum Beenden tippen (Esc)"
     title: "Übersetzungskorrektur vorschlagen"
     current_text: "Aktueller Text"

data/config/locales/i18n_feedback.en.yml

@@ -1,6 +1,8 @@
 en:
   i18n_feedback:
     pill: "Suggest edits"
+    start: "Suggest edits"
+    stop: "Stop suggesting"
     pill_active: "Suggesting — tap to exit (Esc)"
     title: "Suggest a translation fix"
     current_text: "Current text"

data/config/locales/i18n_feedback.es.yml

@@ -1,6 +1,8 @@
 es:
   i18n_feedback:
     pill: "Sugerir cambios"
+    start: "Sugerir cambios"
+    stop: "Dejar de sugerir"
     pill_active: "Sugiriendo — toca para salir (Esc)"
     title: "Sugerir una corrección de traducción"
     current_text: "Texto actual"

data/config/locales/i18n_feedback.fr.yml

@@ -1,6 +1,8 @@
 fr:
   i18n_feedback:
     pill: "Proposer des corrections"
+    start: "Proposer des corrections"
+    stop: "Arrêter de proposer"
     pill_active: "En cours — appuyez pour quitter (Échap)"
     title: "Proposer une correction de traduction"
     current_text: "Texte actuel"

data/config/locales/i18n_feedback.hi.yml

@@ -1,6 +1,8 @@
 hi:
   i18n_feedback:
     pill: "बदलाव सुझाएँ"
+    start: "बदलाव सुझाएँ"
+    stop: "सुझाव देना बंद करें"
     pill_active: "सुझाव मोड — बाहर निकलने के लिए टैप करें (Esc)"
     title: "अनुवाद सुधार सुझाएँ"
     current_text: "वर्तमान टेक्स्ट"

data/config/locales/i18n_feedback.id.yml

@@ -1,6 +1,8 @@
 id:
   i18n_feedback:
     pill: "Sarankan perubahan"
+    start: "Sarankan perubahan"
+    stop: "Berhenti menyarankan"
     pill_active: "Menyarankan — ketuk untuk keluar (Esc)"
     title: "Sarankan perbaikan terjemahan"
     current_text: "Teks saat ini"

data/config/locales/i18n_feedback.it.yml

@@ -1,6 +1,8 @@
 it:
   i18n_feedback:
     pill: "Suggerisci modifiche"
+    start: "Suggerisci modifiche"
+    stop: "Interrompi i suggerimenti"
     pill_active: "Suggerimento — tocca per uscire (Esc)"
     title: "Suggerisci una correzione di traduzione"
     current_text: "Testo attuale"

data/config/locales/i18n_feedback.ja.yml

@@ -1,6 +1,8 @@
 ja:
   i18n_feedback:
     pill: "修正を提案"
+    start: "修正を提案"
+    stop: "提案を終了"
     pill_active: "提案中 — タップで終了（Esc）"
     title: "翻訳の修正を提案"
     current_text: "現在のテキスト"

data/config/locales/i18n_feedback.ko.yml

@@ -1,6 +1,8 @@
 ko:
   i18n_feedback:
     pill: "수정 제안"
+    start: "수정 제안"
+    stop: "제안 중지"
     pill_active: "제안 중 — 종료하려면 탭하세요 (Esc)"
     title: "번역 수정 제안"
     current_text: "현재 텍스트"

data/config/locales/i18n_feedback.nl.yml

@@ -1,6 +1,8 @@
 nl:
   i18n_feedback:
     pill: "Wijzigingen voorstellen"
+    start: "Wijzigingen voorstellen"
+    stop: "Stoppen met voorstellen"
     pill_active: "Aan het voorstellen — tik om te sluiten (Esc)"
     title: "Een vertaalcorrectie voorstellen"
     current_text: "Huidige tekst"

data/config/locales/i18n_feedback.pl.yml

@@ -1,6 +1,8 @@
 pl:
   i18n_feedback:
     pill: "Zaproponuj zmiany"
+    start: "Zaproponuj zmiany"
+    stop: "Zakończ sugerowanie"
     pill_active: "Tryb sugestii — dotknij, aby wyjść (Esc)"
     title: "Zaproponuj poprawkę tłumaczenia"
     current_text: "Bieżący tekst"

data/config/locales/i18n_feedback.pt.yml

@@ -1,6 +1,8 @@
 pt:
   i18n_feedback:
     pill: "Sugerir edições"
+    start: "Sugerir edições"
+    stop: "Parar de sugerir"
     pill_active: "Sugerindo — toque para sair (Esc)"
     title: "Sugerir uma correção de tradução"
     current_text: "Texto atual"

data/config/locales/i18n_feedback.ru.yml

@@ -1,6 +1,8 @@
 ru:
   i18n_feedback:
     pill: "Предложить правки"
+    start: "Предложить правки"
+    stop: "Остановить предложения"
     pill_active: "Режим предложений — нажмите, чтобы выйти (Esc)"
     title: "Предложить исправление перевода"
     current_text: "Текущий текст"

data/config/locales/i18n_feedback.th.yml

@@ -1,6 +1,8 @@
 th:
   i18n_feedback:
     pill: "แนะนำการแก้ไข"
+    start: "แนะนำการแก้ไข"
+    stop: "หยุดแนะนำ"
     pill_active: "กำลังแนะนำ — แตะเพื่อออก (Esc)"
     title: "แนะนำการแก้ไขคำแปล"
     current_text: "ข้อความปัจจุบัน"

data/config/locales/i18n_feedback.tr.yml

@@ -1,6 +1,8 @@
 tr:
   i18n_feedback:
     pill: "Düzenleme öner"
+    start: "Düzenleme öner"
+    stop: "Önermeyi durdur"
     pill_active: "Öneri modu — çıkmak için dokun (Esc)"
     title: "Çeviri düzeltmesi öner"
     current_text: "Mevcut metin"

data/config/locales/i18n_feedback.uk.yml

@@ -1,6 +1,8 @@
 uk:
   i18n_feedback:
     pill: "Запропонувати зміни"
+    start: "Запропонувати зміни"
+    stop: "Зупинити пропозиції"
     pill_active: "Режим пропозицій — торкніться, щоб вийти (Esc)"
     title: "Запропонувати виправлення перекладу"
     current_text: "Поточний текст"

data/config/locales/i18n_feedback.ur.yml

@@ -1,6 +1,8 @@
 ur:
   i18n_feedback:
     pill: "ترامیم تجویز کریں"
+    start: "ترامیم تجویز کریں"
+    stop: "تجویز کرنا بند کریں"
     pill_active: "تجویز موڈ — باہر نکلنے کے لیے تھپتھپائیں (Esc)"
     title: "ترجمے کی اصلاح تجویز کریں"
     current_text: "موجودہ متن"

data/config/locales/i18n_feedback.vi.yml

@@ -1,6 +1,8 @@
 vi:
   i18n_feedback:
     pill: "Đề xuất chỉnh sửa"
+    start: "Đề xuất chỉnh sửa"
+    stop: "Dừng đề xuất"
     pill_active: "Đang đề xuất — chạm để thoát (Esc)"
     title: "Đề xuất sửa bản dịch"
     current_text: "Văn bản hiện tại"

data/config/locales/i18n_feedback.zh-CN.yml

@@ -1,6 +1,8 @@
 zh-CN:
   i18n_feedback:
     pill: "建议修改"
+    start: "建议修改"
+    stop: "停止建议"
     pill_active: "建议中 — 点击退出（Esc）"
     title: "建议翻译修正"
     current_text: "当前文本"

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

@@ -41,4 +41,9 @@ I18nFeedback.configure do |config|
   # 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 }
+
+  # Per-IP throttle on the submission endpoint, passed to Rails' built-in rate
+  # limiter (Rails 7.2+; ignored on 7.1). Set nil to disable.
+  #
+  # config.rate_limit = { to: 30, within: 60 }
 end

data/lib/i18n_feedback/version.rb

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

metadata

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