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
|
# frozen_string_literal: true
module RuboCop
module Cop
module RSpec
# Checks for examples without a description.
#
# RSpec allows for auto-generated example descriptions when there is no
# description provided or the description is an empty one.
#
# This cop removes empty descriptions.
# It also defines whether auto-generated description is allowed, based
# on the configured style.
#
# This cop can be configured using the `EnforcedStyle` option
#
# @example `EnforcedStyle: always_allow` (default)
# # bad
# it('') { is_expected.to be_good }
# it '' do
# result = service.call
# expect(result).to be(true)
# end
#
# # good
# it { is_expected.to be_good }
# it do
# result = service.call
# expect(result).to be(true)
# end
#
# @example `EnforcedStyle: single_line_only`
# # bad
# it('') { is_expected.to be_good }
# it do
# result = service.call
# expect(result).to be(true)
# end
#
# # good
# it { is_expected.to be_good }
#
# @example `EnforcedStyle: disallow`
# # bad
# it { is_expected.to be_good }
# it do
# result = service.call
# expect(result).to be(true)
# end
#
class ExampleWithoutDescription < Base
include ConfigurableEnforcedStyle
MSG_DEFAULT_ARGUMENT = 'Omit the argument when you want to ' \
'have auto-generated description.'
MSG_ADD_DESCRIPTION = 'Add a description.'
# @!method example_description(node)
def_node_matcher :example_description, '(send nil? _ $(str $_))'
def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
return unless example?(node)
check_example_without_description(node.send_node)
example_description(node.send_node) do |message_node, message|
return unless message.to_s.empty?
add_offense(message_node, message: MSG_DEFAULT_ARGUMENT)
end
end
private
def check_example_without_description(node)
return if node.arguments?
return unless disallow_empty_description?(node)
add_offense(node, message: MSG_ADD_DESCRIPTION)
end
def disallow_empty_description?(node)
style == :disallow ||
(style == :single_line_only && node.parent.multiline?)
end
end
end
end
end
|
