-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
text.rb
155 lines (122 loc) 路 5.78 KB
/
text.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
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# typed: true
# frozen_string_literal: true
require "rubocops/extend/formula"
module RuboCop
module Cop
module FormulaAudit
# This cop checks for various problems in a formula's source code.
#
# @api private
class Text < FormulaCop
extend AutoCorrector
def audit_formula(node, _class_node, _parent_class_node, body_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: range))
end
end
return if body_node.nil?
if !find_node_method_by_name(body_node, :plist_options) &&
find_method_def(body_node, :plist)
problem "Please set plist_options when using a formula-defined plist."
end
if (depends_on?("openssl") || depends_on?("openssl@1.1")) && depends_on?("libressl")
problem "Formulae should not depend on both OpenSSL and LibreSSL (even optionally)."
end
if formula_tap == "homebrew-core" && (depends_on?("veclibfort") || depends_on?("lapack"))
problem "Formulae in homebrew/core should use OpenBLAS as the default serial linear algebra library."
end
unless method_called_ever?(body_node, :go_resource)
# 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 unnecessary unless using `go_resource`s"
end
end
find_instance_method_call(body_node, "Formula", :factory) do
problem "\"Formula.factory(name)\" is deprecated in favor of \"Formula[name]\""
end
find_method_with_args(body_node, :system, "xcodebuild") do
problem %q(use "xcodebuild *args" instead of "system 'xcodebuild', *args")
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
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_method_with_args(body_node, :system, "cargo", "build") do |m|
next if parameters_passed?(m, [/--lib/])
problem "use \"cargo\", \"install\", *std_cargo_args"
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
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
prefix_path(body_node) do |prefix_node, path|
next unless (match = path.match(%r{^(bin|include|libexec|lib|sbin|share|Frameworks)(?:/| |$)}))
offending_node(prefix_node)
problem "Use `#{match[1].downcase}` instead of `prefix + \"#{match[1]}\"`"
end
end
# Find: prefix + "foo"
def_node_search :prefix_path, <<~EOS
$(send (send nil? :prefix) :+ (str $_))
EOS
end
end
module FormulaAuditStrict
# This cop contains stricter checks for various problems in a formula's source code.
#
# @api private
class Text < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node)
return if body_node.nil?
find_method_with_args(body_node, :go_resource) do
problem "`go_resource`s are deprecated. Please ask upstream to implement Go vendoring"
end
find_method_with_args(body_node, :env, :userpaths) do
problem "`env :userpaths` in homebrew/core formulae is deprecated"
end
share_path_starts_with(body_node, @formula_name) do |share_node|
offending_node(share_node)
problem "Use `pkgshare` instead of `share/\"#{@formula_name}\"`"
end
interpolated_share_path_starts_with(body_node, "/#{@formula_name}") do |share_node|
offending_node(share_node)
problem "Use `\#{pkgshare}` instead of `\#{share}/#{@formula_name}`"
end
return unless formula_tap == "homebrew-core"
find_method_with_args(body_node, :env, :std) do
problem "`env :std` in homebrew/core formulae is deprecated"
end
end
# Check whether value starts with the formula name and then a "/", " " or EOS.
def path_starts_with?(path, starts_with)
path.match?(%r{^#{Regexp.escape(starts_with)}(/| |$)})
end
# Find "#{share}/foo"
def_node_search :interpolated_share_path_starts_with, <<~EOS
$(dstr (begin (send nil? :share)) (str #path_starts_with?(%1)))
EOS
# Find share/"foo"
def_node_search :share_path_starts_with, <<~EOS
$(send (send nil? :share) :/ (str #path_starts_with?(%1)))
EOS
end
end
end
end