2015-02-12 18:53:23 +00:00
|
|
|
require 'spec_helper'
|
2012-08-02 00:26:21 +00:00
|
|
|
|
2017-04-03 09:55:15 +00:00
|
|
|
describe MarkupHelper do
|
2017-01-25 22:10:32 +00:00
|
|
|
let!(:project) { create(:project, :repository) }
|
2012-09-02 06:13:13 +00:00
|
|
|
|
2012-12-07 03:40:42 +00:00
|
|
|
let(:user) { create(:user, username: 'gfm') }
|
2015-04-21 13:13:40 +00:00
|
|
|
let(:commit) { project.commit }
|
2012-09-02 06:13:13 +00:00
|
|
|
let(:issue) { create(:issue, project: project) }
|
2013-04-25 14:15:33 +00:00
|
|
|
let(:merge_request) { create(:merge_request, source_project: project, target_project: project) }
|
2013-03-25 07:20:14 +00:00
|
|
|
let(:snippet) { create(:project_snippet, project: project) }
|
2012-09-02 06:13:13 +00:00
|
|
|
|
2012-08-02 00:26:21 +00:00
|
|
|
before do
|
2015-09-01 22:09:20 +00:00
|
|
|
# Ensure the generated reference links aren't redacted
|
|
|
|
project.team << [user, :master]
|
|
|
|
|
2012-09-02 06:13:13 +00:00
|
|
|
# Helper expects a @project instance variable
|
2015-09-01 22:09:20 +00:00
|
|
|
helper.instance_variable_set(:@project, project)
|
|
|
|
|
|
|
|
# Stub the `current_user` helper
|
|
|
|
allow(helper).to receive(:current_user).and_return(user)
|
2012-08-02 00:26:21 +00:00
|
|
|
end
|
|
|
|
|
2015-08-27 20:09:01 +00:00
|
|
|
describe "#markdown" do
|
2012-09-02 06:13:13 +00:00
|
|
|
describe "referencing multiple objects" do
|
2015-05-21 20:35:15 +00:00
|
|
|
let(:actual) { "#{merge_request.to_reference} -> #{commit.to_reference} -> #{issue.to_reference}" }
|
2012-09-02 06:13:13 +00:00
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it "links to the merge request" do
|
2015-01-24 18:02:58 +00:00
|
|
|
expected = namespace_project_merge_request_path(project.namespace, project, merge_request)
|
2015-09-01 22:09:20 +00:00
|
|
|
expect(helper.markdown(actual)).to match(expected)
|
2012-08-02 00:26:21 +00:00
|
|
|
end
|
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it "links to the commit" do
|
2015-01-24 18:02:58 +00:00
|
|
|
expected = namespace_project_commit_path(project.namespace, project, commit)
|
2015-09-01 22:09:20 +00:00
|
|
|
expect(helper.markdown(actual)).to match(expected)
|
2012-08-02 00:26:21 +00:00
|
|
|
end
|
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it "links to the issue" do
|
2015-01-24 18:02:58 +00:00
|
|
|
expected = namespace_project_issue_path(project.namespace, project, issue)
|
2015-09-01 22:09:20 +00:00
|
|
|
expect(helper.markdown(actual)).to match(expected)
|
2012-08-02 00:26:21 +00:00
|
|
|
end
|
|
|
|
end
|
2015-09-18 18:05:27 +00:00
|
|
|
|
|
|
|
describe "override default project" do
|
|
|
|
let(:actual) { issue.to_reference }
|
2015-10-07 15:00:48 +00:00
|
|
|
let(:second_project) { create(:project, :public) }
|
2015-09-18 18:05:27 +00:00
|
|
|
let(:second_issue) { create(:issue, project: second_project) }
|
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it 'links to the issue' do
|
2015-09-18 18:05:27 +00:00
|
|
|
expected = namespace_project_issue_path(second_project.namespace, second_project, second_issue)
|
|
|
|
expect(markdown(actual, project: second_project)).to match(expected)
|
|
|
|
end
|
|
|
|
end
|
2012-09-02 06:13:13 +00:00
|
|
|
end
|
2012-08-02 00:26:21 +00:00
|
|
|
|
2015-04-20 19:43:27 +00:00
|
|
|
describe '#link_to_gfm' do
|
2017-01-25 22:10:32 +00:00
|
|
|
let(:link) { '/commits/0a1b2c3d' }
|
2017-01-26 12:09:29 +00:00
|
|
|
let(:issues) { create_list(:issue, 2, project: project) }
|
2012-08-02 00:26:21 +00:00
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it 'handles references nested in links with all the text' do
|
2017-01-25 22:10:32 +00:00
|
|
|
actual = helper.link_to_gfm("This should finally fix #{issues[0].to_reference} and #{issues[1].to_reference} for real", link)
|
2015-04-20 19:43:27 +00:00
|
|
|
doc = Nokogiri::HTML.parse(actual)
|
2012-08-02 00:26:21 +00:00
|
|
|
|
2015-04-21 17:12:19 +00:00
|
|
|
# Make sure we didn't create invalid markup
|
|
|
|
expect(doc.errors).to be_empty
|
|
|
|
|
2012-09-02 06:13:13 +00:00
|
|
|
# Leading commit link
|
2017-01-25 22:10:32 +00:00
|
|
|
expect(doc.css('a')[0].attr('href')).to eq link
|
2015-04-20 19:43:27 +00:00
|
|
|
expect(doc.css('a')[0].text).to eq 'This should finally fix '
|
2012-08-02 00:26:21 +00:00
|
|
|
|
2012-09-02 06:13:13 +00:00
|
|
|
# First issue link
|
2015-04-20 19:43:27 +00:00
|
|
|
expect(doc.css('a')[1].attr('href')).
|
|
|
|
to eq namespace_project_issue_path(project.namespace, project, issues[0])
|
2015-05-21 20:35:15 +00:00
|
|
|
expect(doc.css('a')[1].text).to eq issues[0].to_reference
|
2012-08-02 00:28:50 +00:00
|
|
|
|
2012-09-02 06:13:13 +00:00
|
|
|
# Internal commit link
|
2017-01-25 22:10:32 +00:00
|
|
|
expect(doc.css('a')[2].attr('href')).to eq link
|
2015-04-20 19:43:27 +00:00
|
|
|
expect(doc.css('a')[2].text).to eq ' and '
|
2012-08-02 00:28:50 +00:00
|
|
|
|
2012-09-02 06:13:13 +00:00
|
|
|
# Second issue link
|
2015-04-20 19:43:27 +00:00
|
|
|
expect(doc.css('a')[3].attr('href')).
|
|
|
|
to eq namespace_project_issue_path(project.namespace, project, issues[1])
|
2015-05-21 20:35:15 +00:00
|
|
|
expect(doc.css('a')[3].text).to eq issues[1].to_reference
|
2012-09-02 06:13:13 +00:00
|
|
|
|
|
|
|
# Trailing commit link
|
2017-01-25 22:10:32 +00:00
|
|
|
expect(doc.css('a')[4].attr('href')).to eq link
|
2015-04-20 19:43:27 +00:00
|
|
|
expect(doc.css('a')[4].text).to eq ' for real'
|
2012-08-02 00:28:50 +00:00
|
|
|
end
|
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it 'forwards HTML options' do
|
2017-01-25 22:10:32 +00:00
|
|
|
actual = helper.link_to_gfm("Fixed in #{commit.id}", link, class: 'foo')
|
2015-08-27 21:28:45 +00:00
|
|
|
doc = Nokogiri::HTML.parse(actual)
|
|
|
|
|
|
|
|
expect(doc.css('a')).to satisfy do |v|
|
|
|
|
# 'foo' gets added to all links
|
|
|
|
v.all? { |a| a.attr('class').match(/foo$/) }
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-09-19 23:42:26 +00:00
|
|
|
it "escapes HTML passed in as the body" do
|
2015-05-21 20:35:15 +00:00
|
|
|
actual = "This is a <h1>test</h1> - see #{issues[0].to_reference}"
|
2017-01-25 22:10:32 +00:00
|
|
|
expect(helper.link_to_gfm(actual, link)).
|
2015-02-12 18:53:23 +00:00
|
|
|
to match('<h1>test</h1>')
|
2012-09-19 23:42:26 +00:00
|
|
|
end
|
2015-05-29 05:56:30 +00:00
|
|
|
|
|
|
|
it 'ignores reference links when they are the entire body' do
|
|
|
|
text = issues[0].to_reference
|
2015-09-01 22:09:20 +00:00
|
|
|
act = helper.link_to_gfm(text, '/foo')
|
2015-05-29 05:56:30 +00:00
|
|
|
expect(act).to eq %Q(<a href="/foo">#{issues[0].to_reference}</a>)
|
|
|
|
end
|
2015-10-01 04:09:07 +00:00
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it 'replaces commit message with emoji to link' do
|
2017-04-25 10:06:24 +00:00
|
|
|
actual = link_to_gfm(':book: Book', '/foo')
|
2015-10-01 04:09:07 +00:00
|
|
|
expect(actual).
|
2017-04-27 10:44:02 +00:00
|
|
|
to eq '<gl-emoji title="open book" data-name="book" data-unicode-version="6.0">📖</gl-emoji><a href="/foo"> Book</a>'
|
2015-10-01 04:09:07 +00:00
|
|
|
end
|
2012-08-02 00:28:50 +00:00
|
|
|
end
|
2012-08-02 00:29:15 +00:00
|
|
|
|
2015-04-13 22:05:42 +00:00
|
|
|
describe '#render_wiki_content' do
|
2013-03-14 06:31:08 +00:00
|
|
|
before do
|
2013-12-14 13:43:48 +00:00
|
|
|
@wiki = double('WikiPage')
|
2015-02-12 18:17:35 +00:00
|
|
|
allow(@wiki).to receive(:content).and_return('wiki content')
|
2016-06-08 05:02:50 +00:00
|
|
|
allow(@wiki).to receive(:slug).and_return('nested/page')
|
2016-01-12 04:10:08 +00:00
|
|
|
helper.instance_variable_set(:@project_wiki, @wiki)
|
2013-03-14 06:31:08 +00:00
|
|
|
end
|
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it "uses Wiki pipeline for markdown files" do
|
2015-02-12 18:17:35 +00:00
|
|
|
allow(@wiki).to receive(:format).and_return(:markdown)
|
2013-03-14 06:31:08 +00:00
|
|
|
|
2017-04-24 10:20:46 +00:00
|
|
|
expect(helper).to receive(:markdown_unsafe).with('wiki content', pipeline: :wiki, project: project, project_wiki: @wiki, page_slug: "nested/page")
|
2013-03-14 06:31:08 +00:00
|
|
|
|
|
|
|
helper.render_wiki_content(@wiki)
|
|
|
|
end
|
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it "uses Asciidoctor for asciidoc files" do
|
2015-05-12 23:07:48 +00:00
|
|
|
allow(@wiki).to receive(:format).and_return(:asciidoc)
|
|
|
|
|
2017-04-21 15:17:19 +00:00
|
|
|
expect(helper).to receive(:asciidoc_unsafe).with('wiki content')
|
2015-05-12 23:07:48 +00:00
|
|
|
|
|
|
|
helper.render_wiki_content(@wiki)
|
|
|
|
end
|
|
|
|
|
2016-07-25 18:16:19 +00:00
|
|
|
it "uses the Gollum renderer for all other file types" do
|
2015-02-12 18:17:35 +00:00
|
|
|
allow(@wiki).to receive(:format).and_return(:rdoc)
|
2013-12-14 13:43:48 +00:00
|
|
|
formatted_content_stub = double('formatted_content')
|
2015-02-12 18:17:35 +00:00
|
|
|
expect(formatted_content_stub).to receive(:html_safe)
|
|
|
|
allow(@wiki).to receive(:formatted_content).and_return(formatted_content_stub)
|
2013-03-14 06:31:08 +00:00
|
|
|
|
|
|
|
helper.render_wiki_content(@wiki)
|
|
|
|
end
|
|
|
|
end
|
2015-06-24 01:00:10 +00:00
|
|
|
|
2017-04-21 15:17:19 +00:00
|
|
|
describe 'markup' do
|
2017-04-06 14:47:52 +00:00
|
|
|
let(:content) { 'Noël' }
|
|
|
|
|
|
|
|
it 'preserves encoding' do
|
|
|
|
expect(content.encoding.name).to eq('UTF-8')
|
2017-04-21 15:17:19 +00:00
|
|
|
expect(helper.markup('foo.rst', content).encoding.name).to eq('UTF-8')
|
2017-04-06 14:47:52 +00:00
|
|
|
end
|
|
|
|
|
2017-04-21 15:17:19 +00:00
|
|
|
it "delegates to #markdown_unsafe when file name corresponds to Markdown" do
|
2017-04-06 14:47:52 +00:00
|
|
|
expect(helper).to receive(:gitlab_markdown?).with('foo.md').and_return(true)
|
2017-04-21 15:17:19 +00:00
|
|
|
expect(helper).to receive(:markdown_unsafe).and_return('NOEL')
|
2017-04-06 14:47:52 +00:00
|
|
|
|
2017-04-21 15:17:19 +00:00
|
|
|
expect(helper.markup('foo.md', content)).to eq('NOEL')
|
2017-04-06 14:47:52 +00:00
|
|
|
end
|
|
|
|
|
2017-04-21 15:17:19 +00:00
|
|
|
it "delegates to #asciidoc_unsafe when file name corresponds to AsciiDoc" do
|
2017-04-06 14:47:52 +00:00
|
|
|
expect(helper).to receive(:asciidoc?).with('foo.adoc').and_return(true)
|
2017-04-21 15:17:19 +00:00
|
|
|
expect(helper).to receive(:asciidoc_unsafe).and_return('NOEL')
|
2017-04-06 14:47:52 +00:00
|
|
|
|
2017-04-21 15:17:19 +00:00
|
|
|
expect(helper.markup('foo.adoc', content)).to eq('NOEL')
|
2017-04-06 14:47:52 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2015-09-23 04:56:27 +00:00
|
|
|
describe '#first_line_in_markdown' do
|
|
|
|
it 'truncates Markdown properly' do
|
2017-03-14 06:24:56 +00:00
|
|
|
text = "@#{user.username}, can you look at this?\nHello world\n"
|
2015-09-23 04:56:27 +00:00
|
|
|
actual = first_line_in_markdown(text, 100, project: project)
|
|
|
|
|
|
|
|
doc = Nokogiri::HTML.parse(actual)
|
|
|
|
|
|
|
|
# Make sure we didn't create invalid markup
|
|
|
|
expect(doc.errors).to be_empty
|
|
|
|
|
|
|
|
# Leading user link
|
|
|
|
expect(doc.css('a').length).to eq(1)
|
|
|
|
expect(doc.css('a')[0].attr('href')).to eq user_path(user)
|
|
|
|
expect(doc.css('a')[0].text).to eq "@#{user.username}"
|
|
|
|
|
|
|
|
expect(doc.content).to eq "@#{user.username}, can you look at this?..."
|
|
|
|
end
|
2017-03-14 06:24:56 +00:00
|
|
|
|
|
|
|
it 'truncates Markdown with emoji properly' do
|
|
|
|
text = "foo :wink:\nbar :grinning:"
|
|
|
|
actual = first_line_in_markdown(text, 100, project: project)
|
|
|
|
|
|
|
|
doc = Nokogiri::HTML.parse(actual)
|
|
|
|
|
|
|
|
# Make sure we didn't create invalid markup
|
|
|
|
# But also account for the 2 errors caused by the unknown `gl-emoji` elements
|
|
|
|
expect(doc.errors.length).to eq(2)
|
|
|
|
|
|
|
|
expect(doc.css('gl-emoji').length).to eq(2)
|
|
|
|
expect(doc.css('gl-emoji')[0].attr('data-name')).to eq 'wink'
|
|
|
|
expect(doc.css('gl-emoji')[1].attr('data-name')).to eq 'grinning'
|
|
|
|
|
|
|
|
expect(doc.content).to eq "foo 😉\nbar 😀"
|
|
|
|
end
|
2015-09-23 04:56:27 +00:00
|
|
|
end
|
2016-12-21 16:41:33 +00:00
|
|
|
|
|
|
|
describe '#cross_project_reference' do
|
|
|
|
it 'shows the full MR reference' do
|
|
|
|
expect(helper.cross_project_reference(project, merge_request)).to include(project.path_with_namespace)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'shows the full issue reference' do
|
|
|
|
expect(helper.cross_project_reference(project, issue)).to include(project.path_with_namespace)
|
|
|
|
end
|
|
|
|
end
|
2012-08-02 00:26:21 +00:00
|
|
|
end
|