HTML
end
it 'looks like the docbook toc' do
expect(converted).to include(<<~HTML)
HTML
end
end
context 'when there is a level 0 section' do
let(:input) do
<<~ASCIIDOC
= Title
= Part 1
== Section 1
== Section 2
ASCIIDOC
end
context 'the table of contents' do
it 'looks like the docbook toc' do
expect(converted).to include(<<~HTML)
HTML
end
end
end
context 'when a section has role=exclude' do
let(:input) do
<<~ASCIIDOC
= Title
== Section 1
[.exclude]
== Section 2
ASCIIDOC
end
context 'the table of contents' do
it "doesn't include the excluded section" do
expect(converted).to include(<<~HTML)
HTML
end
end
end
context 'when a section has reftext' do
let(:convert_attributes) do
{
# Shrink the output slightly so it is easier to read
'stylesheet!' => false,
# Set some metadata that will be included in the header
'dc.type' => 'FooType',
'dc.subject' => 'BarSubject',
'dc.identifier' => 'BazIdentifier',
'toc' => '',
'toclevels' => 2,
}
end
shared_examples 'reftext' do
context 'the table of contents' do
it 'includes the abbreviated title' do
expect(converted).to include <<~HTML
S1
HTML
end
it 'includes the correct title for a subsection' do
expect(converted).to include <<~HTML
Section 2
HTML
end
end
context 'the body' do
it "doesn't include the titleabbrev tag" do
expect(converted).not_to include ''
end
it 'includes the unabbreviated title' do
expect(converted).to include 'Section 1'
end
it 'includes a link to the abbreviated section' do
expect(converted).to include <<~HTML.strip
S1
HTML
end
end
end
context 'using a pass block containing titleabbrev' do
let(:input) do
<<~ASCIIDOC
= Title
[[s1]]
== Section 1
++++
S1
++++
=== Section 2
<>
ASCIIDOC
end
include_examples 'reftext'
context 'when the titleabbrev contains an attribute' do
let(:input) do
<<~ASCIIDOC
= Title
:abbrev: S1
[[s1]]
== Section 1
++++
{abbrev}
++++
=== Section 2
<>
ASCIIDOC
end
include_examples 'reftext'
end
end
context 'using an attribute' do
let(:input) do
<<~ASCIIDOC
= Title
[id=s1,reftext=_S1_]
== Section 1
=== Section 2
<>
ASCIIDOC
end
include_examples 'reftext'
end
end
end
context 'when there is a subtitle' do
let(:input) do
<<~ASCIIDOC
= Title: Subtitle
Words.
ASCIIDOC
end
context 'the header' do
it 'includes the title and subtitle' do
expect(converted).to include(<<~HTML)
HTML
end
end
end
context 'when there is markup in the title' do
let(:input) do
<<~ASCIIDOC
= `foo`
Words.
ASCIIDOC
end
context 'the title' do
it 'only includes the text of the title' do
expect(converted).to include(<<~HTML)
foo | Elastic
HTML
end
end
context 'the header' do
it 'includes the title and subtitle' do
expect(converted).to include(<<~HTML)
HTML
end
end
end
context 'contains a navheader' do
# Emulates the chunker without trying to include it.
let(:input) do
<<~ASCIIDOC
= Title: Subtitle
[pass]
--
--
Words.
ASCIIDOC
end
context 'the navheader' do
it 'is moved above the "book" wrapper' do
expect(converted).to include(<<~HTML)
HTML
end
end
end
context 'contains a navfooer' do
# Emulates the chunker without trying to include it.
let(:input) do
<<~ASCIIDOC
= Title: Subtitle
[pass]
--
--
Words.
ASCIIDOC
end
context 'the navfooter' do
it 'is moved below the "book" wrapper' do
expect(converted).to include(<<~HTML)
HTML
end
end
end
context 'when there is a page-header' do
let(:convert_attributes) do
{
# Shrink the output slightly so it is easier to read
'stylesheet!' => false,
'page-header' => '',
}
end
let(:input) do
<<~ASCIIDOC
= Title
Words.
ASCIIDOC
end
context 'the header' do
it 'contains the page-header right after the body tag' do
expect(converted).not_to include <<~HTML
HTML
end
end
end
context 'when the head is disabled' do
let(:convert_attributes) do
{
# Shrink the output slightly so it is easier to read
'stylesheet!' => false,
# Set some metadata that will be included in the header
'dc.type' => 'FooType',
'dc.subject' => 'BarSubject',
'dc.identifier' => 'BazIdentifier',
# Turn off indexing
'noindex' => true,
}
end
let(:input) do
<<~ASCIIDOC
= Title
Words.
ASCIIDOC
end
context 'the head' do
it 'contains a directive to not follow or index the page' do
expect(converted).to include(
''
)
end
end
end
context 'when there is title-extra' do
let(:convert_attributes) do
{
# Shrink the output slightly so it is easier to read
'stylesheet!' => false,
# Set some metadata that will be included in the header
'dc.type' => 'FooType',
'dc.subject' => 'BarSubject',
'dc.identifier' => 'BazIdentifier',
'toc' => '',
'toclevels' => 1,
'title-extra' => ' [fooo]',
}
end
let(:input) do
<<~ASCIIDOC
= Title
== Section 1
== Section 2
ASCIIDOC
end
context 'the title' do
it 'includes Elastic' do
expect(converted).to include(<<~HTML)
Title [fooo] | Elastic
HTML
end
end
end
end
context 'sections' do
shared_examples 'section basics' do |wrapper_class, hlevel, id, title|
context 'the wrapper' do
it "has the '#{wrapper_class}' class" do
expect(converted).to include(<<~HTML.strip)
HTML
end
end
context 'the header' do
let(:xpack_tag) do
if (input.include? '.xpack') &&
(!input.include? ':hide-xpack-tags: true')
''
else
''
end
end
it "is wrapped in docbook's funny titlepage" do
level = hlevel < 2 ? 2 : hlevel
expect(converted).to include(<<~HTML)
HTML
end
end
end
context 'level 1' do
let(:input) do
<<~ASCIIDOC
== Section
ASCIIDOC
end
include_examples 'section basics', 'chapter', 1, '_section', 'Section'
context 'with the xpack role' do
let(:input) do
<<~ASCIIDOC
[.xpack]
== S1
ASCIIDOC
end
include_examples 'section basics', 'chapter xpack', 1, '_s1', 'S1'
context 'with the hide-xpack-tags attribute' do
let(:input) do
<<~ASCIIDOC
:hide-xpack-tags: true
[.xpack]
== Some XPack Feature
ASCIIDOC
end
# Because the block is marked with the `xpack` role, the surrounding
#
HTML
end
context 'paired with a callout list' do
let(:input) do
<<~ASCIIDOC
[source,sh]
----
cpanm Search::Elasticsearch <1>
----
<1> Foo
ASCIIDOC
end
context 'the listing' do
it 'includes the callout' do
expect(converted).to include <<~HTML.strip
cpanm Search::Elasticsearch
HTML
end
end
context 'the callout list' do
it 'is rendered like a docbook callout list' do
expect(converted).to include <<~HTML
HTML
end
end
context 'that has a role' do
let(:input) do
<<~ASCIIDOC
[source,sh]
----
cpanm Search::Elasticsearch <1>
----
[.foo]
<1> Foo
ASCIIDOC
end
context 'the callout list' do
it 'includes the role' do
expect(converted).to include ' will still have the "xpack" class. But the clickable icon
# should be hidden.
include_examples 'section basics', 'chapter xpack', 1,
'_some_xpack_feature', 'Some XPack Feature'
end
end
end
context 'level 2' do
let(:input) do
<<~ASCIIDOC
=== Section 2
ASCIIDOC
end
include_examples 'section basics', 'section', 2, '_section_2', 'Section 2'
context 'with the xpack role' do
let(:input) do
<<~ASCIIDOC
[.xpack]
=== S2
ASCIIDOC
end
include_examples 'section basics', 'section xpack', 2, '_s2', 'S2'
end
end
context 'level 3' do
let(:input) do
<<~ASCIIDOC
==== Section 3
ASCIIDOC
end
include_examples 'section basics', 'section', 3, '_section_3', 'Section 3'
context 'with the xpack role' do
let(:input) do
<<~ASCIIDOC
[.xpack]
==== S3
ASCIIDOC
end
include_examples 'section basics', 'section xpack', 3, '_s3', 'S3'
end
end
context 'level 0' do
let(:input) do
<<~ASCIIDOC
= Title
= Section
== L1
=== L2
ASCIIDOC
end
include_examples 'section basics', 'part', 1, '_section', 'Section'
it "bumps the h tag of it's children" do
expect(converted).to include 'L1'
end
it "doesn't bump the h tag of it's children's children" do
# Docbook doesn't seem to do this
expect(converted).to include 'L2'
end
context 'with the xpack role' do
let(:input) do
<<~ASCIIDOC
= Title
[.xpack]
= S1
== Chapter
ASCIIDOC
end
include_examples 'section basics', 'part xpack', 1, '_s1', 'S1'
end
end
context 'a preface' do
let(:input) do
<<~ASCIIDOC
[preface]
== Preface
Words.
ASCIIDOC
end
include_examples 'section basics', 'preface', 1, '_preface', 'Preface'
context 'with the xpack role' do
let(:input) do
<<~ASCIIDOC
[preface.xpack]
== P
ASCIIDOC
end
include_examples 'section basics', 'preface xpack', 1, '_p', 'P'
end
end
context 'an appendix' do
let(:input) do
<<~ASCIIDOC
[appendix]
== Foo
Words.
ASCIIDOC
end
include_examples 'section basics', 'appendix', 1, '_foo',
'Appendix A: Foo'
context 'with the xpack role' do
let(:input) do
<<~ASCIIDOC
[appendix.xpack]
== Foo
ASCIIDOC
end
include_examples 'section basics', 'appendix xpack', 1, '_foo',
'Appendix A: Foo'
end
context 'with level 0' do
let(:input) do
<<~ASCIIDOC
= Title
[appendix]
= Foo
== Bar
ASCIIDOC
end
include_examples 'section basics', 'appendix', 1, '_foo',
'Appendix A: Foo'
it "doesn't bump the h tags of sections within it" do
expect(converted).to include 'Bar'
end
end
end
end
context 'a paragraph' do
let(:input) do
<<~ASCIIDOC
= Title
== Section
Words words words.
ASCIIDOC
end
it "isn't wrapped in a paragraph div" do
expect(converted).not_to include('
')
end
it 'contains the words' do
expect(converted).to include('>.
[[foo]]
== Foo
ASCIIDOC
end
it 'has xref class' do
expect(converted).to include(' class="xref"')
end
it 'references the target' do
expect(converted).to include(' href="#foo"')
end
it "contains the target's title" do
expect(converted).to include(' title="Foo"')
end
it 'wraps the title in ' do
expect(converted).to include('>Foo')
end
context 'when the link text is overridden' do
let(:input) do
<<~ASCIIDOC
Words <>.
[[foo]]
== Foo
ASCIIDOC
end
it 'contains the overridden text' do
expect(converted).to include('>override text')
end
end
context 'when the section title has markup' do
let(:input) do
<<~ASCIIDOC
Words <>.
[[foo]]
== `foo`
ASCIIDOC
end
it "contains the target's title without the markup" do
expect(converted).to include('title="foo"')
end
end
context 'when the section title is empty' do
let(:input) do
<<~ASCIIDOC
Words <>.
[[foo]]
==
ASCIIDOC
end
it "doesn't contain a title at all" do
expect(converted).not_to include('title')
end
end
context 'to an inline anchor' do
let(:input) do
<<~ASCIIDOC
[[target]]`target`:: foo
<>
ASCIIDOC
end
it 'references the url' do
expect(converted).to include('href="#target"')
end
it 'has the right text' do
expect(converted).to include('>>
ASCIIDOC
end
it 'references the url' do
expect(converted).to include('href="#target"')
end
it 'has the right text' do
expect(converted).to include('>Section heading')
end
end
end
context 'to an appendix' do
let(:input) do
<<~ASCIIDOC
<>
[[target]]
[appendix]
== Foo
ASCIIDOC
end
it 'references the url' do
expect(converted).to include('href="#target"')
end
it 'has the right text' do
expect(converted).to include('>Appendix A, Foo')
end
end
end
context 'a floating title' do
let(:input) do
<<~ASCIIDOC
[float]
==== Foo
ASCIIDOC
end
it 'has the right h level' do
expect(converted).to include('')
end
it 'has an inline anchor for docbook compatibility' do
expect(converted).to include('')
end
context 'with the xpack role' do
let(:input) do
<<~ASCIIDOC
[float.xpack]
==== Foo
ASCIIDOC
end
it 'has the xpack class' do
expect(converted).to include '
HTML
end
end
end
context 'a listing block' do
let(:input) do
<<~ASCIIDOC
[source,sh]
----
cpanm Search::Elasticsearch
----
ASCIIDOC
end
it "is wrapped in docbook's funny wrapper" do
# It is important that there isn't any extra space around the Words words words.
') end context 'has an id' do let(:input) do <<~ASCIIDOC [[foo]] Words. ASCIIDOC end it 'contains the id' do expect(converted).to include '' end end context 'with a title' do let(:input) do <<~ASCIIDOC .Title Words. ASCIIDOC end it 'contains the title' do expect(converted).to include 'TitleWords.
' end end context 'with a role' do let(:input) do <<~ASCIIDOC [.screenshot] image:foo[] ASCIIDOC end it 'has the role as a class' do expect(converted).to include <<~HTMLtarget')
end
context 'when that inline anchor has empty text' do
let(:input) do
<<~ASCIIDOC
== Section heading
Words.
[[target]]
more words.
<')
end
it 'has an inline anchor for docbook compatibility' do
expect(converted).to include('')
end
context 'with the xpack role' do
let(:input) do
<<~ASCIIDOC
[float.xpack]
==== Foo
ASCIIDOC
end
it 'has the xpack class' do
expect(converted).to include ''
end
it 'has the xpack tag' do
expect(converted).to include(
'
'
)
end
end
context 'with the xpack bug is declared inline' do
let(:input) do
<<~ASCIIDOC
[float]
==== [xpack]#Foo#
ASCIIDOC
end
it 'has the xpack tag' do
expect(converted).to include <<~HTML
Foo
tags
expect(converted).to include(<<~HTML)
cpanm Search::Elasticsearch
HTML
end
it "isn't followed by an extra blank line" do
expect(converted).to include(<<~HTML)
'
end
end
end
context 'that has duplicates' do
let(:input) do
<<~ASCIIDOC
[source,sh]
----
foo <1>
bar <1>
baz <2>
----
<1> Foo
<2> Baz
ASCIIDOC
end
context 'the duplicated callouts in the listing' do
it 'have the same data-value' do
expect(converted).to include <<~HTML
foo
bar
HTML
end
end
context 'the unique callout in the listing' do
it 'has a number that counts up from the previously shown number' do
expect(converted).to include <<~HTML
baz
HTML
end
end
context 'the duplicated callouts in the callout list' do
it 'only contains a single number' do
expect(converted).to include <<~HTML
HTML
end
end
context 'the unique callout in the callout list' do
it 'has a number that counts up from the previously shown number' do
expect(converted).to include <<~HTML
HTML
end
end
end
end
context 'with a title' do
let(:input) do
<<~ASCIIDOC
.Title
[source,sh]
----
cpanm Search::Elasticsearch
----
ASCIIDOC
end
it "the title is before in docbook's funny wrapper" do
expect(converted).to include(<<~HTML)
Title.
HTML
end
context 'that ends in a :' do
let(:input) do
<<~ASCIIDOC
.Title:
[source,sh]
----
cpanm Search::Elasticsearch
----
ASCIIDOC
end
it "the title is before in docbook's funny wrapper" do
expect(converted).to include(<<~HTML)
Title:
HTML
end
end
end
context 'with an id' do
let(:input) do
<<~ASCIIDOC
[source,sh,id=foo]
----
cpanm Search::Elasticsearch
----
ASCIIDOC
end
it "the title is before in docbook's funny wrapper" do
expect(converted).to include(<<~HTML)
HTML
end
end
context 'with an id and a title' do
let(:input) do
<<~ASCIIDOC
.Title
[source,sh,id=foo]
----
cpanm Search::Elasticsearch
----
ASCIIDOC
end
it "the title is before in docbook's funny wrapper" do
expect(converted).to include(<<~HTML)
HTML
end
end
context 'with a role' do
let(:input) do
<<~ASCIIDOC
[source,sh,role=foo]
----
cpanm Search::Elasticsearch
----
ASCIIDOC
end
it 'the role is included as a class' do
expect(converted).to include(<<~HTML)
HTML
end
end
context "when the listing doesn't have a language" do
let(:input) do
<<~ASCIIDOC
----
cpanm Search::Elasticsearch
----
ASCIIDOC
end
it "is wrapped in docbook's funny wrapper" do
# It is important that there isn't any extra space around the
HTML
end
context 'with a title' do
let(:input) do
<<~ASCIIDOC
.Title
----
cpanm Search::Elasticsearch
----
ASCIIDOC
end
it "the title is before in docbook's funny wrapper" do
expect(converted).to include(<<~HTML)
cpanm Search::Elasticsearch
tags
expect(converted).to include(<<~HTML)
cpanm Search::Elasticsearch
HTML
end
it "isn't followed by an extra blank line" do
expect(converted).to include(<<~HTML)
Title.
cpanm Search::ElasticsearchHTML end end end end context 'an unordered list' do let(:input) do <<~ASCIIDOC * Thing * Other thing * Third thing ASCIIDOC end it 'is wrapped an itemizedlist div' do expect(converted).to include('
')
end
it 'has the itemizedlist class' do
expect(converted).to include('
-
Thing
HTML
end
end
context 'the second item' do
it 'has the listitem class' do
expect(converted).to include(<<~HTML)
- Other thing HTML end end context 'the third item' do it 'has the listitem class' do expect(converted).to include(<<~HTML)
- Third thing HTML end end context 'when there is a title' do let(:input) do <<~ASCIIDOC .Title * Thing ASCIIDOC end context 'the title' do it 'is wrapped a strong' do expect(converted).to include <<~HTML
- ❏ Thing
- ✓ Thing
- Thing
- Thing
- Other thing HTML end end context 'the third item' do it 'has the listitem class' do expect(converted).to include(<<~HTML)
- Third thing HTML end end context 'when there is a title' do let(:input) do <<~ASCIIDOC .Title . Thing ASCIIDOC end context 'the title' do it 'is wrapped a strong' do expect(converted).to include <<~HTML
-
Foo
HTML end it 'includes the complex content' do expect(converted).to include(<<~HTML)Complex
HTML
end
end
context 'second level' do
let(:input) do
<<~ASCIIDOC
. L1
.. L2
.. Thing 2
ASCIIDOC
end
it 'the outer list is wrapped an orderedlist div' do
expect(converted).to include <<~HTML
- Foo
- The foo. HTML end it 'contains the second item' do expect(converted).to include <<~HTML
- Bar
- The bar. HTML end end context 'without a descrition' do let(:input) do <<~ASCIIDOC Foo:: ASCIIDOC end it "doesn't have a dd" do expect(converted).not_to include '
- ' end end context 'with complex content' do let(:input) do <<~ASCIIDOC Foo:: + -- Lots of content. In many paragraphs. -- ASCIIDOC end it 'contains complex content' do expect(converted).to include <<~HTML
- Foo
-
Lots of content.
In many paragraphs.
HTML
end
end
context 'when the anchor is on the previous line' do
let(:input) do
<<~ASCIIDOC
[[bar]]
Bar:: The bar.
ASCIIDOC
end
it 'the id preceeds dl' do
expect(converted).to include <<~HTML
Title
HTML end end end context 'when it is a TODO list' do context "when it isn't done" do let(:input) do <<~ASCIIDOC * [ ] Thing ASCIIDOC end it 'includes to empty check box' do expect(converted).to include <<~HTML')
end
it 'has the itemizedlist class' do
expect(converted).to include('
-
Thing
HTML
end
end
context 'the second item' do
it 'has the listitem class' do
expect(converted).to include(<<~HTML)
Title
HTML end end end context 'when the list if defined with 1.' do let(:input) do <<~ASCIIDOC 1. Thing ASCIIDOC end it 'is wrapped an orderedlist div' do expect(converted).to include('')
end
it 'has the itemizedlist class' do
expect(converted).to include('
-
Thing
HTML
end
end
end
context 'with complex contents' do
let(:input) do
<<~ASCIIDOC
. Foo
+
--
Complex
--
ASCIIDOC
end
it 'wraps the text in a
' do expect(converted).to include(<<~HTML)
-
HTML
end
it 'the inner list is wrapped an orderedlist div' do
expect(converted).to include <<~HTML
L1
-
HTML
end
end
end
context 'a description list' do
context 'basic' do
let(:input) do
<<~ASCIIDOC
Foo:: The foo.
[[bar]] Bar:: The bar.
ASCIIDOC
end
it 'is wrapped like docbook' do
expect(converted).to include <<~HTML
-
HTML
expect(converted).to include <<~HTML
-
HTML
end
end
context 'horizontally styled' do
let(:input) do
<<~ASCIIDOC
[horizontal]
Foo:: The foo.
Bar:: The bar.
ASCIIDOC
end
it 'is rendered like a table' do
expect(converted).to include <<~HTML
Foo
The foo.
Bar
The bar.
Table 1. Title
HTML
end
it 'has the title as the summary' do
expect(converted).to include <<~HTML