-
Notifications
You must be signed in to change notification settings - Fork 346
/
linter.rb
437 lines (387 loc) · 13.5 KB
/
linter.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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
require 'cocoapods-core/specification/linter/result'
require 'cocoapods-core/specification/linter/analyzer'
module Pod
class Specification
# The Linter check specifications for errors and warnings.
#
# It is designed not only to guarantee the formal functionality of a
# specification, but also to support the maintenance of sources.
#
class Linter
include ResultHelpers
# @return [Specification] the specification to lint.
#
attr_reader :spec
# @return [Pathname] the path of the `podspec` file where {#spec} is
# defined.
#
attr_reader :file
# @param [Specification, Pathname, String] spec_or_path
# the Specification or the path of the `podspec` file to lint.
#
def initialize(spec_or_path)
if spec_or_path.is_a?(Specification)
@spec = spec_or_path
@file = @spec.defined_in_file
else
@file = Pathname.new(spec_or_path)
begin
@spec = Specification.from_file(@file)
rescue Exception => e
@spec = nil
@raise_message = e.message
end
end
end
# Lints the specification adding a {Result} for any failed check to the
# {#results} list.
#
# @return [Bool] whether the specification passed validation.
#
def lint
@results = []
if spec
perform_textual_analysis
check_required_root_attributes
run_root_validation_hooks
perform_all_specs_analysis
else
error "The specification defined in `#{file}` could not be loaded." \
"\n\n#{@raise_message}"
end
results.empty?
end
#-----------------------------------------------------------------------#
# !@group Lint results
public
# @return [Array<Result>] all the errors generated by the Linter.
#
def errors
@errors ||= results.select { |r| r.type == :error }
end
# @return [Array<Result>] all the warnings generated by the Linter.
#
def warnings
@warnings ||= results.select { |r| r.type == :warning }
end
#-----------------------------------------------------------------------#
private
# !@group Lint steps
# It reads a podspec file and checks for strings corresponding
# to features that are or will be deprecated
#
# @return [void]
#
def perform_textual_analysis
return unless @file
text = @file.read
if text =~ /config\..?os.?/
error '`config.ios?` and `config.osx?` are deprecated.'
end
if text =~ /clean_paths/
error 'clean_paths are deprecated (use preserve_paths).'
end
all_lines_count = text.lines.count
comments_lines_count = text.scan(/^\s*#\s+/).length
comments_ratio = comments_lines_count.fdiv(all_lines_count)
if comments_lines_count > 20 && comments_ratio > 0.2
warning 'Comments must be deleted.'
end
if text.lines.first =~ /^\s*#\s+/
warning "Comments placed at the top of the specification must be " \
"deleted."
end
end
# Checks that every root only attribute which is required has a value.
#
# @return [void]
#
def check_required_root_attributes
attributes = DSL.attributes.values.select(&:root_only?)
attributes.each do |attr|
value = spec.send(attr.name)
next unless attr.required?
unless value && (!value.respond_to?(:empty?) || !value.empty?)
if attr.name == :license
warning("Missing required attribute `#{attr.name}`.")
else
error("Missing required attribute `#{attr.name}`.")
end
end
end
end
# Runs the validation hook for root only attributes.
#
# @return [void]
#
def run_root_validation_hooks
attributes = DSL.attributes.values.select(&:root_only?)
run_validation_hooks(attributes, spec)
end
# Run validations for multi-platform attributes activating .
#
# @return [void]
#
def perform_all_specs_analysis
all_specs = [spec, *spec.recursive_subspecs]
all_specs.each do |current_spec|
current_spec.available_platforms.each do |platform|
@consumer = Specification::Consumer.new(current_spec, platform)
run_all_specs_validation_hooks
analyzer = Analyzer.new(@consumer)
analyzer.analyze
add_results(analyzer.results)
@consumer = nil
end
end
end
# @return [Specification::Consumer] the current consumer.
#
attr_accessor :consumer
# Runs the validation hook for the attributes that are not root only.
#
# @return [void]
#
def run_all_specs_validation_hooks
attributes = DSL.attributes.values.reject(&:root_only?)
run_validation_hooks(attributes, consumer)
end
# Runs the validation hook for each attribute.
#
# @note Hooks are called only if there is a value for the attribute as
# required attributes are already checked by the
# {#check_required_root_attributes} step.
#
# @return [void]
#
def run_validation_hooks(attributes, target)
attributes.each do |attr|
validation_hook = "_validate_#{attr.name}"
next unless respond_to?(validation_hook, true)
value = target.send(attr.name)
next unless value
send(validation_hook, value)
end
end
#-----------------------------------------------------------------------#
private
# @!group Root spec validation helpers
# Performs validations related to the `name` attribute.
#
def _validate_name(n)
if spec.name && file
acceptable_names = [
spec.root.name + '.podspec',
spec.root.name + '.podspec.json',
]
names_match = acceptable_names.include?(file.basename.to_s)
unless names_match
error 'The name of the spec should match the name of the file.'
end
if spec.root.name =~ /\s/
error 'The name of a spec should not contain whitespace.'
end
end
end
def _validate_version(v)
if v.to_s.empty?
error 'A version is required.'
elsif v <= Version::ZERO
error 'The version of the spec should be higher than 0.'
end
end
# Performs validations related to the `summary` attribute.
#
def _validate_summary(s)
if s.length > 140
warning "The summary should be a short version of `description` " \
"(max 140 characters)."
end
if s =~ /A short description of/
warning 'The summary is not meaningful.'
end
end
# Performs validations related to the `description` attribute.
#
def _validate_description(d)
if d =~ /An optional longer description of/
warning 'The description is not meaningful.'
end
if d == spec.summary
warning 'The description is equal to the summary.'
end
if d.length < spec.summary.length
warning 'The description is shorter than the summary.'
end
end
# Performs validations related to the `homepage` attribute.
#
def _validate_homepage(h)
if h =~ %r{http://EXAMPLE}
warning 'The homepage has not been updated from default'
end
end
# Performs validations related to the `frameworks` attribute.
#
def _validate_frameworks(frameworks)
if frameworks_invalid?(frameworks)
error 'A framework should only be specified by its name'
end
end
# Performs validations related to the `weak frameworks` attribute.
#
def _validate_weak_frameworks(frameworks)
if frameworks_invalid?(frameworks)
error 'A weak framework should only be specified by its name'
end
end
# Performs validations related to the `libraries` attribute.
#
def _validate_libraries(libs)
if libraries_invalid?(libs)
error 'A library should only be specified by its name'
end
end
# Performs validations related to the `license` attribute.
#
def _validate_license(l)
type = l[:type]
if type.nil?
warning 'Missing license type.'
end
if type && type.gsub(' ', '').gsub("\n", '').empty?
warning 'Invalid license type.'
end
if type && type =~ /\(example\)/
error 'Sample license type.'
end
end
# Performs validations related to the `source` attribute.
#
def _validate_source(s)
if git = s[:git]
tag, commit = s.values_at(:tag, :commit)
version = spec.version.to_s
if git =~ %r{http://EXAMPLE}
error 'The Git source still contains the example URL.'
end
if commit && commit.downcase =~ /head/
error 'The commit of a Git source cannot be `HEAD`.'
end
if tag && !tag.to_s.include?(version)
warning 'The version should be included in the Git tag.'
end
if version == '0.0.1'
if commit.nil? && tag.nil?
error 'Git sources should specify either a commit or a tag.'
end
else
warning 'Git sources should specify a tag.' if tag.nil?
end
end
perform_github_source_checks(s)
end
# Performs validations related to github sources.
#
def perform_github_source_checks(s)
require 'uri'
if git = s[:git]
return unless git =~ /^#{URI.regexp}$/
git_uri = URI.parse(git)
if git_uri.host == 'github.com' || git_uri.host == 'gist.github.com'
unless git.end_with?('.git')
warning 'Github repositories should end in `.git`.'
end
unless git_uri.scheme == 'https'
warning 'Github repositories should use `https` link.'
end
end
end
end
# Performs validations related to the `social_media_url` attribute.
#
def _validate_social_media_url(s)
if s =~ %r{https://twitter.com/EXAMPLE}
warning 'The social media URL has not been updated from default'
end
end
#-----------------------------------------------------------------------#
# @!group All specs validation helpers
private
# Performs validations related to the `compiler_flags` attribute.
#
def _validate_compiler_flags(flags)
if flags.join(' ').split(' ').any? { |flag| flag.start_with?('-Wno') }
warning "Warnings must not be disabled (`-Wno' compiler flags)."
end
end
# Returns whether the frameworks are valid
#
# @params frameworks [Array<String>]
# The frameworks to be validated
#
# @return [Boolean] true if a framework contains any
# non-alphanumeric character or includes an extension.
#
def frameworks_invalid?(frameworks)
frameworks.any? do |framework|
framework_regex = /[^a-zA-Z\d]/
framework =~ framework_regex
end
end
# Returns whether the libraries are valid
#
# @params libs [Array<String>]
# The libraries to be validated
#
# @return [Boolean] true if a library ends with `.a`, `.dylib`,
# starts with `lib` or contains any non-alphanumeric character.
def libraries_invalid?(libs)
libs.any? do |lib|
lib_regex = /^(lib)|([^a-zA-Z\d])/
lib =~ lib_regex
end
end
end
end
end
# # TODO
# # Converts the resources file patterns to a hash defaulting to the
# # resource key if they are defined as an Array or a String.
# #
# # @param [String, Array, Hash] value.
# # The value of the attribute as specified by the user.
# #
# # @return [Hash] the resources.
# #
# def _prepare_deployment_target(deployment_target)
# unless @define_for_platforms.count == 1
# raise StandardError, "The deployment target must be defined " \
# "per platform like `s.ios.deployment_target = '5.0'`."
# end
# Version.new(deployment_target)
# end
# # TODO
# # Converts the resources file patterns to a hash defaulting to the
# # resource key if they are defined as an Array or a String.
# #
# # @param [String, Array, Hash] value.
# # The value of the attribute as specified by the user.
# #
# # @return [Hash] the resources.
# #
# def _prepare_platform(name_and_deployment_target)
# return nil if name_and_deployment_target.nil?
# if name_and_deployment_target.is_a?(Array)
# name = name_and_deployment_target.first
# deployment_target = name_and_deployment_target.last
# else
# name = name_and_deployment_target
# deployment_target = nil
# end
# unless PLATFORMS.include?(name)
# raise StandardError, "Unsupported platform `#{name}`. The available " \
# "names are `#{PLATFORMS.inspect}`"
# end
# Platform.new(name, deployment_target)
# end