mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-25 18:28:31 +08:00
21f682435a
Previously the only options we had for making excerpts was to completely strip images or to replace them with the markdown equivalent e.g. ![alt]. This doesn't look nice in certain scenarios where you want excerpts but you do want to see images still too. This commit adds `keep_images: true` option to the ExcerptParser which leaves images in the excerpt, and adds extensive tests for the different image options.
282 lines
12 KiB
Ruby
Vendored
282 lines
12 KiB
Ruby
Vendored
# frozen_string_literal: true
|
|
|
|
require "excerpt_parser"
|
|
|
|
RSpec.describe ExcerptParser do
|
|
it "handles nested <details> blocks" do
|
|
html = <<~HTML.strip
|
|
<details>
|
|
<summary>FOO</summary>
|
|
<details>
|
|
<summary>BAR</summary>
|
|
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
|
|
</details>
|
|
</details>
|
|
HTML
|
|
|
|
expect(ExcerptParser.get_excerpt(html, 50, {})).to match_html "▶ FOO"
|
|
expect(ExcerptParser.get_excerpt(html, 6, {})).to match_html "▶ FOO"
|
|
expect(ExcerptParser.get_excerpt(html, 3, {})).to match_html "▶ FOO"
|
|
expect(ExcerptParser.get_excerpt(html, 2, {})).to match_html "▶ FO…"
|
|
end
|
|
|
|
it "allows <svg> with <use> inside for icons when keep_svg is true" do
|
|
html = '<svg class="fa d-icon d-icon-folder svg-icon svg-node"><use href="#folder"></use></svg>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, { keep_svg: true })).to match_html(
|
|
'<svg class="fa d-icon d-icon-folder svg-icon svg-node"><use href="#folder"></use></svg>',
|
|
)
|
|
expect(ExcerptParser.get_excerpt(html, 100, {})).to match_html("")
|
|
|
|
html = '<svg class="blah"><use href="#folder"></use></svg>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, { keep_svg: true })).to match_html("")
|
|
|
|
html = '<svg><use href="#folder"></use></svg>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, { keep_svg: true })).to match_html("")
|
|
|
|
html =
|
|
'<use href="#user"></use><svg class="fa d-icon d-icon-folder svg-icon svg-node"><use href="#folder"></use></svg>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, { keep_svg: true })).to match_html(
|
|
'<svg class="fa d-icon d-icon-folder svg-icon svg-node"><use href="#folder"></use></svg>',
|
|
)
|
|
end
|
|
|
|
describe "keep_onebox_body parameter" do
|
|
it "keeps the body content for external oneboxes" do
|
|
html = <<~HTML.strip
|
|
<aside class="onebox">
|
|
<header class="source">
|
|
<img src="https://github.githubassets.com/favicon.ico" class="site-icon" width="32" height="32">
|
|
<a href="https://github.com/discourse/discourse" target="_blank">GitHub</a>
|
|
</header>
|
|
<article class="onebox-body">
|
|
<img src="/uploads/default/original/1X/10c0f1565ee5b6ca3fe43f3183529bc0afd26003.jpeg" class="thumbnail">
|
|
<h3>
|
|
<a href="https://github.com/discourse/discourse" target="_blank">discourse/discourse</a>
|
|
</h3>
|
|
<p>A platform for community discussion. Free, open, simple. - discourse/discourse</p>
|
|
</article>
|
|
</aside>
|
|
HTML
|
|
expect(ExcerptParser.get_excerpt(html, 100, keep_onebox_body: true)).to eq(<<~HTML.strip)
|
|
[image]
|
|
|
|
<a href="https://github.com/discourse/discourse" target="_blank">discourse/discourse</a>
|
|
|
|
A platform for community discussion. Free, o…
|
|
HTML
|
|
end
|
|
|
|
it "keeps the content for internal oneboxes" do
|
|
html = <<~HTML.strip
|
|
<aside class="quote" data-post="1" data-topic="8">
|
|
<div class="title">
|
|
<div class="quote-controls"></div>
|
|
<img width="20" height="20" src="/user_avatar/localhost/system/40/2_2.png" class="avatar">
|
|
<a href="/t/welcome-to-discourse/8/1">Welcome to Discourse</a>
|
|
</div>
|
|
<blockquote>The first paragraph of this pinned topic will be visible as a welcome message to all new visitors on your homepage.</blockquote>
|
|
</aside>
|
|
HTML
|
|
expect(ExcerptParser.get_excerpt(html, 100, keep_onebox_body: true)).to eq(<<~HTML.strip)
|
|
[image]
|
|
|
|
<a href="/t/welcome-to-discourse/8/1">Welcome to Discourse</a>
|
|
|
|
The first paragraph of this pinned topic will be …
|
|
HTML
|
|
end
|
|
|
|
it "keeps the content for internal oneboxes that contain github oneboxes" do
|
|
html = <<~HTML.strip
|
|
<p>Another commit to test out.</p>
|
|
<p>This time this commit has a longer commit message.</p>
|
|
<aside class="onebox githubcommit" data-onebox-src="https://github.com/discourse/discourse/commit/90f395a11895e9cfb7edd182b0bf5ec3d51d7892">
|
|
<header class="source">
|
|
<a href="https://github.com/discourse/discourse/commit/90f395a11895e9cfb7edd182b0bf5ec3d51d7892" target="_blank" rel="noopener">github.com/discourse/discourse</a>
|
|
</header>
|
|
<article class="onebox-body">
|
|
<div class="github-row">
|
|
<div class="github-icon-container" title="Commit">
|
|
<svg width="60" height="60" class="github-icon" viewBox="0 0 14 16" aria-hidden="true"><path fill-rule="evenodd" d="M10.86 7c-.45-1.72-2-3-3.86-3-1.86 0-3.41 1.28-3.86 3H0v2h3.14c.45 1.72 2 3 3.86 3 1.86 0 3.41-1.28 3.86-3H14V7h-3.14zM7 10.2c-1.22 0-2.2-.98-2.2-2.2 0-1.22.98-2.2 2.2-2.2 1.22 0 2.2.98 2.2 2.2 0 1.22-.98 2.2-2.2 2.2z"></path></svg>
|
|
</div>
|
|
<div class="github-info-container">
|
|
<h4>
|
|
<a href="https://github.com/discourse/discourse/commit/90f395a11895e9cfb7edd182b0bf5ec3d51d7892" target="_blank" rel="noopener">DEV: Skip srcset for onebox thumbnails (#22621)</a>
|
|
</h4>
|
|
<div class="github-info">
|
|
<div class="date">
|
|
committed <span class="discourse-local-date" data-format="ll" data-date="2023-07-19" data-time="18:21:34" data-timezone="UTC">06:21PM - 19 Jul 23 UTC (UTC)</span>
|
|
</div>
|
|
<div class="user">
|
|
<a href="https://github.com/oblakeerickson" target="_blank" rel="noopener">
|
|
<img alt="oblakeerickson" src="//localhost:3000/uploads/default/original/1X/741ac99d6a66d71cdd46dd99fb5156506e13fdf2.jpeg" class="onebox-avatar-inline" width="20" height="20" data-dominant-color="3C3C3C">
|
|
oblakeerickson
|
|
</a>
|
|
</div>
|
|
<div class="lines" title="changed 2 files with 24 additions and 15 deletions">
|
|
<a href="https://github.com/discourse/discourse/commit/90f395a11895e9cfb7edd182b0bf5ec3d51d7892" target="_blank" rel="noopener">
|
|
<span class="added">+24</span>
|
|
<span class="removed">-15</span>
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="github-row">
|
|
<p class="github-body-container">* DEV: Test commit message
|
|
This is a longer commit message <span class="show-more-container"><a href="https://github.com/discourse/discourse/commit/90f395a11895e9cfb7edd182b0bf5ec3d51d7892" target="_blank" rel="noopener" class="show-more">…</a></span><span class="excerpt hidden">that has the show-more class along with the exerpt hidden class</span></p>
|
|
</div>
|
|
</article>
|
|
<div class="onebox-metadata">
|
|
</div>
|
|
<div style="clear: both"></div>
|
|
</aside>
|
|
HTML
|
|
expect(ExcerptParser.get_excerpt(html, 100, keep_onebox_body: false)).to eq(<<~HTML.strip)
|
|
Another commit to test out. \nThis time this commit has a longer commit message.
|
|
HTML
|
|
end
|
|
end
|
|
|
|
describe "keep_quotes parameter" do
|
|
it "should keep the quoted content in html" do
|
|
html = <<~HTML.strip
|
|
<aside class="quote">
|
|
<blockquote>
|
|
This is a quoted text.
|
|
</blockquote>
|
|
</aside>
|
|
HTML
|
|
expect(ExcerptParser.get_excerpt(html, 100, keep_quotes: true)).to eq(
|
|
"This is a quoted text.",
|
|
)
|
|
end
|
|
end
|
|
|
|
describe "image handling options" do
|
|
describe "default behavior (no image option specified)" do
|
|
it "replaces images with alt text in brackets" do
|
|
html = '<p>Check out <img src="/uploads/image.jpg" alt="sunset"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100)).to eq("Check out [sunset]")
|
|
end
|
|
|
|
it "uses title text when alt is not present" do
|
|
html = '<p><img src="/uploads/image.jpg" title="My Image"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100)).to eq("[My Image]")
|
|
end
|
|
|
|
it "uses default image text when neither alt nor title is present" do
|
|
html = '<p><img src="/uploads/image.jpg"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100)).to eq("[image]")
|
|
end
|
|
|
|
it "handles multiple images" do
|
|
html =
|
|
'<p><img src="/uploads/1.jpg" alt="first"> and <img src="/uploads/2.jpg" alt="second"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100)).to eq("[first] and [second]")
|
|
end
|
|
|
|
it "does not include the URL" do
|
|
html = '<p><img src="/uploads/image.jpg" alt="photo"></p>'
|
|
result = ExcerptParser.get_excerpt(html, 100)
|
|
expect(result).to eq("[photo]")
|
|
expect(result).not_to include("/uploads/image.jpg")
|
|
end
|
|
end
|
|
|
|
describe "strip_images option" do
|
|
it "completely removes images with no replacement text" do
|
|
html = '<p>Check out this photo: <img src="/uploads/image.jpg" alt="sunset"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, strip_images: true)).to eq(
|
|
"Check out this photo:",
|
|
)
|
|
end
|
|
|
|
it "removes images regardless of alt or title attributes" do
|
|
html = '<p><img src="/uploads/image.jpg" title="My Image"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, strip_images: true)).to eq("")
|
|
end
|
|
|
|
it "removes images with no attributes" do
|
|
html = '<p><img src="/uploads/image.jpg"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, strip_images: true)).to eq("")
|
|
end
|
|
|
|
it "removes multiple images leaving only text" do
|
|
html =
|
|
'<p><img src="/uploads/1.jpg" alt="first"> and <img src="/uploads/2.jpg" alt="second"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, strip_images: true)).to eq("and")
|
|
end
|
|
|
|
it "still handles emoji images with keep_emoji_images" do
|
|
html =
|
|
'<p>Hello <img src="/images/emoji/emoji_one/smile.png" class="emoji" alt=":smile:"></p>'
|
|
expect(
|
|
ExcerptParser.get_excerpt(html, 100, strip_images: true, keep_emoji_images: true),
|
|
).to match(/<img.*class="emoji"/)
|
|
end
|
|
end
|
|
|
|
describe "markdown_images option" do
|
|
it "converts images to markdown format with alt text" do
|
|
html = '<p>Check out <img src="/uploads/image.jpg" alt="sunset"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, markdown_images: true)).to eq(
|
|
"Check out ",
|
|
)
|
|
end
|
|
|
|
it "uses title text when alt is not present" do
|
|
html = '<p><img src="/uploads/image.jpg" title="My Image"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, markdown_images: true)).to eq(
|
|
"",
|
|
)
|
|
end
|
|
|
|
it "uses default image text when neither alt nor title is present" do
|
|
html = '<p><img src="/uploads/image.jpg"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, markdown_images: true)).to eq(
|
|
"",
|
|
)
|
|
end
|
|
|
|
it "handles multiple images" do
|
|
html =
|
|
'<p><img src="/uploads/1.jpg" alt="first"> and <img src="/uploads/2.jpg" alt="second"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, markdown_images: true)).to eq(
|
|
" and ",
|
|
)
|
|
end
|
|
|
|
it "handles images with complex URLs" do
|
|
html = '<p><img src="https://example.com/path/to/image.jpg?size=large" alt="external"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, markdown_images: true)).to eq(
|
|
"",
|
|
)
|
|
end
|
|
end
|
|
|
|
describe "keep_images option" do
|
|
it "preserves the full img tag" do
|
|
html = '<p>Check out <img src="/uploads/image.jpg" alt="sunset" class="photo"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, keep_images: true)).to eq(
|
|
'Check out <img src="/uploads/image.jpg" alt="sunset" class="photo">',
|
|
)
|
|
end
|
|
|
|
it "preserves multiple attributes" do
|
|
html =
|
|
'<p><img src="/uploads/image.jpg" alt="sunset" title="Beautiful" width="100" height="100"></p>'
|
|
expect(ExcerptParser.get_excerpt(html, 100, keep_images: true)).to eq(
|
|
'<img src="/uploads/image.jpg" alt="sunset" title="Beautiful" width="100" height="100">',
|
|
)
|
|
end
|
|
|
|
it "preserves multiple images" do
|
|
html = '<p><img src="/1.jpg" alt="a"> <img src="/2.jpg" alt="b"></p>'
|
|
result = ExcerptParser.get_excerpt(html, 100, keep_images: true)
|
|
expect(result).to include('<img src="/1.jpg" alt="a">')
|
|
expect(result).to include('<img src="/2.jpg" alt="b">')
|
|
end
|
|
end
|
|
end
|
|
end
|
