codeninjasllc/discourse
1
0
Fork 0
mirror of https://github.com/codeninjasllc/discourse.git synced 2024-11-30 10:58:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Create and use new rspec matcher 'match_html'

Browse source 
This introduces match_html, which converts actual and expected HTML strings into "canonical" HTML using Nokogiri with NOBLANKS and COMPACT, and then does a simple equality comparison.

This eliminates whitespace differences introduced by library changes (e.g. the libxml2 2.9.0 change).

pretty_text_spec.rb has been changed to use match_html where appropriate. and all tests pass under libxml2 2.7.6, 2.8.0 or 2.9.0
This commit is contained in:
Michael Scott Shappe 2013-04-09 22:27:33 -05:00
parent 9b487953c4
commit 2fb673dd72
2 changed files with 35 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
spec/components/pretty_text_spec.rb
View file

@ -7,7 +7,7 @@ describe PrettyText do
it "should support github style code blocks" do it "should support github style code blocks" do
PrettyText.cook("``` PrettyText.cook("```
test test
```").should == "<pre><code class=\"lang-auto\">test \n</code></pre>" ```").should match_html "<pre><code class=\"lang-auto\">test \n</code></pre>"
end end
it "should support quoting [] " do it "should support quoting [] " do
@ -15,64 +15,64 @@ test
end end
it "produces a quote even with new lines in it" do it "produces a quote even with new lines in it" do
PrettyText.cook("[quote=\"EvilTrout, post:123, topic:456, full:true\"]ddd\n[/quote]").should == "<p></p><aside class=\"quote\" data-post=\"123\" data-topic=\"456\" data-full=\"true\"><div class=\"title\">\n <div class=\"quote-controls\"></div>\n <img width=\"20\" height=\"20\" src=\"/users/eviltrout/avatar/40?__ws=http%3A%2F%2Ftest.localhost\" class=\"avatar \" title=\"\">\n EvilTrout\n said:\n </div>\n <blockquote>ddd</blockquote>\n</aside><p> </p>" PrettyText.cook("[quote=\"EvilTrout, post:123, topic:456, full:true\"]ddd\n[/quote]").should match_html "<p></p><aside class=\"quote\" data-post=\"123\" data-topic=\"456\" data-full=\"true\"><div class=\"title\">\n <div class=\"quote-controls\"></div>\n <img width=\"20\" height=\"20\" src=\"/users/eviltrout/avatar/40?__ws=http%3A%2F%2Ftest.localhost\" class=\"avatar \" title=\"\">\n EvilTrout\n said:\n </div>\n <blockquote>ddd</blockquote>\n</aside><p> </p>"
end end
it "should produce a quote" do it "should produce a quote" do
PrettyText.cook("[quote=\"EvilTrout, post:123, topic:456, full:true\"]ddd[/quote]").should == "<p></p><aside class=\"quote\" data-post=\"123\" data-topic=\"456\" data-full=\"true\"><div class=\"title\">\n <div class=\"quote-controls\"></div>\n <img width=\"20\" height=\"20\" src=\"/users/eviltrout/avatar/40?__ws=http%3A%2F%2Ftest.localhost\" class=\"avatar \" title=\"\">\n EvilTrout\n said:\n </div>\n <blockquote>ddd</blockquote>\n</aside><p> </p>" PrettyText.cook("[quote=\"EvilTrout, post:123, topic:456, full:true\"]ddd[/quote]").should match_html "<p></p><aside class=\"quote\" data-post=\"123\" data-topic=\"456\" data-full=\"true\"><div class=\"title\">\n <div class=\"quote-controls\"></div>\n <img width=\"20\" height=\"20\" src=\"/users/eviltrout/avatar/40?__ws=http%3A%2F%2Ftest.localhost\" class=\"avatar \" title=\"\">\n EvilTrout\n said:\n </div>\n <blockquote>ddd</blockquote>\n</aside><p> </p>"
end end
it "trims spaces on quote params" do it "trims spaces on quote params" do
PrettyText.cook("[quote=\"EvilTrout, post:555, topic: 666\"]ddd[/quote]").should == "<p></p><aside class=\"quote\" data-post=\"555\" data-topic=\"666\"><div class=\"title\">\n <div class=\"quote-controls\"></div>\n <img width=\"20\" height=\"20\" src=\"/users/eviltrout/avatar/40?__ws=http%3A%2F%2Ftest.localhost\" class=\"avatar \" title=\"\">\n EvilTrout\n said:\n </div>\n <blockquote>ddd</blockquote>\n</aside><p> </p>" PrettyText.cook("[quote=\"EvilTrout, post:555, topic: 666\"]ddd[/quote]").should match_html "<p></p><aside class=\"quote\" data-post=\"555\" data-topic=\"666\"><div class=\"title\">\n <div class=\"quote-controls\"></div>\n <img width=\"20\" height=\"20\" src=\"/users/eviltrout/avatar/40?__ws=http%3A%2F%2Ftest.localhost\" class=\"avatar \" title=\"\">\n EvilTrout\n said:\n </div>\n <blockquote>ddd</blockquote>\n</aside><p> </p>"
end end
it "should handle 3 mentions in a row" do it "should handle 3 mentions in a row" do
PrettyText.cook('@hello @hello @hello').should == "<p><span class=\"mention\">@hello</span> <span class=\"mention\">@hello</span> <span class=\"mention\">@hello</span></p>" PrettyText.cook('@hello @hello @hello').should match_html "<p><span class=\"mention\">@hello</span> <span class=\"mention\">@hello</span> <span class=\"mention\">@hello</span></p>"
end end
it "should not do weird @ mention stuff inside a pre block" do it "should not do weird @ mention stuff inside a pre block" do
PrettyText.cook("``` PrettyText.cook("```
a @test a @test
```").should == "<pre><code class=\"lang-auto\">a @test \n</code></pre>" ```").should match_html "<pre><code class=\"lang-auto\">a @test \n</code></pre>"
end end
it "should sanitize the html" do it "should sanitize the html" do
PrettyText.cook("<script>alert(42)</script>").should == "alert(42)" PrettyText.cook("<script>alert(42)</script>").should match_html "alert(42)"
end end
it "should escape html within the code block" do it "should escape html within the code block" do
PrettyText.cook("```text PrettyText.cook("```text
<header>hello</header> <header>hello</header>
```").should == "<pre><code class=\"text\">&lt;header&gt;hello&lt;/header&gt; \n</code></pre>" ```").should match_html "<pre><code class=\"text\">&lt;header&gt;hello&lt;/header&gt; \n</code></pre>"
end end
it "should support language choices" do it "should support language choices" do
PrettyText.cook("```ruby PrettyText.cook("```ruby
test test
```").should == "<pre><code class=\"ruby\">test \n</code></pre>" ```").should match_html "<pre><code class=\"ruby\">test \n</code></pre>"
end end
it 'should decorate @mentions' do it 'should decorate @mentions' do
PrettyText.cook("Hello @eviltrout").should == "<p>Hello <span class=\"mention\">@eviltrout</span></p>" PrettyText.cook("Hello @eviltrout").should match_html "<p>Hello <span class=\"mention\">@eviltrout</span></p>"
end end
it 'should allow for @mentions to have punctuation' do it 'should allow for @mentions to have punctuation' do
PrettyText.cook("hello @bob's @bob,@bob; @bob\"").should == PrettyText.cook("hello @bob's @bob,@bob; @bob\"").should
"<p>hello <span class=\"mention\">@bob</span>'s <span class=\"mention\">@bob</span>,<span class=\"mention\">@bob</span>; <span class=\"mention\">@bob</span>\"</p>" match_html "<p>hello <span class=\"mention\">@bob</span>'s <span class=\"mention\">@bob</span>,<span class=\"mention\">@bob</span>; <span class=\"mention\">@bob</span>\"</p>"
end end
it 'should add spoiler tags' do it 'should add spoiler tags' do
PrettyText.cook("[spoiler]hello[/spoiler]").should == "<p><span class=\"spoiler\">hello</span></p>" PrettyText.cook("[spoiler]hello[/spoiler]").should match_html "<p><span class=\"spoiler\">hello</span></p>"
end end
it "should only detect ``` at the begining of lines" do it "should only detect ``` at the begining of lines" do
PrettyText.cook(" ```\n hello\n ```") PrettyText.cook(" ```\n hello\n ```")
.should == "<pre><code>```\nhello\n```\n</code></pre>" .should match_html "<pre><code>```\nhello\n```\n</code></pre>"
end end
end end

21
spec/support/match_html_matcher.rb Normal file
View file

@ -0,0 +1,21 @@
require 'nokogiri/xml/parse_options'
RSpec::Matchers.define :match_html do |expected|
match do |actual|
a = make_canonical_html expected
b = make_canonical_html actual
a.to_html == b.to_html
end
failure_message_for_should do |actual|
"after sanitizing for extra white space and compactness, expected #{actual} to match #{expected}"
end
failure_message_for_should_not do |actual|
"after sanitizing for extra white space and compactness, expected #{actual} not to match #{expected}"
end
def make_canonical_html(html)
Nokogiri::HTML(html) { |config| config.options = Nokogiri::XML::ParseOptions::NOBLANKS | Nokogiri::XML::ParseOptions::COMPACT }
end
end