-
-
Notifications
You must be signed in to change notification settings - Fork 18
/
desc.rb
82 lines (70 loc) · 2.24 KB
/
desc.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
# frozen_string_literal: true
module RuboCop
module Cop
module Rake
# Rake task definition should have a description with `desc` method.
# It is useful as a documentation of task. And Rake does not display
# task that does not have `desc` by `rake -T`.
#
# Note: This cop does not require description for the default task,
# because the default task is executed with `rake` without command.
#
# @example
# # bad
# task :do_something
#
# # bad
# task :do_something do
# end
#
# # good
# desc 'Do something'
# task :do_something
#
# # good
# desc 'Do something'
# task :do_something do
# end
#
class Desc < Base
include Helper::OnTask
extend AutoCorrector
MSG = 'Describe the task with `desc` method.'
def_node_matcher :prerequisites, <<~PATTERN
(send nil? :task (hash (pair _ $_)))
PATTERN
def on_task(node)
return if task_with_desc?(node)
return if Helper::TaskName.task_name(node) == :default
requirements = prerequisites(node)
return if requirements&.array_type?
add_offense(node)
end
private def task_with_desc?(node)
parent, task = parent_and_task(node)
return false unless parent
return true unless can_insert_desc_to?(parent)
idx = parent.children.find_index(task) - 1
desc_candidate = parent.children[idx]
return false unless desc_candidate
desc_candidate.send_type? && desc_candidate.method?(:desc)
end
private def parent_and_task(task_node)
parent = task_node.parent
return nil, task_node unless parent
return parent, task_node unless parent.block_type?
if parent.children.find_index(task_node) == 0
# when task {}
[parent.parent, parent]
else
# when something { task }
[parent, task_node]
end
end
private def can_insert_desc_to?(parent)
parent.begin_type? || parent.block_type? || parent.kwbegin_type?
end
end
end
end
end