rubocop/cop/gitlab/json.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

# frozen_string_literal: true

module RuboCop
  module Cop
    module Gitlab
      class Json < RuboCop::Cop::Base
        extend RuboCop::Cop::AutoCorrector

        MSG = <<~EOL
          Prefer `Gitlab::Json` over calling `JSON` directly. See https://docs.gitlab.com/ee/development/json.html
        EOL

        AVAILABLE_METHODS = %i[parse parse! load decode dump generate encode pretty_generate].to_set.freeze

        def_node_matcher :json_node?, <<~PATTERN
          (send (const {nil? | (const nil? :ActiveSupport)} :JSON) $_ $...)
        PATTERN

        def on_send(node)
          method_name, arg_source = match_node(node)
          return unless method_name

          add_offense(node) do |corrector|
            replacement = "#{cbased(node)}Gitlab::Json.#{method_name}(#{arg_source})"

            corrector.replace(node.source_range, replacement)
          end
        end

        private

        def match_node(node)
          method_name, arg_nodes = json_node?(node)

          # Only match if the method is implemented by Gitlab::Json
          if method_name && AVAILABLE_METHODS.include?(method_name)
            return [method_name, arg_nodes.map(&:source).join(", ")]
          end

          nil
        end

        def cbased(node)
          return unless %r{/ee/}.match?(node.location.expression.source_buffer.name)

          "::"
        end
      end
    end
  end
end