i18n_feedback 0.8.2 → 0.8.3

data/lib/i18n_feedback/widget.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module I18nFeedback
-  # Serves the self-contained browser widget. The JavaScript is plain ES (no
-  # framework, no build step) and styles itself inline, so it drops into any Rails
-  # app regardless of its CSS or JS setup. It is inlined into the page rather than
-  # served as a separate asset to avoid any dependency on the host's asset
-  # pipeline.
-  module Widget
-    # Lives under lib/ (not app/assets/), so a host that runs an asset
-    # pipeline never ingests it: Rails auto-registers every engine's
-    # app/assets/* directory, which would put this file in the host's asset
-    # namespace as a bare "widget.js" and into its precompiled output.
-    SOURCE = File.expand_path('widget.js', __dir__)
-
-    # Right-to-left scripts, so the popover renders mirrored for those locales.
-    # Matched on the language subtag, so region variants ("ar-EG") count too.
-    RTL_LANGUAGES = %w[ar arc ckb dv fa ha he ks ku ps sd ug ur yi].freeze
-
-    class << self
-      def javascript
-        @javascript ||= File.read(SOURCE)
-      end
-
-      # The two <script> tags to place before </body>.
-      #
-      # The config rides in a `type="application/json"` block: it is *data*, not
-      # code, so the browser never executes it and Turbo never tries to re-run it
-      # on a soft visit — which means it needs no CSP nonce and, crucially, the
-      # widget can re-read the *current* page's config on every `turbo:load`
-      # instead of being stuck with whatever the last full load evaluated.
-      #
-      # `nonce:` stamps only the widget script (the code), so it runs under a
-      # nonce-based Content-Security-Policy; pass nil when the app has no nonce.
-      def snippet(endpoint:, locale:, active:, nonce: nil)
-        config = {
-          endpoint: endpoint,
-          locale: locale.to_s,
-          active: active ? true : false,
-          showPill: I18nFeedback.config.show_pill ? true : false,
-          pillLabel: I18nFeedback.config.pill_label,
-          toggleParam: I18nFeedback.config.toggle_param,
-          labels: labels(locale),
-          rtl: rtl?(locale)
-        }
-        # Escape "</" so a value can't close the <script> block early.
-        json = config.to_json.gsub('</', '<\/')
-        nonce_attr = nonce ? %( nonce="#{nonce}") : ''
-
-        %(<script type="application/json" data-i18n-feedback-config>#{json}</script>) +
-          %(<script data-i18n-feedback-widget#{nonce_attr}>#{javascript}</script>)
-      end
-
-      private
-
-      # Every user-facing string in the widget, resolved through Rails I18n so the
-      # popover matches the locale the page was rendered in. The locale is passed
-      # explicitly (not read from I18n.locale) because auto-injection runs in
-      # middleware *after* the controller action, by which point an
-      # `around_action { I18n.with_locale(...) }` has reset the ambient locale
-      # back to the default. Each lookup carries an English default, so the widget
-      # stays fully worded even for a locale the gem ships no translation for.
-      def labels(locale)
-        {
-          pill: t(locale, :pill, 'Suggest edits'),
-          pillActive: t(locale, :pill_active, 'Stop suggesting (Esc)'),
-          title: t(locale, :title, 'Suggest a translation fix'),
-          currentText: t(locale, :current_text, 'Current text'),
-          suggestedText: t(locale, :suggested_text, 'Suggested text'),
-          comment: t(locale, :comment, 'Comment'),
-          commentPlaceholder: t(locale, :comment_placeholder, 'Optional note for the developer'),
-          priorTitle: t(locale, :prior_title, 'Already suggested (pending)'),
-          cancel: t(locale, :cancel, 'Cancel'),
-          save: t(locale, :save, 'Send suggestion'),
-          errorBlank: t(locale, :error_blank, 'Please enter a suggestion.'),
-          errorSave: t(locale, :error_save, 'Could not save the suggestion.')
-        }
-      end
-
-      # Resolve under the given locale, tolerating one the app doesn't list in
-      # available_locales (enforce_available_locales would otherwise raise) — the
-      # English default still applies.
-      def t(locale, key, default)
-        I18n.t(key, scope: :i18n_feedback, locale: locale, default: default)
-      rescue I18n::InvalidLocale
-        default
-      end
-
-      def rtl?(locale)
-        RTL_LANGUAGES.include?(locale.to_s.downcase.split(/[-_]/).first)
-      end
-    end
-  end
-end