Files
chatwoot/spec/lib/custom_markdown_renderer_spec.rb
Nithin David Thomas 53dc38e650 fix: Renders youtube and vimeo links within blank lines as embeds (#7422)
Within the article we are now rendering every link for youtube and vimeo as embeds. This isn't a good solution, as users might need to have plain links as well. This fix will render only links within two blank lines as embeds.

Co-authored-by: Sojan Jose <sojan@pepalo.com>
2023-09-21 00:16:03 -07:00

128 lines
4.6 KiB
Ruby

require 'rails_helper'
describe CustomMarkdownRenderer do
let(:renderer) { described_class.new }
def render_markdown(markdown)
doc = CommonMarker.render_doc(markdown, :DEFAULT)
renderer.render(doc)
end
describe '#text' do
it 'converts text wrapped in ^ to superscript' do
markdown = 'This is an example of a superscript: ^superscript^.'
expect(render_markdown(markdown)).to include('<sup>superscript</sup>')
end
it 'does not convert text not wrapped in ^' do
markdown = 'This is an example without superscript.'
expect(render_markdown(markdown)).not_to include('<sup>')
end
it 'converts multiple superscripts in the same text' do
markdown = 'This is an example with ^multiple^ ^superscripts^.'
rendered_html = render_markdown(markdown)
expect(rendered_html.scan('<sup>').length).to eq(2)
expect(rendered_html).to include('<sup>multiple</sup>')
expect(rendered_html).to include('<sup>superscripts</sup>')
end
end
describe 'broken ^ usage' do
it 'does not convert text that only starts with ^' do
markdown = 'This is an example with ^broken superscript.'
expected_output = '<p>This is an example with ^broken superscript.</p>'
expect(render_markdown(markdown)).to include(expected_output)
end
it 'does not convert text that only ends with ^' do
markdown = 'This is an example with broken^ superscript.'
expected_output = '<p>This is an example with broken^ superscript.</p>'
expect(render_markdown(markdown)).to include(expected_output)
end
it 'does not convert text with uneven numbers of ^' do
markdown = 'This is an example with ^broken^ superscript^.'
expected_output = '<p>This is an example with <sup>broken</sup> superscript^.</p>'
expect(render_markdown(markdown)).to include(expected_output)
end
end
describe '#link' do
def render_markdown_link(link)
doc = CommonMarker.render_doc("[link](#{link})", :DEFAULT)
renderer.render(doc)
end
context 'when link is a YouTube URL' do
let(:youtube_url) { 'https://www.youtube.com/watch?v=VIDEO_ID' }
it 'renders an iframe with YouTube embed code' do
output = render_markdown_link(youtube_url)
expect(output).to include(`
<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/VIDEO_ID"
`)
end
end
context 'when link is a Vimeo URL' do
let(:vimeo_url) { 'https://vimeo.com/1234567' }
it 'renders an iframe with Vimeo embed code' do
output = render_markdown_link(vimeo_url)
expect(output).to include(`
<iframe
src="https://player.vimeo.com/video/1234567"
`)
end
end
context 'when link is an MP4 URL' do
let(:mp4_url) { 'https://example.com/video.mp4' }
it 'renders a video element with the MP4 source' do
output = render_markdown_link(mp4_url)
expect(output).to match(`
<video width="640" height="360" controls >
<source src="https://example.com/video.mp4" type="video/mp4">
Your browser does not support the video tag.
</video>
`)
end
end
context 'when link is a normal URL' do
let(:normal_url) { 'https://example.com' }
it 'renders a normal link' do
output = render_markdown_link(normal_url)
expect(output).to include('<a href="https://example.com">')
end
end
context 'when multiple links are present' do
it 'renders all links when present between empty lines' do
markdown = "\n[youtube](https://www.youtube.com/watch?v=VIDEO_ID)\n\n[vimeo](https://vimeo.com/1234567)\n^ hello ^ [normal](https://example.com)"
output = render_markdown(markdown)
expect(output).to include('src="https://www.youtube.com/embed/VIDEO_ID"')
expect(output).to include('src="https://player.vimeo.com/video/1234567"')
expect(output).to include('<a href="https://example.com">')
expect(output).to include('<sup> hello </sup>')
end
end
context 'when links within text are present' do
it 'renders only text within blank lines as embeds' do
markdown = "\n[youtube](https://www.youtube.com/watch?v=VIDEO_ID)\nthis is such an amazing [vimeo](https://vimeo.com/1234567)\n[vimeo](https://vimeo.com/1234567)"
output = render_markdown(markdown)
expect(output).to include('src="https://www.youtube.com/embed/VIDEO_ID"')
expect(output).to include('href="https://vimeo.com/1234567"')
expect(output).to include('src="https://player.vimeo.com/video/1234567"')
end
end
end
end