copy_tuner_client 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d298d7f59a4cacd30c925e2a0af2b6026fbd3610d4564fae70e5b6efbad4ad0c
-  data.tar.gz: 0f7e09019505a1b49353550b696a2f4a0a4a40eaf74573e4a4e916ec547bd1e9
+  metadata.gz: 238593f77e71df10a71b7710228cf56cf930a320a141a74e573e9ff015b1f730
+  data.tar.gz: acd4453041d32c2e43b81207953fca9b68c1bbec5f4cc3dafafc4722fcaada54
 SHA512:
-  metadata.gz: 934b99a1624d8dd517c9f2df68c37ffb667128beca73222db458b5f973534398eda88f01c6550c48219e54205fb14b6e47d9731f9556ec0c55d06ce5b47b3729
-  data.tar.gz: 11e6f16e6792603ee6d5c74f4888f293895cf483d10f88d57298bc80bd54a05cb50da5dcdba2c9ade055bf6d57afe66a398b355de806a87a0528dea9e19efaae
+  metadata.gz: bea767cacf8232f89e3fdd6f1b6b0caee1957b7306cbf018cadfcccee49a7ce22d74640f4319771cb4dda000b61142d45190791cb46aa0b2ee4f4e1f216d7576
+  data.tar.gz: 8f4c0d08195e35de0918ca7b1380146770242867f681166a39d8fc206cf16965f316e532bef59baa0525fe26f069b99b876f8ba38de49f6b88d25e2d2a820edc

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    cooldown:
+      default-days: 5
+    ignore:
+      - dependency-name: "ruby/setup-ruby"
+        update-types:
+          - "version-update:semver-patch"
+          - "version-update:semver-minor"
+      - dependency-name: "actions/checkout"
+        update-types:
+          - "version-update:semver-patch"
+          - "version-update:semver-minor"
+    schedule:
+      # Check for updates to GitHub Actions every weekday
+      interval: "weekly"

data/.github/workflows/rspec.yml

@@ -22,14 +22,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.1", "3.2", "3.3", "3.4"]
-        gemfile: ["7.1", "7.2", "8.0", "main"]
+        ruby: ["3.3", "3.4", "4.0"]
+        gemfile: ["8.0", "8.1", "main"]
         exclude:
-          - ruby: "3.1"
-            gemfile: "8.0"
-          - ruby: "3.1"
+          - ruby: "3.3"
             gemfile: "main"
-          - ruby: "3.2"
+          - ruby: "3.4"
             gemfile: "main"
     steps:
       - name: Install packages
@@ -37,7 +35,7 @@ jobs:
           sudo apt update -y
           sudo apt install -y libsqlite3-dev
 
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

data/.rubocop.yml

@@ -1,2 +1,7 @@
 inherit_gem:
   sgcop: ruby/rubocop.yml
+
+# .ruby-version が RuboCop 未対応の新しい Ruby を指すと解析が落ちるため、
+# サポート最低バージョンを明示する
+AllCops:
+  TargetRubyVersion: 3.3

data/.ruby-version

@@ -1 +1 @@
-3.4.5
+4.0.5

data/copy_tuner_client.gemspec

@@ -2,11 +2,11 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'copy_tuner_client/version'
 
 Gem::Specification.new do |s|
-  s.required_ruby_version = '>= 3.1.0'
+  s.required_ruby_version = '>= 3.3.0'
   s.add_dependency 'i18n', '>= 0.5.0'
   s.add_dependency 'json'
   s.add_dependency 'nokogiri'
-  s.add_development_dependency 'rails', '~> 7.1'
+  s.add_development_dependency 'rails', '~> 8.0'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'sham_rack'

data/gemfiles/{7.1.gemfile → 8.1.gemfile}

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

data/lib/copy_tuner_client/dotted_hash.rb

@@ -3,9 +3,7 @@ module CopyTunerClient
     def to_h(dotted_hash)
       hash = {}
       dotted_hash.to_h.transform_keys(&:to_s).sort.each do |key, value|
-        # Rails i18n標準との互換性のため、特定のキーを適切な型に変換
-        converted_value = convert_value_type(key, value)
-        _hash = key.split('.').reverse.inject(converted_value) { |memo, _key| { _key => memo } }
+        _hash = key.split('.').reverse.inject(value) { |memo, _key| { _key => memo } }
         hash.deep_merge!(_hash)
       end
       hash
@@ -29,22 +27,6 @@ module CopyTunerClient
       results
     end
 
-    private
-
-    def convert_value_type(key, value)
-      return value unless value.is_a?(String)
-
-      # Rails i18n標準で数値型として扱われるキー
-      if key.end_with?('.precision')
-        value.to_i
-      # Rails i18n標準で真偽値として扱われるキー
-      elsif key.end_with?('.significant', '.strip_insignificant_zeros')
-        value == 'true'
-      else
-        value
-      end
-    end
-
-    module_function :to_h, :conflict_keys, :convert_value_type # rubocop:disable Style/AccessModifierDeclarations
+    module_function :to_h, :conflict_keys # rubocop:disable Style/AccessModifierDeclarations
   end
 end

data/lib/copy_tuner_client/helper_extension.rb

@@ -17,6 +17,12 @@ module CopyTunerClient
               I18n.t(key.to_s.first == '.' ? scope_key_by_partial(key) : key, **options)
             end
 
+            # NOTE: マーカーは HTML コメントとしてブラウザに無視されつつ Copyray オーバーレイのキー特定に
+            # 使われる。HTML 以外の経路（メール本文・render :json・CSV/PDF など）ではコメントが文字列として
+            # 出力に混入してしまうため、それらの経路には注入しない。default 引数による初期値登録は維持する
+            # 必要があるため、このガードは初期値登録（上の I18n.t 呼び出し）より後に置く。
+            return source unless copyray_injectable?
+
             if CopyTunerClient.configuration.disable_copyray_comment_injection
               source
             else
@@ -32,6 +38,24 @@ module CopyTunerClient
               CopyTunerClient::Copyray.augment_template(source, scope_key)
             end
           end
+
+          # NOTE: HTML 以外の経路（メール本文・render :json・CSV/PDF など）ではマーカーが文字列として
+          # 出力に混入するため注入しない。判定には controller.request.format を使い、@current_template.format /
+          # lookup_context.formats のような ActionView の内部実装には依存させない（Rails バージョン間で壊れうるため）。
+          def copyray_injectable?
+            current_controller = controller
+            return false if current_controller.nil?
+
+            # NOTE: mailer は request を持たず request.format で判定できない。かつメール本文への
+            # マーカー混入は実害が大きいため、controller の型で明示除外する。
+            return false if defined?(ActionMailer::Base) && current_controller.is_a?(ActionMailer::Base)
+
+            # NOTE: request が無い／format が html でない経路には注入しない。&. と || false で
+            # request 不在時も安全に false を返す。
+            current_controller.request&.format&.html? || false
+          end
+          private :copyray_injectable?
+
           if middleware_enabled
             alias_method :translate_without_copyray_comment, :translate
             alias_method :translate, :translate_with_copyray_comment

data/lib/copy_tuner_client/version.rb

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

data/skills/copy-tuner/SKILL.md

@@ -18,13 +18,19 @@ license: MIT
 | 判別 | 管理場所 | 操作 |
 |---|---|---|
 | マッチする | config/locales（copy_tuner と完全分離） | `config/locales/*.yml` を Read / Edit |
-| マッチしない・未設定 | copy_tuner | MCP ツール（下記） |
+| マッチしない・未設定 | copy_tuner | **MCP ツール経由でのみ探す**（下記） |
+
+**copy_tuner 管理のキーは必ず MCP ツール経由で探すこと。** ローカルの `.yml` を grep して見つけたつもりになってはならない。
 
 **例外（gem 組み込み・設定不要で常に config/locales 管理）:** Rails 標準の `number.format` /
 `number.currency.format` / `number.percentage.format` / `number.human.format`（およびその配下）。
 `precision` 等の非文字列値を含み copy_tuner では正しく扱えないため、gem が常にバイパスする。
 これらは `config/locales/*.yml` を見る・編集すること（アプリ独自の `number.gift_amount` 等は対象外で通常どおり copy_tuner）。
 
+**`config/locales` 以外の export 済み yml は参照禁止:**
+環境によっては copy_tuner から export したキャッシュ用の `.yml`（`config/locales` 配下以外、例: アプリ直下や `tmp/`、`db/` などに置かれた export ファイル）が存在することがある。
+これらは古いスナップショットであり権威ある情報源ではない。**読んで判断材料にしてはならない。** copy_tuner 管理キーは常に MCP ツールで最新を確認する。
+
 **config/locales 管理キーの落とし穴:**
 - copy_tuner には存在しないので、MCP ツールで探しても見つからない。`config/locales` を見ること。
 - copy_tuner に登録しても lookup でバイパスされ無効。必ず `.yml` 側に書く。
@@ -38,7 +44,8 @@ license: MIT
 | キー名（一部）から翻訳を調べる | `search_key`（引数は英語キーワード） |
 | 画面テキストからキーを逆引き | `search_translations` |
 | 新しいキーを登録する | `create_i18n_key` |
-| 既存キーの翻訳を更新する | `get_edit_url`（ブラウザ編集） |
+| 既存キーのドラフト訳を更新する | `update_i18n_key` |
+| 既存キーの翻訳を更新する（ブラウザ） | `get_edit_url` |
 | 使用中ロケールを確認 | `get_locales` |
 
 ## 新規キー登録
@@ -46,6 +53,19 @@ license: MIT
 1. `search_key` で関連キーを検索し、既存の命名パターンに合わせる（例: `search_key("move_out")`）。
 2. ja は必須。他は `get_locales` で確認し、存在するロケール分を登録する。
 
+## 既存キーの訳を更新する
+
+`update_i18n_key` を使う。`key` と `translations`（ロケール・値のペア配列）は両方必須。
+
+**制約**: ドラフト状態または未発行のキーのみ更新可能。発行済み（published）かどうかを事前に知る手段はなく、API にリクエストしてエラーが返るかどうかで初めてわかる。
+
+**published キーへの対応方針**: 値を直接書き換えるのはリスクが高いため、原則として以下の手順を推奨する:
+1. 新しいキーにバージョン番号を付けて登録する（例: `views.foo_v2`）→ **新規キー登録の手順に従う**
+2. コード側の参照を新キーに差し替える
+3. 古いキーを `config/initializers/copy_tuner.rb` の `ignored_keys` に追加する
+
+どうしても既存キーを書き換えたい場合は `get_edit_url` でブラウザから編集する。
+
 ## 不要なキーの処理
 
 削除せず `config/initializers/copy_tuner.rb` の `ignored_keys` に追加する。

data/spec/copy_tuner_client/dotted_hash_spec.rb

@@ -59,75 +59,22 @@ describe CopyTunerClient::DottedHash do
       it { is_expected.to eq({ 'en' => { 'test' => { 'key' => 'en test value' } } }) }
     end
 
-    context "Rails i18nの数値precisionキーの場合" do
+    # NOTE: number.*.format 配下のキー（precision 等）は I18nBackend の local_first_key? ガードで
+    # tree_cache をバイパスしローカル YAML 優先になるため、ここで型変換せず文字列のまま保持する。
+    # （number_to_currency が壊れないことは i18n_backend_spec の number ローカル優先テストで担保）
+    context "number.*.format 配下の値を含む場合" do
       let(:dotted_hash) do
         {
           'en.number.currency.format.precision' => '2',
-          'en.number.format.precision' => '3',
-        }
-      end
-
-      it "precision値を整数に変換する" do
-        is_expected.to eq({
-          'en' => {
-            'number' => {
-              'currency' => {
-                'format' => {
-                  'precision' => 2,
-                },
-              },
-              'format' => {
-                'precision' => 3,
-              },
-            },
-          },
-        })
-      end
-    end
-
-    context "Rails i18nのbooleanキーの場合" do
-      let(:dotted_hash) do
-        {
-          'en.number.currency.format.significant' => 'false',
-          'en.number.format.strip_insignificant_zeros' => 'true',
-        }
-      end
-
-      it "boolean値を実際の真偽値に変換する" do
-        is_expected.to eq({
-          'en' => {
-            'number' => {
-              'currency' => {
-                'format' => {
-                  'significant' => false,
-                },
-              },
-              'format' => {
-                'strip_insignificant_zeros' => true,
-              },
-            },
-          },
-        })
-      end
-    end
-
-    context "Rails i18n以外で似たパターンを含むキーの場合" do
-      let(:dotted_hash) do
-        {
           'en.custom.precision' => 'custom_value',
-          'en.other.significant_value' => 'true',
         }
       end
 
-      it "Rails i18nパターンで終わるキーのみ変換する" do
+      it "型変換せず値を文字列のまま保持する" do
         is_expected.to eq({
           'en' => {
-            'custom' => {
-              'precision' => 0, # .precision suffix triggers conversion
-            },
-            'other' => {
-              'significant_value' => 'true', # no conversion for non-exact match
-            },
+            'number' => { 'currency' => { 'format' => { 'precision' => '2' } } },
+            'custom' => { 'precision' => 'custom_value' },
           },
         })
       end

data/spec/copy_tuner_client/helper_extension_spec.rb

@@ -3,13 +3,39 @@ require 'copy_tuner_client/helper_extension'
 require 'copy_tuner_client/copyray'
 
 describe CopyTunerClient::HelperExtension do
+  # NOTE: helper_extension が参照する CopyTunerClient::Rails は engine への依存があり
+  # 単体 spec では require できないため、メソッドをスタブできる最小の入れ物だけ用意する。
+  module CopyTunerClient
+    module Rails
+      def self.controller_of_rails_engine?(_controller)
+        false
+      end
+    end
+  end
+
+  # NOTE: request.format で描画フォーマットを判定するため、format を差し替えられる
+  # 最小のフェイク request / controller を用意する。mailer 判定は controller の型で行う。
+  Format = Struct.new(:type) do
+    def html?
+      type == :html
+    end
+  end
+  Request = Struct.new(:format)
+  Controller = Struct.new(:request)
+
   module KeywordArgumentsHelper
+    attr_writer :controller
+
     def translate(key, **options)
       "Hello, #{options[:name]}"
     end
 
     def controller
-      nil
+      return @controller if defined?(@controller)
+
+      # NOTE: 実 HTML 描画では controller が存在し request.format が html になるため、
+      # デフォルトはそれを再現した controller。
+      @controller = Controller.new(Request.new(Format.new(:html)))
     end
   end
 
@@ -19,14 +45,67 @@ describe CopyTunerClient::HelperExtension do
 
   CopyTunerClient::HelperExtension.hook_translation_helper(KeywordArgumentsHelper, middleware_enabled: true)
 
+  let(:view) { KeywordArgumentsView.new }
+
+  before do
+    # NOTE: controller_of_rails_engine? は ::Rails::Engine への依存があり単体 spec では評価できないため、
+    # この spec の関心（注入ガード）に絞って常に false を返すようスタブする。
+    allow(CopyTunerClient::Rails).to receive(:controller_of_rails_engine?).and_return(false)
+  end
+
   it 'works with keyword argument method' do
-    view = KeywordArgumentsView.new
     expect(view.translate('some.key', name: 'World')).to eq '<!--COPYRAY some.key-->Hello, World'
   end
 
   it 'does not inject the overlay marker for a local_first key' do
     CopyTunerClient.configuration.local_first_key_regexp = /\Aviews\./
-    view = KeywordArgumentsView.new
     expect(view.translate('views.foo', name: 'World')).to eq 'Hello, World'
   end
+
+  context 'injection guard by request format' do
+    it 'injects the marker when request.format is html' do
+      expect(view.translate('some.key', name: 'World')).to eq '<!--COPYRAY some.key-->Hello, World'
+    end
+
+    %i[json text csv pdf].each do |format|
+      it "does not inject the marker when request.format is :#{format}" do
+        view.controller = Controller.new(Request.new(Format.new(format)))
+        expect(view.translate('some.key', name: 'World')).to eq 'Hello, World'
+      end
+    end
+  end
+
+  context 'injection guard by controller' do
+    it 'does not inject the marker when rendered by a mailer' do
+      stub_const('ActionMailer::Base', Class.new)
+      view.controller = ActionMailer::Base.new
+      expect(view.translate('some.key', name: 'World')).to eq 'Hello, World'
+    end
+
+    it 'does not inject the marker when controller is nil' do
+      view.controller = nil
+      expect(view.translate('some.key', name: 'World')).to eq 'Hello, World'
+    end
+
+    it 'does not inject the marker when the controller has no request' do
+      view.controller = Controller.new(nil)
+      expect(view.translate('some.key', name: 'World')).to eq 'Hello, World'
+    end
+
+    it 'does not raise when ActionMailer is not loaded' do
+      hide_const('ActionMailer::Base') if defined?(ActionMailer::Base)
+      view.controller = Controller.new(Request.new(Format.new(:html)))
+      expect { view.translate('some.key', name: 'World') }.not_to raise_error
+    end
+  end
+
+  # NOTE: マーカー注入を抑止する非 HTML 経路でも、default 引数による初期値登録（I18n.t 呼び出し）は
+  # 維持されなければならない。注入ガードが初期値登録まで巻き添えで止めていないことを保証する。
+  context 'default value registration' do
+    it 'registers the default value even when the marker is not injected' do
+      view.controller = Controller.new(Request.new(Format.new(:json)))
+      expect(I18n).to receive(:t).with('some.key', hash_including(default: 'Default'))
+      view.translate('some.key', name: 'World', default: 'Default')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_client
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - SonicGarden
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +185,7 @@ files:
 - ".babelrc"
 - ".eslintrc.js"
 - ".gitattributes"
+- ".github/dependabot.yml"
 - ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
@@ -200,9 +201,8 @@ files:
 - app/assets/javascripts/copytuner.js
 - app/assets/stylesheets/copytuner.css
 - copy_tuner_client.gemspec
-- gemfiles/7.1.gemfile
-- gemfiles/7.2.gemfile
 - gemfiles/8.0.gemfile
+- gemfiles/8.1.gemfile
 - gemfiles/main.gemfile
 - index.html
 - lib/copy_tuner_client.rb
@@ -288,14 +288,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Client for the CopyTuner copy management service
 test_files: []

data/gemfiles/7.2.gemfile

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