copy_tuner_client 2.1.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34fcab16da8e238f416a8d4be1c68212818ae95afb7f82112391517e901fbb8f
-  data.tar.gz: dc9a727af71a83e39cb4d4c4aa41a8d1e982244936f294462da8e44b0b57d9fc
+  metadata.gz: 6a9a2fe07a403679fa3bf6d10c72c13fadcd31536af653a79b3e6d84e80c10ab
+  data.tar.gz: b3300594e38799ec7004f4c4fb0e35b051a447c6dd8b66ffb512bb59d7b851b2
 SHA512:
-  metadata.gz: aed1f966e3c35e5d25f82fc96c56ff5532dd0b8d651be0a275f7f6f85f10a0bc58efe6b414ef004140306be70c2c2294c8c1054a112530a32e21070b098f4557
-  data.tar.gz: 9179c177ecbc48104ea0b17db2e6adc1f88e8aa4a5dac4eb0366e171543d2f83bc03e160d7f6cadf65ccb4e8664280904b0c06eca2260d222c9463a51449ff04
+  metadata.gz: 5af9d06699d0361e360ea31dd4bb67ba04d2e711e0324ee9d85ee59914404ef905e173e7b6fd6ef81ede67773784fd4788ccb45fac7399ce57ad1b67d6d094ce
+  data.tar.gz: 2143f94b230219cae83f8d317f52ba338b282894178edce8129eac5382be76836209fbb29b8dd9e25ac96d3a91a6b93fa326fed4c426f9b2304b9b12d9233482

data/.gitignore

@@ -22,3 +22,8 @@ node_modules
 
 Gemfile.lock
 .claude/settings.local.json
+
+# >>> bundler-skills managed >>>
+.claude/skills/gem-*
+.agents/skills/gem-*
+# <<< bundler-skills managed <<<

data/.rubocop.yml

@@ -1,7 +1,52 @@
 inherit_gem:
-  sgcop: ruby/rubocop.yml
+  sgcop:
+    - ruby/rubocop_strict.yml
+    - ruby/rubocop_rspec_strict.yml
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
 
 # .ruby-version が RuboCop 未対応の新しい Ruby を指すと解析が落ちるため、
 # サポート最低バージョンを明示する
+# rubocop-rails は Rails プロジェクトではないため意図的に読み込まない
 AllCops:
   TargetRubyVersion: 3.3
+  NewCops: enable
+  SuggestExtensions: false
+
+# gemfiles/*.gemfile が `gemspec path: '../'` で本体 gemspec の development dependency を
+# 読み込む構成のため、Gemfile 側への移行は各 gemfiles/*.gemfile への書き戻しが必要になり
+# 意味を変えない自動修正の範囲を超える。gemspec でのdevelopment dependency 宣言を維持する。
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'copy_tuner_client.gemspec'
+
+# middleware（テスト対象自身）の private メソッド append_js / helpers を no-op や
+# フェイクに差し替えないと、Rails の ActionController::Base.helpers 依存を外して
+# Rewriter の効果だけを検証できないため対象外。
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/copy_tuner_client/copyray_middleware_spec.rb'
+
+# Ruby 標準 Queue#pop(non_block=false) のインターフェースに意図的に合わせた実装のため、
+# キーワード引数化すると標準 Queue との互換性が崩れる。
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/copy_tuner_client/queue_with_timeout.rb'
+
+# Client#download は yield 前提の実装で、ブロックを渡さないと downloaded 時に
+# LocalJumpError になる。ダウンロード結果自体を検証しないテストでは空ブロックが必須。
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/copy_tuner_client/client_spec.rb'
+
+# 要判断: configuration_spec.rb の i18n/config/application は Rails gem 自体を
+# stub_const('Rails', Module.new) で丸ごと偽装するための double。ActiveSupport::OrderedOptions
+# は method_missing 経由でアクセサを実装するため instance_double では検証できない。
+# request_sync_spec.rb の app は Rack app プロトコル（call(env) を実装する任意オブジェクト）で
+# 対応する具体的なクラスが存在しないため、Duck Typing 前提の double が妥当。
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/copy_tuner_client/configuration_spec.rb'
+    - 'spec/copy_tuner_client/request_sync_spec.rb'

data/CHANGELOG.md

@@ -1,235 +1,2 @@
-## Unreleased
-
-- **【後方互換性に影響】** `config.exclude_key_regexp` を削除しました。後継の `config.local_first_key_regexp`
-  を使ってください。両者は対象キーの形式が異なります（`exclude_key_regexp` は locale 付き `ja.views.foo`、
-  `local_first_key_regexp` は locale を除いた `views.foo`）。正規表現から locale プレフィックスを外して
-  移行してください。挙動も異なり、`local_first_key_regexp` は lookup 時に CopyTuner キャッシュをスキップして
-  ローカル YAML を優先します（完全分離）。
-- **【後方互換性に影響】** `config.project_id` を必須にしました。未設定のまま `configure`（`apply`）すると
-  `ArgumentError: project_id is required` で失敗します。これまで `project_id` 未設定時は `api_key` へ
-  フォールバックして deprecation 警告を出していましたが、このフォールバックは削除しました。initializer に
-  `config.project_id = <プロジェクト ID>` を設定してください。
-- Copyray オーバーレイのマーカー方式を刷新。訳文への HTML コメント `<!--COPYRAY key-->` 注入をやめ、
-  可視トークン `⟦CT:key⟧` を埋め込んだうえで `CopyrayMiddleware` が `data-copyray-key` 属性に変換し、
-  トークンを HTML から完全に除去するようになりました。最終配信 HTML にコメント・トークンは残りません。
-- **【後方互換性に影響】** `config.html_escape` 設定を削除しました。HTML の安全性判定は i18n 標準
-  （`.html` / `_html` で終わるキーのみ html_safe）に統一され、この設定は参照されなくなっていました（no-op）。
-  no-op だったため動作には影響しませんが、`config.html_escape = ...` を設定している initializer は
-  `NoMethodError` になるため、その行を削除してください。`html_escape = false`（全訳文を html_safe 扱いに
-  する旧互換挙動）に依存していたアプリは、`.html` / `_html` キー命名へ移行してください。
-- Copyray オーバーレイは平文・html_safe（`.html` / `_html` キー）どちらの訳文もハイライト対象です。マーカートークンの
-  区切り記号は HTML 特殊文字ではないため、平文訳文が ActionView でエスケープされてもトークンは無傷で残り、
-  `data-copyray-key` 属性へ正しく変換されます。`<head>` 内（title/meta）はトークンを除去するのみでオーバーレイ
-  非対象ですが、従来どおりリスト導線（CopyTuner バー）から編集できます。
-- **【後方互換性に影響】** `tt` ヘルパーを削除しました。マーカー方式の刷新で `t`（`translate`）が安全にマーカー
-  注入できるようになり、`tt` の存在理由は失われました。`tt` の呼び出しは `t` へ置き換えてください。`tt` を使い続けたい
-  アプリは、ビューヘルパーで `t` に委譲するだけの `tt` を自前で定義してください（gem 撤去後は `t` と実質同義）。
-
-## 0.16.1
-
-- Support for i18n@1.13.0
-- キーの相対パス指定とdefaultオプションを組み合わせた場合の不具合修正
-
-## 0.16.0
-
-- Railsエンジン内のviewではオリジナルのtヘルパが呼ばれるように修正
-
-## 0.15.1
-
-- tヘルパーにdefault引数が渡された場合に初期値として登録されない問題を修正
-
-## 0.15.0
-
-- Drop support for ruby 2.7
-
-## 0.14.1
-
-- Fix super call in define_method
-
-## 0.14.0
-
-- Add Support for good_job
-- Drop Support for Resque
-
-## 0.13.5
-
-- Rename assets
-
-## 0.13.4
-
-- Fix csp nonce
-
-## 0.13.3
-
-- Add `media="all"` attribute to stylesheet link tag
-
-## 0.13.2
-
-- Add `crossorigin="anonymous"` attribute to script tag
-
-## 0.13.1
-
-- Add `type="module"` attribute to script tag
-
-## 0.13.0
-
-- Drop support for ruby 2.6
-
-## 0.12.0
-
-- Add `config.ignored_keys` and `config.ignored_key_handler`
-
-## 0.11.0
-
-- Remove deprecated rescue_format option
-- Fix ruby@2.7 keyword warning
-
-## 0.10.0
-
-- Add copy_tuner:detect_html_incompatible_keys task
-
-## 0.9.0
-
-- Do not upload invalid type keys
-
-## 0.8.1
-
-- Fix bug in `CopyrayMiddleware`
-
-## 0.8.0
-
-- Change the default value of config.upload_disabled_environments
-
-## 0.7.0
-
-- Add config.upload_disabled_environments
-
-## 0.6.2
-
-- Add arguments to export task
-
-## 0.6.1
-
-- Fix ruby@2.7 keyword warning
-
-## 0.6.0
-
-- Drop support for ruby 2.4
-- Drop support for rails 5.1
-
-## 0.5.2
-
-- Do not upload invalid keys
-
-## 0.5.1
-
-- Do not upload downloaded keys
-
-## 0.5.0
-
-- Drop support for ruby 2.3
-- Add tt helper
-- Add copy_tuner:detect_conflict_keys task
-- Do not re-upload empty keys
-- Fix dual loading tasks
-- Remove config.copyray_js_injection_regexp_for_debug
-- Remove config.copyray_js_injection_regexp_for_precompiled
-- Download translation when initialization
-
-## 0.4.11
-
-- changes
-  - Fix hide toggle button on mobile device.
-
-## 0.4.10
-
-- changes
-  - Hide copyray bar on all media.
-
-## 0.4.9
-
-- changes
-  - Smaller toggle button.
-  - Hide toggle button on mobile device.
-
-## 0.4.8
-
-- changes
-  - Support passenger 5.3.x
-
-## 0.4.7
-
-- changes
-  - Compatibile with bullet gem (rewrap response with ActionDispatch::Response::RackBody)
-
-## 0.4.6
-
-- changes
-  - Performance imporovement (sync with server asynchronously)
-  - Add config.middleware_position
-
-## 0.4.5
-
-- changes
-  - Fix deprecated css.
-
-## 0.4.4
-
-- bug fix
-  - Don't upload resolved default values.
-
-## 0.4.3
-
-- bug fix
-  - Start poller thread regardless of puma mode. #39
-
-## 0.4.2
-
-- changes
-  - span tag is no longer added to translation text.
-
-## 0.4.1
-
-- bug fixes
-
-  - js injection failed if jquery is not used. #33
-  - Fix some js error. #34
-  - Wrong key is displayed if scoped option is used. #35
-
-- deprecation
-  - config.copyray_js_injection_regexp_for_debug is no longer needed.
-  - config.copyray_js_injection_regexp_for_precompiled is no longer needed.
-
-## 0.4.0
-
-- Remove jQuery dependency.
-
-## 0.3.5
-
-- Support Rails 5.1
-
-## 0.3.4
-
-- Use Logger to /dev/null as default when rails console
-
-## 0.3.3
-
-- Add config.locales. (#24)
-- Fix initialization order bug. (#25)
-
-## 0.3.2
-
-- Support I18n.t :scope option.
-- Update copyray_js_injection_regexp_for_debug.
-
-## 0.3.1
-
-- Add search box to copyray bar.
-- Add disable_copyray_comment_injection to configuration.
-
-## 0.3.0
-
-- Use https as default.
-- Download blurbs from S3.
-- Add toolbar.
-- "Translations in this page" menu.
+> [!NOTE]
+> 変更履歴は [GitHub Releases](https://github.com/SonicGarden/copy-tuner-ruby-client/releases) に移行済みです。

data/CLAUDE.md

@@ -26,6 +26,7 @@ Rails 統合は engine.rb のイニシャライザ経由（ヘルパー/SimpleFo
 - 新機能・バグ修正ともに「テスト追加 → RED 確認 → 実装 → GREEN」のサイクルを守る
 - テストを書かずに実装を先行させない
 - **コメントは WHY のみ日本語で書く**: 識別子やコードから読み取れる WHAT は書かない
+  （例外: RuboCop Style/Documentation 対応でクラス/モジュール直前に追加する一行の説明コメントは、名前だけでは把握しづらいクラスの役割を一目で示す目的のため、WHAT の説明も可）
 - **テストの `describe` / `context` / `it` の説明文は日本語で書く**: 識別子（クラス名・メソッド名など）はそのまま
 
 ## Gotchas

data/Gemfile

@@ -2,4 +2,5 @@ source 'http://rubygems.org'
 
 gemspec
 
+gem 'bundler-skills'
 gem 'sgcop', github: 'SonicGarden/sgcop'

data/README.md

@@ -62,20 +62,57 @@ CopyTuner で一元管理している翻訳を、`views.*` のような単位で
 
 アプリ独自の `number.*` キー（例 `number.gift_amount`）は対象外で、従来どおり CopyTuner で管理できます。
 
-## Claude Code スキル
+## Middleware の挿入位置
 
-`skills/copy-tuner/` に Claude Code 向けのスキルが含まれています。
+CopyTuner は開発環境で `RequestSync` / `CopyrayMiddleware` を Rack の middleware スタックに挿入します。`RequestSync` はリクエスト毎に CopyTuner サーバと同期し、`CopyrayMiddleware` はページ内のマーカー（`⟦CT:key⟧`）を除去・変換します。
 
-### copy-tuner スキル
+挿入位置は自動で決まるため、通常は設定不要です。Devise（Warden）を使っているアプリでは `Warden::Manager` の直前、それ以外の環境ではスタック末尾に挿入されます。
 
-i18n キーの操作を支援するスキルです。翻訳キーの検索・登録・確認などの依頼に自動的に使用されます。
+Devise 併用時に Warden の直前へ寄せるのは `throw :warden` の挙動に対応するためです。`throw :warden` は `Warden::Manager` の `catch(:warden)` までスタックを巻き戻すため、CopyTuner の middleware が Warden より内側にあると、認証エラー時のレスポンス（`Devise::FailureApp` が返す HTML）を受け取れず、Copyray のマーカーがページに残ってしまいます。
+
+位置を変えたい場合は `config.middleware_position` に `{ before: SomeMiddleware }` または `{ after: SomeMiddleware }` を指定すると、このデフォルトを上書きできます。
+
+```ruby
+CopyTunerClient.configure do |config|
+  # ...
+  config.middleware_position = { after: Rack::Runtime }
+end
+```
+
+指定した middleware がスタックに存在しない場合、Rails の起動時に例外（`No such middleware to insert before: ...` / `... insert after: ...`）が発生します。
+
+## Claude Code スキル
+
+`skills/` 以下に Claude Code 向けのスキルが含まれています。
 
 ```
-gh skill install SonicGarden/copy-tuner-ruby-client copy-tuner --scope project
+gh skill install SonicGarden/copy-tuner-ruby-client <スキル名> --scope project
 ```
 
+### copy-tuner スキル
+
+i18n キーの操作を支援するスキルです。翻訳キーの検索・登録・確認などの依頼に自動的に使用されます。
+
 詳細: [skills/copy-tuner/SKILL.md](skills/copy-tuner/SKILL.md)
 
+### copy-tuner-to-locales-migrate-prefix スキル
+
+copy_tuner が集中管理する i18n キーを、prefix（正規表現）単位で `config/locales` のローカル YAML 管理へ移行するスキルです。gem は残したまま特定 prefix だけをローカル化する「部分ローカル化」と、全 prefix を移して完全撤去する「全移行」の両方に使えます。明示的に呼び出したときのみ動作します。
+
+詳細: [skills/copy-tuner-to-locales-migrate-prefix/SKILL.md](skills/copy-tuner-to-locales-migrate-prefix/SKILL.md)
+
+### copy-tuner-to-locales-cleanup スキル
+
+`copy-tuner-to-locales-migrate-prefix` で全 prefix の移行が完了した後に、gem・初期化子・CI・deploy・ドキュメント・MCP 設定を一括撤去し、copy_tuner 依存を完全に取り除くスキルです。明示的に呼び出したときのみ動作します。
+
+詳細: [skills/copy-tuner-to-locales-cleanup/SKILL.md](skills/copy-tuner-to-locales-cleanup/SKILL.md)
+
+### copy-tuner-to-t-migrate スキル
+
+copy_tuner_client v2.0.0 で削除された独自ヘルパー `tt` の呼び出しを、Rails 標準の `t`（`translate`）へ置換するスキルです。機械的に安全な箇所は一括変換し、文字列加工や `label` の第一引数に渡している箇所は 1 件ずつ確認しながら置換します。破壊的な一括書き換えを含むため、明示的に呼び出したときのみ動作します。
+
+詳細: [skills/copy-tuner-to-t-migrate/SKILL.md](skills/copy-tuner-to-t-migrate/SKILL.md)
+
 Development
 =================
 

data/copy_tuner_client.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.homepage = 'https://github.com/SonicGarden/copy-tuner-ruby-client'
 
-  s.metadata["homepage_uri"] = s.homepage
-  s.metadata["source_code_uri"] = "https://github.com/SonicGarden/copy-tuner-ruby-client"
-  s.metadata["changelog_uri"] = "https://github.com/SonicGarden/copy-tuner-ruby-client/releases"
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/SonicGarden/copy-tuner-ruby-client'
+  s.metadata['changelog_uri'] = 'https://github.com/SonicGarden/copy-tuner-ruby-client/releases'
   s.metadata['rubygems_mfa_required'] = 'true'
 
   s.name = 'copy_tuner_client'

data/gemfiles/8.0.gemfile

@@ -1,5 +1,5 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", "~> 8.0"
+gem 'rails', '~> 8.0'
 
-gemspec :path => "../"
+gemspec path: '../'

data/gemfiles/8.1.gemfile

@@ -1,5 +1,5 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", "~> 8.1"
+gem 'rails', '~> 8.1'
 
-gemspec :path => "../"
+gemspec path: '../'

data/gemfiles/main.gemfile

@@ -1,5 +1,5 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "rails", github: "rails/rails", branch: "main"
+gem 'rails', github: 'rails/rails', branch: 'main'
 
-gemspec :path => "../"
+gemspec path: '../'

data/lib/copy_tuner_client/cache.rb

@@ -23,7 +23,7 @@ module CopyTunerClient
       @local_first_key_regexp = options[:local_first_key_regexp]
       @upload_disabled = options[:upload_disabled]
       @ignored_keys = options.fetch(:ignored_keys, [])
-      @ignored_key_handler = options.fetch(:ignored_key_handler, -> (e) { raise e })
+      @ignored_key_handler = options.fetch(:ignored_key_handler, ->(e) { raise e })
       @locales = Array(options[:locales]).map(&:to_s)
       # mutable states
       @blurbs = {}
@@ -48,18 +48,14 @@ module CopyTunerClient
     # @param key [String] the key of the blurb to update
     # @param value [String] the new contents of the blurb
     def []=(key, value)
-      return unless key.include?('.')
-      return if @locales.present? && !@locales.member?(key.split('.').first)
-      return if @upload_disabled
+      return if skip_upload?(key)
 
       # NOTE: config/locales以下のファイルに除外キーが残っていた場合の対応
       key_without_locale = key.split('.')[1..].join('.')
       # NOTE: local_first キー（組み込みの Rails number.*.format + ユーザー設定）は copy_tuner と完全分離するためアップロードしない
       return if local_first_key?(key_without_locale)
 
-      if @ignored_keys.include?(key_without_locale)
-        @ignored_key_handler.call(IgnoredKey.new("Ignored key: #{key_without_locale}"))
-      end
+      handle_ignored_key(key_without_locale)
 
       lock do
         return if @blank_keys.member?(key) || @blurbs.key?(key)
@@ -100,17 +96,16 @@ module CopyTunerClient
 
       logger.info 'Waiting for first download'
 
-      if logger.respond_to? :flush
-        logger.flush
-      end
+      logger.flush if logger.respond_to?(:flush)
 
-      sleep 0.1 while pending?
+      sleep(0.1) while pending?
     end
 
     def flush
-      res = with_queued_changes do |queued|
-        client.upload queued
-      end
+      res =
+        with_queued_changes do |queued|
+          client.upload(queued)
+        end
 
       @last_uploaded_at = Time.now.utc
 
@@ -122,15 +117,16 @@ module CopyTunerClient
     def download
       @status = STATUS_PENDING unless ready?
 
-      res = client.download(cache_fallback: pending?) do |downloaded_blurbs|
-        blank_keys = Set.new
-        blurbs = {}
-        downloaded_blurbs.each { |key, value| value == '' ? blank_keys << key : blurbs[key] = value }
-        lock do
-          @blank_keys = blank_keys
-          @blurbs = blurbs
+      res =
+        client.download(cache_fallback: pending?) do |downloaded_blurbs|
+          blank_keys = Set.new
+          blurbs = {}
+          downloaded_blurbs.each { |key, value| value == '' ? blank_keys << key : blurbs[key] = value }
+          lock do
+            @blank_keys = blank_keys
+            @blurbs = blurbs
+          end
         end
-      end
 
       @last_downloaded_at = Time.now.utc
       @status = STATUS_READY unless ready?
@@ -163,6 +159,13 @@ module CopyTunerClient
 
     attr_reader :client, :logger
 
+    def skip_upload?(key)
+      return true unless key.include?('.')
+      return true if @locales.present? && !@locales.member?(key.split('.').first)
+
+      @upload_disabled
+    end
+
     # NOTE: 組み込みの Rails number.*.format キーは lookup 経路（Configuration#local_first_key?）と
     # アップロード抑止経路（ここ）で同じ判定を共有する。判定本体は Configuration に集約し付け忘れの穴を防ぐ。
     def local_first_key?(key_without_locale)
@@ -171,6 +174,12 @@ module CopyTunerClient
       @local_first_key_regexp && key_without_locale.match?(@local_first_key_regexp)
     end
 
+    def handle_ignored_key(key_without_locale)
+      return unless @ignored_keys.include?(key_without_locale)
+
+      @ignored_key_handler.call(IgnoredKey.new("Ignored key: #{key_without_locale}"))
+    end
+
     def with_queued_changes
       changes_to_push = nil
 
@@ -181,9 +190,7 @@ module CopyTunerClient
         end
       end
 
-      if changes_to_push
-        yield nil_value_to_empty(changes_to_push)
-      end
+      yield(nil_value_to_empty(changes_to_push)) if changes_to_push
     end
 
     def nil_value_to_empty(hash)
@@ -197,8 +204,8 @@ module CopyTunerClient
       hash
     end
 
-    def lock(&block)
-      @mutex.synchronize &block
+    def lock(&)
+      @mutex.synchronize(&)
     end
   end
 end