blob: 4a7ef14ccbc16466d4d21d7d119438d2e65aebd4 (
plain)
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
|
# frozen_string_literal: true
require 'rubocop_spec_helper'
require_relative '../../../../rubocop/cop/gitlab/doc_url'
RSpec.describe RuboCop::Cop::Gitlab::DocUrl, feature_category: :not_owned do
context 'when string literal is added with docs url prefix' do
context 'when inlined' do
it 'registers an offense' do
expect_offense(<<~RUBY)
'See [the docs](https://docs.gitlab.com/ee/user/permissions#roles).'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `#help_page_url` instead of directly including link. See https://docs.gitlab.com/ee/development/documentation/#linking-to-help-in-ruby.
RUBY
end
end
context 'when multilined' do
it 'registers an offense' do
expect_offense(<<~'RUBY')
'See the docs: ' \
'https://docs.gitlab.com/ee/user/permissions#roles'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `#help_page_url` instead of directly including link. See https://docs.gitlab.com/ee/development/documentation/#linking-to-help-in-ruby.
RUBY
end
end
context 'with heredoc' do
it 'registers an offense' do
expect_offense(<<~RUBY)
<<-HEREDOC
See the docs:
https://docs.gitlab.com/ee/user/permissions#roles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `#help_page_url` instead of directly including link. See https://docs.gitlab.com/ee/development/documentation/#linking-to-help-in-ruby.
HEREDOC
RUBY
end
end
end
context 'when string literal is added without docs url prefix' do
context 'when inlined' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
'[The DevSecOps Platform](https://about.gitlab.com/)'
RUBY
end
end
context 'when multilined' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
'The DevSecOps Platform: ' \
'https://about.gitlab.com/'
RUBY
end
end
context 'with heredoc' do
it 'does not register an offense' do
expect_no_offenses(<<~RUBY)
<<-HEREDOC
The DevSecOps Platform:
https://about.gitlab.com/
HEREDOC
RUBY
end
end
end
end
|
