Class: RuboCop::Cop::FormulaAudit::Text Private

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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

# File 'rubocops/text.rb', line 14

def audit_formula(formula_nodes)
  node = formula_nodes.node
  full_source_content = source_buffer(node).source

  if (match = full_source_content.match(/^require ['"]formula['"]$/))
    range = source_range(source_buffer(node), match.pre_match.count("\n") + 1, 0, match[0].length)
    add_offense(range, message: "`#{match}` is now unnecessary") do |corrector|
      corrector.remove(range_with_surrounding_space(range:))
    end
  end

  return if (body_node = formula_nodes.body_node).nil?

  if find_method_def(body_node, :plist)
    problem "`def plist` is deprecated. Please use services instead: https://docs.brew.sh/Formula-Cookbook#service-files"
  end

  if (depends_on?("openssl") || depends_on?("openssl@3")) && depends_on?("libressl")
    problem "Formulae should not depend on both OpenSSL and LibreSSL (even optionally)."
  end

  if formula_tap == "homebrew-core"
    if depends_on?("veclibfort") || depends_on?("lapack")
      problem "Formulae in homebrew/core should use OpenBLAS as the default serial linear algebra library."
    end

    if find_node_method_by_name(body_node, :keg_only)&.source&.include?("HOMEBREW_PREFIX")
      problem "`keg_only` reason should not include `$HOMEBREW_PREFIX` " \
              "as it creates confusing `brew info` output."
    end
  end

  # processed_source.ast is passed instead of body_node because `require` would be outside body_node
  find_method_with_args(processed_source.ast, :require, "language/go") do
    problem '`require "language/go"` is no longer necessary or correct'
  end

  find_instance_method_call(body_node, "Formula", :factory) do
    problem "`Formula.factory(name)` is deprecated in favour of `Formula[name]`"
  end

  find_method_with_args(body_node, :revision, 0) do
    problem "`revision 0` is unnecessary"
  end

  find_method_with_args(body_node, :system, "xcodebuild") do
    problem "Use `xcodebuild *args` instead of `system 'xcodebuild', *args`"
  end

  if !depends_on?(:xcode) && method_called_ever?(body_node, :xcodebuild)
    problem "`xcodebuild` needs an Xcode dependency"
  end

  if (method_node = find_method_def(body_node, :install))
    find_method_with_args(method_node, :system, "go", "get") do
      problem "Do not use `go get`. Please ask upstream to implement Go vendoring"
    end

    find_method_with_args(method_node, :system, "cargo", "build") do |m|
      next if parameters_passed?(m, [/--lib/])

      problem 'Use `"cargo", "install", *std_cargo_args`'
    end
  end

  find_method_with_args(body_node, :system, "dep", "ensure") do |d|
    next if parameters_passed?(d, [/vendor-only/])
    next if @formula_name == "goose" # needed in 2.3.0

    problem 'Use `"dep", "ensure", "-vendor-only"`'
  end

  find_every_method_call_by_name(body_node, :system).each do |m|
    next unless parameters_passed?(m, [/make && make/])

    offending_node(m)
    problem "Use separate `make` calls"
  end

  find_every_method_call_by_name(body_node, :+).each do |plus_node|
    next unless plus_node.receiver&.send_type?
    next unless plus_node.first_argument&.str_type?

    receiver_method = plus_node.receiver.method_name
    path_arg = plus_node.first_argument.str_content

    case receiver_method
    when :prefix
      next unless (match = path_arg.match(%r{^(bin|include|libexec|lib|sbin|share|Frameworks)(?:/| |$)}))

      offending_node(plus_node)
      problem "Use `#{match[1].downcase}` instead of `prefix + \"#{match[1]}\"`"
    when :bin, :include, :libexec, :lib, :sbin, :share
      next if path_arg.empty?

      offending_node(plus_node)
      good = "#{receiver_method}/\"#{path_arg}\""
      problem "Use `#{good}` instead of `#{plus_node.source}`" do |corrector|
        corrector.replace(plus_node.loc.expression, good)
      end
    end
  end

  body_node.each_descendant(:dstr) do |dstr_node|
    dstr_node.each_descendant(:begin) do |interpolation_node|
      next unless interpolation_node.source.match?(/#\{\w+\s*\+\s*['"][^}]+\}/)

      offending_node(interpolation_node)
      problem "Do not concatenate paths in string interpolation"
    end
  end
end