# encoding: UTF-8
unless defined? ASCIIDOCTOR_PROJECT_DIR
$: << File.dirname(__FILE__); $:.uniq!
require 'test_helper'
end
# TODO
# - test negatives
# - test role on every quote type
context 'Substitutions' do
context 'Dispatcher' do
test 'apply normal substitutions' do
para = block_from_string("[blue]_http://asciidoc.org[AsciiDoc]_ & [red]*Ruby*\n§ Making +++documentation+++ together +\nsince (C) {inception_year}.")
para.document.attributes['inception_year'] = '2012'
result = para.apply_normal_subs(para.lines)
assert_equal %{AsciiDoc & Ruby\n§ Making documentation together
\nsince © 2012.}, result
end
end
context 'Quotes' do
BACKSLASH = '\\'
test 'single-line double-quoted string' do
para = block_from_string(%q{``a few quoted words''}, :attributes => {'compat-mode' => ''})
assert_equal '“a few quoted words”', para.sub_quotes(para.source)
para = block_from_string(%q{"`a few quoted words`"})
assert_equal '“a few quoted words”', para.sub_quotes(para.source)
end
test 'escaped single-line double-quoted string' do
para = block_from_string %(#{BACKSLASH}``a few quoted words''), :attributes => {'compat-mode' => ''}
assert_equal %q(‘`a few quoted words’'), para.sub_quotes(para.source)
para = block_from_string %(#{BACKSLASH * 2}``a few quoted words''), :attributes => {'compat-mode' => ''}
assert_equal %q(``a few quoted words''), para.sub_quotes(para.source)
para = block_from_string(%(#{BACKSLASH}"`a few quoted words`"))
assert_equal %q("`a few quoted words`"), para.sub_quotes(para.source)
para = block_from_string(%(#{BACKSLASH * 2}"`a few quoted words`"))
assert_equal %(#{BACKSLASH}"`a few quoted words`"), para.sub_quotes(para.source)
end
test 'multi-line double-quoted string' do
para = block_from_string(%Q{``a few\nquoted words''}, :attributes => {'compat-mode' => ''})
assert_equal "“a few\nquoted words”", para.sub_quotes(para.source)
para = block_from_string(%Q{"`a few\nquoted words`"})
assert_equal "“a few\nquoted words”", para.sub_quotes(para.source)
end
test 'double-quoted string with inline single quote' do
para = block_from_string(%q{``Here's Johnny!''}, :attributes => {'compat-mode' => ''})
assert_equal %q{“Here's Johnny!”}, para.sub_quotes(para.source)
para = block_from_string(%q{"`Here's Johnny!`"})
assert_equal %q{“Here's Johnny!”}, para.sub_quotes(para.source)
end
test 'double-quoted string with inline backquote' do
para = block_from_string(%q{``Here`s Johnny!''}, :attributes => {'compat-mode' => ''})
assert_equal %q{“Here`s Johnny!”}, para.sub_quotes(para.source)
para = block_from_string(%q{"`Here`s Johnny!`"})
assert_equal %q{“Here`s Johnny!”}, para.sub_quotes(para.source)
end
test 'double-quoted string around monospaced text' do
para = block_from_string(%q("``E=mc^2^` is the solution!`"))
assert_equal %q(“`E=mc2` is the solution!”), para.apply_subs(para.source);
para = block_from_string(%q("```E=mc^2^`` is the solution!`"))
assert_equal %q(“E=mc2
is the solution!”), para.apply_subs(para.source);
end
test 'single-line single-quoted string' do
para = block_from_string(%q{`a few quoted words'}, :attributes => {'compat-mode' => ''})
assert_equal '‘a few quoted words’', para.sub_quotes(para.source)
para = block_from_string(%q{'`a few quoted words`'})
assert_equal '‘a few quoted words’', para.sub_quotes(para.source)
end
test 'escaped single-line single-quoted string' do
para = block_from_string(%(#{BACKSLASH}`a few quoted words'), :attributes => {'compat-mode' => ''})
assert_equal %(`a few quoted words'), para.sub_quotes(para.source)
para = block_from_string(%(#{BACKSLASH}'`a few quoted words`'))
assert_equal %('`a few quoted words`'), para.sub_quotes(para.source)
end
test 'multi-line single-quoted string' do
para = block_from_string(%Q{`a few\nquoted words'}, :attributes => {'compat-mode' => ''})
assert_equal "‘a few\nquoted words’", para.sub_quotes(para.source)
para = block_from_string(%Q{'`a few\nquoted words`'})
assert_equal "‘a few\nquoted words’", para.sub_quotes(para.source)
end
test 'single-quoted string with inline single quote' do
para = block_from_string(%q{`That isn't what I did.'}, :attributes => {'compat-mode' => ''})
assert_equal %q{‘That isn't what I did.’}, para.sub_quotes(para.source)
para = block_from_string(%q{'`That isn't what I did.`'})
assert_equal %q{‘That isn't what I did.’}, para.sub_quotes(para.source)
end
test 'single-quoted string with inline backquote' do
para = block_from_string(%q{`Here`s Johnny!'}, :attributes => {'compat-mode' => ''})
assert_equal %q{‘Here`s Johnny!’}, para.sub_quotes(para.source)
para = block_from_string(%q{'`Here`s Johnny!`'})
assert_equal %q{‘Here`s Johnny!’}, para.sub_quotes(para.source)
end
test 'single-line constrained marked string' do
#para = block_from_string(%q{#a few words#}, :attributes => {'compat-mode' => ''})
#assert_equal 'a few words', para.sub_quotes(para.source)
para = block_from_string(%q{#a few words#})
assert_equal 'a few words', para.sub_quotes(para.source)
end
test 'escaped single-line constrained marked string' do
para = block_from_string(%(#{BACKSLASH}#a few words#))
assert_equal '#a few words#', para.sub_quotes(para.source)
end
test 'multi-line constrained marked string' do
#para = block_from_string(%Q{#a few\nwords#}, :attributes => {'compat-mode' => ''})
#assert_equal "a few\nwords", para.sub_quotes(para.source)
para = block_from_string(%Q{#a few\nwords#})
assert_equal "a few\nwords", para.sub_quotes(para.source)
end
test 'constrained marked string should not match entity references' do
para = block_from_string('111 #mark a# 222 "`quote a`" 333 #mark b# 444')
assert_equal %(111 mark a 222 “quote a” 333 mark b 444), para.sub_quotes(para.source)
end
test 'single-line unconstrained marked string' do
#para = block_from_string(%q{##--anything goes ##}, :attributes => {'compat-mode' => ''})
#assert_equal '--anything goes ', para.sub_quotes(para.source)
para = block_from_string(%q{##--anything goes ##})
assert_equal '--anything goes ', para.sub_quotes(para.source)
end
test 'escaped single-line unconstrained marked string' do
para = block_from_string(%(#{BACKSLASH}#{BACKSLASH}##--anything goes ##))
assert_equal '##--anything goes ##', para.sub_quotes(para.source)
end
test 'multi-line unconstrained marked string' do
#para = block_from_string(%Q{##--anything\ngoes ##}, :attributes => {'compat-mode' => ''})
#assert_equal "--anything\ngoes ", para.sub_quotes(para.source)
para = block_from_string(%Q{##--anything\ngoes ##})
assert_equal "--anything\ngoes ", para.sub_quotes(para.source)
end
test 'single-line constrained marked string with role' do
para = block_from_string(%q{[statement]#a few words#})
assert_equal 'a few words', para.sub_quotes(para.source)
end
test 'single-line constrained strong string' do
para = block_from_string(%q{*a few strong words*})
assert_equal 'a few strong words', para.sub_quotes(para.source)
end
test 'escaped single-line constrained strong string' do
para = block_from_string(%(#{BACKSLASH}*a few strong words*))
assert_equal '*a few strong words*', para.sub_quotes(para.source)
end
test 'multi-line constrained strong string' do
para = block_from_string(%Q{*a few\nstrong words*})
assert_equal "a few\nstrong words", para.sub_quotes(para.source)
end
test 'constrained strong string containing an asterisk' do
para = block_from_string(%q{*bl*ck*-eye})
assert_equal 'bl*ck-eye', para.sub_quotes(para.source)
end
test 'constrained strong string containing an asterisk and multibyte word chars' do
para = block_from_string(%q{*黑*眼圈*})
assert_equal '黑*眼圈', para.sub_quotes(para.source)
end if ::RUBY_MIN_VERSION_1_9
test 'single-line constrained quote variation emphasized string' do
para = block_from_string(%q{_a few emphasized words_})
assert_equal 'a few emphasized words', para.sub_quotes(para.source)
end
test 'escaped single-line constrained quote variation emphasized string' do
para = block_from_string(%(#{BACKSLASH}_a few emphasized words_))
assert_equal %q(_a few emphasized words_), para.sub_quotes(para.source)
end
test 'escaped single quoted string' do
para = block_from_string(%(#{BACKSLASH}'a few emphasized words'))
# NOTE the \' is replaced with ' by the :replacements substitution, later in the substitution pipeline
assert_equal %(#{BACKSLASH}'a few emphasized words'), para.sub_quotes(para.source)
end
test 'multi-line constrained emphasized quote variation string' do
para = block_from_string(%Q{_a few\nemphasized words_})
assert_equal "a few\nemphasized words", para.sub_quotes(para.source)
end
test 'single-quoted string containing an emphasized phrase' do
para = block_from_string(%q{`I told him, 'Just go for it!''}, :attributes => {'compat-mode' => ''})
assert_equal '‘I told him, Just go for it!’', para.sub_quotes(para.source)
para = block_from_string(%q{'`I told him, 'Just go for it!'`'})
assert_equal %q(‘I told him, 'Just go for it!'’), para.sub_quotes(para.source)
end
test 'escaped single-quotes inside emphasized words are restored' do
para = block_from_string(%('Here#{BACKSLASH}'s Johnny!'), :attributes => {'compat-mode' => ''})
assert_equal %q(Here's Johnny!), para.apply_normal_subs(para.lines)
para = block_from_string(%('Here#{BACKSLASH}'s Johnny!'))
assert_equal %q('Here's Johnny!'), para.apply_normal_subs(para.lines)
end
test 'single-line constrained emphasized underline variation string' do
para = block_from_string(%q{_a few emphasized words_})
assert_equal 'a few emphasized words', para.sub_quotes(para.source)
end
test 'escaped single-line constrained emphasized underline variation string' do
para = block_from_string(%(#{BACKSLASH}_a few emphasized words_))
assert_equal '_a few emphasized words_', para.sub_quotes(para.source)
end
test 'multi-line constrained emphasized underline variation string' do
para = block_from_string(%Q{_a few\nemphasized words_})
assert_equal "a few\nemphasized words", para.sub_quotes(para.source)
end
# NOTE must use apply_normal_subs because constrained monospaced is handled as a passthrough
test 'single-line constrained monospaced string' do
para = block_from_string(%(`a few <{monospaced}> words`), :attributes => {'monospaced' => 'monospaced', 'compat-mode' => ''})
assert_equal 'a few <{monospaced}> words
', para.apply_normal_subs(para.lines)
para = block_from_string(%(`a few <{monospaced}> words`), :attributes => {'monospaced' => 'monospaced'})
assert_equal 'a few <monospaced> words
', para.apply_normal_subs(para.lines)
end
# NOTE must use apply_normal_subs because constrained monospaced is handled as a passthrough
test 'single-line constrained monospaced string with role' do
para = block_from_string(%([input]`a few <{monospaced}> words`), :attributes => {'monospaced' => 'monospaced', 'compat-mode' => ''})
assert_equal 'a few <{monospaced}> words
', para.apply_normal_subs(para.lines)
para = block_from_string(%([input]`a few <{monospaced}> words`), :attributes => {'monospaced' => 'monospaced'})
assert_equal 'a few <monospaced> words
', para.apply_normal_subs(para.lines)
end
# NOTE must use apply_normal_subs because constrained monospaced is handled as a passthrough
test 'escaped single-line constrained monospaced string' do
para = block_from_string(%(#{BACKSLASH}`a few words`), :attributes => {'compat-mode' => ''})
assert_equal '`a few <monospaced> words`', para.apply_normal_subs(para.lines)
para = block_from_string(%(#{BACKSLASH}`a few words`))
assert_equal '`a few <monospaced> words`', para.apply_normal_subs(para.lines)
end
# NOTE must use apply_normal_subs because constrained monospaced is handled as a passthrough
test 'escaped single-line constrained monospaced string with role' do
para = block_from_string(%([input]#{BACKSLASH}`a few words`), :attributes => {'compat-mode' => ''})
assert_equal '[input]`a few <monospaced> words`', para.apply_normal_subs(para.lines)
para = block_from_string(%([input]#{BACKSLASH}`a few words`))
assert_equal '[input]`a few <monospaced> words`', para.apply_normal_subs(para.lines)
end
# NOTE must use apply_normal_subs because constrained monospaced is handled as a passthrough
test 'escaped role on single-line constrained monospaced string' do
para = block_from_string(%(#{BACKSLASH}[input]`a few words`), :attributes => {'compat-mode' => ''})
assert_equal '[input]a few <monospaced> words
', para.apply_normal_subs(para.lines)
para = block_from_string(%(#{BACKSLASH}[input]`a few words`))
assert_equal '[input]a few <monospaced> words
', para.apply_normal_subs(para.lines)
end
# NOTE must use apply_normal_subs because constrained monospaced is handled as a passthrough
test 'escaped role on escaped single-line constrained monospaced string' do
para = block_from_string(%(#{BACKSLASH}[input]#{BACKSLASH}`a few words`), :attributes => {'compat-mode' => ''})
assert_equal %(#{BACKSLASH}[input]`a few <monospaced> words`), para.apply_normal_subs(para.lines)
para = block_from_string(%(#{BACKSLASH}[input]#{BACKSLASH}`a few words`))
assert_equal %(#{BACKSLASH}[input]`a few <monospaced> words`), para.apply_normal_subs(para.lines)
end
# NOTE must use apply_normal_subs because constrained monospaced is handled as a passthrough
test 'multi-line constrained monospaced string' do
para = block_from_string(%(`a few\n<{monospaced}> words`), :attributes => {'monospaced' => 'monospaced', 'compat-mode' => ''})
assert_equal "a few\n<{monospaced}> words
", para.apply_normal_subs(para.lines)
para = block_from_string(%(`a few\n<{monospaced}> words`), :attributes => {'monospaced' => 'monospaced'})
assert_equal "a few\n<monospaced> words
", para.apply_normal_subs(para.lines)
end
test 'single-line unconstrained strong chars' do
para = block_from_string(%q{**Git**Hub})
assert_equal 'GitHub', para.sub_quotes(para.source)
end
test 'escaped single-line unconstrained strong chars' do
para = block_from_string(%(#{BACKSLASH}**Git**Hub))
assert_equal '*Git*Hub', para.sub_quotes(para.source)
end
test 'multi-line unconstrained strong chars' do
para = block_from_string(%Q{**G\ni\nt\n**Hub})
assert_equal "G\ni\nt\nHub", para.sub_quotes(para.source)
end
test 'unconstrained strong chars with inline asterisk' do
para = block_from_string(%q{**bl*ck**-eye})
assert_equal 'bl*ck-eye', para.sub_quotes(para.source)
end
test 'unconstrained strong chars with role' do
para = block_from_string(%q{Git[blue]**Hub**})
assert_equal %q{GitHub}, para.sub_quotes(para.source)
end
# TODO this is not the same result as AsciiDoc, though I don't understand why AsciiDoc gets what it gets
test 'escaped unconstrained strong chars with role' do
para = block_from_string(%(Git#{BACKSLASH}[blue]**Hub**))
assert_equal %q{Git[blue]*Hub*}, para.sub_quotes(para.source)
end
test 'single-line unconstrained emphasized chars' do
para = block_from_string(%q{__Git__Hub})
assert_equal 'GitHub', para.sub_quotes(para.source)
end
test 'escaped single-line unconstrained emphasized chars' do
para = block_from_string(%(#{BACKSLASH}__Git__Hub))
assert_equal '__Git__Hub', para.sub_quotes(para.source)
end
test 'escaped single-line unconstrained emphasized chars around word' do
para = block_from_string(%(#{BACKSLASH}#{BACKSLASH}__GitHub__))
assert_equal '__GitHub__', para.sub_quotes(para.source)
end
test 'multi-line unconstrained emphasized chars' do
para = block_from_string(%Q{__G\ni\nt\n__Hub})
assert_equal "G\ni\nt\nHub", para.sub_quotes(para.source)
end
test 'unconstrained emphasis chars with role' do
para = block_from_string(%q{[gray]__Git__Hub})
assert_equal %q{GitHub}, para.sub_quotes(para.source)
end
test 'escaped unconstrained emphasis chars with role' do
para = block_from_string(%(#{BACKSLASH}[gray]__Git__Hub))
assert_equal %q{[gray]__Git__Hub}, para.sub_quotes(para.source)
end
test 'single-line constrained monospaced chars' do
para = block_from_string(%q{call +save()+ to persist the changes}, :attributes => {'compat-mode' => ''})
assert_equal 'call save()
to persist the changes', para.sub_quotes(para.source)
para = block_from_string(%q{call [x-]+save()+ to persist the changes})
assert_equal 'call save()
to persist the changes', para.apply_subs(para.source)
para = block_from_string(%q{call `save()` to persist the changes})
assert_equal 'call save()
to persist the changes', para.sub_quotes(para.source)
end
test 'single-line constrained monospaced chars with role' do
para = block_from_string(%q{call [method]+save()+ to persist the changes}, :attributes => {'compat-mode' => ''})
assert_equal 'call save()
to persist the changes', para.sub_quotes(para.source)
para = block_from_string(%q{call [method x-]+save()+ to persist the changes})
assert_equal 'call save()
to persist the changes', para.apply_subs(para.source)
para = block_from_string(%q{call [method]`save()` to persist the changes})
assert_equal 'call save()
to persist the changes', para.sub_quotes(para.source)
end
test 'escaped single-line constrained monospaced chars' do
para = block_from_string(%(call #{BACKSLASH}+save()+ to persist the changes), :attributes => {'compat-mode' => ''})
assert_equal 'call +save()+ to persist the changes', para.sub_quotes(para.source)
para = block_from_string(%(call #{BACKSLASH}`save()` to persist the changes))
assert_equal 'call `save()` to persist the changes', para.sub_quotes(para.source)
end
test 'escaped single-line constrained monospaced chars with role' do
para = block_from_string(%(call [method]#{BACKSLASH}+save()+ to persist the changes), :attributes => {'compat-mode' => ''})
assert_equal 'call [method]+save()+ to persist the changes', para.sub_quotes(para.source)
para = block_from_string(%(call [method]#{BACKSLASH}`save()` to persist the changes))
assert_equal 'call [method]`save()` to persist the changes', para.sub_quotes(para.source)
end
test 'escaped role on single-line constrained monospaced chars' do
para = block_from_string(%(call #{BACKSLASH}[method]+save()+ to persist the changes), :attributes => {'compat-mode' => ''})
assert_equal 'call [method]save()
to persist the changes', para.sub_quotes(para.source)
para = block_from_string(%(call #{BACKSLASH}[method]`save()` to persist the changes))
assert_equal 'call [method]save()
to persist the changes', para.sub_quotes(para.source)
end
test 'escaped role on escaped single-line constrained monospaced chars' do
para = block_from_string(%(call #{BACKSLASH}[method]#{BACKSLASH}+save()+ to persist the changes), :attributes => {'compat-mode' => ''})
assert_equal %(call #{BACKSLASH}[method]+save()+ to persist the changes), para.sub_quotes(para.source)
para = block_from_string(%(call #{BACKSLASH}[method]#{BACKSLASH}`save()` to persist the changes))
assert_equal %(call #{BACKSLASH}[method]`save()` to persist the changes), para.sub_quotes(para.source)
end
test 'single-line unconstrained monospaced chars' do
para = block_from_string(%q{Git++Hub++}, :attributes => {'compat-mode' => ''})
assert_equal 'GitHub
', para.sub_quotes(para.source)
para = block_from_string(%q{Git[x-]++Hub++})
assert_equal 'GitHub
', para.apply_subs(para.source)
para = block_from_string(%q{Git``Hub``})
assert_equal 'GitHub
', para.sub_quotes(para.source)
end
test 'escaped single-line unconstrained monospaced chars' do
para = block_from_string(%(Git#{BACKSLASH}++Hub++), :attributes => {'compat-mode' => ''})
assert_equal 'Git+Hub
+', para.sub_quotes(para.source)
para = block_from_string(%(Git#{BACKSLASH * 2}++Hub++), :attributes => {'compat-mode' => ''})
assert_equal 'Git++Hub++', para.sub_quotes(para.source)
para = block_from_string(%(Git#{BACKSLASH}``Hub``))
assert_equal 'Git``Hub``', para.sub_quotes(para.source)
end
test 'multi-line unconstrained monospaced chars' do
para = block_from_string(%Q{Git++\nH\nu\nb++}, :attributes => {'compat-mode' => ''})
assert_equal "Git\nH\nu\nb
", para.sub_quotes(para.source)
para = block_from_string(%Q{Git[x-]++\nH\nu\nb++})
assert_equal %(Git\nH\nu\nb
), para.apply_subs(para.source)
para = block_from_string(%Q{Git``\nH\nu\nb``})
assert_equal "Git\nH\nu\nb
", para.sub_quotes(para.source)
end
test 'single-line superscript chars' do
para = block_from_string(%(x^2^ = x * x, e = mc^2^, there's a 1^st^ time for everything))
assert_equal %(x2 = x * x, e = mc2, there\'s a 1st time for everything), para.sub_quotes(para.source)
end
test 'escaped single-line superscript chars' do
para = block_from_string(%(x#{BACKSLASH}^2^ = x * x))
assert_equal 'x^2^ = x * x', para.sub_quotes(para.source)
end
test 'does not match superscript across whitespace' do
para = block_from_string(%Q{x^(n\n-\n1)^})
assert_equal para.source, para.sub_quotes(para.source)
end
test 'does not match adjacent superscript chars' do
para = block_from_string 'a ^^ b'
assert_equal 'a ^^ b', para.sub_quotes(para.source)
end
test 'does not confuse superscript and links with blank window shorthand' do
para = block_from_string(%Q{http://localhost[Text^] on the 21^st^ and 22^nd^})
assert_equal 'Text on the 21st and 22nd', para.content
end
test 'single-line subscript chars' do
para = block_from_string(%q{H~2~O})
assert_equal 'H2O', para.sub_quotes(para.source)
end
test 'escaped single-line subscript chars' do
para = block_from_string(%(H#{BACKSLASH}~2~O))
assert_equal 'H~2~O', para.sub_quotes(para.source)
end
test 'does not match subscript across whitespace' do
para = block_from_string(%Q{project~ view\non\nGitHub~})
assert_equal para.source, para.sub_quotes(para.source)
end
test 'does not match adjacent subscript chars' do
para = block_from_string 'a ~~ b'
assert_equal 'a ~~ b', para.sub_quotes(para.source)
end
test 'does not match subscript across distinct URLs' do
para = block_from_string(%Q{http://www.abc.com/~def[DEF] and http://www.abc.com/~ghi[GHI]})
assert_equal para.source, para.sub_quotes(para.source)
end
test 'quoted text with role shorthand' do
para = block_from_string(%q{[.white.red-background]#alert#})
assert_equal 'alert', para.sub_quotes(para.source)
end
test 'quoted text with id shorthand' do
para = block_from_string(%q{[#bond]#007#})
assert_equal '007', para.sub_quotes(para.source)
end
test 'quoted text with id and role shorthand' do
para = block_from_string(%q{[#bond.white.red-background]#007#})
assert_equal '007', para.sub_quotes(para.source)
end
test 'quoted text with id and role shorthand using docbook backend' do
para = block_from_string(%q{[#bond.white.red-background]#007#}, :backend => 'docbook45')
assert_equal '007', para.sub_quotes(para.source)
end
test 'should ignore attributes after comma' do
para = block_from_string(%q{[red, foobar]#alert#})
assert_equal 'alert', para.sub_quotes(para.source)
end
test 'should assign role attribute when shorthand style contains a role' do
para = block_from_string 'blah'
result = para.parse_quoted_text_attributes '.red#idref'
expect = {'id' => 'idref', 'role' => 'red'}
assert_equal expect, result
end
test 'should not assign role attribute if shorthand style has no roles' do
para = block_from_string 'blah'
result = para.parse_quoted_text_attributes '#idref'
expect = {'id' => 'idref'}
assert_equal expect, result
end
end
context 'Macros' do
test 'a single-line link macro should be interpreted as a link' do
para = block_from_string('link:/home.html[]')
assert_equal %q{/home.html}, para.sub_macros(para.source)
end
test 'a single-line link macro with text should be interpreted as a link' do
para = block_from_string('link:/home.html[Home]')
assert_equal %q{Home}, para.sub_macros(para.source)
end
test 'a mailto macro should be interpreted as a mailto link' do
para = block_from_string('mailto:doc.writer@asciidoc.org[]')
assert_equal %q{doc.writer@asciidoc.org}, para.sub_macros(para.source)
end
test 'a mailto macro with text should be interpreted as a mailto link' do
para = block_from_string('mailto:doc.writer@asciidoc.org[Doc Writer]')
assert_equal %q{Doc Writer}, para.sub_macros(para.source)
end
test 'a mailto macro with text and subject should be interpreted as a mailto link' do
para = block_from_string('mailto:doc.writer@asciidoc.org[Doc Writer, Pull request]', :attributes => {'linkattrs' => ''})
assert_equal %q{Doc Writer}, para.sub_macros(para.source)
end
test 'a mailto macro with text, subject and body should be interpreted as a mailto link' do
para = block_from_string('mailto:doc.writer@asciidoc.org[Doc Writer, Pull request, Please accept my pull request]', :attributes => {'linkattrs' => ''})
assert_equal %q{Doc Writer}, para.sub_macros(para.source)
end
test 'should recognize inline email addresses' do
para = block_from_string('doc.writer@asciidoc.org')
assert_equal %q{doc.writer@asciidoc.org}, para.sub_macros(para.source)
para = block_from_string('')
assert_equal %q{<doc.writer@asciidoc.org>}, para.apply_normal_subs(para.lines)
para = block_from_string('author+website@4fs.no')
assert_equal %q{author+website@4fs.no}, para.sub_macros(para.source)
para = block_from_string('john@domain.uk.co')
assert_equal %q{john@domain.uk.co}, para.sub_macros(para.source)
end
test 'should ignore escaped inline email address' do
para = block_from_string(%(#{BACKSLASH}doc.writer@asciidoc.org))
assert_equal %q{doc.writer@asciidoc.org}, para.sub_macros(para.source)
end
test 'a single-line raw url should be interpreted as a link' do
para = block_from_string('http://google.com')
assert_equal %q{http://google.com}, para.sub_macros(para.source)
end
test 'a single-line raw url with text should be interpreted as a link' do
para = block_from_string('http://google.com[Google]')
assert_equal %q{Google}, para.sub_macros(para.source)
end
test 'a multi-line raw url with text should be interpreted as a link' do
para = block_from_string("http://google.com[Google\nHomepage]")
assert_equal %{Google\nHomepage}, para.sub_macros(para.source)
end
test 'a multi-line raw url with attribute as text should be interpreted as a link with resolved attribute' do
para = block_from_string("http://google.com[{google_homepage}]")
para.document.attributes['google_homepage'] = 'Google Homepage'
assert_equal %q{Google Homepage}, para.sub_macros(para.source)
end
test 'a single-line escaped raw url should not be interpreted as a link' do
para = block_from_string(%(#{BACKSLASH}http://google.com))
assert_equal %q{http://google.com}, para.sub_macros(para.source)
end
test 'a comma separated list of links should not include commas in links' do
para = block_from_string('http://foo.com, http://bar.com, http://example.org')
assert_equal %q{http://foo.com, http://bar.com, http://example.org}, para.sub_macros(para.source)
end
test 'a single-line image macro should be interpreted as an image' do
para = block_from_string('image:tiger.png[]')
assert_equal %{}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'a single-line image macro with text should be interpreted as an image with alt text' do
para = block_from_string('image:tiger.png[Tiger]')
assert_equal %{}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'a single-line image macro with text containing escaped square bracket should be interpreted as an image with alt text' do
para = block_from_string(%(image:tiger.png[[Another#{BACKSLASH}] Tiger]))
assert_equal %{}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'a single-line image macro with text and dimensions should be interpreted as an image with alt text and dimensions' do
para = block_from_string('image:tiger.png[Tiger, 200, 100]')
assert_equal %{},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'a single-line image macro with text and dimensions should be interpreted as an image with alt text and dimensions in docbook' do
para = block_from_string 'image:tiger.png[Tiger, 200, 100]', :backend => 'docbook'
assert_equal %{Tiger},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'a single-line image macro with text and link should be interpreted as a linked image with alt text' do
para = block_from_string('image:tiger.png[Tiger, link="http://en.wikipedia.org/wiki/Tiger"]')
assert_equal %{},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'a multi-line image macro with text and dimensions should be interpreted as an image with alt text and dimensions' do
para = block_from_string(%(image:tiger.png[Another\nAwesome\nTiger, 200,\n100]))
assert_equal %{},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'an inline image macro with a url target should be interpreted as an image' do
para = block_from_string %(Beware of the image:http://example.com/images/tiger.png[tiger].)
assert_equal %{Beware of the .},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'an inline image macro with a float attribute should be interpreted as a floating image' do
para = block_from_string %(image:http://example.com/images/tiger.png[tiger, float="right"] Beware of the tigers!)
assert_equal %{ Beware of the tigers!},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'should prepend value of imagesdir attribute to inline image target if target is relative path' do
para = block_from_string %(Beware of the image:tiger.png[tiger].), :attributes => {'imagesdir' => './images'}
assert_equal %{Beware of the .},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'should not prepend value of imagesdir attribute to inline image target if target is absolute path' do
para = block_from_string %(Beware of the image:/tiger.png[tiger].), :attributes => {'imagesdir' => './images'}
assert_equal %{Beware of the .},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'should not prepend value of imagesdir attribute to inline image target if target is url' do
para = block_from_string %(Beware of the image:http://example.com/images/tiger.png[tiger].), :attributes => {'imagesdir' => './images'}
assert_equal %{Beware of the .},
para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'a block image macro should not be detected within paragraph text' do
para = block_from_string(%(Not an inline image macro image::tiger.png[].))
result = para.sub_macros(para.source)
assert !result.include?(' {'icons' => ''}
assert_equal %{}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'an icon macro should be interpreted as alt text if icons are disabled' do
para = block_from_string 'icon:github[]'
assert_equal %{[github]}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'an icon macro should render alt text if icons are disabled and alt is given' do
para = block_from_string 'icon:github[alt="GitHub"]'
assert_equal %{[GitHub]}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'an icon macro should be interpreted as a font-based icon when icons=font' do
para = block_from_string 'icon:github[]', :attributes => {'icons' => 'font'}
assert_equal %{}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'an icon macro with a size should be interpreted as a font-based icon with a size when icons=font' do
para = block_from_string 'icon:github[4x]', :attributes => {'icons' => 'font'}
assert_equal %{}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'an icon macro with a role and title should be interpreted as a font-based icon with a class and title when icons=font' do
para = block_from_string 'icon:heart[role="red", title="Heart me"]', :attributes => {'icons' => 'font'}
assert_equal %{}, para.sub_macros(para.source).gsub(/>\s+, '><')
end
test 'a single-line footnote macro should be registered and rendered as a footnote' do
para = block_from_string('Sentence text footnote:[An example footnote.].')
assert_equal %(Sentence text .), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote = para.document.references[:footnotes].first
assert_equal 1, footnote.index
assert footnote.id.nil?
assert_equal 'An example footnote.', footnote.text
end
test 'a multi-line footnote macro should be registered and rendered as a footnote without endline' do
para = block_from_string("Sentence text footnote:[An example footnote\nwith wrapped text.].")
assert_equal %(Sentence text .), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote = para.document.references[:footnotes].first
assert_equal 1, footnote.index
assert footnote.id.nil?
assert_equal "An example footnote with wrapped text.", footnote.text
end
test 'an escaped closing square bracket in a footnote should be unescaped when rendered' do
para = block_from_string(%(footnote:[a #{BACKSLASH}] b].))
assert_equal %(.), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote = para.document.references[:footnotes].first
assert_equal "a ] b", footnote.text
end
test 'a footnote macro can be directly adjacent to preceding word' do
para = block_from_string('Sentence textfootnote:[An example footnote.].')
assert_equal %(Sentence text.), para.sub_macros(para.source)
end
test 'a footnote macro may contain an escaped backslash' do
para = block_from_string("footnote:[\\]]\nfootnote:[a \\] b]\nfootnote:[a \\]\\] b]")
para.sub_macros(para.source)
assert_equal 3, para.document.references[:footnotes].size
footnote1 = para.document.references[:footnotes][0]
assert_equal ']', footnote1.text
footnote2 = para.document.references[:footnotes][1]
assert_equal 'a ] b', footnote2.text
footnote3 = para.document.references[:footnotes][2]
assert_equal 'a ]] b', footnote3.text
end
test 'a footnote macro may contain a link macro' do
para = block_from_string('Share your code. footnote:[http://github.com[GitHub]]')
assert_equal %(Share your code. ), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote1 = para.document.references[:footnotes][0]
assert_equal 'GitHub', footnote1.text
end
test 'a footnote macro may contain a plain URL' do
para = block_from_string %(the JLine footnote:[https://github.com/jline/jline2]\nlibrary.)
result = para.sub_macros para.source
assert_equal %(the JLine \nlibrary.), result
assert_equal 1, para.document.references[:footnotes].size
fn1 = para.document.references[:footnotes].first
assert_equal 'https://github.com/jline/jline2', fn1.text
end
test 'a footnote macro followed by a semi-colon may contain a plain URL' do
para = block_from_string %(the JLine footnote:[https://github.com/jline/jline2];\nlibrary.)
result = para.sub_macros para.source
assert_equal %(the JLine ;\nlibrary.), result
assert_equal 1, para.document.references[:footnotes].size
fn1 = para.document.references[:footnotes].first
assert_equal 'https://github.com/jline/jline2', fn1.text
end
test 'a footnote macro may contain an xref macro' do
# specialcharacters escaping is simulated
para = block_from_string('text footnote:[<<_install,Install>>]')
assert_equal %(text ), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote1 = para.document.references[:footnotes][0]
assert_equal 'Install', footnote1.text
end
test 'a footnote macro may contain an anchor macro' do
para = block_from_string('text footnote:[a [[b\]\] \[[c\]\] d]')
assert_equal %(text ), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote1 = para.document.references[:footnotes][0]
assert_equal 'a [[c]] d', footnote1.text
end
test 'subsequent footnote macros with escaped URLs should be restored in DocBook' do
input = <<-EOS
foofootnote:[+http://example.com+]barfootnote:[+http://acme.com+]baz
EOS
result = render_embedded_string input, :doctype => 'inline', :backend => 'docbook'
assert_equal 'foohttp://example.combarhttp://acme.combaz', result
end
test 'a footnote macro may contain a bibliographic anchor macro' do
para = block_from_string('text footnote:[a [[[b\]\]\] c]')
assert_equal %(text ), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote1 = para.document.references[:footnotes][0]
assert_equal 'a [b] c', footnote1.text
end
test 'should increment index of subsequent footnote macros' do
para = block_from_string("Sentence text footnote:[An example footnote.]. Sentence text footnote:[Another footnote.].")
assert_equal %(Sentence text . Sentence text .), para.sub_macros(para.source)
assert_equal 2, para.document.references[:footnotes].size
footnote1 = para.document.references[:footnotes][0]
assert_equal 1, footnote1.index
assert footnote1.id.nil?
assert_equal "An example footnote.", footnote1.text
footnote2 = para.document.references[:footnotes][1]
assert_equal 2, footnote2.index
assert footnote2.id.nil?
assert_equal "Another footnote.", footnote2.text
end
test 'a footnoteref macro with id and single-line text should be registered and rendered as a footnote' do
para = block_from_string('Sentence text footnoteref:[ex1, An example footnote.].')
assert_equal %(Sentence text .), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote = para.document.references[:footnotes].first
assert_equal 1, footnote.index
assert_equal 'ex1', footnote.id
assert_equal 'An example footnote.', footnote.text
end
test 'a footnoteref macro with id and multi-line text should be registered and rendered as a footnote without endlines' do
para = block_from_string("Sentence text footnoteref:[ex1, An example footnote\nwith wrapped text.].")
assert_equal %(Sentence text .), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote = para.document.references[:footnotes].first
assert_equal 1, footnote.index
assert_equal 'ex1', footnote.id
assert_equal "An example footnote with wrapped text.", footnote.text
end
test 'a footnoteref macro with id should refer to footnoteref with same id' do
para = block_from_string('Sentence text footnoteref:[ex1, An example footnote.]. Sentence text footnoteref:[ex1].')
assert_equal %(Sentence text . Sentence text .), para.sub_macros(para.source)
assert_equal 1, para.document.references[:footnotes].size
footnote = para.document.references[:footnotes].first
assert_equal 1, footnote.index
assert_equal 'ex1', footnote.id
assert_equal 'An example footnote.', footnote.text
end
test 'an unresolved footnoteref should not crash the processor' do
para = block_from_string('Sentence text footnoteref:[ex1].')
para.sub_macros para.source
end
test 'a single-line index term macro with a primary term should be registered as an index reference' do
sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
macros = ['indexterm:[Tigers]', '(((Tigers)))']
macros.each do |macro|
para = block_from_string("#{sentence}#{macro}")
output = para.sub_macros(para.source)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['Tigers'], para.document.references[:indexterms].first
end
end
test 'a single-line index term macro with primary and secondary terms should be registered as an index reference' do
sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
macros = ['indexterm:[Big cats, Tigers]', '(((Big cats, Tigers)))']
macros.each do |macro|
para = block_from_string("#{sentence}#{macro}")
output = para.sub_macros(para.source)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['Big cats', 'Tigers'], para.document.references[:indexterms].first
end
end
test 'a single-line index term macro with primary, secondary and tertiary terms should be registered as an index reference' do
sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
macros = ['indexterm:[Big cats,Tigers , Panthera tigris]', '(((Big cats,Tigers , Panthera tigris)))']
macros.each do |macro|
para = block_from_string("#{sentence}#{macro}")
output = para.sub_macros(para.source)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['Big cats', 'Tigers', 'Panthera tigris'], para.document.references[:indexterms].first
end
end
test 'a multi-line index term macro should be compacted and registered as an index reference' do
sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
macros = ["indexterm:[Panthera\ntigris]", "(((Panthera\ntigris)))"]
macros.each do |macro|
para = block_from_string("#{sentence}#{macro}")
output = para.sub_macros(para.source)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['Panthera tigris'], para.document.references[:indexterms].first
end
end
test 'should not split index terms on commas inside of quoted terms' do
inputs = []
inputs.push <<-EOS
Tigers are big, scary cats.
indexterm:[Tigers, "[Big\\],
scary cats"]
EOS
inputs.push <<-EOS
Tigers are big, scary cats.
(((Tigers, "[Big],
scary cats")))
EOS
inputs.each do |input|
para = block_from_string input
output = para.sub_macros(para.source)
assert_equal input.lines.first, output
assert_equal 1, para.document.references[:indexterms].size
terms = para.document.references[:indexterms].first
assert_equal 2, terms.size
assert_equal 'Tigers', terms.first
assert_equal '[Big], scary cats', terms.last
end
end
test 'normal substitutions are performed on an index term macro' do
sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
macros = ['indexterm:[*Tigers*]', '(((*Tigers*)))']
macros.each do |macro|
para = block_from_string("#{sentence}#{macro}")
output = para.apply_normal_subs(para.lines)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['Tigers'], para.document.references[:indexterms].first
end
end
test 'registers multiple index term macros' do
sentence = "The tiger (Panthera tigris) is the largest cat species."
macros = "(((Tigers)))\n(((Animals,Cats)))"
para = block_from_string("#{sentence}\n#{macros}")
output = para.sub_macros(para.source)
assert_equal sentence, output.rstrip
assert_equal 2, para.document.references[:indexterms].size
assert_equal ['Tigers'], para.document.references[:indexterms][0]
assert_equal ['Animals', 'Cats'], para.document.references[:indexterms][1]
end
test 'an index term macro with round bracket syntax may contain round brackets in term' do
sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
macro = '(((Tiger (Panthera tigris))))'
para = block_from_string("#{sentence}#{macro}")
output = para.sub_macros(para.source)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['Tiger (Panthera tigris)'], para.document.references[:indexterms].first
end
test 'an index term macro with square bracket syntax may contain square brackets in term' do
sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
macro = 'indexterm:[Tiger [Panthera tigris\\]]'
para = block_from_string("#{sentence}#{macro}")
output = para.sub_macros(para.source)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['Tiger [Panthera tigris]'], para.document.references[:indexterms].first
end
test 'a single-line index term 2 macro should be registered as an index reference and retain term inline' do
sentence = 'The tiger (Panthera tigris) is the largest cat species.'
macros = ['The indexterm2:[tiger] (Panthera tigris) is the largest cat species.', 'The ((tiger)) (Panthera tigris) is the largest cat species.']
macros.each do |macro|
para = block_from_string(macro)
output = para.sub_macros(para.source)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['tiger'], para.document.references[:indexterms].first
end
end
test 'a multi-line index term 2 macro should be compacted and registered as an index reference and retain term inline' do
sentence = 'The panthera tigris is the largest cat species.'
macros = ["The indexterm2:[ panthera\ntigris ] is the largest cat species.", "The (( panthera\ntigris )) is the largest cat species."]
macros.each do |macro|
para = block_from_string(macro)
output = para.sub_macros(para.source)
assert_equal sentence, output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['panthera tigris'], para.document.references[:indexterms].first
end
end
test 'registers multiple index term 2 macros' do
sentence = "The ((tiger)) (Panthera tigris) is the largest ((cat)) species."
para = block_from_string(sentence)
output = para.sub_macros(para.source)
assert_equal 'The tiger (Panthera tigris) is the largest cat species.', output
assert_equal 2, para.document.references[:indexterms].size
assert_equal ['tiger'], para.document.references[:indexterms][0]
assert_equal ['cat'], para.document.references[:indexterms][1]
end
test 'normal substitutions are performed on an index term 2 macro' do
sentence = 'The ((*tiger*)) (Panthera tigris) is the largest cat species.'
para = block_from_string sentence
output = para.apply_normal_subs(para.lines)
assert_equal 'The tiger (Panthera tigris) is the largest cat species.', output
assert_equal 1, para.document.references[:indexterms].size
assert_equal ['tiger'], para.document.references[:indexterms].first
end
test 'index term 2 macro with round bracket syntex should not interfer with index term macro with round bracket syntax' do
sentence = "The ((panthera tigris)) is the largest cat species.\n(((Big cats,Tigers)))"
para = block_from_string sentence
output = para.sub_macros(para.source)
assert_equal "The panthera tigris is the largest cat species.\n", output
terms = para.document.references[:indexterms]
assert_equal 2, terms.size
assert_equal ['panthera tigris'], terms[0]
assert_equal ['Big cats', 'Tigers'], terms[1]
end
context 'Button macro' do
test 'btn macro' do
para = block_from_string('btn:[Save]', :attributes => {'experimental' => ''})
assert_equal %q{Save}, para.sub_macros(para.source)
end
test 'btn macro for docbook backend' do
para = block_from_string('btn:[Save]', :backend => 'docbook', :attributes => {'experimental' => ''})
assert_equal %q{Save}, para.sub_macros(para.source)
end
end
context 'Keyboard macro' do
test 'kbd macro with single key' do
para = block_from_string('kbd:[F3]', :attributes => {'experimental' => ''})
assert_equal %q{F3}, para.sub_macros(para.source)
end
test 'kbd macro with single key, docbook backend' do
para = block_from_string('kbd:[F3]', :backend => 'docbook', :attributes => {'experimental' => ''})
assert_equal %q{F3}, para.sub_macros(para.source)
end
test 'kbd macro with key combination' do
para = block_from_string('kbd:[Ctrl+Shift+T]', :attributes => {'experimental' => ''})
assert_equal %q{Ctrl+Shift+T}, para.sub_macros(para.source)
end
test 'kbd macro with key combination with spaces' do
para = block_from_string('kbd:[Ctrl + Shift + T]', :attributes => {'experimental' => ''})
assert_equal %q{Ctrl+Shift+T}, para.sub_macros(para.source)
end
test 'kbd macro with key combination delimited by commas' do
para = block_from_string('kbd:[Ctrl,Shift,T]', :attributes => {'experimental' => ''})
assert_equal %q{Ctrl+Shift+T}, para.sub_macros(para.source)
end
test 'kbd macro with key combination containing a plus key no spaces' do
para = block_from_string('kbd:[Ctrl++]', :attributes => {'experimental' => ''})
assert_equal %q{Ctrl++}, para.sub_macros(para.source)
end
test 'kbd macro with key combination delimited by commands containing a comma key' do
para = block_from_string('kbd:[Ctrl,,]', :attributes => {'experimental' => ''})
assert_equal %q{Ctrl+,}, para.sub_macros(para.source)
end
test 'kbd macro with key combination containing a plus key with spaces' do
para = block_from_string('kbd:[Ctrl + +]', :attributes => {'experimental' => ''})
assert_equal %q{Ctrl++}, para.sub_macros(para.source)
end
test 'kbd macro with key combination containing escaped bracket' do
para = block_from_string('kbd:[Ctrl + \]]', :attributes => {'experimental' => ''})
assert_equal %q{Ctrl+]}, para.sub_macros(para.source)
end
test 'kbd macro with key combination, docbook backend' do
para = block_from_string('kbd:[Ctrl+Shift+T]', :backend => 'docbook', :attributes => {'experimental' => ''})
assert_equal %q{CtrlShiftT}, para.sub_macros(para.source)
end
end
context 'Menu macro' do
test 'should process menu using macro sytnax' do
para = block_from_string('menu:File[]', :attributes => {'experimental' => ''})
assert_equal %q{}, para.sub_macros(para.source)
end
test 'should process menu for docbook backend' do
para = block_from_string('menu:File[]', :backend => 'docbook', :attributes => {'experimental' => ''})
assert_equal %q{File}, para.sub_macros(para.source)
end
test 'should process menu with menu item using macro syntax' do
para = block_from_string('menu:File[Save As…]', :attributes => {'experimental' => ''})
assert_equal %q{}, para.sub_macros(para.source)
end
test 'should process menu with menu item for docbook backend' do
para = block_from_string('menu:File[Save As…]', :backend => 'docbook', :attributes => {'experimental' => ''})
assert_equal %q{File Save As…}, para.sub_macros(para.source)
end
test 'should process menu with menu item in submenu using macro syntax' do
para = block_from_string('menu:Tools[Project > Build]', :attributes => {'experimental' => ''})
assert_equal %q{}, para.sub_macros(para.source)
end
test 'should process menu with menu item in submenu for docbook backend' do
para = block_from_string('menu:Tools[Project > Build]', :backend => 'docbook', :attributes => {'experimental' => ''})
assert_equal %q{Tools Project Build}, para.sub_macros(para.source)
end
test 'should process menu with menu item in submenu using macro syntax and comma delimiter' do
para = block_from_string('menu:Tools[Project, Build]', :attributes => {'experimental' => ''})
assert_equal %q{}, para.sub_macros(para.source)
end
test 'should process menu with menu item using inline syntax' do
para = block_from_string('"File > Save As…"', :attributes => {'experimental' => ''})
assert_equal %q{}, para.sub_macros(para.source)
end
test 'should process menu with menu item in submenu using inline syntax' do
para = block_from_string('"Tools > Project > Build"', :attributes => {'experimental' => ''})
assert_equal %q{}, para.sub_macros(para.source)
end
test 'inline syntax should not closing quote of XML attribute' do
para = block_from_string('<node>r', :attributes => {'experimental' => ''})
assert_equal %q{<node>r}, para.sub_macros(para.source)
end
test 'should process menu macro with items containing multibyte characters' do
para = block_from_string('menu:视图[放大, 重置]', :attributes => {'experimental' => ''})
assert_equal %q{}, para.sub_macros(para.source)
end if ::RUBY_MIN_VERSION_1_9
test 'should process inline menu with items containing multibyte characters' do
para = block_from_string('"视图 > 放大 > 重置"', :attributes => {'experimental' => ''})
assert_equal %q{}, para.sub_macros(para.source)
end if ::RUBY_MIN_VERSION_1_9
end
end
context 'Passthroughs' do
test 'collect inline triple plus passthroughs' do
para = block_from_string('+++inline code
+++')
result = para.extract_passthroughs(para.source)
assert_equal Asciidoctor::Substitutors::PASS_START + '0' + Asciidoctor::Substitutors::PASS_END, result
assert_equal 1, para.passthroughs.size
assert_equal 'inline code
', para.passthroughs[0][:text]
assert para.passthroughs[0][:subs].empty?
end
test 'collect multi-line inline triple plus passthroughs' do
para = block_from_string("+++inline\ncode
+++")
result = para.extract_passthroughs(para.source)
assert_equal Asciidoctor::Substitutors::PASS_START + '0' + Asciidoctor::Substitutors::PASS_END, result
assert_equal 1, para.passthroughs.size
assert_equal "inline\ncode
", para.passthroughs[0][:text]
assert para.passthroughs[0][:subs].empty?
end
test 'collect inline double dollar passthroughs' do
para = block_from_string('$${code}
$$')
result = para.extract_passthroughs(para.source)
assert_equal Asciidoctor::Substitutors::PASS_START + '0' + Asciidoctor::Substitutors::PASS_END, result
assert_equal 1, para.passthroughs.size
assert_equal '{code}
', para.passthroughs[0][:text]
assert_equal [:specialcharacters], para.passthroughs[0][:subs]
end
test 'collect inline double plus passthroughs' do
para = block_from_string('++{code}
++')
result = para.extract_passthroughs(para.source)
assert_equal Asciidoctor::Substitutors::PASS_START + '0' + Asciidoctor::Substitutors::PASS_END, result
assert_equal 1, para.passthroughs.size
assert_equal '{code}
', para.passthroughs[0][:text]
assert_equal [:specialcharacters], para.passthroughs[0][:subs]
end
test 'collect multi-line inline double dollar passthroughs' do
para = block_from_string("$$\n{code}\n
$$")
result = para.extract_passthroughs(para.source)
assert_equal Asciidoctor::Substitutors::PASS_START + '0' + Asciidoctor::Substitutors::PASS_END, result
assert_equal 1, para.passthroughs.size
assert_equal "\n{code}\n
", para.passthroughs[0][:text]
assert_equal [:specialcharacters], para.passthroughs[0][:subs]
end
test 'collect multi-line inline double plus passthroughs' do
para = block_from_string("++\n{code}\n
++")
result = para.extract_passthroughs(para.source)
assert_equal Asciidoctor::Substitutors::PASS_START + '0' + Asciidoctor::Substitutors::PASS_END, result
assert_equal 1, para.passthroughs.size
assert_equal "\n{code}\n
", para.passthroughs[0][:text]
assert_equal [:specialcharacters], para.passthroughs[0][:subs]
end
test 'collect passthroughs from inline pass macro' do
para = block_from_string(%Q{pass:specialcharacters,quotes[['code'\\]
]})
result = para.extract_passthroughs(para.source)
assert_equal Asciidoctor::Substitutors::PASS_START + '0' + Asciidoctor::Substitutors::PASS_END, result
assert_equal 1, para.passthroughs.size
assert_equal %q{['code']
}, para.passthroughs[0][:text]
assert_equal [:specialcharacters, :quotes], para.passthroughs[0][:subs]
end
test 'collect multi-line passthroughs from inline pass macro' do
para = block_from_string(%Q{pass:specialcharacters,quotes[['more\ncode'\\]
]})
result = para.extract_passthroughs(para.source)
assert_equal Asciidoctor::Substitutors::PASS_START + '0' + Asciidoctor::Substitutors::PASS_END, result
assert_equal 1, para.passthroughs.size
assert_equal %Q{['more\ncode']
}, para.passthroughs[0][:text]
assert_equal [:specialcharacters, :quotes], para.passthroughs[0][:subs]
end
test 'resolves sub shorthands on inline pass macro' do
para = block_from_string 'pass:q,a[*<{backend}>*]'
result = para.extract_passthroughs para.source
assert_equal 1, para.passthroughs.size
assert_equal [:quotes, :attributes], para.passthroughs[0][:subs]
result = para.restore_passthroughs result
assert_equal '', result
end
# NOTE placeholder is surrounded by text to prevent reader from stripping trailing boundary char (unique to test scenario)
test 'restore inline passthroughs without subs' do
para = block_from_string("some #{Asciidoctor::Substitutors::PASS_START}" + '0' + "#{Asciidoctor::Substitutors::PASS_END} to study")
para.passthroughs[0] = {:text => 'inline code
', :subs => []}
result = para.restore_passthroughs(para.source)
assert_equal "some inline code
to study", result
end
# NOTE placeholder is surrounded by text to prevent reader from stripping trailing boundary char (unique to test scenario)
test 'restore inline passthroughs with subs' do
para = block_from_string("some #{Asciidoctor::Substitutors::PASS_START}" + '0' + "#{Asciidoctor::Substitutors::PASS_END} to study in the #{Asciidoctor::Substitutors::PASS_START}" + '1' + "#{Asciidoctor::Substitutors::PASS_END} programming language")
para.passthroughs[0] = {:text => '{code}
', :subs => [:specialcharacters]}
para.passthroughs[1] = {:text => '{language}', :subs => [:specialcharacters]}
result = para.restore_passthroughs(para.source)
assert_equal 'some <code>{code}</code> to study in the {language} programming language', result
end
test 'should restore nested passthroughs' do
result = render_embedded_string %q(+Sometimes you feel pass:q[`mono`].+ Sometimes you +$$don't$$+.), :doctype => :inline
assert_equal %q(Sometimes you feel mono
. Sometimes you don't.), result
end
test 'should honor role on double plus passthrough' do
result = render_embedded_string 'Print the version using [var]++{asciidoctor-version}++.', :doctype => :inline
assert_equal 'Print the version using {asciidoctor-version}.', result
end
test 'complex inline passthrough macro' do
text_to_escape = %q{[(] <'basic form'> <'logical operator'> <'basic form'> [)]}
para = block_from_string %($$#{text_to_escape}$$)
result = para.extract_passthroughs(para.source)
assert_equal 1, para.passthroughs.size
assert_equal text_to_escape, para.passthroughs[0][:text]
text_to_escape_escaped = %q{[(\] <'basic form'> <'logical operator'> <'basic form'> [)\]}
para = block_from_string %(pass:specialcharacters[#{text_to_escape_escaped}])
result = para.extract_passthroughs(para.source)
assert_equal 1, para.passthroughs.size
assert_equal text_to_escape, para.passthroughs[0][:text]
end
test 'inline pass macro with a composite sub' do
para = block_from_string %(pass:verbatim[<{backend}>])
assert_equal '<{backend}>', para.content
end
context 'Math macros' do
test 'should passthrough text in asciimath macro and surround with AsciiMath delimiters' do
input = 'asciimath:[x/x={(1,if x!=0),(text{undefined},if x=0):}]'
para = block_from_string input
assert_equal '\$x/x={(1,if x!=0),(text{undefined},if x=0):}\$', para.content
end
test 'should not recognize asciimath macro with no content' do
input = 'asciimath:[]'
para = block_from_string input
assert_equal 'asciimath:[]', para.content
end
test 'should perform specialcharacters subs on asciimath macro content in html backend by default' do
input = 'asciimath:[a < b]'
para = block_from_string input
assert_equal '\$a < b\$', para.content
end
test 'should not perform specialcharacters subs on asciimath macro content in docbook backend by default' do
input = 'asciimath:[a < b]'
para = block_from_string input, :backend => :docbook
assert_equal 'a < b', para.content
end
test 'should honor explicit subslist on asciimath macro' do
input = 'asciimath:attributes[{expr}]'
para = block_from_string input, :attributes => {'expr' => 'x != 0'}
assert_equal '\$x != 0\$', para.content
end
test 'should passthrough text in latexmath macro and surround with LaTeX math delimiters' do
input = 'latexmath:[C = \alpha + \beta Y^{\gamma} + \epsilon]'
para = block_from_string input
assert_equal '\(C = \alpha + \beta Y^{\gamma} + \epsilon\)', para.content
end
test 'should not recognize latexmath macro with no content' do
input = 'latexmath:[]'
para = block_from_string input
assert_equal 'latexmath:[]', para.content
end
test 'should perform specialcharacters subs on latexmath macro in html backend by default' do
input = 'latexmath:[a < b]'
para = block_from_string input
assert_equal '\(a < b\)', para.content
end
test 'should not perform specialcharacters subs on latexmath macro content in docbook backend by default' do
input = 'latexmath:[a < b]'
para = block_from_string input, :backend => :docbook
assert para.content.include?('')
end
test 'should honor explicit subslist on latexmath macro' do
input = 'latexmath:attributes[{expr}]'
para = block_from_string input, :attributes => {'expr' => '\sqrt{4} = 2'}
assert_equal '\(\sqrt{4} = 2\)', para.content
end
test 'should passthrough math macro inside another passthrough' do
input = 'the text `asciimath:[x = y]` should be passed through as +literal+ text'
para = block_from_string input, :attributes => {'compat-mode' => ''}
assert_equal 'the text asciimath:[x = y]
should be passed through as literal
text', para.content
input = 'the text [x-]`asciimath:[x = y]` should be passed through as `literal` text'
para = block_from_string input
assert_equal 'the text asciimath:[x = y]
should be passed through as literal
text', para.content
input = 'the text `+asciimath:[x = y]+` should be passed through as `literal` text'
para = block_from_string input
assert_equal 'the text asciimath:[x = y]
should be passed through as literal
text', para.content
end
test 'should not recognize stem macro with no content' do
input = 'stem:[]'
para = block_from_string input
assert_equal input, para.content
end
test 'should passthrough text in stem macro and surround with AsciiMath delimiters if stem attribute != latexmath' do
[
{},
{'stem' => ''},
{'stem' => 'asciimath'}
].each do |attributes|
input = 'stem:[x/x={(1,if x!=0),(text{undefined},if x=0):}]'
para = block_from_string input, :attributes => attributes
assert_equal '\$x/x={(1,if x!=0),(text{undefined},if x=0):}\$', para.content
end
end
test 'should passthrough text in stem macro and surround with LaTeX math delimiters if stem attribute = latexmath' do
input = 'stem:[C = \alpha + \beta Y^{\gamma} + \epsilon]'
para = block_from_string input, :attributes => {'stem' => 'latexmath'}
assert_equal '\(C = \alpha + \beta Y^{\gamma} + \epsilon\)', para.content
end
test 'should find and replace placeholder duplicated by substitution' do
input = %q(+first passthrough+ followed by link:$$http://example.com/__u_no_format_me__$$[] with passthrough)
result = render_embedded_string input, :doctype => :inline
assert_equal 'first passthrough followed by http://example.com/__u_no_format_me__ with passthrough', result
end
end
end
context 'Replacements' do
test 'unescapes XML entities' do
para = block_from_string '< " " " >'
assert_equal '< " " " >', para.apply_normal_subs(para.lines)
end
test 'replaces arrows' do
para = block_from_string '<- -> <= => \<- \-> \<= \=>'
assert_equal '← → ⇐ ⇒ <- -> <= =>', para.apply_normal_subs(para.source)
end
test 'replaces dashes' do
para = block_from_string %(-- foo foo--bar foo\\--bar foo -- bar foo \\-- bar
stuff in between
-- foo
stuff in between
foo --
stuff in between
foo --)
expected = ' — foo foo—bar foo--bar foo — bar foo -- bar
stuff in between — foo
stuff in between
foo — stuff in between
foo — '
assert_equal expected, para.sub_replacements(para.source)
end
test 'replaces dashes between multibyte word characters' do
para = block_from_string %(富--巴)
expected = '富—巴'
assert_equal expected, para.sub_replacements(para.source)
end if ::RUBY_MIN_VERSION_1_9
test 'replaces marks' do
para = block_from_string '(C) (R) (TM) \(C) \(R) \(TM)'
assert_equal '© ® ™ (C) (R) (TM)', para.sub_replacements(para.source)
end
test 'preserves entity references' do
input = '& © ✔ •'
result = render_embedded_string input, :doctype => :inline
assert_equal input, result
end
test 'replaces punctuation' do
para = block_from_string %(John's Hideout is the Whites`' place... foo\\'bar)
assert_equal "John’s Hideout is the Whites’ place… foo'bar", para.sub_replacements(para.source)
end
test 'should replace right single quote marks' do
given = [
%(`'Twas the night),
%(a `'57 Chevy!),
%(the whites`' place),
%(the whites`'.),
%(the whites`'--where the wild things are),
%(the whites`'\nhave),
%(It's Mary`'s little lamb.),
%(consecutive single quotes '' are not modified),
%(he is 6' tall),
%(\\`')
]
expected = [
%(’Twas the night),
%(a ’57 Chevy!),
%(the whites’ place),
%(the whites’.),
%(the whites’--where the wild things are),
%(the whites’\nhave),
%(It’s Mary’s little lamb.),
%(consecutive single quotes '' are not modified),
%(he is 6' tall),
%(`')
]
given.size.times {|i|
para = block_from_string given[i]
assert_equal expected[i], para.sub_replacements(para.source)
}
end
end
context 'Post replacements' do
test 'line break inserted after line with line break character' do
para = block_from_string("First line +\nSecond line")
result = para.apply_subs(para.lines, :post_replacements, true)
assert_equal 'First line
', result.first
end
test 'line break inserted after line wrap with hardbreaks enabled' do
para = block_from_string("First line\nSecond line", :attributes => {'hardbreaks' => ''})
result = para.apply_subs(para.lines, :post_replacements, true)
assert_equal 'First line
', result.first
end
test 'line break character stripped from end of line with hardbreaks enabled' do
para = block_from_string("First line +\nSecond line", :attributes => {'hardbreaks' => ''})
result = para.apply_subs(para.lines, :post_replacements, true)
assert_equal 'First line
', result.first
end
test 'line break not inserted for single line with hardbreaks enabled' do
para = block_from_string('First line', :attributes => {'hardbreaks' => ''})
result = para.apply_subs(para.lines, :post_replacements, true)
assert_equal 'First line', result.first
end
end
context 'Resolve subs' do
test 'should resolve subs for block' do
block = Asciidoctor::Block.new(empty_document, :paragraph)
block.attributes['subs'] = 'quotes,normal'
block.lock_in_subs
assert_equal [:quotes, :specialcharacters, :attributes, :replacements, :macros, :post_replacements], block.subs
end
test 'should resolve specialcharacters sub as highlight for source block when source highlighter is coderay' do
doc = empty_document :attributes => {'source-highlighter' => 'coderay'}
block = Asciidoctor::Block.new(doc, :listing, :content_model => :verbatim)
block.style = 'source'
block.attributes['subs'] = 'specialcharacters'
block.attributes['language'] = 'ruby'
block.lock_in_subs
assert_equal [:highlight], block.subs
end
test 'should resolve specialcharacters sub as highlight for source block when source highlighter is pygments' do
doc = empty_document :attributes => {'source-highlighter' => 'pygments'}
block = Asciidoctor::Block.new(doc, :listing, :content_model => :verbatim)
block.style = 'source'
block.attributes['subs'] = 'specialcharacters'
block.attributes['language'] = 'ruby'
block.lock_in_subs
assert_equal [:highlight], block.subs
end
test 'should not resolve specialcharacters sub as highlight for source block when source highlighter is not set' do
doc = empty_document
block = Asciidoctor::Block.new(doc, :listing, :content_model => :verbatim)
block.style = 'source'
block.attributes['subs'] = 'specialcharacters'
block.attributes['language'] = 'ruby'
block.lock_in_subs
assert_equal [:specialcharacters], block.subs
end
test 'should not use subs if subs option passed to block constructor is nil' do
doc = empty_document
block = Asciidoctor::Block.new doc, :paragraph, :source => '*bold* _italic_', :subs => nil, :attributes => {'subs' => 'quotes'}
assert block.subs.empty?
block.lock_in_subs
assert block.subs.empty?
end
test 'should not use subs if subs option passed to block constructor is empty array' do
doc = empty_document
block = Asciidoctor::Block.new doc, :paragraph, :source => '*bold* _italic_', :subs => [], :attributes => {'subs' => 'quotes'}
assert block.subs.empty?
block.lock_in_subs
assert block.subs.empty?
end
test 'should use subs from subs option passed to block constructor' do
doc = empty_document
block = Asciidoctor::Block.new doc, :paragraph, :source => '*bold* _italic_', :subs => [:specialcharacters], :attributes => {'subs' => 'quotes'}
assert_equal [:specialcharacters], block.subs
block.lock_in_subs
assert_equal [:specialcharacters], block.subs
end
test 'should use subs from subs attribute if subs option is not passed to block constructor' do
doc = empty_document
block = Asciidoctor::Block.new doc, :paragraph, :source => '*bold* _italic_', :attributes => {'subs' => 'quotes'}
assert block.subs.empty?
# in this case, we have to call lock_in_subs to resolve the subs
block.lock_in_subs
assert_equal [:quotes], block.subs
end
test 'should use subs from subs attribute if subs option passed to block constructor is :default' do
doc = empty_document
block = Asciidoctor::Block.new doc, :paragraph, :source => '*bold* _italic_', :subs => :default, :attributes => {'subs' => 'quotes'}
assert_equal [:quotes], block.subs
block.lock_in_subs
assert_equal [:quotes], block.subs
end
test 'should use built-in subs if subs option passed to block constructor is :default and subs attribute is absent' do
doc = empty_document
block = Asciidoctor::Block.new doc, :paragraph, :source => '*bold* _italic_', :subs => :default
assert_equal [:specialcharacters, :quotes, :attributes, :replacements, :macros, :post_replacements], block.subs
block.lock_in_subs
assert_equal [:specialcharacters, :quotes, :attributes, :replacements, :macros, :post_replacements], block.subs
end
end
# TODO move to helpers_test.rb
context 'Helpers' do
test 'should URI encode non-word characters generally' do
given = ' /%&?\\'
expect = '%20%2F%25%26%3F%5C'
assert_equal expect, (Asciidoctor::Helpers.encode_uri given)
end
test 'should not URI select non-word characters' do
given = '-.!~*\';:@=+$,()[]'
expect = given
assert_equal expect, (Asciidoctor::Helpers.encode_uri given)
end
end
end