blob: 916f93d8f2cf98540ed14e534fdf44b6eb0ca943 (
plain)
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
|
require 'formula'
require 'utils'
def ff
return Formula.all if ARGV.named.empty?
return ARGV.formulae
end
def audit_formula_text text
problems = []
# Commented-out cmake support from default template
if text =~ /# depends_on 'cmake'/
problems << " * Commented cmake support found."
end
# SourceForge URL madness
if text =~ /\?use_mirror=/
problems << " * Remove 'use_mirror' from url."
end
# 2 (or more, if in an if block) spaces before depends_on, please
if text =~ /^\ ?depends_on/
problems << " * Check indentation of 'depends_on'."
end
# Check for string concatenation; prefer interpolation
if text =~ /(#\{\w+\s*\+\s*['"][^}]+\})/
problems << " * Try not to concatenate paths in string interpolation:\n #{$1}"
end
# Prefer formula path shortcuts in Pathname+
if text =~ %r{\(\s*(prefix\s*\+\s*(['"])(bin|include|lib|libexec|sbin|share))}
problems << " * \"(#{$1}...#{$2})\" should be \"(#{$3}+...)\""
end
# Prefer formula path shortcuts in strings
if text =~ %r[(\#\{prefix\}/(bin|include|lib|libexec|sbin|share))]
problems << " * \"#{$1}\" should be \"\#{#{$2}}\""
end
if text =~ %r[((\#\{prefix\}/share/man/|\#\{man\}/)(man[1-8]))]
problems << " * \"#{$1}\" should be \"\#{#{$3}}\""
end
if text =~ %r[(\#\{prefix\}/share/(info|man))]
problems << " * \"#{$1}\" should be \"\#{#{$2}}\""
end
# Empty checksums
if text =~ /md5\s+\'\'/
problems << " * md5 is empty"
end
# No trailing whitespace, please
if text =~ /[ ]+$/
problems << " * Trailing whitespace was found."
end
return problems
end
def audit_formula_options f, text
problems = []
# Find possible options
options = []
text.scan(/ARGV\.include\?[ ]*\(?(['"])(.+?)\1/) { |m| options << m[1] }
options.reject! {|o| o.include? "#"}
options.uniq!
# Find documented options
begin
opts = f.options
documented_options = []
opts.each{ |o| documented_options << o[0] }
documented_options.reject! {|o| o.include? "="}
rescue
documented_options = []
end
if options.length > 0
options.each do |o|
problems << " * Option #{o} is not documented" unless documented_options.include? o
end
end
if documented_options.length > 0
documented_options.each do |o|
problems << " * Option #{o} is unused" unless options.include? o
end
end
return problems
end
def audit_some_formulae
ff.each do |f|
problems = []
# Don't depend_on aliases; use full name
aliases = Formula.aliases
f.deps.select {|d| aliases.include? d}.each do |d|
problems << " * Dep #{d} is an alias; switch to the real name."
end
text = ""
File.open(f.path, "r") { |afile| text = afile.read }
# DATA with no __END__
if (text =~ /\bDATA\b/) and not (text =~ /^\s*__END__\s*$/)
problems << " * 'DATA' was found, but no '__END__'"
end
# Don't try remaining audits on text in __END__
text_without_patch = (text.split("__END__")[0]).strip()
problems += audit_formula_text(text_without_patch)
problems += audit_formula_options(f, text_without_patch)
unless problems.empty?
puts "#{f.name}:"
puts problems * "\n"
puts
end
end
end
audit_some_formulae
|
