70 lines
2.3 KiB
Ruby
70 lines
2.3 KiB
Ruby
|
# 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
|