SWAMPy

✎ CARVE FLESH

EDITING: html_text_helper_spec.rb

# frozen_string_literal: true

# Copyright (C) 2014 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

require "spec_helper"

describe HtmlTextHelper do
  let(:th) { Class.new.tap { |th| th.extend HtmlTextHelper } }

context "format_message" do
    it "detects and linkify URLs" do
      str = th.format_message("click here: (http://www.instructure.com) to check things out\nnewline").first
      html = Nokogiri::HTML5.fragment(str)
      link = html.css("a").first
      expect(link["href"]).to eq("http://www.instructure.com")

str = th.format_message("click here: http://www.instructure.com\nnewline").first
      html = Nokogiri::HTML5.fragment(str)
      link = html.css("a").first
      expect(link["href"]).to eq("http://www.instructure.com")

str = th.format_message("click here: www.instructure.com/a/b?a=1&b=2\nnewline").first
      html = Nokogiri::HTML5.fragment(str)
      link = html.css("a").first
      expect(link["href"]).to eq("http://www.instructure.com/a/b?a=1&b=2")

str = th.format_message("click here: http://www.instructure.com/\nnewline").first
      html = Nokogiri::HTML5.fragment(str)
      link = html.css("a").first
      expect(link["href"]).to eq("http://www.instructure.com/")

str = th.format_message("click here: http://www.instructure.com/courses/1/pages/informação").first
      html = Nokogiri::HTML5.fragment(str)
      link = html.css("a").first
      expect(link["href"]).to eq("http://www.instructure.com/courses/1/pages/informação")

str = th.format_message("click here: http://www.instructure.com/courses/1/pages#anchor").first
      html = Nokogiri::HTML5.fragment(str)
      link = html.css("a").first
      expect(link["href"]).to eq("http://www.instructure.com/courses/1/pages#anchor")

str = th.format_message("click here: http://www.instructure.com/'onclick=alert(document.cookie)//\nnewline").first
      html = Nokogiri::HTML5.fragment(str)
      link = html.css("a").first
      expect(link["href"]).to eq("http://www.instructure.com/%27onclick=alert(document.cookie)//")

# > ~15 chars in parens used to blow up the parser to take forever
      str = th.format_message("click here: http://www.instructure.com/(012345678901234567890123456789012345678901234567890)").first
      html = Nokogiri::HTML5.fragment(str)
      link = html.css("a").first
      expect(link["href"]).to eq("http://www.instructure.com/(012345678901234567890123456789012345678901234567890)")
    end

it "handles having the placeholder in the text body" do
      str = th.format_message("this text has the placeholder #{HtmlTextHelper::AUTO_LINKIFY_PLACEHOLDER} embedded right in it.\nhttp://www.instructure.com/\n").first
      expect(str).to eq("this text has the placeholder #{HtmlTextHelper::AUTO_LINKIFY_PLACEHOLDER} embedded right in it.<br/>\r\n<a href='http://www.instructure.com/'>http://www.instructure.com/</a><br/>\r")
    end
  end

context ".html_to_text" do
    it "formats links in markdown-like style" do
      expect(th.html_to_text("<a href='www.example.com'>Link</a>")).to eq("[Link] (www.example.com)")
      expect(th.html_to_text("<a href='www.example.com'>www.example.com</a>")).to eq("www.example.com")
    end

it "does not format href-less links" do
      expect(th.html_to_text("<a>Link</a>")).to eq("Link")
    end

it "turns images into urls" do
      expect(th.html_to_text("<img src='http://www.example.com/a'>")).to eq("http://www.example.com/a")
    end

it "turns images with alt text into markdown style links" do
      expect(th.html_to_text('<img alt="an image" src="/image.png"')).to eq("[an image] (/image.png)")
    end

it "does not format src-less images" do
      expect(th.html_to_text('<img alt="an image">')).to eq("")
    end

it "adds base urls to links" do
      expect(th.html_to_text('<a href="/link">Link</a>', base_url: "http://example.com")).to eq("[Link] (http://example.com/link)")
      expect(th.html_to_text('<a href="http://example.org/link">Link</a>', base_url: "http://example.com")).to eq("[Link] (http://example.org/link)")
    end

it "adds base urls to img src" do
      expect(th.html_to_text('<img src="/image.png" alt="Image" />', base_url: "http://example.com")).to eq("[Image] (http://example.com/image.png)")
      expect(th.html_to_text('<img src="http://example.org/image.png" />', base_url: "http://example.com")).to eq("http://example.org/image.png")
    end

it "does not format src-less images even with base urls" do
      expect(th.html_to_text('<img alt="an image">', base_url: "http://example.com")).to eq("")
    end

it "formats list elements" do
      expect(th.html_to_text("<li>Item 1</li><li>Item 2</li>\n<li>Item 3</li> <li>Item 4\n<li>  Item 5")).to eq <<~MD.strip
        * Item 1

* Item 2

* Item 3

* Item 4

* Item 5
      MD
    end

it "formats headings" do
      expect(th.html_to_text("<h1>heading 1</h1><h2>heading two<br>text\n</h2>\n<h3>heading 3 <br> through heading 6</h3>")).to eq <<~MD.strip
        *********
        heading 1
        *********

-----------
        heading two
        text
        -----------

heading 3
        through heading 6
        -----------------
      MD
    end

it "formats headings in a word wrap friendly way" do
      expect(th.html_to_text("<h1>heading 1</h1><h2>heading two<br>text\n</h2>\n<h3>heading 3 through heading 6</h3>", line_width: 9)).to eq <<~MD.strip
        *********
        heading 1
        *********

---------
        heading
        two
        text
        ---------

heading 3
        through
        heading 6
        ---------
      MD
    end

it "words wrap" do
      expect(th.html_to_text("text that is a bit too long", line_width: 10)).to eq <<~MD.strip
        text that
        is a bit
        too long
      MD
    end

it "squeezes whitespace" do
      expect(th.html_to_text("too     many\n\n\nspaces   ")).to eq("too many spaces")
    end

it "strips link and script tags" do
      expect(th.html_to_text('<script>script script script</script>text<link rel="stuff">')).to eq("text")
    end

it "strips unclosed tags" do
      expect(th.html_to_text('<iframe src="javascript:alert(document.domain)"<h1>text</h1>')).to eq("text")
    end

it "strips other tags but leave their text" do
      expect(th.html_to_text("text<span>span text</span>")).to eq("textspan text")
    end

it "replaces html entities" do
      expect(th.html_to_text("&&amp; >&lt;&nbsp;")).to eq("&& ><\302\240")
    end

it "adds newlines around block elements" do
      expect(th.html_to_text("text<div>div text</div>")).to eq("text\n\ndiv text")
    end

it "preserves whitespace in pre tags (until squeezing)" do
      expect(th.html_to_text("<pre>i have\nactual\n\nnewlines\n\n\n!</pre>")).to eq("i have\nactual\n\nnewlines\n\n!")
    end

it "inserts newlines for ps and brs" do
      expect(th.html_to_text("Ohai<br>Text <p>paragraph of text.</p>End")).to eq("Ohai\nText\n\nparagraph of text.\n\nEnd")
    end

it "returns a string with no html back unchanged" do
      expect(th.html_to_text("String without HTML")).to eq("String without HTML")
    end

it "returns an empty string if passed a nil value" do
      expect(th.html_to_text(nil)).to eq("")
    end

it "just uses the given link if it cannot be parsed" do
      html_input = '<a href="http://&example.org/link">Link</a>'
      expect(th.html_to_text(html_input, base_url: "http://example.com")).to eq("[Link] (http://&example.org/link)")
    end

it "just uses the img src given if it cannot be parsed" do
      html_input = '<img src="http://example=.org/image.png" />'
      expect(th.html_to_text(html_input, base_url: "http://example.com")).to eq("http://example=.org/image.png")
    end
  end

describe "simplify html" do
    before do
      @body = <<~HTML.strip
        <p><strong>This is a bold tag</strong></p>
        <p><em>This is an em tag</em></p>
        <h1>This is an h1 tag</h1>
        <h2>This is an h2 tag</h2>
        <h3>This is an h3 tag</h3>
        <h4>This is an h4 tag</h4>
        <h5>This is an h5 tag</h5>
        <h6>This is an h6 tag</h6>
        <p><a href="http://foo.com">Link to Foo</a></p>
        <p><img src="http://google.com/someimage.png" width="50" height="50" alt="Some Image" title="Some Image" /></p>
      HTML
    end

it "converts simple tags to minimal html" do
      html = th.html_to_simple_html(@body).gsub("\r\n", "\n")
      expect(html).not_to match(/<h[1-6]|img/)
    end

it "converts relative links to absolute links" do
      original_html = ' <a href="/relative/link">Relative link</a> '
      html          = th.html_to_simple_html(original_html, base_url: "http://example.com")

expect(html).to match(%r{http://example.com/relative/link})
    end

it "resolves doubleslashes" do
      original_html = ' <a href="/relative/link">Relative link</a> '
      html          = th.html_to_simple_html(original_html, base_url: "http://example.com/")

expect(html).to match(%r{http://example.com/relative/link})
    end

it "respects passed in tags and attributes" do
      original_html =
        ' <a href="/relative/link">Relative link</a><table border=1>foo</table><tr border=1>bar</tr></table> '
      html = th.html_to_simple_html(original_html,
                                    base_url: "http://example.com",
                                    tags: ["table"],
                                    attributes: { "table" => ["border"] })
      expect(html).to match(%r{http://example.com/relative/link})
      expect(html).to match(/table border/)
      expect(html).not_to match(/tr border/)
    end
  end

context "banner" do
    it "adds a banner above and below the text equal to text length" do
      expect(th.banner("hi", char: "#")).to eq "##\nhi\n##"
    end

it "defaults to '*' if not char is passed" do
      expect(th.banner("hi")).to eq "**\nhi\n**"
    end

it "returns the input text if it is nil or empty" do
      expect(th.banner("")).to eq ""
    end
  end

context "#strip_and_truncate" do
    it "strips and truncate text" do
      allow(HtmlTextHelper).to receive(:strip_tags) { "something else" }
      allow(CanvasTextHelper).to receive(:truncate_text) { true }
      expect(HtmlTextHelper.strip_and_truncate("some text")).to be_truthy
      expect(HtmlTextHelper).to have_received(:strip_tags).with("some text")
      expect(CanvasTextHelper).to have_received(:truncate_text).with("something else", {})
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 html_text_helper_spec.rb	RB	11 KB	2023-09-24 03:36	EDIT
📄 spec_helper.rb	RB	1.5 KB	2023-09-24 03:36	EDIT