/
rule_spec.rb
228 lines (194 loc) · 6.89 KB
/
rule_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
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe RubocopChallenger::Rubocop::Rule do
describe '#title' do
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 2
# Configuration parameters: CountComments.
Metrics/MethodLength:
Max: 17
CONTENTS
it 'returns title of the rule' do
expect(rule.title).to eq 'Metrics/MethodLength'
end
end
describe '#offense_count' do
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 27
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
Exclude:
- 'Gemfile'
- 'Rakefile'
- 'bin/console'
- 'rubocop_challenger.gemspec'
- 'lib/rubocop_challenger/rubocop/todo_reader.rb'
- 'lib/rubocop_challenger/version.rb'
- 'spec/rubocop_challenger_spec.rb'
- 'spec/spec_helper.rb'
CONTENTS
it 'returns offense count of the rule' do
expect(rule.offense_count).to eq 27
end
end
describe '#contents' do
let(:rule) { described_class.new(contents) }
let(:contents) { <<~CONTENTS }
# Offense count: 4
# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
# URISchemes: http, https
Metrics/LineLength:
Max: 87
CONTENTS
it 'returns raw contents' do
expect(rule.contents).to eq contents
end
end
describe '#==' do
subject { rule == other }
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 2
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
Style/HashSyntax:
Exclude:
- 'Rakefile'
CONTENTS
context 'when the rule title is same to other one' do
let(:other) { described_class.new(<<~CONTENTS) }
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
Style/HashSyntax:
Exclude:
- 'rubocop_challenger.gemspec'
CONTENTS
it { is_expected.to be_truthy }
end
context 'when the rule title is different to other one' do
let(:other) { described_class.new(<<~CONTENTS) }
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
Layout/LeadingBlankLines:
Exclude:
- 'rubocop_challenger.gemspec'
CONTENTS
it { is_expected.to be_falsey }
end
end
describe '#<=>' do
subject { rule <=> other }
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 2
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
Style/HashSyntax:
Exclude:
- 'Rakefile'
CONTENTS
context 'when the rule offense count greater than other one' do
let(:other) { described_class.new(<<~CONTENTS) }
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
Layout/LeadingBlankLines:
Exclude:
- 'rubocop_challenger.gemspec'
CONTENTS
it { is_expected.to eq(1) }
end
context 'when the rule offense count is equal to other one' do
let(:other) { described_class.new(<<~CONTENTS) }
# Offense count: 2
# This cop supports safe auto-correction (--auto-correct).
Style/ExpandPathArguments:
Exclude:
- 'rubocop_challenger.gemspec'
CONTENTS
it { is_expected.to be_zero }
end
context 'when the rule offense count is less than other one' do
let(:other) { described_class.new(<<~CONTENTS) }
# Offense count: 3
Style/Documentation:
Exclude:
- 'spec/**/*'
- 'test/**/*'
- 'lib/rubocop_challenger.rb'
CONTENTS
it { is_expected.to eq(-1) }
end
end
describe '#auto_correctable?' do
subject { rule.auto_correctable? }
context 'with auto-correction comment: Cop supports --auto-correct' do
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 1
# Cop supports --auto-correct.
Performance/StringReplacement:
Exclude:
- 'lib/rubocop_challenger.rb'
CONTENTS
it { is_expected.to be_truthy }
end
context 'with auto-correction comment: This cop supports safe auto-correction' do
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
Performance/StringReplacement:
Exclude:
- 'lib/rubocop_challenger.rb'
CONTENTS
it { is_expected.to be_truthy }
end
context 'with auto-correction comment: This cop supports unsafe auto-correction' do
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 1
# This cop supports unsafe auto-correction (--auto-correct-all).
Performance/StringReplacement:
Exclude:
- 'lib/rubocop_challenger.rb'
CONTENTS
it { is_expected.to be_truthy }
end
context 'without auto-correction comment' do
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 1
Metrics/AbcSize:
Max: 19
CONTENTS
it { is_expected.to be_falsey }
end
end
describe '#rubydoc_url' do
context 'when the rule is included in the rubocop gem' do
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
Style/RedundantSelf:
Exclude:
- 'lib/rubocop_challenger/rubocop/rule.rb'
CONTENTS
it "returns rubocop gem's document url" do
expect(rule.rubydoc_url)
.to eq 'https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/RedundantSelf'
end
end
context 'when the rule is included in the rubocop-rspec gem' do
let(:rule) { described_class.new(<<~CONTENTS) }
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
# Configuration parameters: CustomTransform, IgnoredWords.
RSpec/ExampleWording:
Exclude:
- 'spec/rubocop_challenger/rubocop/rule_spec.rb'
CONTENTS
it "returns rubocop-rspec gem's document url" do
expect(rule.rubydoc_url)
.to eq 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleWording'
end
end
end
end