copy_tuner_client 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10935db209e8b915ac8101dfa324bf5a40da15978124e8300746c0be13407862
-  data.tar.gz: faa6e39b7149540c342ec9fcefce9f0c47425614c4f361fa8b8b597ff932d69c
+  metadata.gz: 238593f77e71df10a71b7710228cf56cf930a320a141a74e573e9ff015b1f730
+  data.tar.gz: acd4453041d32c2e43b81207953fca9b68c1bbec5f4cc3dafafc4722fcaada54
 SHA512:
-  metadata.gz: 83ea46e846b20d110366e5d8d7ecb5c415a082a700e45682931e2303a7516e50c6d1b0fcdce5ea7deada42dd3ef7e6f9df07ff4084c3b211db0cb42d1de1d422
-  data.tar.gz: 194dc1188ab23b9776b030ec08c453444513a8f55d6b674d4b06b6953c652409951690bbfad569b1e2524a02c7951f5faeb55a4fe0d1eafbfd77c61d72cb2a45
+  metadata.gz: bea767cacf8232f89e3fdd6f1b6b0caee1957b7306cbf018cadfcccee49a7ce22d74640f4319771cb4dda000b61142d45190791cb46aa0b2ee4f4e1f216d7576
+  data.tar.gz: 8f4c0d08195e35de0918ca7b1380146770242867f681166a39d8fc206cf16965f316e532bef59baa0525fe26f069b99b876f8ba38de49f6b88d25e2d2a820edc

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.4.0'.freeze
+  VERSION = '1.5.0'.freeze
 
   # API version being used to communicate with the server
   API_VERSION = '2.0'.freeze

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.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - SonicGarden