Module: CopyTunerClient::HelperExtension

Defined in:
lib/copy_tuner_client/helper_extension.rb

Class Method Summary collapse

Class Method Details

.hook_translation_helper(mod, middleware_enabled:) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/copy_tuner_client/helper_extension.rb', line 4

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)

      if controller && CopyTunerClient::Rails.controller_of_rails_engine?(controller)
        return source
      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?

      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

    # 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
      alias :t :translate
      alias :tt :translate_without_copyray_comment
    else
      alias :tt :translate
    end
  end
end