copy_tuner_client 2.1.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c816e1f12e5715861194284864c00ab5d18428d3c56b6a3140cfe9db9cd360
-  data.tar.gz: d9a8cd76caf12860c0a981a840655254a5aab64665745d16f4524ded77821771
+  metadata.gz: 34fcab16da8e238f416a8d4be1c68212818ae95afb7f82112391517e901fbb8f
+  data.tar.gz: dc9a727af71a83e39cb4d4c4aa41a8d1e982244936f294462da8e44b0b57d9fc
 SHA512:
-  metadata.gz: 1538da853220ee8f4bfc4942023e1afcfd55dc4f719a89b3c965d8719acb57ec5bd418d8821e72eee8adbb5b59ca2f23b462d8894b9239734ff68a30b8a0a074
-  data.tar.gz: '091eee7aae91c30f88fb294716bd9a139d55d7ac90d982602e14305d2c43203360dc81b98092e17dd931dcce1885940af27a47f0031e374e9724eaf4898934d5'
+  metadata.gz: aed1f966e3c35e5d25f82fc96c56ff5532dd0b8d651be0a275f7f6f85f10a0bc58efe6b414ef004140306be70c2c2294c8c1054a112530a32e21070b098f4557
+  data.tar.gz: 9179c177ecbc48104ea0b17db2e6adc1f88e8aa4a5dac4eb0366e171543d2f83bc03e160d7f6cadf65ccb4e8664280904b0c06eca2260d222c9463a51449ff04

data/lib/copy_tuner_client/copyray/rewriter.rb

@@ -19,7 +19,10 @@ module CopyTunerClient
         # NOTE: 戻り値は [html, skipped]。skipped は data-copyray-key を付与できなかったことを表す
         # （巨大DOMでのスキップ・Nokogiri 例外の双方で true）。ミドルウェアがこれを JS に伝え、
         # オーバーレイ非対応である旨をツールバーで案内する。
-        def rewrite(html)
+        # NOTE: fragment: true は turbo stream など body に差し込む HTML 断片向け。
+        # Nokogiri::HTML だと html/body/DOCTYPE ラッパが付いて断片が壊れるため、
+        # fragment パーサでラッパを付けずに走査・除去する。
+        def rewrite(html, fragment: false)
           # NOTE: ボディが ASCII-8BIT に転落していると UTF-8 の Marker::PREFIX との include? 比較が
           # Encoding::CompatibilityError を投げる（ミドルウェアのボディ連結で非ASCIIバイトを含む
           # ASCII-8BIT チャンクが混じると発生）。実バイト列は本来 UTF-8 なので判定用に UTF-8 とみなす。
@@ -35,7 +38,7 @@ module CopyTunerClient
           # NOTE: 閾値超は Nokogiri を通さず可視トークン除去のみ。skipped=true で編集導線を諦めた旨を伝える。
           return [strip_markers(scannable), true] if scannable.bytesize > MAX_REWRITE_BYTESIZE
 
-          [rewrite_with_nokogiri(scannable), false]
+          [rewrite_with_nokogiri(scannable, fragment: fragment), false]
         rescue StandardError => e
           # NOTE: Copyray は開発支援機能なので、壊れた HTML 等で Nokogiri 処理が落ちても
           # ページを 500 にしない。data-copyray-key 付与（編集導線）は諦め、最低限可視トークンだけ除去する。
@@ -51,8 +54,8 @@ module CopyTunerClient
           scannable.gsub(Marker::SCAN_REGEXP, '')
         end
 
-        def rewrite_with_nokogiri(scannable)
-          doc = Nokogiri::HTML(scannable)
+        def rewrite_with_nokogiri(scannable, fragment: false)
+          doc = fragment ? Nokogiri::HTML.fragment(scannable) : Nokogiri::HTML(scannable)
 
           doc.traverse do |node|
             if node.text?

data/lib/copy_tuner_client/copyray_middleware.rb

@@ -11,18 +11,22 @@ module CopyTunerClient
     def call(env)
       CopyTunerClient::TranslationLog.clear
       status, headers, response = @app.call(env)
-      if html_headers?(status, headers) && body = response_body(response)
+      if rewritable?(status, headers) && body = response_body(response)
         csp_nonce = env['action_dispatch.content_security_policy_nonce'] || env['secure_headers_content_security_policy_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)
+        # NOTE: turbo stream はページ断片なので fragment パーサで走査する（html/body ラッパを付けない）。
+        turbo_stream = turbo_stream?(headers)
+        body, skipped = CopyTunerClient::Copyray::Rewriter.rewrite(body, fragment: turbo_stream)
+        # NOTE: ブートストラップ JS はフルページ読み込み時に一度だけ挿入すればよい。turbo stream 断片には
+        # 挿入先の </body> も無く、既に初期化済みのページへマージされるだけなので挿入しない。
+        body = append_js(body, csp_nonce, skipped: skipped) unless turbo_stream
         content_length = body.bytesize.to_s
         headers['Content-Length'] = content_length
         # maintains compatibility with other middlewares
-        if defined?(ActionDispatch::Response::RackBody) && ActionDispatch::Response::RackBody === response
+        if defined?(ActionDispatch::Response::RackBody) && response.is_a?(ActionDispatch::Response::RackBody)
           ActionDispatch::Response.new(status, headers, [body]).to_a
         else
           [status, headers, [body]]
@@ -65,14 +69,19 @@ module CopyTunerClient
     end
 
     def file?(headers)
-      headers["Content-Transfer-Encoding"] == 'binary'
+      headers['Content-Transfer-Encoding'] == 'binary'
     end
 
-    def html_headers?(status, headers)
+    def rewritable?(status, headers)
       [200, 422].include?(status) &&
+        headers['Content-Type'] &&
+        (headers['Content-Type'].include?('text/html') || turbo_stream?(headers)) &&
+        !file?(headers)
+    end
+
+    def turbo_stream?(headers)
       headers['Content-Type'] &&
-      headers['Content-Type'].include?('text/html') &&
-      !file?(headers)
+        headers['Content-Type'].include?('text/vnd.turbo-stream.html')
     end
 
     def response_body(response)

data/lib/copy_tuner_client/version.rb

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

data/skills/copy-tuner-to-t-migrate/SKILL.md

@@ -3,8 +3,9 @@ name: copy-tuner-to-t-migrate
 description: >-
   copy_tuner_client v2.0.0 への移行で、削除された独自ヘルパー tt の呼び出しを Rails 標準の t（translate）へ
   置換するスキル。tt は PR #122 で存在理由を失い gem から削除されたため、残った tt(...) は NoMethodError に
-  なる。大半は機械的に tt( → t( で済むが、訳文を文字列加工している箇所だけは t ではなく I18n.t へ移す必要があり
-  （開発環境のマーカートークン混入バグ対策）、そこは 1 件ずつ確認する。対象は app 配下の .rb / .haml / .erb。
+  なる。大半は機械的に tt( → t( で済むが、訳文を文字列加工している箇所（→ I18n.t へ）と label 系ヘルパーの
+  第一引数に渡している箇所（→ 引数構造を分離）だけは別扱いで、開発環境のマーカートークン残留バグを避けるため
+  1 件ずつ確認する。対象は app 配下の .rb / .haml / .erb。
 disable-model-invocation: true
 license: MIT
 ---
@@ -36,13 +37,46 @@ middleware 自体が無いので再現しない＝開発環境だけ壊れる）
 `t` にすると、`tt` がもともと潰していたバグをそのまま復活させてしまう。そこは middleware のラッパーを通らない
 **`I18n.t`（絶対キー）** へ移すのが正解で、機械的には決められないため 1 件ずつ確認する。
 
+## もう一つの罠: label の第一引数に渡す
+
+文字列加工していなくても危険な経路がもう一つある。`t(...)` の戻り値を **`label` 系ヘルパーの第一引数**
+（form builder の `f.label` / `label_tag` / 素の `label`）に渡しているケース:
+
+```haml
+= f.label t('activerecord.attributes.field.keywords'), class: 'form-label'
+```
+
+`f.label` の**第一引数は「ラベルテキスト」ではなく method 名**（`for` 属性・`id`・ラベル文字列の元）として
+扱われる。そのため development では次の連鎖でマーカーが消せない位置に残る:
+
+1. `t(...)` が `⟦CT:activerecord.attributes.field.keywords⟧分類` を返す。
+2. `f.label` がこれを method 名と解釈し、**ラベルテキスト**と **`for` 属性**の 2 か所に展開する。
+3. ラベルテキスト側は Rails の `humanize` で**小文字化**され `⟦ct:…⟧` になる。
+4. Rewriter のマーカー検出プレフィックスは **大文字 `⟦CT:` 固定**（`lib/copy_tuner_client/copyray/marker.rb`
+   の `PREFIX`）。小文字化された `⟦ct:` は一致せず、除去されないまま画面に残る。
+
+これも v1.x では `tt`（マーカー無し版）だったため表面化せず、**`tt → t` 一括置換で初めて顕在化する回帰**。
+
+**重要: このケースは `I18n.t` 化では直らない。** マーカーを消しても、`t`/`I18n.t` の戻り値（訳文文字列）を
+`label` の第一引数に渡す構造自体が `humanize` / `for` 属性の挙動として不適切だからだ。正しい修正は
+**method 名を第一引数・表示テキストを第二引数に分離**すること:
+
+```haml
+= f.label :keywords_cont, t('activerecord.attributes.field.keywords'), class: 'form-label'
+```
+
+`for` 属性が変わるので、ラベルクリックでフィールドにフォーカスが当たることを実機で確認する。
+スクリプトはこのパターンを suspicious のサブ種別 `label_arg` として抽出する（`label:` オプションに渡す
+simple_form の `f.input :x, label: tt('k')` も同様に拾う）。
+
 ## 変換の 3 分類
 
-| 分類 | 例 | 扱い |
-|---|---|---|
-| **safe** | `tt('views.foo')` / `= tt '.title'` / `tt(key, default: x)` | `tt(` → `t(` に決定論的一括変換 |
-| **suspicious** | `truncate(tt('k'))` / `tt('k').length` / `tt('k')[0..n]` / `tt('k') =~ /re/` / `tt('k').gsub(...)` 等 | `I18n.t('絶対キー')` へ。**1 件ずつ確認**。スクリプトは触らない |
-| **other** | `def tt` / `alias tt`（定義側）/ app 外（`lib/` 等）/ `tt` を含む別識別子の誤検出 | 最後にまとめて提示。自動変換しない |
+| 分類 | サブ種別 | 例 | 扱い |
+|---|---|---|---|
+| **safe** | — | `tt('views.foo')` / `= tt '.title'` / `tt(key, default: x)` / `f.label :method, tt('k')`（第二引数） | `tt(` → `t(` に決定論的一括変換 |
+| **suspicious** | `string_manipulation` | `truncate(tt('k'))` / `tt('k').length` / `tt('k')[0..n]` / `tt('k') =~ /re/` / `tt('k').gsub(...)` 等 | `I18n.t('絶対キー')` へ。**1 件ずつ確認**。スクリプトは触らない |
+| **suspicious** | `label_arg` | `= f.label tt('k')` / `label_tag tt('k')` / `f.input :x, label: tt('k')`（label 系の**第一引数 / label: オプション**） | **`f.label :method, t('k')` へ構造を直す**（method 名を第一引数・表示テキストを第二引数に）。**`I18n.t` 化では直らない**。1 件ずつ確認 |
+| **other** | — | `def tt` / `alias tt`（定義側）/ app 外（`lib/` 等）/ `tt` を含む別識別子の誤検出 | 最後にまとめて提示。自動変換しない |
 
 **重要（定義側の罠）:** アプリが v2.0.0 を待つ間の後方互換として `ApplicationHelper` に `def tt(key, **) = t(key, **)`
 のような **`tt` の定義**を生やしていることがある。これは「呼び出し」ではないので `t(` へ機械置換すると Rails の `t`
@@ -80,11 +114,21 @@ suspicious / other の行は**一切触らない**（行番号で限定してい
 
 ### 3. suspicious な箇所を 1 件ずつ確認
 
-ここが人間の判断が要る核心。手順 1 の suspicious 各件について、次を 1 件ずつ提示して確認を取る:
+ここが人間の判断が要る核心。手順 1 の suspicious 各件について、次を 1 件ずつ提示して確認を取る。
+**suspicious はサブ種別（`[label_arg]` / `[string_manipulation]`）で修正方法が異なる**ので、種別で分岐する:
 
+**`[string_manipulation]`（戻り値を文字列加工している）:**
 - 該当コード（`ファイル:行`）と、なぜ怪しいか（戻り値を文字列加工している＝マーカー混入の危険）
 - 提案する置換: `t(...)` ではなく **`I18n.t('絶対キー')`**（`I18n` モジュール直呼びはラッパーを通らずマーカーが付かない）
 
+**`[label_arg]`（label 系の第一引数 / label: オプションに渡している）:**
+- なぜ怪しいか（`humanize` で小文字化された `⟦ct:…⟧` が大文字 `⟦CT:` 固定の Rewriter をすり抜け残る。「もう一つの罠」参照）
+- 提案する置換: **`I18n.t` 化ではなく引数構造を直す。** `= f.label t('views.foo.bar'), class: …` →
+  `= f.label :method_name, t('views.foo.bar'), class: …`。第一引数の method 名（`for` 属性に使うシンボル）は
+  ユーザに確認するか、対応する入力フィールド（`f.text_field :keywords_cont` 等）から推定する。
+  `label:` オプション（`f.input :x, label: tt('k')`）の場合は引数構造はそのままで `t('k')` でよいことが多いが、
+  そのフィールドのラベルが `humanize` を経るかは入力次第なので 1 件ずつ確認する。
+
 注意点:
 - **たとえユーザが「全部まとめて I18n.t にして」と言っても、suspicious は必ず 1 件ずつ提示する。** 相対キーを含む件は絶対キーをユーザと確認しないと置換できないためで、省略すると誤ったキーを書き込む危険がある。
 - **相対キー（先頭ドット `tt('.foo')`）は `I18n.t` では解決できない。** 絶対キー（`I18n.t('views.foo.bar')`）へ
@@ -94,6 +138,8 @@ suspicious / other の行は**一切触らない**（行番号で限定してい
   調べて基点キーを特定するか、ユーザに直接絶対キーを確認する。絶対キーが不明なときは
   `grep -r "キー末尾部分" config/locales/` でロケールファイルを検索して候補を絞り込む。
 - 本当に文字列加工していない（誤検出）なら、その場合は `t(...)` でよい。ユーザの判断に従う。
+- **行をまたぐ変数経由（`txt = t('k')` → 別行で `f.label txt` や `truncate(txt)`）はスクリプトの行単位
+  スキャンでは拾えない**（構造的限界）。最終防波堤は手順 5 の「実画面に小文字マーカー `⟦ct:…⟧` が出ないか目視」。
 
 確認が取れた箇所だけ Edit で個別に置換する（スクリプトでは変換しない）。
 
@@ -118,6 +164,9 @@ git grep -nwI tt -- app   # -I でバイナリ（画像等）の誤マッチを
   （safe は 0 件、`I18n.t` 化した suspicious も `tt` としては消える）。
 - 対象アプリで `bundle exec rspec`（または該当アプリのテスト）を回し、`NoMethodError` が出ないこと。
 - development で実画面を開き、文字列加工していた箇所にマーカートークン（`⟦CT:...⟧`）が混入していないこと。
+- **label を含む画面で、小文字マーカー `⟦ct:...⟧`（小文字 ct）が残っていないこと。** Rewriter は大文字
+  `⟦CT:` しか除去しないため、`humanize` で小文字化された取りこぼしは**この目視が最終防波堤**になる
+  （label 第一引数の罠・行をまたぐ変数経由はここで初めて顕在化することがある）。
 
 ## スクリプトの責務（決定論的な範囲のみ）
 

data/skills/copy-tuner-to-t-migrate/scripts/migrate_tt.rb

@@ -81,6 +81,18 @@ STRING_METHOD_RE = /\btt\b\s*(?:\([^\n]*?\)|['":@][^\n,]*)\s*(?:\.\s*(?:#{STRING
 # 先頭ドットの相対キー tt('.foo') は I18n.t では解決できず絶対キー化が要る → 強調表示用。
 RELATIVE_KEY_RE = /\btt\b\s*(?:\(\s*)?['":]\s*\./
 
+# label 系ヘルパーの第一引数 / label: オプションに tt(t) を渡すパターン。
+# t 化すると戻り値(⟦CT:..⟧) が method 名扱いされ、humanize で小文字化された ⟦ct:..⟧ が
+# Rewriter(大文字 ⟦CT: 固定)の除去網をすり抜け画面に残る。I18n.t 化では直らない。
+# 正しい修正は method 名を第一引数・表示テキストを第二引数へ分離すること。
+LABEL_FIRST_ARG_RE = /
+  (?: (?<![\w.])\w+\.label\b | \blabel_tag\b | (?<![\w.])label(?![\w]) )
+  \s*\(?\s*
+  tt\b (?=\s*[("':@])
+/x
+# simple_form 等の label: オプションに渡すケース（f.input :x, label: tt('k')）
+LABEL_OPTION_RE = /\blabel:\s*tt\b/
+
 def relative(path)
   path.sub("#{ROOT}/", '')
 end
@@ -117,8 +129,19 @@ def classify_line(line, entry, in_app:)
     return [:other, entry]
   end
 
+  # label の第一引数 / label: オプションに渡すケースは文字列加工が無いので、safe 確定より前に拾う。
+  # 修正方法が文字列加工系（I18n.t 化）と異なるためサブ種別 :label_arg で区別する。
+  if line.match?(LABEL_FIRST_ARG_RE) || line.match?(LABEL_OPTION_RE)
+    entry[:kind] = :label_arg
+    entry[:hint] = 'label の引数に渡している。t 化すると humanize で小文字化された ⟦ct:..⟧ が ' \
+                   'Rewriter(大文字 ⟦CT: のみ除去)をすり抜け画面に残る。I18n.t 化では直らない。' \
+                   'method 名を第一引数・表示テキストを第二引数に分離: f.label :method, t(...)'
+    return [:suspicious, entry]
+  end
+
   return [:safe, entry] unless line.match?(STRING_HELPER_RE) || line.match?(STRING_METHOD_RE)
 
+  entry[:kind] = :string_manipulation
   entry[:relative_key] = line.match?(RELATIVE_KEY_RE)
   entry[:hint] = if entry[:relative_key]
                    'I18n.t へ。相対キー(.foo)は絶対キーへ書き換えが必要'
@@ -147,10 +170,14 @@ end
 def print_section(title, entries)
   puts "\n== #{title} (#{entries.size}) =="
   entries.each do |e|
+    # hint があれば必ず kind も付く（classify_line で対で設定）ので素直に出す。
+    # suspicious 内のサブ種別(label_arg / string_manipulation)を可視化する。
     suffix = if e[:hint]
-               "  # #{e[:hint]}"
+               "  # [#{e[:kind]}] #{e[:hint]}"
+             elsif e[:reason]
+               "  # #{e[:reason]}"
              else
-               (e[:reason] ? "  # #{e[:reason]}" : '')
+               ''
              end
     puts "#{e[:file]}:#{e[:lineno]}: #{e[:code].strip}#{suffix}"
   end

data/spec/copy_tuner_client/copyray/rewriter_spec.rb

@@ -202,6 +202,22 @@ describe CopyTunerClient::Copyray::Rewriter do
       end
     end
 
+    context 'fragment: true（turbo stream などの HTML 断片）' do
+      let(:html) { %(<turbo-stream action="replace" target="x"><template><p>#{marker('a.b')}Hello</p></template></turbo-stream>) }
+      subject(:result) { described_class.rewrite(html, fragment: true).first }
+
+      it 'html/body ラッパを足さず断片のまま返す' do
+        expect(result).not_to include('<html>')
+        expect(result).not_to include('<body>')
+        expect(result).to start_with('<turbo-stream')
+      end
+
+      it 'template 内の要素に data-copyray-key を付与しトークンを除去する' do
+        expect(result).to include('data-copyray-key="a.b"')
+        expect(result).not_to match CopyTunerClient::Copyray::Marker::SCAN_REGEXP
+      end
+    end
+
     context '出力にマーカートークンが一切残らない' do
       let(:html) do
         "<html><head><title>#{marker('t')}T</title></head>" \

data/spec/copy_tuner_client/copyray_middleware_spec.rb

@@ -41,6 +41,40 @@ describe CopyTunerClient::CopyrayMiddleware do
     end
   end
 
+  context 'turbo stream レスポンスのとき' do
+    let(:headers) { { 'Content-Type' => 'text/vnd.turbo-stream.html' } }
+    let(:body) { %(<turbo-stream action="replace" target="x"><template><p>#{marker('a.b')}Hello</p></template></turbo-stream>) }
+
+    before do
+      # NOTE: append_js のトップレベル no-op スタブを外し、turbo stream では JS を挿入しないことを検証する。
+      allow(middleware).to receive(:append_js).and_call_original
+    end
+
+    it 'マーカーを data-copyray-key 属性に書き換え、トークンを除去する' do
+      _status, _headers, response = middleware.call({})
+      result = response.join
+
+      expect(result).to include('data-copyray-key="a.b"')
+      expect(result).not_to match CopyTunerClient::Copyray::Marker::SCAN_REGEXP
+    end
+
+    it 'html/body ラッパを付けず turbo-stream 断片のまま返す' do
+      _status, _headers, response = middleware.call({})
+      result = response.join
+
+      expect(result).to start_with('<turbo-stream')
+      expect(result).not_to include('<body>')
+    end
+
+    it 'ブートストラップ JS を挿入しない（断片なので）' do
+      _status, _headers, response = middleware.call({})
+      result = response.join
+
+      expect(result).not_to include('window.CopyTuner')
+      expect(result).not_to include('copytuner')
+    end
+  end
+
   context 'HTML 以外のレスポンスのとき' do
     let(:headers) { { 'Content-Type' => 'application/json' } }
     let(:body) { "{\"x\":\"#{marker('a.b')}\"}" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - SonicGarden
@@ -182,7 +182,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".babelrc"
 - ".gitattributes"
 - ".github/dependabot.yml"
 - ".github/workflows/rspec.yml"
@@ -302,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.15
 specification_version: 4
 summary: Client for the CopyTuner copy management service
 test_files: []

data/.babelrc

@@ -1,18 +0,0 @@
-{
-  "presets": [
-    [
-      "env",
-      {
-        "modules": false,
-        "targets": {
-          "browsers": "> 1%",
-          "uglify": true,
-        },
-        "useBuiltIns": true,
-      },
-    ],
-  ],
-  "plugins": [
-    "external-helpers"
-  ]
-}