/
leading_comment_space_spec.rb
204 lines (174 loc) · 4.98 KB
/
leading_comment_space_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Layout::LeadingCommentSpace, :config do
subject(:cop) { described_class.new(config) }
it 'registers an offense and corrects comment without leading space' do
expect_offense(<<~RUBY)
#missing space
^^^^^^^^^^^^^^ Missing space after `#`.
RUBY
expect_correction(<<~RUBY)
# missing space
RUBY
end
it 'does not register an offense for # followed by no text' do
expect_no_offenses('#')
end
it 'does not register an offense for more than one space' do
expect_no_offenses('# heavily indented')
end
it 'does not register an offense for more than one #' do
expect_no_offenses('###### heavily indented')
end
it 'does not register an offense for only #s' do
expect_no_offenses('######')
end
it 'does not register an offense for #! on first line' do
expect_no_offenses(<<~RUBY)
#!/usr/bin/ruby
test
RUBY
end
it 'registers an offense and corrects #! after the first line' do
expect_offense(<<~RUBY)
test
#!/usr/bin/ruby
^^^^^^^^^^^^^^^ Missing space after `#`.
RUBY
expect_correction(<<~RUBY)
test
# !/usr/bin/ruby
RUBY
end
context 'file named config.ru' do
it 'does not register an offense for #\ on first line' do
expect_no_offenses(<<~'RUBY', 'config.ru')
#\ -w -p 8765
test
RUBY
end
it 'registers an offense and corrects for #\ after the first line' do
expect_offense(<<~'RUBY')
test
#\ -w -p 8765
^^^^^^^^^^^^^ Missing space after `#`.
RUBY
expect_correction(<<~'RUBY')
test
# \ -w -p 8765
RUBY
end
end
context 'file not named config.ru' do
it 'registers an offense and corrects #\ on first line' do
expect_offense(<<~'RUBY')
#\ -w -p 8765
^^^^^^^^^^^^^ Missing space after `#`.
test
RUBY
expect_correction(<<~'RUBY')
# \ -w -p 8765
test
RUBY
end
it 'registers an offense and corrects #\ after the first line' do
expect_offense(<<~'RUBY')
test
#\ -w -p 8765
^^^^^^^^^^^^^ Missing space after `#`.
RUBY
expect_correction(<<~'RUBY')
test
# \ -w -p 8765
RUBY
end
end
describe 'Doxygen style' do
context 'when config option is disabled' do
let(:cop_config) { { 'AllowDoxygenCommentStyle' => false } }
it 'registers an offense and corrects using Doxygen style' do
expect_offense(<<~RUBY)
#**
^^^ Missing space after `#`.
# Some comment
# Another comment on a second line
#*
^^ Missing space after `#`.
RUBY
expect_correction(<<~RUBY)
# **
# Some comment
# Another comment on a second line
# *
RUBY
end
end
context 'when config option is enabled' do
let(:cop_config) { { 'AllowDoxygenCommentStyle' => true } }
it 'does not register offense when using Doxygen style' do
expect_no_offenses(<<~RUBY)
#**
# Some comment
# Another comment on a second line
#*
RUBY
end
end
end
it 'accepts rdoc syntax' do
expect_no_offenses(<<~RUBY)
#++
#--
#:nodoc:
RUBY
end
it 'accepts sprockets directives' do
expect_no_offenses('#= require_tree .')
end
it 'accepts =begin/=end comments' do
expect_no_offenses(<<~RUBY)
=begin
#blahblah
=end
RUBY
end
describe 'Gemfile Ruby comment' do
context 'when config option is disabled' do
let(:cop_config) { { 'AllowGemfileRubyComment' => false } }
it 'registers an offense when using ruby config as comment' do
expect_offense(<<~'RUBY')
# Specific version (comment) will be used by RVM
#ruby=2.7.0
^^^^^^^^^^^ Missing space after `#`.
#ruby-gemset=myproject
^^^^^^^^^^^^^^^^^^^^^^ Missing space after `#`.
ruby '~> 2.7.0'
RUBY
end
end
context 'when config option is enabled' do
let(:cop_config) { { 'AllowGemfileRubyComment' => true } }
context 'file not named Gemfile' do
it 'registers an offense when using ruby config as comment' do
expect_offense(<<~'RUBY', 'test/test_case.rb')
# Specific version (comment) will be used by RVM
#ruby=2.7.0
^^^^^^^^^^^ Missing space after `#`.
#ruby-gemset=myproject
^^^^^^^^^^^^^^^^^^^^^^ Missing space after `#`.
ruby '~> 2.7.0'
RUBY
end
end
context 'file named Gemfile' do
it 'does not register an offense when using ruby config as comment' do
expect_no_offenses(<<~'RUBY', 'Gemfile')
# Specific version (comment) will be used by RVM
#ruby=2.7.0
#ruby-gemset=myproject
ruby '~> 2.7.0'
RUBY
end
end
end
end
end