/
ordered_dependencies_spec.rb
212 lines (190 loc) · 6.37 KB
/
ordered_dependencies_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
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Gemspec::OrderedDependencies, :config do
subject(:cop) { described_class.new(config) }
let(:cop_config) do
{
'TreatCommentsAsGroupSeparators' => treat_comments_as_group_separators,
'Include' => nil
}
end
let(:treat_comments_as_group_separators) { false }
let(:message) do
'Dependencies should be sorted in an alphabetical order within their ' \
'section of the gemspec. Dependency `%s` should appear before `%s`.'
end
shared_examples 'ordered dependency' do |add_dependency|
context "when #{add_dependency}" do
context 'When gems are alphabetically sorted' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY)
Gem::Specification.new do |spec|
spec.#{add_dependency} 'rspec'
spec.#{add_dependency} 'rubocop'
end
RUBY
end
end
context 'when gems are not alphabetically sorted' do
let(:source) { <<~RUBY }
Gem::Specification.new do |spec|
spec.#{add_dependency} 'rubocop'
spec.#{add_dependency} 'rspec'
end
RUBY
it 'registers an offense' do
expect_offense(offense_message)
end
it 'autocorrects' do
new_source = autocorrect_source_with_loop(source)
expect(new_source).to eq(<<~RUBY)
Gem::Specification.new do |spec|
spec.#{add_dependency} 'rspec'
spec.#{add_dependency} 'rubocop'
end
RUBY
end
end
context 'when each individual group of line is sorted' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY)
Gem::Specification.new do |spec|
spec.#{add_dependency} 'rspec'
spec.#{add_dependency} 'rubocop'
spec.#{add_dependency} 'hello'
spec.#{add_dependency} 'world'
end
RUBY
end
end
context 'when dependency is separated by multiline comment' do
let(:source) { <<~RUBY }
Gem::Specification.new do |spec|
# For code quality
spec.#{add_dependency} 'rubocop'
# For
# test
spec.#{add_dependency} 'rspec'
end
RUBY
context 'with TreatCommentsAsGroupSeparators: true' do
let(:treat_comments_as_group_separators) { true }
it 'accepts' do
expect_no_offenses(<<~RUBY)
Gem::Specification.new do |spec|
# For code quality
spec.#{add_dependency} 'rubocop'
# For
# test
spec.#{add_dependency} 'rspec'
end
RUBY
end
end
context 'with TreatCommentsAsGroupSeparators: false' do
it 'registers an offense' do
expect_offense(offense_message_with_multiline_comment)
end
it 'autocorrects' do
new_source = autocorrect_source_with_loop(source)
expect(new_source).to eq(<<~RUBY)
Gem::Specification.new do |spec|
# For
# test
spec.#{add_dependency} 'rspec'
# For code quality
spec.#{add_dependency} 'rubocop'
end
RUBY
end
end
end
end
end
it_behaves_like 'ordered dependency', 'add_dependency' do
let(:offense_message) { <<~RUBY }
Gem::Specification.new do |spec|
spec.add_dependency 'rubocop'
spec.add_dependency 'rspec'
^^^^^^^^^^^^^^^^^^^^^^^^^^^ #{format(message, 'rspec', 'rubocop')}
end
RUBY
let(:offense_message_with_multiline_comment) { <<~RUBY }
Gem::Specification.new do |spec|
# For code quality
spec.add_dependency 'rubocop'
# For
# test
spec.add_dependency 'rspec'
^^^^^^^^^^^^^^^^^^^^^^^^^^^ #{format(message, 'rspec', 'rubocop')}
end
RUBY
end
it_behaves_like 'ordered dependency', 'add_runtime_dependency' do
let(:offense_message) { <<~RUBY }
Gem::Specification.new do |spec|
spec.add_runtime_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ #{format(message, 'rspec', 'rubocop')}
end
RUBY
let(:offense_message_with_multiline_comment) { <<~RUBY }
Gem::Specification.new do |spec|
# For code quality
spec.add_runtime_dependency 'rubocop'
# For
# test
spec.add_runtime_dependency 'rspec'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ #{format(message, 'rspec', 'rubocop')}
end
RUBY
end
it_behaves_like 'ordered dependency', 'add_development_dependency' do
let(:offense_message) { <<~RUBY }
Gem::Specification.new do |spec|
spec.add_development_dependency 'rubocop'
spec.add_development_dependency 'rspec'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ #{format(message, 'rspec', 'rubocop')}
end
RUBY
let(:offense_message_with_multiline_comment) { <<~RUBY }
Gem::Specification.new do |spec|
# For code quality
spec.add_development_dependency 'rubocop'
# For
# test
spec.add_development_dependency 'rspec'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ #{format(message, 'rspec', 'rubocop')}
end
RUBY
end
context 'when different dependencies are consecutive' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY)
Gem::Specification.new do |spec|
spec.add_dependency 'rubocop'
spec.add_runtime_dependency 'rspec'
end
RUBY
end
end
context 'When using method call to gem names' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY)
Gem::Specification.new do |spec|
spec.add_dependency 'rubocop'.freeze
spec.add_runtime_dependency 'rspec'.freeze
end
RUBY
end
end
context 'When using a local variable in an argument of dependent gem' do
it 'does not register any offenses' do
expect_no_offenses(<<~RUBY)
Gem::Specification.new do |spec|
%w(rubocop-performance rubocop-rails).each { |dep| spec.add_dependency dep }
spec.add_dependency 'parser'
end
RUBY
end
end
end