rubocop/cop/static_translation_definition.rb


1
2
3
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

# frozen_string_literal: true

module RuboCop
  module Cop
    class StaticTranslationDefinition < RuboCop::Cop::Cop
      MSG = "The text you're translating will be already in the translated form when it's assigned to the constant. When a users changes the locale, these texts won't be translated again. Consider moving the translation logic to a method.".freeze

      TRANSLATION_METHODS = %i[_ s_ n_].freeze

      def_node_matcher :translation_method?, <<~PATTERN
      (send _ _ str*)
      PATTERN

      def_node_matcher :lambda_node?, <<~PATTERN
      (send _ :lambda)
      PATTERN

      def on_send(node)
        return unless translation_method?(node)

        method_name = node.children[1]
        return unless TRANSLATION_METHODS.include?(method_name)

        translation_memoized = false

        node.each_ancestor do |ancestor|
          receiver, _ = *ancestor
          break if lambda_node?(receiver) # translations defined in lambda nodes should be allowed

          if constant_assignment?(ancestor)
            add_offense(node, location: :expression)

            break
          end

          translation_memoized = true if memoization?(ancestor)

          if translation_memoized && class_method_definition?(ancestor)
            add_offense(node, location: :expression)

            break
          end
        end
      end

      private

      def constant_assignment?(node)
        node.type == :casgn
      end

      def memoization?(node)
        node.type == :or_asgn
      end

      def class_method_definition?(node)
        node.type == :defs
      end
    end
  end
end