/
gem_comment_spec.rb
254 lines (222 loc) · 7.97 KB
/
gem_comment_spec.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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Bundler::GemComment, :config do
let(:cop_config) do
{
'Include' => ['**/Gemfile'],
'IgnoredGems' => ['rake'],
'OnlyFor' => []
}
end
context 'when investigating Ruby files' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY, 'foo.rb')
gem('rubocop')
RUBY
end
end
context 'when investigating Gemfiles' do
context 'and the file is empty' do
it 'does not register any offenses' do
expect_no_offenses('', 'Gemfile')
end
end
context 'and the gem is commented' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY, 'Gemfile')
# Style-guide enforcer.
gem 'rubocop'
RUBY
end
end
context 'and the gem is commented on the same line' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY, 'Gemfile')
gem 'rubocop' # Style-guide enforcer.
RUBY
end
end
context 'and the gem is permitted' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY, 'Gemfile')
gem 'rake'
RUBY
end
end
context 'and the file contains source and group' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY, 'Gemfile')
source 'http://rubygems.org'
# Style-guide enforcer.
group :development do
# …
end
RUBY
end
end
context 'and a gem has no comment' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop'
^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when the "OnlyFor" option is set' do
before { cop_config['OnlyFor'] = checked_options }
context 'including "version_specifiers"' do
let(:checked_options) { ['version_specifiers'] }
context 'when a gem is commented' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, 'Gemfile')
# Style-guide enforcer.
gem 'rubocop'
RUBY
end
end
context 'when a gem is uncommented and has no version specified' do
it 'does not register an offense' do
expect_no_offenses(<<-GEM, 'Gemfile')
gem 'rubocop'
GEM
end
end
context 'when a gem is uncommented and has options but no version specifiers' do
it 'does not register an offense' do
expect_no_offenses(<<-GEM, 'Gemfile')
gem 'rubocop', group: development
GEM
end
end
context 'when a gem is uncommented and has a version specifier' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', '~> 12.0'
^^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when a gem is uncommented and has multiple version specifiers' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', '~> 12.0', '>= 11.0'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when a gem is uncommented and has a version specifier along with other options' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', '~> 12.0', required: true
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
end
context 'including "restrictive_version_specifiers"' do
let(:checked_options) { ['restrictive_version_specifiers'] }
context 'when a gem is commented' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY, 'Gemfile')
# Style-guide enforcer.
gem 'rubocop'
RUBY
end
end
context 'when a gem is uncommented and has no version specified' do
it 'does not register an offense' do
expect_no_offenses(<<-GEM, 'Gemfile')
gem 'rubocop'
GEM
end
end
context 'when a gem is uncommented and has options but no version specifiers' do
it 'does not register an offense' do
expect_no_offenses(<<-GEM, 'Gemfile')
gem 'rubocop', group: development
GEM
end
end
context 'when a gem is uncommented and has only a minimum version specifier' do
it 'does not register an offense' do
expect_no_offenses(<<-GEM, 'Gemfile')
gem 'rubocop', '>= 12.0'
GEM
end
end
context 'when a gem is uncommented and has a non-minimum version specifier with a leading space' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', ' ~> 12.0'
^^^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when a gem is uncommented and has a version specifier without operator' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', '12.0'
^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when a gem is uncommented and has a frozen version specifier' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', '= 12.0'
^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when a gem is uncommented and has a pessimistic version specifier' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', '~> 12.0'
^^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when a gem is uncommented and has both minimum and non-minimum version specifier' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', '~> 12.0', '>= 11.0'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when a gem is uncommented and has a version specifier along with other options' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', '~> 12.0', required: true
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
end
context 'including one or more option names but not "version_specifiers"' do
let(:checked_options) { %w[github required] }
context 'when a gem is uncommented and has one of the specified options' do
it 'registers an offense' do
expect_offense(<<-GEM, 'Gemfile')
gem 'rubocop', github: 'some_user/some_fork'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Missing gem description comment.
GEM
end
end
context 'when a gem is uncommented and has a version specifier but none of the specified options' do
it 'does not register an offense' do
expect_no_offenses(<<-GEM, 'Gemfile')
gem 'rubocop', '~> 12.0'
GEM
end
end
context 'when a gem is uncommented and contains only options not specified' do
it 'does not register an offense' do
expect_no_offenses(<<-GEM, 'Gemfile')
gem 'rubocop', group: development
GEM
end
end
end
end
end
end