# frozen_string_literal: true require_relative '../../test/dsl/file_context' require_relative '../../test/matcher/file_exist' require 'chunker/extension' require 'docbook_compat/extension' require 'fileutils' require 'tmpdir' RSpec.describe Chunker do before(:each) do Asciidoctor::Extensions.register Chunker end after(:each) do Asciidoctor::Extensions.unregister_all end include_context 'convert without logs' let(:standalone) { true } let(:home_title) { 'Title' } let(:prev_title) { prev_page == 'index' ? 'Title' : prev_page.upcase } let(:next_title) { next_page.upcase } let(:prev_link_title) { prev_title } let(:next_link_title) { next_title } shared_examples 'standard page' do |prev_arg, next_arg| let(:prev_page) { prev_arg } let(:next_page) { next_arg } context 'the ' do it 'contains the charset' do expect(contents).to include(<<~HTML) HTML end it 'contains the home link' do expect(contents).to include(<<~HTML) HTML end if prev_arg it 'contains the prev link' do expect(contents).to include(<<~HTML) HTML end else it "doesn't contain the prev link" do expect(contents).not_to include('rel="prev"') end end if next_arg it 'contains the next link' do expect(contents).to include(<<~HTML) HTML end else it "doesn't contain the next link" do expect(contents).not_to include('rel="next"') end end it "doesn't contain the builtin asciidoctor stylesheet" do # We turned the stylesheet off expect(contents).not_to include('' do it 'contains the navheader' do expect(contents).to include('
') end it 'contains the navfooter' do expect(contents).to include('
') end if prev_arg && prev_arg != 'index' it 'contains the prev nav' do expect(contents).to include(<<~HTML) « #{prev_title} HTML end else it 'contains an empty prev nav' do expect(contents).to include(<<~HTML) HTML end end if next_arg it 'contains the next nav' do expect(contents).to include(<<~HTML) #{next_title} » HTML end else it 'contains an empty next nav' do expect(contents).to include(<<~HTML) HTML end end end end shared_examples 'subpage' do it "doesn't contain the main title" do expect(contents).not_to include('

Title

') end end context 'when outdir is configured' do let(:outdir) { Dir.mktmpdir } after(:example) { FileUtils.remove_entry outdir } ## # Build a path to a file in the destination directory. # Needed by file_context. def dest_file(file) converted File.join outdir, file end context 'when chunk level is 1' do let(:convert_attributes) do { 'outdir' => outdir, 'chunk_level' => 1, # Shrink the output slightly so it is easier to read 'stylesheet!' => false, # We always enable the toc for multi-page books 'toc' => '', } end context 'there are two level 1 sections' do let(:input) do <<~ASCIIDOC = Title [[s1]] == Section "1" [[linkme]] Words words.footnote:[foo] <> [[s2]] == Section `2` Words again. <> <> footnote:[bar] ASCIIDOC end context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 's1' let(:next_title) { 'Section "1"' } let(:next_link_title) { 'Section "1"' } it 'contains a link to the first section' do expect(converted).to include(<<~HTML.strip)
  • Section "1"
    • HTML end it 'contains a link to the second section' do expect(converted).to include(<<~HTML.strip)
  • Section 2
    • HTML end it "doesn't contain breadcrumbs" do expect(converted).not_to include('
    ') end it "doesn't contain any footnotes" do expect(converted).not_to include('
    ') end end file_context 'the first section', 's1.html' do include_examples 'standard page', 'index', 's2' let(:next_title) { 'Section 2' } let(:next_link_title) { 'Section 2' } include_examples 'subpage' it 'contains the correct title' do expect(contents).to include('Section "1" | Title') end it 'contains the heading' do expect(contents).to include('

    Section "1"

    ') end it 'contains the contents' do expect(contents).to include <<~HTML

    Words words.[1]

    HTML end it 'contains a link to the second section' do expect(contents).to include( 'Section 2' ) end it 'contains the footnote' do expect(contents).to include <<~HTML
    [1] foo
    HTML end end file_context 'the second section', 's2.html' do include_examples 'standard page', 's1', nil let(:prev_title) { 'Section "1"' } let(:prev_link_title) { 'Section "1"' } include_examples 'subpage' it 'contains the correct title' do expect(contents).to include('Section 2 | Title') end it 'contains the heading' do expect(contents).to include( '

    Section 2

    ' ) end it 'contains the contents' do expect(contents).to include '

    Words again.

    ' end it 'contains a link to an element in the first section' do expect(contents).to include( 'override text' ) end it 'contains a link to the first section with override text' do expect(contents).to include('override text') end it 'contains the footnote' do expect(contents).to include <<~HTML
    [2] bar
    HTML end end context 'breadcrumbs' do before(:each) do # We need docbook compat to verify breadcrumbs # We unregister_all first because the order that we # register the plugins matters. Asciidoctor::Extensions.unregister_all Asciidoctor::Extensions.register DocbookCompat Asciidoctor::Extensions.register Chunker end file_context 'the first section', 's1.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title
    HTML end end file_context 'the second section', 's2.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title
    HTML end end end end context 'there is a level 2 section' do let(:input) do <<~ASCIIDOC = Title [[l1]] == Level 1 Words words. [[l2]] === Level 2 Words again. ASCIIDOC end context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 'l1' let(:next_title) { 'Level 1' } it 'contains a link to the level 1 section' do expect(converted).to include(<<~HTML.strip)
  • Level 1
    • HTML end it "doesn't contain a link to the level 2 section" do expect(converted).not_to include(<<~HTML.strip) HTML end end file_context 'the level one section', 'l1.html' do include_examples 'standard page', 'index', nil include_examples 'subpage' it 'contains the header of the level 1 section' do expect(contents).to include('

    Level 1

    ') end it 'contains first paragraph' do expect(contents).to include('

    Words words.

    ') end it 'contains the header of the level 2 section' do expect(contents).to include('

    Level 2

    ') end it 'contains the contents of the level 2 section' do expect(contents).to include('

    Words again.

    ') end it "doesn't contain a link to the level 2 section" do expect(converted).not_to include(<<~HTML.strip)     HTML end end it 'there is no file named for the level 2 section' do expect(File.join(outdir, 'l2.html')).not_to file_exist end end context 'there is a level 0 section' do let(:input) do <<~ASCIIDOC = Title [[l0]] = L0 Words words. [[l1]] == L1 Words again. ASCIIDOC end context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 'l0' it 'contains a link to the level 0 section' do expect(converted).to include(<<~HTML.strip)
  • L0 HTML end it 'contains a link to the level 1 section' do expect(converted).to include(<<~HTML.strip)
  • L1
    • HTML end end file_context 'the level 0 section', 'l0.html' do include_examples 'standard page', 'index', 'l1' include_examples 'subpage' it 'contains the header of the level 0 section' do expect(contents).to include('

    L0

    ') end it 'contains the contents' do expect(contents).to include('Words words.') end end file_context 'the level 1 section', 'l1.html' do include_examples 'standard page', 'l0', nil include_examples 'subpage' it 'contains the header of the level 1 section' do expect(contents).to include('

    L1

    ') end it 'contains contents' do expect(contents).to include('

    Words again.

    ') end end end context 'when there is title-extra' do let(:convert_attributes) do { 'outdir' => outdir, 'chunk_level' => 1, # Shrink the output slightly so it is easier to read 'stylesheet!' => false, # We always enable the toc for multi-page books 'toc' => '', 'title-extra' => ' [fooo]', } end let(:input) do <<~ASCIIDOC = Title [[s1]] == S1 ASCIIDOC end let(:home_title) { 'Title [fooo]' } context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 's1' it 'contains the correct title' do expect(contents).to include('Title') end end file_context 'the section', 's1.html' do include_examples 'standard page', 'index', nil let(:prev_title) { 'Title [fooo]' } include_examples 'subpage' end context 'breadcrumbs' do before(:each) do # We need docbook compat to verify breadcrumbs # We unregister_all first because the order that we # register the plugins matters. Asciidoctor::Extensions.unregister_all Asciidoctor::Extensions.register DocbookCompat Asciidoctor::Extensions.register Chunker end file_context 'the section', 's1.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title [fooo]
    HTML end end end end context 'there are many spaces in the title' do let(:input) do <<~ASCIIDOC = Title With Spaces [[s]] == S Words. ASCIIDOC end let(:home_title) { 'Title With Spaces' } context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 's' end file_context 'the section', 's.html' do include_examples 'standard page', 'index', nil let(:prev_title) { 'Title With Spaces' } include_examples 'subpage' end end context 'there is html in a section title' do let(:input) do <<~ASCIIDOC = Title [[s]] == Section `foo` Words. ASCIIDOC end context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 's' let(:next_title) { 'Section foo' } let(:next_link_title) { 'Section foo' } it 'contains a link to the section' do expect(converted).to include(<<~HTML.strip)
  • Section foo
    • HTML end end file_context 'the section', 's.html' do include_examples 'standard page', 'index', nil include_examples 'subpage' it 'contains the heading' do expect(contents).to include( '

    Section foo

    ' ) end end end context 'there is a subtitle on a section' do before(:each) do # We need docbook compat to verify that we disabled the # title separator. We unregister_all first because the order that we # register the plugins matters. Asciidoctor::Extensions.unregister_all Asciidoctor::Extensions.register DocbookCompat Asciidoctor::Extensions.register Chunker end let(:input) do <<~ASCIIDOC = Title [[s]] == Section: With subtitle Words. ASCIIDOC end context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 's' let(:next_title) { 'Section: With subtitle' } it 'contains a link to the section' do expect(converted).to include(<<~HTML.strip)
  • Section: With subtitle
    • HTML end end file_context 'the section', 's.html' do include_examples 'standard page', 'index', nil include_examples 'subpage' it 'contains the correct title' do expect(contents).to include(<<~HTML.strip) Section: With subtitle | Title | Elastic HTML end it 'contains the heading' do expect(contents).to include( '

    Section: With subtitle

    ' ) end it 'contains the contents' do expect(contents).to include <<~HTML

    Words.

    HTML end it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title
    HTML end end end context 'the section has a canonical link' do let(:input) do <<~ASCIIDOC = Title [id="otd",canonical-url="bazbar"] == Outdated [[current]] == Current Words. ASCIIDOC end file_context 'first subpage', 'otd.html' do let(:next_title) { 'Current' } include_examples 'standard page', 'index', 'current' it 'contains a header tag' do expect(contents).to include <<~HTML HTML end end file_context 'second subpage', 'current.html' do let(:prev_title) { 'Outdated' } include_examples 'standard page', 'otd', nil it 'does not contains a canonical header tag' do expect(contents).not_to include 'canonical' expect(contents).not_to include 'bazbar' end end end end context 'when chunk level is 2' do let(:convert_attributes) do { 'outdir' => outdir, 'chunk_level' => 2, # Shrink the output slightly so it is easier to read 'stylesheet!' => false, # We always enable the toc for multi-page books 'toc' => '', } end context 'there are a few sections' do let(:input) do <<~ASCIIDOC = Title [[s1]] == S1 <> [[s1_1]] === S1_1 [[s2]] == S2 [[s2_1]] === S2_1 [[s2_1_1]] ==== S2_1_1 [[s2_2]] === S2_2 ASCIIDOC end context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 's1' it 'contains a link to the level 1 sections' do expect(converted).to include(<<~HTML.strip)
  • S1 HTML expect(converted).to include(<<~HTML.strip)
  • S2 HTML end it 'contains a link to the level 2 sections' do expect(converted).to include(<<~HTML.strip)
  • S1_1
    • HTML expect(converted).to include(<<~HTML.strip)
  • S2_1
    • HTML expect(converted).to include(<<~HTML.strip)
  • S2_2
    • HTML end it "doesn't contain a link to the level 3 section" do expect(converted).not_to include('S2_1_1') end end file_context 'the first level 1 section', 's1.html' do include_examples 'standard page', 'index', 's1_1' include_examples 'subpage' it 'contains the heading' do expect(contents).to include('

    S1

    ') end it 'contains a link to the level 3 section' do expect(contents).to include('S2_1_1') end end file_context 'the first level 2 section', 's1_1.html' do include_examples 'standard page', 's1', 's2' include_examples 'subpage' it 'contains the heading' do expect(contents).to include('

    S1_1

    ') end end file_context 'the second level 1 section', 's2.html' do include_examples 'standard page', 's1_1', 's2_1' include_examples 'subpage' it 'contains the heading' do expect(contents).to include('

    S2

    ') end end file_context 'the second level 2 section', 's2_1.html' do include_examples 'standard page', 's2', 's2_2' include_examples 'subpage' it 'contains the heading' do expect(contents).to include('

    S2_1

    ') end it 'contains the level 3 section' do expect(contents).to include('

    S2_1_1

    ') end end file_context 'the last level 2 section', 's2_2.html' do include_examples 'standard page', 's2_1', nil include_examples 'subpage' it 'contains the heading' do expect(contents).to include('

    S2_2

    ') end end context 'breadcrumbs' do before(:each) do # We need docbook compat to verify breadcrumbs # We unregister_all first because the order that we # register the plugins matters. Asciidoctor::Extensions.unregister_all Asciidoctor::Extensions.register DocbookCompat Asciidoctor::Extensions.register Chunker end file_context 'the first level 1 section', 's1.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title
    HTML end file_context 'the first level 2 section', 's1_1.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title ›S1
    HTML end end file_context 'the second level 1 section', 's2.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title
    HTML end end file_context 'the second level 2 section', 's2_1.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title ›S2
    HTML end end file_context 'the last level 2 section', 's2_2.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title ›S2
    HTML end end end end end context 'there is an appendix' do let(:input) do <<~ASCIIDOC = Title [[s1]] == S1 [appendix,id=app] == Foo [[app_1]] === Foo 1 [[app_2]] === Foo 2 ASCIIDOC end context 'the main output' do let(:contents) { converted } include_examples 'standard page', nil, 's1' it 'contains a link to the level 1 sections' do expect(converted).to include(<<~HTML.strip)
  • S1 HTML expect(converted).to include(<<~HTML.strip)
  • Appendix A: Foo HTML end it 'contains a link to the level 2 sections' do expect(converted).to include(<<~HTML.strip)
  • Foo 1
    • HTML expect(converted).to include(<<~HTML.strip)
  • Foo 2
    • HTML end end file_context 'the section', 's1.html' do include_examples 'standard page', 'index', 'app' let(:next_title) { 'Appendix A: Foo' } include_examples 'subpage' end file_context 'the appendix', 'app.html' do include_examples 'standard page', 's1', 'app_1' let(:next_title) { 'Foo 1' } include_examples 'subpage' it 'contains the correct title' do expect(contents).to include( 'Appendix A: Foo | Title' ) end it 'contains the heading' do expect(contents).to include('

    Appendix A: Foo

    ') end end file_context 'the first page in the appendix', 'app_1.html' do include_examples 'standard page', 'app', 'app_2' let(:prev_title) { 'Appendix A: Foo' } let(:next_title) { 'Foo 2' } include_examples 'subpage' it 'contains the heading' do expect(contents).to include('

    Foo 1

    ') end end file_context 'the first page in the appendix', 'app_2.html' do include_examples 'standard page', 'app_1', nil let(:prev_title) { 'Foo 1' } include_examples 'subpage' it 'contains the heading' do expect(contents).to include('

    Foo 2

    ') end end context 'breadcrumbs' do before(:each) do # We need docbook compat to verify breadcrumbs # We unregister_all first because the order that we # register the plugins matters. Asciidoctor::Extensions.unregister_all Asciidoctor::Extensions.register DocbookCompat Asciidoctor::Extensions.register Chunker end file_context 'the appendix', 'app.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title
    HTML end file_context 'the first page in the appendix', 'app_1.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title ›Foo
    HTML end end file_context 'the first page in the appendix', 'app_2.html' do it 'contains the breadcrumbs' do expect(contents).to include <<~HTML
    Elastic Docs ›Title ›Foo
    HTML end end end end end end end context "when outdir isn't configured" do context 'the plugin does nothing' do let(:input) do <<~ASCIIDOC = Title [[s1]] == Section 1 Words words. [[s2]] == Section 2 Words again. ASCIIDOC end context 'the main output' do it 'contains all the headings' do expect(converted).to include('

    Section 1

    ') expect(converted).to include('

    Section 2

    ') end end end end end