copy_tuner_client 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 803784553a4dbeb3916ccdffef8ebe40626644c18b1ac7fa0e42ff9158d9ae1a
-  data.tar.gz: aa985dc5ac60c2f137fe95a9fd5c3c15fd7e8667e7b4f183d49f1e89ba448aa7
+  metadata.gz: 938a08aeb03719e98a6e118eb714b820798f91ff3d5e69cce65eeea3d8b243ca
+  data.tar.gz: 9da7bbe8fa7ed6b92b90fa090f9ebf5ec67cb8945bace845494aa7638640b3ce
 SHA512:
-  metadata.gz: 321d3cc14cfd86127ca2bbe204fa89cd76f152a9770991ed0d8939f6b7724500b1bd7c92dca63b615e4ae741b2652ef0176f60e4c6342afd0a1c718ae8503ddc
-  data.tar.gz: 3860c2738c49a2c7fd4af233ba3f062fda3fff1a6d789a851a1f2973029e4cbc201f6d61898ba05f63bf9f79fd5e19d2b8a40ddf387f58d0699e0475d2d08f8c
+  metadata.gz: 86d05a06a42a06da4586d60bc80649cdb9f4cd98c26425d6528f7b121c2ca880b366bc12aeec7b20952bbc7129b2837dcd9261851bb960ddebd7de773e0b64b6
+  data.tar.gz: 831783835b4ede6b590dd298e89f596c8c9ca417260e4ae490f8b6bbca576e07c7b5f89a490eb8b2b651e305a66b0c9dac7c526f0592d2fdef7f7337d70f6607

data/lib/copy_tuner_client/copyray.rb

@@ -3,6 +3,10 @@ require 'copy_tuner_client/copyray/marker'
 module CopyTunerClient
   # 翻訳テキストにオーバーレイ編集用のマーカートークンを埋め込む
   class Copyray
+    # NOTE: マーカーは CopyrayMiddleware の Rewriter でしか除去されない。注入可否を「format が html か」ではなく
+    # 「この描画の出力が middleware を通るか」で判定するため、middleware が env にこの印を立てる。
+    ENV_KEY = 'copy_tuner.copyray_injectable'.freeze
+
     # This:
     #   message
     # Becomes:

data/lib/copy_tuner_client/copyray_middleware.rb

@@ -1,5 +1,6 @@
 # cf) xray-rails : xray/middleware.rb
 
+require 'copy_tuner_client/copyray'
 require 'copy_tuner_client/copyray/rewriter'
 
 module CopyTunerClient
@@ -11,6 +12,7 @@ module CopyTunerClient
 
     def call(env)
       CopyTunerClient::TranslationLog.clear
+      env[CopyTunerClient::Copyray::ENV_KEY] = true
       status, headers, response = @app.call(env)
       if rewritable?(status, headers) && (body = response_body(response))
         rewrite_response(env, status, headers, body, response)

data/lib/copy_tuner_client/engine.rb

@@ -17,6 +17,13 @@ module CopyTunerClient
         )
       end
 
+      ActiveSupport.on_load(:action_controller_base) do
+        CopyTunerClient::HelperExtension.hook_render_to_string(
+          ActionController::Base,
+          middleware_enabled: CopyTunerClient.configuration.enable_middleware?
+        )
+      end
+
       CopyTunerClient::TranslationLog.install_hook if CopyTunerClient.configuration.enable_middleware?
 
       require 'copy_tuner_client/simple_form_extention'

data/lib/copy_tuner_client/helper_extension.rb

@@ -1,5 +1,7 @@
+require 'copy_tuner_client/copyray'
+
 module CopyTunerClient
-  # ActionView の translate/t を alias_method で差し替え、Copyray のオーバーレイマーカーを注入する
+  # ActionView の translate/t を差し替えて Copyray のオーバーレイマーカーを注入し、注入してよい描画経路を制御する
   module HelperExtension
     # NOTE: class_eval ブロック内で def すると、ブロック内メソッドの複雑さが
     # hook_translation_helper 自体の Metrics/AbcSize としてカウントされてしまうため、
@@ -50,14 +52,40 @@ module CopyTunerClient
         # マーカー混入は実害が大きいため、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
+        request = current_controller.request
+        return false unless passes_copyray_middleware?(request)
+
+        # NOTE: middleware を通っても render json: などは rewritable? に弾かれ書き換えられないため、
+        # format が html でない経路には注入しない。
+        request.format&.html? || false
       end
       private :copyray_injectable?
+
+      # NOTE: format が html でも出力が CopyrayMiddleware を通らない経路（ApplicationController.renderer や
+      # render_to_string）ではマーカーが除去されずに残るため、middleware が立てた印がある場合に限り注入する。
+      def passes_copyray_middleware?(request)
+        request&.env&.[](CopyTunerClient::Copyray::ENV_KEY)
+      end
+      private :passes_copyray_middleware?
     end
     private_constant :CopyrayCommentInjection
 
+    # NOTE: render_to_string の結果は PDF 化や JSON 埋め込みなどレスポンス以外に使われ、middleware の
+    # 書き換えを通らない。実行中だけ印を外し、その間の translate にマーカーを注入させない。
+    module RenderToStringGuard
+      def render_to_string(*, **, &)
+        env = request&.env
+        return super unless env&.delete(CopyTunerClient::Copyray::ENV_KEY)
+
+        begin
+          super
+        ensure
+          env[CopyTunerClient::Copyray::ENV_KEY] = true
+        end
+      end
+    end
+    private_constant :RenderToStringGuard
+
     def self.hook_translation_helper(mod, middleware_enabled:)
       return unless middleware_enabled
 
@@ -68,5 +96,11 @@ module CopyTunerClient
         alias_method :t, :translate
       end
     end
+
+    def self.hook_render_to_string(mod, middleware_enabled:)
+      return unless middleware_enabled
+
+      mod.prepend(RenderToStringGuard)
+    end
   end
 end

data/lib/copy_tuner_client/version.rb

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

data/spec/copy_tuner_client/copyray_middleware_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 require 'copy_tuner_client/copyray_middleware'
 require 'copy_tuner_client/copyray/marker'
+require 'copy_tuner_client/copyray'
 require 'copy_tuner_client/translation_log'
 
 describe CopyTunerClient::CopyrayMiddleware do
@@ -78,6 +79,19 @@ describe CopyTunerClient::CopyrayMiddleware do
     end
   end
 
+  context '下流の app を呼ぶとき' do
+    it '下流の app に渡る env にフラグが立っている' do
+      received_env = nil
+      recording_app =
+        ->(env) do
+          received_env = env.dup
+          [200, { 'Content-Type' => 'application/json' }, ['{}']]
+        end
+      described_class.new(recording_app).call({})
+      expect(received_env[CopyTunerClient::Copyray::ENV_KEY]).to be true
+    end
+  end
+
   context 'HTML 以外のレスポンスのとき' do
     let(:headers) { { 'Content-Type' => 'application/json' } }
     let(:body) { "{\"x\":\"#{marker('a.b')}\"}" }

data/spec/copy_tuner_client/helper_extension_spec.rb

@@ -17,7 +17,12 @@ describe CopyTunerClient::HelperExtension do
   end
 
   def request_class
-    @request_class ||= Struct.new(:format)
+    @request_class ||= Struct.new(:format, :env)
+  end
+
+  # NOTE: CopyrayMiddleware を通るリクエストを再現するため、フラグ付きの env を持つ request を作る。
+  def injectable_request(format = :html)
+    request_class.new(format_class.new(format), { CopyTunerClient::Copyray::ENV_KEY => true })
   end
 
   def controller_class
@@ -44,7 +49,7 @@ describe CopyTunerClient::HelperExtension do
   # デフォルトはそれを再現した controller を持たせておく。
   let(:view) do
     Class.new.include(keyword_arguments_helper).new.tap do |v|
-      v.controller = controller_class.new(request_class.new(format_class.new(:html)))
+      v.controller = controller_class.new(injectable_request)
     end
   end
 
@@ -84,10 +89,20 @@ describe CopyTunerClient::HelperExtension do
 
     %i[json text csv pdf].each do |format|
       it "does not inject the marker when request.format is :#{format}" do
-        view.controller = controller_class.new(request_class.new(format_class.new(format)))
+        view.controller = controller_class.new(injectable_request(format))
         expect(view.translate('some.key', name: 'World')).to eq 'Hello, World'
       end
     end
+
+    it 'format が html でも env にフラグが無ければ注入しない' do
+      view.controller = controller_class.new(request_class.new(format_class.new(:html), {}))
+      expect(view.translate('some.key', name: 'World')).to eq 'Hello, World'
+    end
+
+    it 'request.env が nil でも落ちずに注入しない' do
+      view.controller = controller_class.new(request_class.new(format_class.new(:html), nil))
+      expect(view.translate('some.key', name: 'World')).to eq 'Hello, World'
+    end
   end
 
   context 'injection guard by controller' do
@@ -109,7 +124,7 @@ describe CopyTunerClient::HelperExtension do
 
     it 'does not raise when ActionMailer is not loaded' do
       hide_const('ActionMailer::Base') if defined?(ActionMailer::Base)
-      view.controller = controller_class.new(request_class.new(format_class.new(:html)))
+      view.controller = controller_class.new(injectable_request)
       expect { view.translate('some.key', name: 'World') }.not_to raise_error
     end
   end
@@ -118,10 +133,91 @@ describe CopyTunerClient::HelperExtension do
   # 維持されなければならない。注入ガードが初期値登録まで巻き添えで止めていないことを保証する。
   context 'default value registration' do
     it 'registers the default value even when the marker is not injected' do
-      view.controller = controller_class.new(request_class.new(format_class.new(:json)))
+      view.controller = controller_class.new(injectable_request(:json))
       allow(I18n).to receive(:t)
       view.translate('some.key', name: 'World', default: 'Default')
       expect(I18n).to have_received(:t).with('some.key', hash_including(default: 'Default'))
     end
   end
+
+  describe '.hook_render_to_string' do
+    # NOTE: ActionController::Base を読み込まずに検証するため、super 呼び出し時の env の状態を
+    # 記録するだけの最小の基底クラスに prepend する。
+    let(:base_class) do
+      Class.new do
+        attr_reader :request, :recorded
+
+        def initialize(request)
+          @request = request
+          @recorded = []
+        end
+
+        def render_to_string(*_args, raise_error: false, nested: false)
+          record_flag
+          if nested
+            render_to_string
+            record_flag
+          end
+          raise 'boom' if raise_error
+
+          'rendered'
+        end
+
+        def record_flag
+          @recorded << request&.env&.key?(CopyTunerClient::Copyray::ENV_KEY)
+        end
+      end
+    end
+    let(:env) { { CopyTunerClient::Copyray::ENV_KEY => true } }
+    let(:controller) { base_class.new(request_class.new(format_class.new(:html), env)) }
+
+    context 'middleware_enabled が true のとき' do
+      before { described_class.hook_render_to_string(base_class, middleware_enabled: true) }
+
+      it '実行中は env からフラグが外れる' do
+        controller.render_to_string
+        expect(controller.recorded).to eq [false]
+      end
+
+      it '元の戻り値を返す' do
+        expect(controller.render_to_string).to eq 'rendered'
+      end
+
+      it '終了後はフラグが復元される' do
+        controller.render_to_string
+        expect(env[CopyTunerClient::Copyray::ENV_KEY]).to be true
+      end
+
+      it '例外が起きてもフラグが復元される' do
+        expect { controller.render_to_string(raise_error: true) }.to raise_error('boom')
+        expect(env[CopyTunerClient::Copyray::ENV_KEY]).to be true
+      end
+
+      it '入れ子でも外側の終了時まで外れたまま' do
+        controller.render_to_string(nested: true)
+        expect(controller.recorded).to eq [false, false, false]
+        expect(env[CopyTunerClient::Copyray::ENV_KEY]).to be true
+      end
+
+      it '元々フラグが無い env にはフラグを足さない' do
+        env.clear
+        controller.render_to_string
+        expect(env).not_to have_key(CopyTunerClient::Copyray::ENV_KEY)
+      end
+
+      it 'request が nil でも落ちない' do
+        controller = base_class.new(nil)
+        expect(controller.render_to_string).to eq 'rendered'
+      end
+    end
+
+    context 'middleware_enabled が false のとき' do
+      before { described_class.hook_render_to_string(base_class, middleware_enabled: false) }
+
+      it 'フックせず実行中もフラグが残る' do
+        controller.render_to_string
+        expect(controller.recorded).to eq [true]
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_client
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - SonicGarden