require "rails_helper" RSpec.describe MarkdownParser do let(:random_word) { Faker::Lorem.word } let(:basic_parsed_markdown) { described_class.new(random_word) } def generate_and_parse_markdown(raw_markdown) described_class.new(raw_markdown).finalize end it "renders plain text as-is" do expect(basic_parsed_markdown.finalize).to include(random_word) end it "escapes liquid tags in codeblock" do code_block = "```\n{% what %}\n```" expect(generate_and_parse_markdown(code_block)).to include("{% what %}") end it "escapes the `raw` Liquid tag in codeblocks" do code_block = "```\n{% raw %}some text{% endraw %}\n```" expect(generate_and_parse_markdown(code_block)).to include("{% raw %}", "{% endraw %}") end it "does not render the escaped dashes when using a `raw` Liquid tag in codeblocks with syntax highlighting" do code_block = "```js\n{% raw %}some text{% endraw %}\n```" expect(generate_and_parse_markdown(code_block)).not_to include("----") end it "does not remove the non-'raw tag related' four dashes" do code_block = "```\n----\n```" expect(generate_and_parse_markdown(code_block)).to include("----") end it "escapes the `raw` Liquid tag in codespans" do code_block = "``{% raw %}some text{% endraw %}``" expect(generate_and_parse_markdown(code_block)).to include("{% raw %}", "{% endraw %}") end it "escapes the `raw` Liquid tag in inline code" do code_block = "`{% raw %}some text{% endraw %}`" expect(generate_and_parse_markdown(code_block)).to include("{% raw %}", "{% endraw %}") end it "escapes codeblocks in numbered lists" do code_block = "1. Define your hooks in config file `lefthook.yml`\n ```yaml pre-push:\n parallel: true\n commands:\n rubocop: run: bundle exec rspec --fail-fast\n ```" escaped_codeblock = generate_and_parse_markdown(code_block) expect(escaped_codeblock).not_to include("```") expect(escaped_codeblock).not_to include("`") expect(escaped_codeblock).to include("bundle exec rspec --fail-fast") end it "escapes liquid tags in code spans" do code_span = "``{% what %}``" expect(generate_and_parse_markdown(code_span)).to include("{% what %}") end it "renders double backtick code spans properly" do code_span = "``#{random_word}``" expect(generate_and_parse_markdown(code_span)).to include random_word end context "when rendering links markdown" do # the following specs are testing HTMLRouge it "renders properly if protocol http is included" do code_span = "[github](http://github.com)" test = generate_and_parse_markdown(code_span) expect(test).to eq("
\n\n") end it "renders properly if protocol https is included" do code_span = "[github](https://github.com)" test = generate_and_parse_markdown(code_span) expect(test).to eq("\n\n") end it "renders properly if protocol is not included" do code_span = "[github](github.com)" test = generate_and_parse_markdown(code_span) expect(test).to eq("\n\n") end it "renders properly relative paths" do code_span = "[career tag](/t/career)" test = generate_and_parse_markdown(code_span) app_protocol = ApplicationConfig["APP_PROTOCOL"] app_domain = ApplicationConfig["APP_DOMAIN"] expect(test).to eq("\n\n") end it "renders properly anchored links" do code_span = "[Chapter 1](#chapter-1)" test = generate_and_parse_markdown(code_span) expect(test).to eq("\n\n") end end describe "mentions" do let(:user) { build_stubbed(:user) } before { allow(User).to receive(:find_by).with(username: user.username).and_return(user) } it "works normally" do mention = "@#{user.username}" result = generate_and_parse_markdown(mention) expect(result).to include "@#{user.username} one two, @#{user.username}\n three four:\n\n@#{user.username}](http://a)')
end
end
context "when provided with liquid tags" do
it "raises error if liquid tag was used incorrectly" do
bad_ltag = "{% #{random_word} %}"
expect { generate_and_parse_markdown(bad_ltag) }.to raise_error(StandardError)
end
end
context "when provided with kbd tag" do
it "leaves the kbd tag in place" do
inline_kbd = generate_and_parse_markdown("Ctrl + ,")
inline_kbd = Nokogiri::HTML(inline_kbd).at("p").inner_html
expect(inline_kbd).to eq("Ctrl + ,")
end
end
describe "#tags_used" do
let(:parsed_markdown) { described_class.new("{% youtube oHg5SJYRHA0 %}") }
it "returns empty if no tag was used" do
expect(basic_parsed_markdown.tags_used).to eq([])
end
it "return tags used if it was used" do
expect(parsed_markdown.tags_used).to eq([YoutubeTag])
end
end
context "when using gifs from Giphy as images" do
let(:giphy_markdown_texts) do
%w(



)
end
it "does not wrap giphy images with Cloudinary" do
giphy_markdown_texts.each do |body_markdown|
html = Nokogiri::HTML(generate_and_parse_markdown(body_markdown))
img_src = html.search("img")[0]["src"]
expect(img_src).not_to include("https://res.cloudinary.com")
end
end
it "uses the raw gif from i.giphy.com" do
giphy_markdown_texts.each do |body_markdown|
html = Nokogiri::HTML(generate_and_parse_markdown(body_markdown))
img_src = html.search("img")[0]["src"]
expect(img_src).to start_with("https://i.giphy.com")
end
end
end
context "when an image is used" do
let(:markdown_with_img) { "" }
it "wraps image in link" do
expect(generate_and_parse_markdown(markdown_with_img)).to include(":o::o::o::o::o::o::o:")
expect(result).to include("⭕️:o:⭕️:o:⭕️⭕️⭕️")
end
end
context "when using Liquid variables" do
it "prevents Liquid variables" do
expect { generate_and_parse_markdown("{{ 'something' }}") }.to raise_error(StandardError)
end
it "allows Liquid variables in codeblocks" do
expect { generate_and_parse_markdown("```\n{{ 'something' }}\n```") }.not_to raise_error
end
it "renders the text in the codeblock properly" do
result = generate_and_parse_markdown("```\n{{ 'something' }}\n```")
expect(result).to include("{{ 'something' }}")
end
it "allows Liquid variables within inline code" do
expect { generate_and_parse_markdown("`{{ 'something' }}`") }.not_to raise_error
end
it "renders the inline code with the text properly" do
result = generate_and_parse_markdown("`{{ 'something' }}`")
expect(result).to include("{{ 'something' }}")
end
it "renders nested lists without linebreaks" do
result = generate_and_parse_markdown("- [A](#a)\n - [B](#b)\n- [C](#c)")
expect(result).not_to include("
")
end
it "permits abbr and aside tags" do
result = generate_and_parse_markdown("