]> git.wincent.com - wikitext.git/blob - spec/external_link_spec.rb
Emit <code> rather than <tt> elements
[wikitext.git] / spec / external_link_spec.rb
1 # encoding: utf-8
2 # Copyright 2007-2010 Wincent Colaiuta. All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are met:
6 #
7 # 1. Redistributions of source code must retain the above copyright notice,
8 #    this list of conditions and the following disclaimer.
9 # 2. Redistributions in binary form must reproduce the above copyright notice,
10 #    this list of conditions and the following disclaimer in the documentation
11 #    and/or other materials provided with the distribution.
12
13 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
17 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 # POSSIBILITY OF SUCH DAMAGE.
24
25 require File.join(File.dirname(__FILE__), 'spec_helper.rb')
26
27 describe Wikitext::Parser, 'external links' do
28   before do
29     @parser = Wikitext::Parser.new
30   end
31
32   it 'should format valid external HTTP links' do
33     expected = %Q{<p><a href="http://google.com/" class="external">Google</a></p>\n}
34     @parser.parse('[http://google.com/ Google]').should == expected
35   end
36
37   it 'should format valid external HTTPS links' do
38     expected = %Q{<p><a href="https://google.com/" class="external">Google</a></p>\n}
39     @parser.parse('[https://google.com/ Google]').should == expected
40   end
41
42   it 'should format valid external FTP links' do
43     expected = %Q{<p><a href="ftp://google.com/" class="external">Google</a></p>\n}
44     @parser.parse('[ftp://google.com/ Google]').should == expected
45   end
46
47   it 'should format valid external SVN links' do
48     expected = %Q{<p><a href="svn://google.com/" class="external">Google</a></p>\n}
49     @parser.parse('[svn://google.com/ Google]').should == expected
50   end
51
52   it 'should format valid external mailto links' do
53     expected = %Q{<p><a href="mailto:user@example.com" class="mailto">john</a></p>\n}
54     @parser.parse('[mailto:user@example.com john]').should == expected
55   end
56
57   it 'should not treat raw email addresses as valid link targets' do
58     expected = %Q{<p>[<a href="mailto:user@example.com" class="mailto">user@example.com</a> john]</p>\n}
59     @parser.parse('[user@example.com john]').should == expected
60   end
61
62   it 'should format absolute path links' do
63     expected = %Q{<p><a href="/foo/bar">fb</a></p>\n} # note no "external" class
64     @parser.parse('[/foo/bar fb]').should == expected
65   end
66
67   it 'should format deeply nested absolute path links' do
68     expected = %Q{<p><a href="/foo/bar/baz/bing">fb</a></p>\n} # note no "external" class
69     @parser.parse('[/foo/bar/baz/bing fb]').should == expected
70   end
71
72   it 'should format minimal absolute path links' do
73     expected = %Q{<p><a href="/">fb</a></p>\n} # note no "external" class
74     @parser.parse('[/ fb]').should == expected
75   end
76
77   it 'should format absolute path links with trailing slashes' do
78     expected = %Q{<p><a href="/foo/bar/">fb</a></p>\n} # note no "external" class
79     @parser.parse('[/foo/bar/ fb]').should == expected
80   end
81
82   it 'should not format relative path links' do
83     # relative paths don't make sense in wikitext because
84     # they could be displayed anywhere (eg. /wiki/article, /dashboard/ etc)
85     expected = %Q{<p>[foo/bar fb]</p>\n}
86     @parser.parse('[foo/bar fb]').should == expected
87   end
88
89   it 'should treat runs of spaces after the link target as a single space' do
90     expected = %Q{<p><a href="http://google.com/" class="external">Google</a></p>\n}
91     @parser.parse('[http://google.com/                  Google]').should == expected
92   end
93
94   it 'should not treat runs of spaces within the link text as a single space' do
95     expected = %Q{<p><a href="http://google.com/" class="external">Google    search</a></p>\n}
96     @parser.parse('[http://google.com/ Google    search]').should == expected
97   end
98
99   it 'should format a link with emphasis in the link text' do
100     expected = %Q{<p><a href="http://google.com/" class="external">Google <em>rocks</em></a></p>\n}
101     @parser.parse("[http://google.com/ Google ''rocks'']").should == expected
102   end
103
104   it "should automatically close unmatched '' tags in the link text" do
105     expected = %Q{<p><a href="http://google.com/" class="external">Google <em>SOC</em></a></p>\n}
106     @parser.parse("[http://google.com/ Google ''SOC]").should == expected
107   end
108
109   it 'should format a link with strong formatting in the link text' do
110     expected = %Q{<p><a href="http://google.com/" class="external"><strong>Google</strong> rocks</a></p>\n}
111     @parser.parse("[http://google.com/ '''Google''' rocks]").should == expected
112   end
113
114   it "should automatically close unmatched ''' tags in the link text" do
115     expected = %Q{<p><a href="http://google.com/" class="external">Google <strong>SOC</strong></a></p>\n}
116     @parser.parse("[http://google.com/ Google '''SOC]").should == expected
117   end
118
119   it 'should format a link with <tt></tt> tags in the link text' do
120     expected = %Q{<p><a href="http://google.com/" class="external">Google <code>SOC</code></a></p>\n}
121     @parser.parse("[http://google.com/ Google <tt>SOC</tt>]").should == expected
122   end
123
124   it 'should automatically close unmatched <tt> tags in the link text' do
125     expected = %Q{<p><a href="http://google.com/" class="external">Google <code>SOC</code></a></p>\n}
126     @parser.parse("[http://google.com/ Google <tt>SOC]").should == expected
127   end
128
129   it 'should format a link with strong and emphasis in the link text' do
130     expected = %Q{<p><a href="http://google.com/" class="external">Google <strong><em>rocks</em></strong></a></p>\n}
131     @parser.parse("[http://google.com/ Google '''''rocks''''']").should == expected
132   end
133
134   it "should automatically close unmatched ''''' tags in the link text" do
135     expected = %Q{<p><a href="http://google.com/" class="external">Google <strong><em>SOC</em></strong></a></p>\n}
136     @parser.parse("[http://google.com/ Google '''''SOC]").should == expected
137   end
138
139   it 'should respect "<nowiki></nowiki>" tags inside the link text' do
140     expected = %Q{<p><a href="http://google.com/" class="external">Google ] rocks</a></p>\n}
141     @parser.parse("[http://google.com/ Google <nowiki>]</nowiki> rocks]").should == expected  # was a bug
142
143     expected = %Q{<p><a href="http://google.com/" class="external">Google [ rocks</a></p>\n}
144     @parser.parse("[http://google.com/ Google <nowiki>[</nowiki> rocks]").should == expected  # was a bug
145   end
146
147   it 'should pass "[" in link text through literally' do
148     expected = %Q{<p><a href="http://google.com/" class="external">Google [ rocks</a></p>\n}
149     @parser.parse("[http://google.com/ Google [ rocks]").should == expected  # was a bug
150   end
151
152   it 'should pass "[[" in link text through literally' do
153     expected = %Q{<p><a href="http://google.com/" class="external">Google [[ rocks</a></p>\n}
154     @parser.parse("[http://google.com/ Google [[ rocks]").should == expected  # was a bug
155   end
156
157   it 'should pass "]]" in link text through literally' do
158     # note how "]]" is treated as a single token, not as a "]" which closes the link followed by another ("] rocks]")
159     expected = %Q{<p><a href="http://google.com/" class="external">Google ]] rocks</a></p>\n}
160     @parser.parse("[http://google.com/ Google ]] rocks]").should == expected  # was a bug
161   end
162
163   it 'should pass through ASCII entities in the link text' do
164     expected = %Q{<p><a href="http://google.com/" class="external">Google &quot;SOC&quot;</a></p>\n}  # QUOT
165     @parser.parse(%Q{[http://google.com/ Google "SOC"]}).should == expected
166     expected = %Q{<p><a href="http://google.com/" class="external">Google &lt;SOC&gt;</a></p>\n}      # LESS, GREATER
167     @parser.parse(%Q{[http://google.com/ Google <SOC>]}).should == expected
168     expected = %Q{<p><a href="http://google.com/" class="external">Google &amp; SOC</a></p>\n}        # AMP
169     @parser.parse(%Q{[http://google.com/ Google & SOC]}).should == expected
170   end
171
172   it 'should pass through named entities in the link text' do
173     expected = %Q{<p><a href="http://google.com/" class="external">Google &euro;</a></p>\n}
174     @parser.parse(%Q{[http://google.com/ Google &euro;]}).should == expected
175   end
176
177   it 'should pass through decimal entities in the link text' do
178     expected = %Q{<p><a href="http://google.com/" class="external">Google &#8364;</a></p>\n}
179     @parser.parse(%Q{[http://google.com/ Google &#8364;]}).should == expected
180   end
181
182   it 'should pass through hexadecimal entities in the link text' do
183     expected = %Q{<p><a href="http://google.com/" class="external">Google &#x20ac;</a></p>\n}
184     @parser.parse(%Q{[http://google.com/ Google &#x20ac;]}).should == expected
185   end
186
187   it 'should convert non-ASCII characters in the link text into entities' do
188     expected = %Q{<p><a href="http://google.com/" class="external">Google &#x20ac;</a></p>\n}
189     @parser.parse(%Q{[http://google.com/ Google €]}).should == expected
190   end
191
192   it 'should pass through unexpected external link end tokens literally' do
193     @parser.parse('foo ] bar').should == "<p>foo ] bar</p>\n"                                     # in plain scope
194     @parser.parse("foo '']'' bar").should == "<p>foo <em>]</em> bar</p>\n"                        # in EM scope
195     @parser.parse("foo ''']''' bar").should == "<p>foo <strong>]</strong> bar</p>\n"              # in STRONG scope
196     @parser.parse("foo ''''']''''' bar").should == "<p>foo <strong><em>]</em></strong> bar</p>\n" # in STRONG_EM scope
197     @parser.parse('foo <tt>]</tt> bar').should == "<p>foo <code>]</code> bar</p>\n"               # in TT scope
198     @parser.parse('= foo ] bar =').should == "<h1>foo ] bar</h1>\n"                               # in H1 scope
199     @parser.parse('== foo ] bar ==').should == "<h2>foo ] bar</h2>\n"                             # in H2 scope
200     @parser.parse('=== foo ] bar ===').should == "<h3>foo ] bar</h3>\n"                           # in H3 scope
201     @parser.parse('==== foo ] bar ====').should == "<h4>foo ] bar</h4>\n"                         # in H4 scope
202     @parser.parse('===== foo ] bar =====').should == "<h5>foo ] bar</h5>\n"                       # in H5 scope
203     @parser.parse('====== foo ] bar ======').should == "<h6>foo ] bar</h6>\n"                     # in H6 scope
204     @parser.parse('> ]').should == "<blockquote>\n  <p>]</p>\n</blockquote>\n"                    # in BLOCKQUOTE scope
205   end
206
207   describe 'questionable links' do
208     it 'should handle links which contain an embedded [ character' do
209       # note that [ is allowed in the link text, although the result may be unexpected to the user
210       expected = %Q{<p><a href="http://google.com/" class="external">[hello</a></p>\n}
211       @parser.parse("[http://google.com/ [hello]").should == expected
212     end
213
214     it 'should handle links which contain an embedded ] character' do
215       # note how the first ] terminates the link
216       expected = %Q{<p><a href="http://google.com/" class="external">[hello</a> world]</p>\n}
217       @parser.parse("[http://google.com/ [hello] world]").should == expected
218     end
219
220     it 'should handle links which contain an embedded [[ character' do
221       # note that [[ is allowed in the link text
222       expected = %Q{<p><a href="http://google.com/" class="external">[[hello</a></p>\n}
223       @parser.parse("[http://google.com/ [[hello]").should == expected
224     end
225
226     it 'should handle links which contain an embedded ]] character' do
227       # note how this time ]] does not terminate the link because it is tokenized as LINK_END rather than EXT_LINK_END
228       expected = %Q{<p><a href="http://google.com/" class="external">[[hello]] world</a></p>\n}
229       @parser.parse("[http://google.com/ [[hello]] world]").should == expected
230     end
231
232     it 'should allow URIs in the link text' do
233       # not sure why you'd want to do this, but...
234       expected = %Q{<p><a href="http://example.net/" class="external">hello http://example.com/ world</a></p>\n}
235       @parser.parse('[http://example.net/ hello http://example.com/ world]').should == expected
236     end
237   end
238
239   describe 'invalid links' do
240     it "should pass through links which don't have a valid target" do
241       expected = "<p>[well]</p>\n"
242       @parser.parse("[well]").should == expected
243     end
244
245     it "should pass through links which don't have any target" do
246       expected = "<p>[]</p>\n"
247       @parser.parse('[]').should == expected
248     end
249
250     it 'should pass through unterminated links (EOF)' do
251       expected = "<p>[</p>\n"
252       @parser.parse('[').should == expected
253
254       expected = "<p>[well</p>\n"
255       @parser.parse("[well").should == expected
256
257       expected = %Q{<p>[<a href="http://example.com/" class="external">http://example.com/</a></p>\n}
258       @parser.parse("[http://example.com/").should == expected
259
260       expected = %Q{<p>[<a href="http://example.com/" class="external">http://example.com/</a> </p>\n}
261       @parser.parse("[http://example.com/ ").should == expected
262
263       expected = %Q{<p>[<a href="http://example.com/" class="external">http://example.com/</a> visit</p>\n}
264       @parser.parse("[http://example.com/ visit").should == expected # was a bug
265
266       expected = %Q{<h6>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h6>\n}
267       @parser.parse("====== [http://example.com/ visit").should == expected # was a bug
268
269       expected = %Q{<h5>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h5>\n}
270       @parser.parse("===== [http://example.com/ visit").should == expected # was a bug
271
272       expected = %Q{<h4>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h4>\n}
273       @parser.parse("==== [http://example.com/ visit").should == expected # was a bug
274
275       expected = %Q{<h3>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h3>\n}
276       @parser.parse("=== [http://example.com/ visit").should == expected # was a bug
277
278       expected = %Q{<h2>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h2>\n}
279       @parser.parse("== [http://example.com/ visit").should == expected # was a bug
280
281       expected = %Q{<h1>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h1>\n}
282       @parser.parse("= [http://example.com/ visit").should == expected # was a bug
283
284       expected = %Q{<p>[<a href="http://example.com/" class="external">http://example.com/</a> ...</p>\n}
285       @parser.parse("[http://example.com/ <nowiki>...\n").should == expected
286     end
287
288     it 'should pass through unterminated links (end-of-line)' do
289       expected = "<p>[</p>\n"
290       @parser.parse("[\n").should == expected
291
292       expected = "<p>[well</p>\n"
293       @parser.parse("[well\n").should == expected
294
295       expected = %Q{<p>[<a href="http://example.com/" class="external">http://example.com/</a></p>\n}
296       @parser.parse("[http://example.com/\n").should == expected
297
298       expected = %Q{<p>[<a href="http://example.com/" class="external">http://example.com/</a> </p>\n}
299       @parser.parse("[http://example.com/ \n").should == expected
300
301       expected = %Q{<p>[<a href="http://example.com/" class="external">http://example.com/</a> visit</p>\n}
302       @parser.parse("[http://example.com/ visit\n").should == expected # was a bug
303
304       expected = %Q{<h6>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h6>\n}
305       @parser.parse("====== [http://example.com/ visit\n").should == expected # was a bug
306
307       expected = %Q{<h5>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h5>\n}
308       @parser.parse("===== [http://example.com/ visit\n").should == expected # was a bug
309
310       expected = %Q{<h4>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h4>\n}
311       @parser.parse("==== [http://example.com/ visit\n").should == expected # was a bug
312
313       expected = %Q{<h3>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h3>\n}
314       @parser.parse("=== [http://example.com/ visit\n").should == expected # was a bug
315
316       expected = %Q{<h2>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h2>\n}
317       @parser.parse("== [http://example.com/ visit\n").should == expected # was a bug
318
319       expected = %Q{<h1>[<a href="http://example.com/" class="external">http://example.com/</a> visit</h1>\n}
320       @parser.parse("= [http://example.com/ visit\n").should == expected # was a bug
321
322       # here's a slightly more complicated example using a blockquote
323       expected = %Q{<blockquote>\n  <p>[<a href="http://google.com/" class="external">http://google.com/</a></p>\n</blockquote>\n}
324       @parser.parse("> [http://google.com/\n").should == expected # was a bug
325     end
326   end
327
328   describe 'regressions' do
329     # assorted examples
330     it 'should not turn failed absolute links into external hyperlinks' do
331       # was emitting: <p>[<a href="/hello" class="external">/hello</a> this</p>\n
332       expected =   %Q{<p>[<a href="/hello">/hello</a> this</p>\n}
333       @parser.parse('[/hello this').should == expected
334
335       # was emitting: <p>[<a href="/hello" class="external">/hello</a> </p>\n
336       expected =   %Q{<p>[<a href="/hello">/hello</a> </p>\n}
337       @parser.parse('[/hello ').should == expected
338
339       # was emitting: <h1>hello [<a href="/hello" class="external">/hello</a> </h1>\n
340       expected =   %Q{<h1>hello [<a href="/hello">/hello</a> </h1>\n}
341       @parser.parse('= hello [/hello =').should == expected
342     end
343   end
344 end