copy_tuner_client 2.1.2 → 2.2.1

data/lib/copy_tuner_client/client.rb

@@ -9,14 +9,16 @@ module CopyTunerClient
   #
   # A client is usually instantiated when {Configuration#apply} is called, and
   # the application will not need to interact with it directly.
-  class Client
+  class Client # rubocop:disable Metrics/ClassLength
     # These errors will be rescued when connecting CopyTuner.
-    HTTP_ERRORS = [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
-                   Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
-                   Net::ProtocolError, SocketError, OpenSSL::SSL::SSLError,
-                   Errno::ECONNREFUSED]
+    HTTP_ERRORS = [
+      Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+      Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError, SocketError, OpenSSL::SSL::SSLError,
+      Errno::ECONNREFUSED
+    ].freeze
 
-    USER_AGENT = "copy_tuner_client #{CopyTunerClient::VERSION}"
+    USER_AGENT = "copy_tuner_client #{CopyTunerClient::VERSION}".freeze
 
     # ETags を外部から取得可能にする
     # @return [String, nil] 現在のETag値
@@ -36,9 +38,11 @@ module CopyTunerClient
       @etag = nil
       @downloaded_blurbs = {}
 
-      [:api_key, :host, :port, :public, :http_read_timeout,
-        :http_open_timeout, :secure, :logger, :ca_file, :s3_host, :download_cache_dir].each do |option|
-        instance_variable_set "@#{option}", options[option]
+      %i[
+        api_key host port public http_read_timeout
+        http_open_timeout secure logger ca_file s3_host download_cache_dir
+      ].each do |option|
+        instance_variable_set("@#{option}", options[option])
       end
 
       @download_cache_dir.mkpath
@@ -59,19 +63,19 @@ module CopyTunerClient
       connect(s3_host) do |http|
         request = Net::HTTP::Get.new(uri(download_resource))
         request['If-None-Match'] = @etag
-        log 'Start downloading translations'
+        log('Start downloading translations')
         t = Time.now
         response = http.request(request)
         t_ms = ((Time.now - t) * 1000).to_i
         downloaded = check(response)
         if downloaded
           # NOTE: Net::HTTPではgzipが透過的に扱われるため正確なファイルサイズや速度をログに出すのは難しい
-          log "Downloaded translations (#{t_ms}ms)"
+          log("Downloaded translations (#{t_ms}ms)")
           @downloaded_blurbs = JSON.parse(response.body)
           @etag = response['ETag']
           last_download_path.write(JSON.pretty_generate(etag: @etag, downloaded_blurbs: @downloaded_blurbs))
         else
-          log "No new translations (#{t_ms}ms)"
+          log("No new translations (#{t_ms}ms)")
         end
 
         yield(@downloaded_blurbs) if downloaded || cache_fallback
@@ -83,9 +87,10 @@ module CopyTunerClient
     # @raise [ConnectionError] if the connection fails
     def upload(data)
       connect(host) do |http|
-        response = http.post(uri('draft_blurbs'), data.to_json, 'Content-Type' => 'application/json', 'User-Agent' => USER_AGENT)
-        check response
-        log 'Uploaded missing translations'
+        headers = { 'Content-Type' => 'application/json', 'User-Agent' => USER_AGENT }
+        response = http.post(uri('draft_blurbs'), data.to_json, headers)
+        check(response)
+        log('Uploaded missing translations')
       end
     end
 
@@ -94,15 +99,22 @@ module CopyTunerClient
     def deploy
       connect(host) do |http|
         response = http.post(uri('deploys'), '', 'User-Agent' => USER_AGENT)
-        check response
-        log 'Deployed'
+        check(response)
+        log('Deployed')
       end
     end
 
     private
 
-    attr_reader :host, :port, :api_key, :http_read_timeout,
-      :http_open_timeout, :secure, :logger, :ca_file, :s3_host
+    attr_reader :host,
+                :port,
+                :api_key,
+                :http_read_timeout,
+                :http_open_timeout,
+                :secure,
+                :logger,
+                :ca_file,
+                :s3_host
 
     def public?
       @public
@@ -130,7 +142,7 @@ module CopyTunerClient
       cache = JSON.parse(pathname.read.to_s).transform_keys(&:to_sym)
       @etag = cache[:etag]
       @downloaded_blurbs = cache[:downloaded_blurbs]
-      log "Loaded cache data from #{pathname}"
+      log("Loaded cache data from #{pathname}")
     rescue JSON::JSONError, Errno::ENOENT, Errno::ENOTDIR
       nil
     end
@@ -144,9 +156,9 @@ module CopyTunerClient
       http.ca_file = ca_file
 
       begin
-        yield http
-      rescue *HTTP_ERRORS => exception
-        raise ConnectionError, "#{exception.class.name}: #{exception.message}"
+        yield(http)
+      rescue *HTTP_ERRORS => e
+        raise ConnectionError, "#{e.class.name}: #{e.message}"
       end
     end
 

data/lib/copy_tuner_client/configuration.rb

@@ -12,14 +12,16 @@ module CopyTunerClient
   # Used to set up and modify settings for the client.
   class Configuration # rubocop:disable Metrics/ClassLength
     # These options will be present in the Hash returned by {#to_hash}.
-    OPTIONS = %i[api_key development_environments environment_name host
-                 http_open_timeout http_read_timeout client_name client_url
-                 client_version port protocol proxy_host proxy_pass
-                 proxy_port proxy_user secure polling_delay sync_interval
-                 sync_interval_staging sync_ignore_path_regex logger
-                 framework middleware disable_middleware disable_test_translation
-                 ca_file local_first_key_regexp s3_host locales ignored_keys ignored_key_handler
-                 download_cache_dir].freeze
+    OPTIONS = %i[
+      api_key development_environments environment_name host
+      http_open_timeout http_read_timeout client_name client_url
+      client_version port protocol proxy_host proxy_pass
+      proxy_port proxy_user secure polling_delay sync_interval
+      sync_interval_staging sync_ignore_path_regex logger
+      framework middleware disable_middleware disable_test_translation
+      ca_file local_first_key_regexp s3_host locales ignored_keys ignored_key_handler
+      download_cache_dir
+    ].freeze
 
     # NOTE: Rails 標準ロケールで非文字列値（precision: Integer, significant: Boolean,
     # strip_insignificant_zeros: Boolean）を含むのは number.*.format 配下のみ。store_item が文字列しか
@@ -182,6 +184,7 @@ module CopyTunerClient
       self.local_first_key_regexp = nil
       self.project_id = nil
       self.download_cache_dir = Pathname.new(Dir.pwd).join('tmp', 'cache', 'copy_tuner_client')
+      self.middleware_position = default_middleware_position
 
       @applied = false
     end
@@ -200,7 +203,7 @@ module CopyTunerClient
       base_options = { public: public?, upload_disabled: upload_disabled? }
 
       OPTIONS.inject(base_options) do |hash, option|
-        hash.merge option.to_sym => public_send(option)
+        hash.merge(option.to_sym => public_send(option))
       end
     end
 
@@ -209,7 +212,7 @@ module CopyTunerClient
     # @param [Hash] hash A set of configuration options that will take precedence over the defaults
     # @return [Hash] the merged configuration hash
     def merge(hash)
-      to_hash.merge hash
+      to_hash.merge(hash)
     end
 
     # Determines if the published or draft content will be used
@@ -222,7 +225,7 @@ module CopyTunerClient
     # Determines if the content will be editable
     # @return [Boolean] Returns +true+ if in a development environment, +false+ otherwise.
     def development?
-      development_environments.include? environment_name
+      development_environments.include?(environment_name)
     end
 
     def enable_middleware?
@@ -252,15 +255,11 @@ module CopyTunerClient
     # This creates the {I18nBackend} and puts them together.
     #
     # When {#test?} returns +false+, the poller will be started.
-    def apply # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def apply # rubocop:disable Metrics/AbcSize
       # NOTE: project_id は必須。未設定なら apply 時点で明示的に失敗させる
       validate_project_id!
 
-      self.locales ||= self.locales = if defined?(::Rails)
-                                        ::Rails.application.config.i18n.available_locales.presence || Array(::Rails.application.config.i18n.default_locale)
-                                      else
-                                        [:en]
-                                      end
+      self.locales ||= default_locales
 
       self.client ||= Client.new(to_hash)
       self.cache ||= Cache.new(client, to_hash)
@@ -268,31 +267,12 @@ module CopyTunerClient
       process_guard = ProcessGuard.new(cache, @poller, to_hash)
       I18n.backend = I18nBackend.new(cache)
 
-      if enable_middleware?
-        logger.info 'Using copytuner sync middleware'
-        request_sync_options = { poller: @poller, cache:, interval: sync_interval, ignore_regex: sync_ignore_path_regex }
-        if middleware_position.is_a?(Hash) && middleware_position[:before]
-          middleware.insert_before middleware_position[:before], RequestSync, request_sync_options
-          middleware.insert_before middleware_position[:before], CopyTunerClient::CopyrayMiddleware
-        elsif middleware_position.is_a?(Hash) && middleware_position[:after]
-          middleware.insert_after middleware_position[:after], RequestSync, request_sync_options
-          middleware.insert_after middleware_position[:after], CopyTunerClient::CopyrayMiddleware
-        else
-          middleware.use RequestSync, request_sync_options
-          middleware.use CopyTunerClient::CopyrayMiddleware
-        end
-      else
-        logger.info '[[[Warn]]] Not using copytuner sync middleware' unless middleware
-      end
+      setup_middleware
 
       @applied = true
-      logger.info "Client #{VERSION} ready (s3_download)"
-      logger.info "Environment Info: #{environment_info}"
-      logger.info "Available locales: #{self.locales.join(' ')}"
+      log_applied
 
-      unless test?
-        process_guard.start
-      end
+      process_guard.start unless test?
 
       unless test? && disable_test_translation
         logger.info 'Download translation now'
@@ -348,7 +328,7 @@ module CopyTunerClient
       validate_project_id!
 
       path = "/projects/#{project_id}"
-      URI::Generic.build(scheme: self.protocol, host: self.host, port: self.port.to_i, path:).to_s
+      URI::Generic.build(scheme: protocol, host:, port: port.to_i, path:).to_s
     end
 
     # locale を除いたキーが local_first_key_regexp にマッチするかを返す。
@@ -369,6 +349,73 @@ module CopyTunerClient
 
     private
 
+    def default_locales
+      if defined?(::Rails)
+        rails_i18n = ::Rails.application.config.i18n
+        rails_i18n.available_locales.presence || Array(rails_i18n.default_locale)
+      else
+        [:en]
+      end
+    end
+
+    # throw :warden は Warden::Manager の catch(:warden) までスタックを巻き戻すため、
+    # Warden より内側の middleware は @app.call の戻り値を受け取れず、Devise::FailureApp の
+    # 応答がマーカー除去を経ずにブラウザへ届いてしまう。これを避けるため Warden の直前を既定位置にする。
+    #
+    # 判定に Devise の有無も見るのは、warden を require するだけで Warden::Manager を
+    # スタックに積まない gem（authtrail 等）が存在するため。定数の有無だけで決めると
+    # そうしたアプリで insert_before が対象を見つけられず起動時例外になる。
+    # スタックへ積むのは Devise の railtie（config.app_middleware.use）である。
+    def default_middleware_position
+      return nil unless defined?(::Warden::Manager) && defined?(::Devise)
+
+      { before: ::Warden::Manager }
+    end
+
+    def setup_middleware
+      if enable_middleware?
+        logger.info 'Using copytuner sync middleware'
+        insert_middleware
+      else
+        logger.info '[[[Warn]]] Not using copytuner sync middleware' unless middleware
+      end
+    end
+
+    def log_applied
+      logger.info "Client #{VERSION} ready (s3_download)"
+      logger.info "Environment Info: #{environment_info}"
+      logger.info "Available locales: #{locales.join(' ')}"
+    end
+
+    def insert_middleware
+      # NOTE: 値の nil を除外するのは、{ before: SomeClass if cond } のように条件次第で nil が入る
+      # 書き方で従来は末尾 use にフォールバックしていた挙動を保つため（キーの有無だけで分岐すると
+      # insert_before(nil) が対象を見つけられず例外になる）。
+      case middleware_position
+      in { before: target } if target
+        middleware.insert_before(target, RequestSync, request_sync_options)
+        middleware.insert_before(target, CopyTunerClient::CopyrayMiddleware)
+      in { after: target } if target
+        # NOTE: insert_after(index, *) は insert(index + 1, *) を呼ぶため、同じ対象へ 2 回挿入すると
+        # 後から挿入した方が対象に近い位置に来て順序が反転する。逆順で呼ぶことで
+        # 外側→内側が RequestSync → CopyrayMiddleware に揃う。
+        middleware.insert_after(target, CopyTunerClient::CopyrayMiddleware)
+        middleware.insert_after(target, RequestSync, request_sync_options)
+      else
+        middleware.use(RequestSync, request_sync_options)
+        middleware.use(CopyTunerClient::CopyrayMiddleware)
+      end
+    end
+
+    def request_sync_options
+      {
+        poller: @poller,
+        cache:,
+        interval: sync_interval,
+        ignore_regex: sync_ignore_path_regex,
+      }
+    end
+
     # project_id は必須。未設定なら明示的に失敗させる。
     # apply（起動時の全体検証）と project_url（apply を経ない経路へのセーフネット）の両方から呼ぶ。
     def validate_project_id!

data/lib/copy_tuner_client/copyray/rewriter.rb

@@ -38,7 +38,7 @@ module CopyTunerClient
           # NOTE: 閾値超は Nokogiri を通さず可視トークン除去のみ。skipped=true で編集導線を諦めた旨を伝える。
           return [strip_markers(scannable), true] if scannable.bytesize > MAX_REWRITE_BYTESIZE
 
-          [rewrite_with_nokogiri(scannable, fragment: fragment), false]
+          [rewrite_with_nokogiri(scannable, fragment:), false]
         rescue StandardError => e
           # NOTE: Copyray は開発支援機能なので、壊れた HTML 等で Nokogiri 処理が落ちても
           # ページを 500 にしない。data-copyray-key 付与（編集導線）は諦め、最低限可視トークンだけ除去する。

data/lib/copy_tuner_client/copyray.rb

@@ -1,6 +1,7 @@
 require 'copy_tuner_client/copyray/marker'
 
 module CopyTunerClient
+  # 翻訳テキストにオーバーレイ編集用のマーカートークンを埋め込む
   class Copyray
     # This:
     #   message

data/lib/copy_tuner_client/copyray_middleware.rb

@@ -3,6 +3,7 @@
 require 'copy_tuner_client/copyray/rewriter'
 
 module CopyTunerClient
+  # レスポンス HTML を Rewriter に通し、マーカートークンを data-copyray-key 属性へ変換する Rack middleware
   class CopyrayMiddleware
     def initialize(app)
       @app = app
@@ -11,26 +12,8 @@ module CopyTunerClient
     def call(env)
       CopyTunerClient::TranslationLog.clear
       status, headers, response = @app.call(env)
-      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 にこれを伝え、オーバーレイ非対応である旨をツールバーで案内させる。
-        # 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) && response.is_a?(ActionDispatch::Response::RackBody)
-          ActionDispatch::Response.new(status, headers, [body]).to_a
-        else
-          [status, headers, [body]]
-        end
+      if rewritable?(status, headers) && (body = response_body(response))
+        rewrite_response(env, status, headers, body, response)
       else
         [status, headers, response]
       end
@@ -38,6 +21,30 @@ module CopyTunerClient
 
     private
 
+    def rewrite_response(env, status, headers, body, response)
+      csp_nonce =
+        env.fetch('action_dispatch.content_security_policy_nonce') do
+          env['secure_headers_content_security_policy_nonce']
+        end
+      # NOTE: CSS/JS 挿入の前に Rewriter を通す。serialize 後も </body> は必ず出力されるので
+      # append_to_html_body の rindex は機能し、CSS/JS タグはトークン非含有なので二重処理も起きない。
+      # NOTE: skipped は data-copyray-key を付与できなかったこと（巨大DOM/Nokogiri例外）を表す。
+      # JS にこれを伝え、オーバーレイ非対応である旨をツールバーで案内させる。
+      # 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:) unless turbo_stream
+      headers['Content-Length'] = body.bytesize.to_s
+      # maintains compatibility with other middlewares
+      if defined?(ActionDispatch::Response::RackBody) && response.is_a?(ActionDispatch::Response::RackBody)
+        ActionDispatch::Response.new(status, headers, [body]).to_a
+      else
+        [status, headers, [body]]
+      end
+    end
+
     def helpers
       ActionController::Base.helpers
     end
@@ -57,7 +64,8 @@ module CopyTunerClient
           keysSkipped: #{skipped},
         }
       SCRIPT
-      append_to_html_body(html, helpers.javascript_include_tag('copytuner', type: 'module', crossorigin: 'anonymous', nonce: csp_nonce))
+      tag = helpers.javascript_include_tag('copytuner', type: 'module', crossorigin: 'anonymous', nonce: csp_nonce)
+      append_to_html_body(html, tag)
     end
 
     def append_to_html_body(html, content)
@@ -65,7 +73,7 @@ module CopyTunerClient
       return html unless html.include?('</body>')
 
       position = html.rindex('</body>')
-      html.insert(position, content + "\n")
+      html.insert(position, "#{content}\n")
     end
 
     def file?(headers)
@@ -80,8 +88,7 @@ module CopyTunerClient
     end
 
     def turbo_stream?(headers)
-      headers['Content-Type'] &&
-        headers['Content-Type'].include?('text/vnd.turbo-stream.html')
+      headers['Content-Type']&.include?('text/vnd.turbo-stream.html')
     end
 
     def response_body(response)

data/lib/copy_tuner_client/dotted_hash.rb

@@ -1,4 +1,5 @@
 module CopyTunerClient
+  # `a.b.c` 形式のドット区切りキーを持つ Hash とネストした Hash を相互変換する
   module DottedHash
     def to_h(dotted_hash)
       hash = {}
@@ -15,18 +16,17 @@ module CopyTunerClient
 
       all_keys.each_with_index do |key, index|
         prefix = "#{key}."
-        conflict_keys = ((index + 1)..Float::INFINITY)
-                        .take_while { |i| all_keys[i]&.start_with?(prefix) }
-                        .map { |i| all_keys[i] }
+        conflict_keys =
+          ((index + 1)..Float::INFINITY)
+          .take_while { |i| all_keys[i]&.start_with?(prefix) }
+          .map { |i| all_keys[i] }
 
-        if conflict_keys.present?
-          results[key] = conflict_keys
-        end
+        results[key] = conflict_keys if conflict_keys.present?
       end
 
       results
     end
 
-    module_function :to_h, :conflict_keys # rubocop:disable Style/AccessModifierDeclarations
+    module_function :to_h, :conflict_keys
   end
 end

data/lib/copy_tuner_client/engine.rb

@@ -5,11 +5,11 @@ require 'copy_tuner_client/helper_extension'
 module CopyTunerClient
   # Connects to integration points for Rails 3 applications
   class Engine < ::Rails::Engine
-    initializer :initialize_copy_tuner_rails, :before => :load_config_initializers do |app|
+    initializer :initialize_copy_tuner_rails, before: :load_config_initializers do |_app|
       CopyTunerClient::Rails.initialize
     end
 
-    initializer :initialize_copy_tuner_hook_methods, :after => :load_config_initializers do |app|
+    initializer :initialize_copy_tuner_hook_methods, after: :load_config_initializers do |_app|
       ActiveSupport.on_load(:action_view) do
         CopyTunerClient::HelperExtension.hook_translation_helper(
           ActionView::Helpers::TranslationHelper,
@@ -17,14 +17,12 @@ module CopyTunerClient
         )
       end
 
-      if CopyTunerClient.configuration.enable_middleware?
-        CopyTunerClient::TranslationLog.install_hook
-      end
+      CopyTunerClient::TranslationLog.install_hook if CopyTunerClient.configuration.enable_middleware?
 
       require 'copy_tuner_client/simple_form_extention'
     end
 
-    initializer "copy_tuner.assets.precompile", group: :all do |app|
+    initializer 'copy_tuner.assets.precompile', group: :all do |app|
       app.config.assets.precompile += ['copytuner.js']
     end
   end

data/lib/copy_tuner_client/helper_extension.rb

@@ -1,67 +1,71 @@
 module CopyTunerClient
+  # ActionView の translate/t を alias_method で差し替え、Copyray のオーバーレイマーカーを注入する
   module HelperExtension
-    class << self
-      def hook_translation_helper(mod, middleware_enabled:)
-        mod.class_eval do
-          def translate_with_copyray_comment(key, **options)
-            source = translate_without_copyray_comment(key, **options)
+    # NOTE: class_eval ブロック内で def すると、ブロック内メソッドの複雑さが
+    # hook_translation_helper 自体の Metrics/AbcSize としてカウントされてしまうため、
+    # メソッド本体は独立したモジュールに切り出して include する。
+    module CopyrayCommentInjection
+      def translate_with_copyray_comment(key, **options)
+        source = translate_without_copyray_comment(key, **options)
 
-            if controller && CopyTunerClient::Rails.controller_of_rails_engine?(controller)
-              return source
-            end
+        return source if controller && CopyTunerClient::Rails.controller_of_rails_engine?(controller)
 
-            # TODO: test
-            # NOTE: default引数が設定されている場合は、copytunerキャッシュの値をI18n.t呼び出しにより上書きしている
-            # SEE: https://github.com/rails/rails/blob/6c43ebc220428ce9fc9569c2e5df90a38a4fc4e4/actionview/lib/action_view/helpers/translation_helper.rb#L82
-            if options.key?(:default)
-              I18n.t(key.to_s.first == '.' ? scope_key_by_partial(key) : key, **options)
-            end
+        # TODO: test
+        # NOTE: default引数が設定されている場合は、copytunerキャッシュの値をI18n.t呼び出しにより上書きしている
+        # SEE: https://github.com/rails/rails/blob/6c43ebc220428ce9fc9569c2e5df90a38a4fc4e4/actionview/lib/action_view/helpers/translation_helper.rb#L82
+        if options.key?(:default)
+          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?
+        # 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
-              separator = options[:separator] || I18n.default_separator
-              scope = options[:scope]
-              scope_key =
-                if key.to_s.first == '.'
-                  scope_key_by_partial(key)
-                else
-                  # NOTE: locale prefix無しのkeyが必要のためこうしている
-                  I18n.normalize_keys(nil, key, scope, separator).compact.join(separator)
-                end
-              CopyTunerClient::Copyray.augment_template(source, scope_key)
-            end
-          end
+        if CopyTunerClient.configuration.disable_copyray_comment_injection
+          source
+        else
+          CopyTunerClient::Copyray.augment_template(source, copyray_scope_key(key, options))
+        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?
+      def copyray_scope_key(key, options)
+        return scope_key_by_partial(key) if key.to_s.first == '.'
 
-            # NOTE: mailer は request を持たず request.format で判定できない。かつメール本文への
-            # マーカー混入は実害が大きいため、controller の型で明示除外する。
-            return false if defined?(ActionMailer::Base) && current_controller.is_a?(ActionMailer::Base)
+        separator = options.fetch(:separator, I18n.default_separator)
+        # NOTE: locale prefix無しのkeyが必要のためこうしている
+        I18n.normalize_keys(nil, key, options[:scope], separator).compact.join(separator)
+      end
+      private :copyray_scope_key
 
-            # NOTE: request が無い／format が html でない経路には注入しない。&. と || false で
-            # request 不在時も安全に false を返す。
-            current_controller.request&.format&.html? || false
-          end
-          private :copyray_injectable?
+      # 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?
 
-          if middleware_enabled
-            alias_method :translate_without_copyray_comment, :translate
-            alias_method :translate, :translate_with_copyray_comment
-            alias :t :translate
-          end
-        end
+        # 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?
+    end
+    private_constant :CopyrayCommentInjection
+
+    def self.hook_translation_helper(mod, middleware_enabled:)
+      return unless middleware_enabled
+
+      mod.include(CopyrayCommentInjection)
+      mod.class_eval do
+        alias_method :translate_without_copyray_comment, :translate
+        alias_method :translate, :translate_with_copyray_comment
+        alias_method :t, :translate
       end
     end
   end