i18n_feedback 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4dee71413e641b59a88d1116ac134410395055d31f097d83800155feead9fc8
-  data.tar.gz: 4e41cd76dd83acbdd77ff95ece48bed916040bdf0e6227e78aa6090f8c28025b
+  metadata.gz: ef2003dd6566b01a576e74b7db0ef2e277e71a642c18e571683e8509db7af1b6
+  data.tar.gz: ea5121783f2dec044550682d9be5cbcdf5c1f8990bef886ec7a04ac414463f26
 SHA512:
-  metadata.gz: 9483d2a561d1edb370685c85ac3dfaa5030532c58102aeb923926ea180de687d738e9e7deccbf8a6689f617f4ae7da7a20750272a5306419d60389d574c5b4f4
-  data.tar.gz: d50924f6b93eec7fe93bb5e5baa8a7a53a43e8fdcf864b571531646d3f47f8554dff87e6766289ce0589830f0d354176759ea85ebadbff6722396664aec632b9
+  metadata.gz: 02fba91e18f211348b3c99a23de1c0ca6b4bdc22c63a7cf7833c537cfc2a671e9802e76ff2385687135b410d574d70a5ae57f38a8e770d0bc70b351946f85d7e
+  data.tar.gz: e30815c01401a293b4226e2fd9f6cfbc39dbb660924520c3325fef0954f786791346f8160d06b96b5f479d0d8f034b4c4bdb80ce1f33cbfb68f4d56bd4beeb3f

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 ## [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
+  values `pending`, `applied`, and `rejected` (`I18nFeedback::Suggestion::STATUSES`),
+  `status_`-prefixed (`status_applied?`, `status_applied!`, `Suggestion.status_pending`)
+  plus a `newest_first` scope. New suggestions start `pending`; the popover's
+  "already suggested" context now shows only pending ones, so applied/rejected
+  wordings stop resurfacing.
+
+  **Upgrading an existing install:** add the column with a migration —
+
+  ```ruby
+  add_column :i18n_feedback_suggestions, :status, :string, null: false, default: "pending"
+  add_index  :i18n_feedback_suggestions, :status
+  ```
+
+- Harden the public submission endpoint against abuse:
+  - Per-IP rate limiting via Rails' built-in limiter (Rails 7.2+; a no-op on
+    7.1). Default 30 requests / 60s, tunable or disable-able via
+    `config.rate_limit`; returns `429 Too Many Requests`.
+  - Length caps on the stored free-text fields (`proposed_value` / `old_value`
+    5000, `comment` / `page_url` 2000, `translation_key` 500) so a client can't
+    bloat the table with unbounded input.
+
+- Add a `.github/workflows/release.yml` that publishes to RubyGems via trusted
+  publishing (OIDC) when a `v*` tag is pushed — no stored credentials or MFA
+  prompt.
+
 ## [0.4.0]
 
 - Add a `config.on_submit` hook, called with each saved suggestion right after

data/README.md

@@ -116,6 +116,10 @@ I18nFeedback.configure do |config|
 
   # Keep in sync with the `mount` in config/routes.rb.
   config.mount_path = "/i18n_feedback"
+
+  # 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
 ```
 
@@ -132,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:
@@ -154,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
 
@@ -226,13 +236,25 @@ blue accent stays the same in both.
 Suggestions are ordinary records:
 
 ```ruby
-I18nFeedback::Suggestion.order(created_at: :desc).each do |s|
+I18nFeedback::Suggestion.where(status: "pending").newest_first.each do |s|
   puts "#{s.locale} #{s.translation_key}: #{s.old_value.inspect} -> #{s.proposed_value.inspect}"
 end
 ```
 
 Each row stores `translation_key`, `locale`, `old_value`, `proposed_value`,
-`comment`, `page_url`, and optional `author_id` / `author_label`.
+`comment`, `page_url`, `status`, and optional `author_id` / `author_label`.
+
+Every suggestion has a `status` — one of `pending`, `applied`, or `rejected`
+(`I18nFeedback::Suggestion::STATUSES`), backed by an Active Record enum. New
+suggestions start `pending`; once you apply a wording to your locale files or
+decide against it, set the status accordingly so the popover stops offering it
+as pending context:
+
+```ruby
+suggestion.status_applied!          # bang setter
+suggestion.status_applied?          # => true
+I18nFeedback::Suggestion.status_pending.newest_first  # scope per status
+```
 
 ### Getting notified
 

data/Rakefile

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
+# Defines build/install/release — `rake release` is what the trusted-publishing
+# workflow (.github/workflows/release.yml) runs to push the gem to RubyGems.
+require 'bundler/gem_tasks'
 
 APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake' if File.exist?(APP_RAKEFILE)

data/app/controllers/i18n_feedback/suggestions_controller.rb

@@ -2,12 +2,26 @@
 
 module I18nFeedback
   class SuggestionsController < ApplicationController
+    # Throttle the public submission endpoint per IP so one user or bot can't
+    # flood the table. Uses the rate limiter built into Rails 7.2+ (backed by
+    # Rails.cache); a no-op on Rails 7.1. Tune or disable via config.rate_limit —
+    # read once at boot, after the host's initializer.
+    if respond_to?(:rate_limit) && I18nFeedback.config.rate_limit
+      rate_limit(**I18nFeedback.config.rate_limit,
+                 only: :create,
+                 with: lambda {
+                   render json: { errors: ['Too many suggestions. Please slow down and try again.'] },
+                          status: :too_many_requests
+                 })
+    end
+
     # Pending suggestions for one key/locale, shown as read-only context when the
     # proofreader reopens the popover for a string someone already flagged.
     def index
       suggestions = Suggestion
                     .where(translation_key: params[:key], locale: params[:locale])
-                    .order(id: :desc)
+                    .status_pending
+                    .newest_first
                     .limit(20)
 
       render json: suggestions.map { |suggestion| suggestion_json(suggestion) }

data/app/models/i18n_feedback/suggestion.rb

@@ -5,10 +5,23 @@ module I18nFeedback
   # is optional and stored as loose fields (no foreign key to the host's user
   # table) so the model is portable across apps with different user models.
   class Suggestion < ApplicationRecord
-    validates :translation_key, presence: true
-    validates :proposed_value, presence: true
+    # Lifecycle of a proposed wording: a fresh suggestion is `pending` until a
+    # developer applies it to the locale files or rejects it. String-backed so
+    # the column stays human-readable; prefixed so the generated methods read as
+    # `status_pending?` / `Suggestion.status_applied` and never clash.
+    STATUSES = %w[pending applied rejected].freeze
+
+    enum :status, STATUSES.index_by(&:itself), prefix: :status, default: :pending
+
+    validates :translation_key, presence: true, length: { maximum: 500 }
+    validates :proposed_value, presence: true, length: { maximum: 5_000 }
+    validates :old_value, length: { maximum: 5_000 }
+    validates :comment, length: { maximum: 2_000 }
+    validates :page_url, length: { maximum: 2_000 }
     validates :locale,
               presence: true,
               inclusion: { in: ->(_) { I18nFeedback.config.available_locales.call.map(&:to_s) } }
+
+    scope :newest_first, -> { order(id: :desc) }
   end
 end

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/create_i18n_feedback_suggestions.rb.tt

@@ -9,6 +9,7 @@ class CreateI18nFeedbackSuggestions < ActiveRecord::Migration<%= migration_versi
       t.text :proposed_value, null: false
       t.text :comment
       t.string :page_url
+      t.string :status, null: false, default: 'pending'
       t.string :author_id
       t.string :author_label
 
@@ -16,5 +17,6 @@ class CreateI18nFeedbackSuggestions < ActiveRecord::Migration<%= migration_versi
     end
 
     add_index :i18n_feedback_suggestions, %i[translation_key locale]
+    add_index :i18n_feedback_suggestions, :status
   end
 end

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/configuration.rb

@@ -52,6 +52,11 @@ module I18nFeedback
     # ticket. Runs inline after save; keep it fast or hand off to a job.
     attr_accessor :on_submit
 
+    # Per-IP throttle for the public submission endpoint, as keyword arguments
+    # for Rails' rate limiter (Rails 7.2+; ignored on 7.1). Read once when the
+    # controller loads — set it in an initializer. nil disables throttling.
+    attr_accessor :rate_limit
+
     def initialize
       @enabled_environments = %w[development staging]
       @enabled = ->(_request) { true }
@@ -64,6 +69,7 @@ module I18nFeedback
       @pill_label = nil
       @toggle_param = 'i18n_feedback'
       @on_submit = ->(_suggestion) {}
+      @rate_limit = { to: 30, within: 60 }
     end
 
     def environment_enabled?

data/lib/i18n_feedback/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nFeedback
-  VERSION = '0.4.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.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yaroslav Shmarov
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.6.9
 specification_version: 4
 summary: 'In-context i18n proofreading for Rails: click any translated string and
   suggest a fix.'