copy_tuner_client 1.5.0 → 2.1.0

data/lib/copy_tuner_client/copyray/marker.rb

@@ -0,0 +1,24 @@
+module CopyTunerClient
+  class Copyray
+    # 訳文に埋め込むキーマーカーの可視テキストトークン。
+    # サーバ側（CopyrayMiddleware の Rewriter）だけが encode/scan/strip すればよく、
+    # フロントは data 属性化された後の DOM を見るので decode は不要。
+    #
+    # 例: encode('views.home.message') #=> "⟦CT:views.home.message⟧"
+    module Marker
+      # NOTE: 通常の本文・属性値に出現しない記号（U+27E6 / U+27E7）と固定プレフィックス CT: で
+      # 偶発衝突を二重に下げる。除去漏れても可読なので人間が原因に気づける（不可視文字は不採用）。
+      PREFIX = '⟦CT:'.freeze
+      SUFFIX = '⟧'.freeze
+
+      # NOTE: PREFIX/SUFFIX から動的構築し、区切り変更時に encode と SCAN_REGEXP がズレないようにする。
+      SCAN_REGEXP = /#{Regexp.escape(PREFIX)}(.*?)#{Regexp.escape(SUFFIX)}/
+
+      module_function
+
+      def encode(key)
+        "#{PREFIX}#{key}#{SUFFIX}"
+      end
+    end
+  end
+end

data/lib/copy_tuner_client/copyray/rewriter.rb

@@ -0,0 +1,113 @@
+require 'nokogiri'
+require 'copy_tuner_client/copyray/marker'
+
+module CopyTunerClient
+  class Copyray
+    # 完成 HTML を走査し、マーカートークンを含むテキストノードの親要素・属性値を持つ要素に
+    # data-copyray-key 属性を付与し、トークンを完全に除去する。
+    # CopyrayMiddleware の HTML 後処理（CSS/JS 挿入）の前段で呼ばれる。
+    module Rewriter
+      DATA_ATTR = 'data-copyray-key'.freeze
+
+      # NOTE: マーカーを含む巨大 HTML を Nokogiri で parse/traverse/再シリアライズすると
+      # サイズに比例して重くなる（実測 ~1MB で 167ms, ~3MB で 514ms）。development 限定機能で
+      # レスポンスを大きく悪化させないため、この閾値超では Nokogiri を通さず可視トークン除去のみ行う。
+      # 失うのは data-copyray-key（オーバーレイ編集導線）だけで、フォールバックの gsub は巨大ページでも数ms。
+      MAX_REWRITE_BYTESIZE = 1_000_000
+
+      class << self
+        # NOTE: 戻り値は [html, skipped]。skipped は data-copyray-key を付与できなかったことを表す
+        # （巨大DOMでのスキップ・Nokogiri 例外の双方で true）。ミドルウェアがこれを JS に伝え、
+        # オーバーレイ非対応である旨をツールバーで案内する。
+        def rewrite(html)
+          # NOTE: ボディが ASCII-8BIT に転落していると UTF-8 の Marker::PREFIX との include? 比較が
+          # Encoding::CompatibilityError を投げる（ミドルウェアのボディ連結で非ASCIIバイトを含む
+          # ASCII-8BIT チャンクが混じると発生）。実バイト列は本来 UTF-8 なので判定用に UTF-8 とみなす。
+          # String.new でエンコーディングだけ付け替える（元オブジェクトを破壊せずバッファもコピーしない）。
+          scannable = html.encoding == Encoding::UTF_8 ? html : String.new(html, encoding: Encoding::UTF_8)
+
+          # NOTE: マーカーが無ければ Copyray 無効時・マーカーの無い通常ページなので一切変形しない（高速パス）。
+          # これによりマーカー非注入の HTML は完全に無傷で、Nokogiri の正規化も通らない。
+          # （そもそも CopyrayMiddleware は development 限定で本番のスタックには登録されず、本番では呼ばれない。）
+          # 判定は正規表現より安い部分文字列検索で行う（プレフィックスがあれば必ずマーカー候補）。
+          return [html, false] unless scannable.include?(Marker::PREFIX)
+
+          # NOTE: 閾値超は Nokogiri を通さず可視トークン除去のみ。skipped=true で編集導線を諦めた旨を伝える。
+          return [strip_markers(scannable), true] if scannable.bytesize > MAX_REWRITE_BYTESIZE
+
+          [rewrite_with_nokogiri(scannable), false]
+        rescue StandardError => e
+          # NOTE: Copyray は開発支援機能なので、壊れた HTML 等で Nokogiri 処理が落ちても
+          # ページを 500 にしない。data-copyray-key 付与（編集導線）は諦め、最低限可視トークンだけ除去する。
+          warn_rewrite_failure(e)
+          [strip_markers(scannable), true]
+        end
+
+        private
+
+        # NOTE: gsub 対象が html ではなく scannable なのは、ASCII-8BIT のままだと UTF-8 の
+        # SCAN_REGEXP との比較で Encoding::CompatibilityError が再発しうるため。
+        def strip_markers(scannable)
+          scannable.gsub(Marker::SCAN_REGEXP, '')
+        end
+
+        def rewrite_with_nokogiri(scannable)
+          doc = Nokogiri::HTML(scannable)
+
+          doc.traverse do |node|
+            if node.text?
+              annotate_text_node(node)
+            elsif node.element?
+              annotate_attributes(node)
+            end
+          end
+
+          # NOTE: Nokogiri 走査はテキストノード親要素・属性値への属性付与とノード単位の除去を担うが、
+          # serialize 時の正規化（エンティティ復元等）でトークンが復活しうる縁を塞ぐため、
+          # 最終出力にもう一度 gsub をかけて残留トークンを保険で全除去する（可視トークンの除去漏れは画面に出るため）。
+          strip_markers(doc.to_html)
+        end
+
+        # NOTE: logger 未設定の構成でもフォールバック自体が落ちないよう nil ガードする。
+        def warn_rewrite_failure(error)
+          logger = CopyTunerClient.configuration.logger
+          logger&.warn("CopyTuner Copyray::Rewriter failed: #{error.class.name}: #{error.message}")
+        end
+
+        def annotate_text_node(node)
+          keys = scan_keys(node.content)
+          return if keys.empty?
+
+          set_keys(node.parent, keys)
+          node.content = node.content.gsub(Marker::SCAN_REGEXP, '')
+        end
+
+        def annotate_attributes(element)
+          element.attribute_nodes.each do |attr|
+            keys = scan_keys(attr.value)
+            next if keys.empty?
+
+            set_keys(element, keys)
+            attr.value = attr.value.gsub(Marker::SCAN_REGEXP, '')
+          end
+        end
+
+        # NOTE: 空キーは除く（JS 側も split 後に空要素を捨てるため、表現を両端で揃える）。
+        def scan_keys(text)
+          text.scan(Marker::SCAN_REGEXP).flatten.reject(&:empty?)
+        end
+
+        # NOTE: 同一テキストノード／属性値に複数マーカーが連結されると全キーをここで受け取り、
+        # 1 要素に複数キーをカンマ区切りで保持する（1 要素 1 キーだと 2 個目以降の編集導線が消える）。
+        # 既存値がある場合（同じ要素を複数経路で踏むケース）はマージして重複排除し、出現順を保つ。
+        # I18n キーに ',' は通常含まれないため区切り文字として安全。JS 側もカンマ区切りを前提に読む。
+        def set_keys(element, keys)
+          return if element.nil? || !element.element?
+
+          existing = element[DATA_ATTR]&.split(',') || []
+          element[DATA_ATTR] = (existing + keys).uniq.join(',')
+        end
+      end
+    end
+  end
+end

data/lib/copy_tuner_client/copyray.rb

@@ -1,9 +1,12 @@
+require 'copy_tuner_client/copyray/marker'
+
 module CopyTunerClient
   class Copyray
     # This:
     #   message
     # Becomes:
-    #   <!--COPYRAY views.home.index.message-->message
+    #   ⟦CT:views.home.index.message⟧message
+    # マーカートークンは CopyrayMiddleware の Rewriter で data-copyray-key 属性に変換され、HTML から除去される。
     def self.augment_template(source, key)
       return source if source.blank? || !source.is_a?(String)
 
@@ -11,9 +14,13 @@ module CopyTunerClient
       # オーバーレイマーカーを出さない。編集できないキーを編集可能だと誤認させないため。
       return source if CopyTunerClient.configuration.local_first_key?(key)
 
-      escape = CopyTunerClient.configuration.html_escape && !source.html_safe?
-      augmented = "<!--COPYRAY #{key}-->#{escape ? ERB::Util.html_escape(source) : source}"
-      augmented.html_safe
+      # NOTE: マーカーは平文・html_safe どちらの訳文にも埋め込む（画面に出る全テキストをオーバーレイ対象にする）。
+      # トークンの区切り記号 ⟦⟧ は HTML 特殊文字ではないため、平文が ActionView でエスケープされても無傷で残り、
+      # Rewriter の走査は崩れない。
+      # html_safe フラグは source のものを引き継ぐ。html_safe を勝手に立てると平文訳文の本体（& < >）が
+      # エスケープされず XSS になり、逆に html_safe を落とすと _html 訳文がエスケープされて壊れるため。
+      augmented = Marker.encode(key) + source
+      source.html_safe? ? augmented.html_safe : augmented
     end
   end
 end

data/lib/copy_tuner_client/copyray_middleware.rb

@@ -1,5 +1,7 @@
 # cf) xray-rails : xray/middleware.rb
 
+require 'copy_tuner_client/copyray/rewriter'
+
 module CopyTunerClient
   class CopyrayMiddleware
     def initialize(app)
@@ -11,8 +13,12 @@ module CopyTunerClient
       status, headers, response = @app.call(env)
       if html_headers?(status, headers) && body = response_body(response)
         csp_nonce = env['action_dispatch.content_security_policy_nonce'] || env['secure_headers_content_security_policy_nonce']
-        body = append_css(body, csp_nonce)
-        body = append_js(body, csp_nonce)
+        # NOTE: CSS/JS 挿入の前に Rewriter を通す。serialize 後も </body> は必ず出力されるので
+        # append_to_html_body の rindex は機能し、CSS/JS タグはトークン非含有なので二重処理も起きない。
+        # NOTE: skipped は data-copyray-key を付与できなかったこと（巨大DOM/Nokogiri例外）を表す。
+        # JS にこれを伝え、オーバーレイ非対応である旨をツールバーで案内させる。
+        body, skipped = CopyTunerClient::Copyray::Rewriter.rewrite(body)
+        body = append_js(body, csp_nonce, skipped: skipped)
         content_length = body.bytesize.to_s
         headers['Content-Length'] = content_length
         # maintains compatibility with other middlewares
@@ -32,12 +38,7 @@ module CopyTunerClient
       ActionController::Base.helpers
     end
 
-    def append_css(html, csp_nonce)
-      css_tag = helpers.stylesheet_link_tag 'copytuner', media: :all, nonce: csp_nonce
-      append_to_html_body(html, css_tag)
-    end
-
-    def append_js(html, csp_nonce)
+    def append_js(html, csp_nonce, skipped: false)
       json =
         if CopyTunerClient::TranslationLog.initialized?
           CopyTunerClient::TranslationLog.translations.to_json
@@ -49,6 +50,7 @@ module CopyTunerClient
         window.CopyTuner = {
           url: '#{CopyTunerClient.configuration.project_url}',
           data: #{json},
+          keysSkipped: #{skipped},
         }
       SCRIPT
       append_to_html_body(html, helpers.javascript_include_tag('copytuner', type: 'module', crossorigin: 'anonymous', nonce: csp_nonce))

data/lib/copy_tuner_client/engine.rb

@@ -25,7 +25,7 @@ module CopyTunerClient
     end
 
     initializer "copy_tuner.assets.precompile", group: :all do |app|
-      app.config.assets.precompile += ['copytuner.js', 'copytuner.css']
+      app.config.assets.precompile += ['copytuner.js']
     end
   end
 end

data/lib/copy_tuner_client/helper_extension.rb

@@ -60,9 +60,6 @@ module CopyTunerClient
             alias_method :translate_without_copyray_comment, :translate
             alias_method :translate, :translate_with_copyray_comment
             alias :t :translate
-            alias :tt :translate_without_copyray_comment
-          else
-            alias :tt :translate
           end
         end
       end

data/lib/copy_tuner_client/i18n_backend.rb

@@ -26,18 +26,11 @@ module CopyTunerClient
     #
     # @return [Object] the translated key (usually a String)
     def translate(locale, key, options = {})
-      # I18nの標準処理に任せる（内部でlookupが呼ばれる）
-      content = super
-
-      return content if content.nil? || content.is_a?(Hash)
-
-      # HTML escapeの処理（ツリー構造のHashは除く）
-      if CopyTunerClient.configuration.html_escape
-        content
-      else
-        # Backward compatible
-        content.respond_to?(:html_safe) ? content.html_safe : content
-      end
+      # I18nの標準処理に任せる（内部でlookupが呼ばれる）。
+      # NOTE: html_safe 化は backend では行わない。.html/_html キーの html_safe 化は
+      # ActionView の TranslationHelper（ActiveSupport::HtmlSafeTranslation）が担うため、
+      # backend は I18n 標準どおり素の content を返すだけにする（旧 html_escape 分岐は廃止）。
+      super
     end
 
     # Returns locales available for this CopyTuner project.

data/lib/copy_tuner_client/version.rb

@@ -1,6 +1,6 @@
 module CopyTunerClient
   # Client version
-  VERSION = '1.5.0'.freeze
+  VERSION = '2.1.0'.freeze
 
   # API version being used to communicate with the server
   API_VERSION = '2.0'.freeze

data/mise.toml

@@ -0,0 +1,3 @@
+[tools]
+node = "24"
+pnpm = "11.9.0"

data/package.json

@@ -4,26 +4,22 @@
   "repository": "https://github.com/SonicGarden/copy-tuner-ruby-client",
   "author": "SonicGarden",
   "license": "MIT",
+  "packageManager": "pnpm@11.9.0",
   "engines": {
-    "node": "16.x"
+    "node": ">=24"
   },
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "lint": "biome lint .",
+    "format": "biome format --write .",
+    "check": "biome check --write ."
   },
   "dependencies": {},
   "devDependencies": {
-    "@sonicgarden/eslint-plugin": "^0.5.2",
-    "@sonicgarden/prettier-config": "^0.0.1",
-    "eslint": "^8.16.0",
-    "lodash.debounce": "^4.0.8",
-    "typescript": "^5.0.2",
-    "vite": "^4.2.1"
-  },
-  "prettier": "@sonicgarden/prettier-config",
-  "volta": {
-    "node": "16.15.0",
-    "yarn": "1.22.18"
+    "@biomejs/biome": "2.5.0",
+    "typescript": "^6.0.0",
+    "vite": "^8.0.0"
   }
 }