test/lib/rich_text_test.rb

   1 require "test_helper"
   2
   3 class RichTextTest < ActiveSupport::TestCase
   4   include Rails::Dom::Testing::Assertions::SelectorAssertions
   5
   6   def test_html_to_html
   7     r = RichText.new("html", "foo http://example.com/ bar")
   8     assert_html r do
   9       assert_select "a", 1
  10       assert_select "a[href='http://example.com/']", 1
  11       assert_select "a[rel='nofollow noopener noreferrer']", 1
  12     end
  13
  14     r = RichText.new("html", "foo <a href='http://example.com/'>bar</a> baz")
  15     assert_html r do
  16       assert_select "a", 1
  17       assert_select "a[href='http://example.com/']", 1
  18       assert_select "a[rel='nofollow noopener noreferrer']", 1
  19     end
  20
  21     r = RichText.new("html", "foo <a rel='junk me trash' href='http://example.com/'>bar</a> baz")
  22     assert_html r do
  23       assert_select "a", 1
  24       assert_select "a[href='http://example.com/']", 1
  25       assert_select "a[rel='me nofollow noopener noreferrer']", 1
  26     end
  27
  28     r = RichText.new("html", "foo example@example.com bar")
  29     assert_html r do
  30       assert_select "a", 0
  31     end
  32
  33     r = RichText.new("html", "foo <a href='mailto:example@example.com'>bar</a> baz")
  34     assert_html r do
  35       assert_select "a", 1
  36       assert_select "a[href='mailto:example@example.com']", 1
  37       assert_select "a[rel='nofollow noopener noreferrer']", 1
  38     end
  39
  40     r = RichText.new("html", "foo <div>bar</div> baz")
  41     assert_html r do
  42       assert_select "div", false
  43       assert_select "p", /^foo *bar *baz$/
  44     end
  45
  46     r = RichText.new("html", "foo <script>bar = 1;</script> baz")
  47     assert_html r do
  48       assert_select "script", false
  49       assert_select "p", /^foo *baz$/
  50     end
  51
  52     r = RichText.new("html", "foo <style>div { display: none; }</style> baz")
  53     assert_html r do
  54       assert_select "style", false
  55       assert_select "p", /^foo *baz$/
  56     end
  57
  58     r = RichText.new("html", "<table><tr><td>column</td></tr></table>")
  59     assert_html r do
  60       assert_select "table[class='table table-sm w-auto']"
  61     end
  62
  63     r = RichText.new("html", "<p class='btn btn-warning'>Click Me</p>")
  64     assert_html r do
  65       assert_select "p[class='btn btn-warning']", false
  66       assert_select "p", /^Click Me$/
  67     end
  68
  69     r = RichText.new("html", "<p style='color:red'>Danger</p>")
  70     assert_html r do
  71       assert_select "p[style='color:red']", false
  72       assert_select "p", /^Danger$/
  73     end
  74   end
  75
  76   def test_html_to_text
  77     r = RichText.new("html", "foo <a href='http://example.com/'>bar</a> baz")
  78     assert_equal "foo <a href='http://example.com/'>bar</a> baz", r.to_text
  79   end
  80
  81   def test_html_spam_score
  82     r = RichText.new("html", "foo <a href='http://example.com/'>bar</a> baz")
  83     assert_equal 55, r.spam_score.round
  84   end
  85
  86   def test_markdown_to_html
  87     r = RichText.new("markdown", "foo http://example.com/ bar")
  88     assert_html r do
  89       assert_select "a", 1
  90       assert_select "a[href='http://example.com/']", 1
  91       assert_select "a[rel='nofollow noopener noreferrer']", 1
  92     end
  93
  94     r = RichText.new("markdown", "foo [bar](http://example.com/) baz")
  95     assert_html r do
  96       assert_select "a", 1
  97       assert_select "a[href='http://example.com/']", 1
  98       assert_select "a[rel='nofollow noopener noreferrer']", 1
  99     end
 100
 101     r = RichText.new("markdown", "foo <a rel='junk me trash' href='http://example.com/'>bar</a>) baz")
 102     assert_html r do
 103       assert_select "a", 1
 104       assert_select "a[href='http://example.com/']", 1
 105       assert_select "a[rel='me nofollow noopener noreferrer']", 1
 106     end
 107
 108     r = RichText.new("markdown", "foo example@example.com bar")
 109     assert_html r do
 110       assert_select "a", 1
 111       assert_select "a[href='mailto:example@example.com']", 1
 112       assert_select "a[rel='nofollow noopener noreferrer']", 1
 113     end
 114
 115     r = RichText.new("markdown", "foo [bar](mailto:example@example.com) bar")
 116     assert_html r do
 117       assert_select "a", 1
 118       assert_select "a[href='mailto:example@example.com']", 1
 119       assert_select "a[rel='nofollow noopener noreferrer']", 1
 120     end
 121
 122     r = RichText.new("markdown", "foo ![bar](http://example.com/example.png) bar")
 123     assert_html r do
 124       assert_select "img", 1
 125       assert_select "img[alt='bar']", 1
 126       assert_select "img[src='http://example.com/example.png']", 1
 127     end
 128
 129     r = RichText.new("markdown", "# foo bar baz")
 130     assert_html r do
 131       assert_select "h1", "foo bar baz"
 132     end
 133
 134     r = RichText.new("markdown", "## foo bar baz")
 135     assert_html r do
 136       assert_select "h2", "foo bar baz"
 137     end
 138
 139     r = RichText.new("markdown", "### foo bar baz")
 140     assert_html r do
 141       assert_select "h3", "foo bar baz"
 142     end
 143
 144     r = RichText.new("markdown", "* foo bar baz")
 145     assert_html r do
 146       assert_select "ul" do
 147         assert_select "li", "foo bar baz"
 148       end
 149     end
 150
 151     r = RichText.new("markdown", "1. foo bar baz")
 152     assert_html r do
 153       assert_select "ol" do
 154         assert_select "li", "foo bar baz"
 155       end
 156     end
 157
 158     r = RichText.new("markdown", "foo *bar* _baz_ qux")
 159     assert_html r do
 160       assert_select "em", "bar"
 161       assert_select "em", "baz"
 162     end
 163
 164     r = RichText.new("markdown", "foo **bar** __baz__ qux")
 165     assert_html r do
 166       assert_select "strong", "bar"
 167       assert_select "strong", "baz"
 168     end
 169
 170     r = RichText.new("markdown", "foo `bar` baz")
 171     assert_html r do
 172       assert_select "code", "bar"
 173     end
 174
 175     r = RichText.new("markdown", "    foo bar baz")
 176     assert_html r do
 177       assert_select "pre", /^\s*foo bar baz\s*$/
 178     end
 179
 180     r = RichText.new("markdown", "|column|column")
 181     assert_html r do
 182       assert_select "table[class='table table-sm w-auto']"
 183     end
 184
 185     r = RichText.new("markdown", "Click Me\n{:.btn.btn-warning}")
 186     assert_html r do
 187       assert_select "p[class='btn btn-warning']", false
 188       assert_select "p", /^Click Me$/
 189     end
 190
 191     r = RichText.new("markdown", "<p style='color:red'>Danger</p>")
 192     assert_html r do
 193       assert_select "p[style='color:red']", false
 194       assert_select "p", /^Danger$/
 195     end
 196   end
 197
 198   def test_markdown_table_alignment
 199     # Ensure that kramdown table alignment styles are converted to bootstrap classes
 200     markdown_table = <<~MARKDOWN
 201       | foo  | bar |
 202       |:----:|----:|
 203       |center|right|
 204     MARKDOWN
 205     r = RichText.new("markdown", markdown_table)
 206     assert_html r do
 207       assert_select "td[style='text-align:center']", false
 208       assert_select "td[class='text-center']", true
 209       assert_select "td[style='text-align:right']", false
 210       assert_select "td[class='text-end']", true
 211     end
 212   end
 213
 214   def test_markdown_to_text
 215     r = RichText.new("markdown", "foo [bar](http://example.com/) baz")
 216     assert_equal "foo [bar](http://example.com/) baz", r.to_text
 217   end
 218
 219   def test_markdown_spam_score
 220     r = RichText.new("markdown", "foo [bar](http://example.com/) baz")
 221     assert_equal 50, r.spam_score.round
 222   end
 223
 224   def test_text_to_html_linkify
 225     with_settings(:linkify_hosts => ["replace-me.example.com"], :linkify_hosts_replacement => "repl.example.com") do
 226       r = RichText.new("text", "foo http://example.com/ bar")
 227       assert_html r do
 228         assert_dom "a", :count => 1, :text => "http://example.com/" do
 229           assert_dom "> @href", "http://example.com/"
 230           assert_dom "> @rel", "nofollow noopener noreferrer"
 231         end
 232       end
 233     end
 234   end
 235
 236   def test_text_to_html_linkify_replace
 237     with_settings(:linkify_hosts => ["replace-me.example.com"], :linkify_hosts_replacement => "repl.example.com") do
 238       r = RichText.new("text", "foo https://replace-me.example.com/some/path?query=te<st&limit=20>10#result12 bar")
 239       assert_html r do
 240         assert_dom "a", :count => 1, :text => "repl.example.com/some/path?query=te<st&limit=20>10#result12" do
 241           assert_dom "> @href", "https://replace-me.example.com/some/path?query=te<st&limit=20>10#result12"
 242           assert_dom "> @rel", "nofollow noopener noreferrer"
 243         end
 244       end
 245     end
 246   end
 247
 248   def test_text_to_html_linkify_replace_other_scheme
 249     with_settings(:linkify_hosts => ["replace-me.example.com"], :linkify_hosts_replacement => "repl.example.com") do
 250       r = RichText.new("text", "foo ftp://replace-me.example.com/some/path?query=te<st&limit=20>10#result12 bar")
 251       assert_html r do
 252         assert_dom "a", :count => 1, :text => "ftp://replace-me.example.com/some/path?query=te<st&limit=20>10#result12" do
 253           assert_dom "> @href", "ftp://replace-me.example.com/some/path?query=te<st&limit=20>10#result12"
 254           assert_dom "> @rel", "nofollow noopener noreferrer"
 255         end
 256       end
 257     end
 258   end
 259
 260   def test_text_to_html_linkify_replace_undefined
 261     with_settings(:linkify_hosts => ["replace-me.example.com"], :linkify_hosts_replacement => nil) do
 262       r = RichText.new("text", "foo https://replace-me.example.com/some/path?query=te<st&limit=20>10#result12 bar")
 263       assert_html r do
 264         assert_dom "a", :count => 1, :text => "https://replace-me.example.com/some/path?query=te<st&limit=20>10#result12" do
 265           assert_dom "> @href", "https://replace-me.example.com/some/path?query=te<st&limit=20>10#result12"
 266           assert_dom "> @rel", "nofollow noopener noreferrer"
 267         end
 268       end
 269     end
 270   end
 271
 272   def test_text_to_html_linkify_wiki_replace_prefix
 273     with_settings(:linkify_wiki_hosts => ["replace-me-wiki.example.com"], :linkify_wiki_hosts_replacement => "wiki.example.com",
 274                   :linkify_wiki_optional_path_prefix => "^/wiki(?=/[A-Z])") do
 275       r = RichText.new("text", "foo https://replace-me-wiki.example.com/wiki/Tag:surface%3Dmetal bar")
 276       assert_html r do
 277         assert_dom "a", :count => 1, :text => "wiki.example.com/Tag:surface%3Dmetal" do
 278           assert_dom "> @href", "https://replace-me-wiki.example.com/wiki/Tag:surface%3Dmetal"
 279           assert_dom "> @rel", "nofollow noopener noreferrer"
 280         end
 281       end
 282     end
 283   end
 284
 285   def test_text_to_html_linkify_wiki_replace_prefix_undefined
 286     with_settings(:linkify_wiki_hosts => ["replace-me-wiki.example.com"], :linkify_wiki_hosts_replacement => "wiki.example.com",
 287                   :linkify_wiki_optional_path_prefix => nil) do
 288       r = RichText.new("text", "foo https://replace-me-wiki.example.com/wiki/Tag:surface%3Dmetal bar")
 289       assert_html r do
 290         assert_dom "a", :count => 1, :text => "wiki.example.com/wiki/Tag:surface%3Dmetal" do
 291           assert_dom "> @href", "https://replace-me-wiki.example.com/wiki/Tag:surface%3Dmetal"
 292           assert_dom "> @rel", "nofollow noopener noreferrer"
 293         end
 294       end
 295     end
 296   end
 297
 298   def test_text_to_html_linkify_wiki_replace_undefined_prefix
 299     with_settings(:linkify_wiki_hosts => ["replace-me-wiki.example.com"], :linkify_wiki_hosts_replacement => nil,
 300                   :linkify_wiki_optional_path_prefix => "^/wiki(?=/[A-Z])") do
 301       r = RichText.new("text", "foo https://replace-me-wiki.example.com/wiki/Tag:surface%3Dmetal bar")
 302       assert_html r do
 303         assert_dom "a", :count => 1, :text => "https://replace-me-wiki.example.com/Tag:surface%3Dmetal" do
 304           assert_dom "> @href", "https://replace-me-wiki.example.com/wiki/Tag:surface%3Dmetal"
 305           assert_dom "> @rel", "nofollow noopener noreferrer"
 306         end
 307       end
 308     end
 309   end
 310
 311   def test_text_to_html_linkify_wiki_replace_prefix_no_match
 312     with_settings(:linkify_wiki_hosts => ["replace-me-wiki.example.com"], :linkify_wiki_hosts_replacement => "wiki.example.com",
 313                   :linkify_wiki_optional_path_prefix => "^/wiki(?=/[A-Z])") do
 314       r = RichText.new("text", "foo https://replace-me-wiki.example.com/wiki/w bar")
 315       assert_html r do
 316         assert_dom "a", :count => 1, :text => "wiki.example.com/wiki/w" do
 317           assert_dom "> @href", "https://replace-me-wiki.example.com/wiki/w"
 318           assert_dom "> @rel", "nofollow noopener noreferrer"
 319         end
 320       end
 321     end
 322   end
 323
 324   def test_text_to_html_email
 325     r = RichText.new("text", "foo example@example.com bar")
 326     assert_html r do
 327       assert_select "a", 0
 328     end
 329   end
 330
 331   def test_text_to_html_escape
 332     r = RichText.new("text", "foo < bar & baz > qux")
 333     assert_html r do
 334       assert_select "p", "foo < bar & baz > qux"
 335     end
 336   end
 337
 338   def test_text_to_text
 339     r = RichText.new("text", "foo http://example.com/ bar")
 340     assert_equal "foo http://example.com/ bar", r.to_text
 341   end
 342
 343   def test_text_spam_score
 344     r = RichText.new("text", "foo http://example.com/ bar")
 345     assert_equal 141, r.spam_score.round
 346   end
 347
 348   def test_text_no_opengraph_properties
 349     r = RichText.new("text", "foo https://example.com/ bar")
 350     assert_nil r.image
 351     assert_nil r.image_alt
 352     assert_nil r.description
 353   end
 354
 355   def test_html_no_opengraph_properties
 356     r = RichText.new("html", "foo <a href='https://example.com/'>bar</a> baz")
 357     assert_nil r.image
 358     assert_nil r.image_alt
 359     assert_nil r.description
 360   end
 361
 362   def test_markdown_no_image
 363     r = RichText.new("markdown", "foo [bar](https://example.com/) baz")
 364     assert_nil r.image
 365     assert_nil r.image_alt
 366   end
 367
 368   def test_markdown_image
 369     r = RichText.new("markdown", "foo ![bar](https://example.com/image.jpg) baz")
 370     assert_equal "https://example.com/image.jpg", r.image
 371     assert_equal "bar", r.image_alt
 372   end
 373
 374   def test_markdown_first_image
 375     r = RichText.new("markdown", "foo ![bar1](https://example.com/image1.jpg) baz\nfoo ![bar2](https://example.com/image2.jpg) baz")
 376     assert_equal "https://example.com/image1.jpg", r.image
 377     assert_equal "bar1", r.image_alt
 378   end
 379
 380   def test_markdown_image_with_empty_src
 381     r = RichText.new("markdown", "![invalid]()")
 382     assert_nil r.image
 383     assert_nil r.image_alt
 384   end
 385
 386   def test_markdown_skip_image_with_empty_src
 387     r = RichText.new("markdown", "![invalid]() ![valid](https://example.com/valid.gif)")
 388     assert_equal "https://example.com/valid.gif", r.image
 389     assert_equal "valid", r.image_alt
 390   end
 391
 392   def test_markdown_html_image
 393     r = RichText.new("markdown", "<img src='https://example.com/img_element.png' alt='alt text here'>")
 394     assert_equal "https://example.com/img_element.png", r.image
 395     assert_equal "alt text here", r.image_alt
 396   end
 397
 398   def test_markdown_html_image_without_alt
 399     r = RichText.new("markdown", "<img src='https://example.com/img_element.png'>")
 400     assert_equal "https://example.com/img_element.png", r.image
 401     assert_nil r.image_alt
 402   end
 403
 404   def test_markdown_html_image_with_empty_src
 405     r = RichText.new("markdown", "<img src='' alt='forgot src'>")
 406     assert_nil r.image
 407     assert_nil r.image_alt
 408   end
 409
 410   def test_markdown_skip_html_image_with_empty_src
 411     r = RichText.new("markdown", "<img src='' alt='forgot src'> <img src='https://example.com/next_img_element.png' alt='have src'>")
 412     assert_equal "https://example.com/next_img_element.png", r.image
 413     assert_equal "have src", r.image_alt
 414   end
 415
 416   def test_markdown_html_image_without_src
 417     r = RichText.new("markdown", "<img alt='totally forgot src'>")
 418     assert_nil r.image
 419     assert_nil r.image_alt
 420   end
 421
 422   def test_markdown_skip_html_image_without_src
 423     r = RichText.new("markdown", "<img alt='totally forgot src'> <img src='https://example.com/next_img_element.png' alt='have src'>")
 424     assert_equal "https://example.com/next_img_element.png", r.image
 425     assert_equal "have src", r.image_alt
 426   end
 427
 428   def test_markdown_no_description
 429     r = RichText.new("markdown", "#Nope")
 430     assert_nil r.description
 431   end
 432
 433   def test_markdown_description
 434     r = RichText.new("markdown", "This is an article about something.")
 435     assert_equal "This is an article about something.", r.description
 436   end
 437
 438   def test_markdown_description_after_heading
 439     r = RichText.new("markdown", "#Heading\n\nHere starts the text.")
 440     assert_equal "Here starts the text.", r.description
 441   end
 442
 443   def test_markdown_description_after_image
 444     r = RichText.new("markdown", "![bar](https://example.com/image.jpg)\n\nThis is below the image.")
 445     assert_equal "This is below the image.", r.description
 446   end
 447
 448   def test_markdown_description_only_first_paragraph
 449     r = RichText.new("markdown", "This thing.\n\nMaybe also that thing.")
 450     assert_equal "This thing.", r.description
 451   end
 452
 453   def test_markdown_description_elements
 454     r = RichText.new("markdown", "*Something* **important** [here](https://example.com/).")
 455     assert_equal "Something important here.", r.description
 456   end
 457
 458   def test_markdown_html_description
 459     r = RichText.new("markdown", "<p>Can use HTML tags.</p>")
 460     assert_equal "Can use HTML tags.", r.description
 461   end
 462
 463   def test_markdown_description_max_length
 464     r = RichText.new("markdown", "x" * RichText::MAX_DESCRIPTION_LENGTH)
 465     assert_equal "x" * RichText::MAX_DESCRIPTION_LENGTH, r.description
 466
 467     r = RichText.new("markdown", "y" * (RichText::MAX_DESCRIPTION_LENGTH + 1))
 468     assert_equal "#{'y' * (RichText::MAX_DESCRIPTION_LENGTH - 3)}...", r.description
 469
 470     r = RichText.new("markdown", "*zzzzzzzzz*z" * ((RichText::MAX_DESCRIPTION_LENGTH + 1) / 10.0).ceil)
 471     assert_equal "#{'z' * (RichText::MAX_DESCRIPTION_LENGTH - 3)}...", r.description
 472   end
 473
 474   private
 475
 476   def assert_html(richtext, &block)
 477     html = richtext.to_html
 478     assert_predicate html, :html_safe?
 479     root = Nokogiri::HTML::DocumentFragment.parse(html)
 480     assert_select root, "*" do
 481       yield block
 482     end
 483   end
 484 end