Lua: add module `pandoc.structure`.

Adds support for table of contents and chunks handling. The function
`make_sections` has been given a friendlier interface and was moved to
the new module; the old `pandoc.utils.make_sections` has been
deprecated.

1 files changed, 139 insertions, 0 deletions

diff --git a/pandoc-lua-engine/test/lua/module/pandoc-structure.lua b/pandoc-lua-engine/test/lua/module/pandoc-structure.lua
new file mode 100644
index 000000000..4d59d9e6a
--- /dev/null
+++ b/pandoc-lua-engine/test/lua/module/pandoc-structure.lua
@@ -0,0 +1,139 @@
+local tasty = require 'tasty'
+local structure = require 'pandoc.structure'
+local path = require 'pandoc.path'
+local system = require 'pandoc.system'
+
+local assert = tasty.assert
+local test = tasty.test_case
+local group = tasty.test_group
+
+return {
+  test('is table', function ()
+    assert.are_equal(type(structure), 'table')
+  end),
+
+  group 'make_sections' {
+    test('sanity check', function ()
+      local blks = {
+        pandoc.Header(1, {pandoc.Str 'First'}),
+        pandoc.Header(2, {pandoc.Str 'Second'}),
+        pandoc.Header(2, {pandoc.Str 'Third'}),
+      }
+      local opts = PANDOC_WRITER_OPTIONS
+      local hblks = structure.make_sections(blks, opts)
+      assert.are_equal('Div', hblks[1].t)
+      assert.are_equal('Header', hblks[1].content[1].t)
+    end),
+    test('respects number_sections', function ()
+      local blks = {
+        pandoc.Header(1, {pandoc.Str 'First'}),
+        pandoc.Para 'Vestibulum convallis, lorem a tempus semper.'
+      }
+      local hblks = structure.make_sections(blks, {number_sections = true})
+      assert.are_equal('Div', hblks[1].t)
+      assert.are_equal('Header', hblks[1].content[1].t)
+      assert.are_equal('1', hblks[1].content[1].attributes['number'])
+    end),
+    test('respects base_level', function ()
+      local blks = {
+        pandoc.Header(1, {pandoc.Str 'First'}),
+        pandoc.Para 'Curabitur lacinia pulvinar nibh.',
+        pandoc.Header(3, {pandoc.Str 'First'}), -- Skipping level 2
+      }
+      local opts = {
+        number_sections = true,
+        base_level = 1
+      }
+      local hblks = structure.make_sections(blks, opts)
+      assert.are_equal('Div', hblks[1].t)
+      assert.are_equal('Header', hblks[1].content[1].t)
+      assert.are_equal('1',   hblks[1].content[1].attributes['number'])
+      assert.are_equal('1.1', hblks[1].content[3].attributes['number'])
+    end)
+  },
+
+  group 'split_into_chunks' {
+    test('is function', function ()
+      assert.are_equal(type(structure.split_into_chunks), 'function')
+    end),
+    test('returns a chunked doc', function ()
+      assert.are_equal(
+        pandoc.utils.type(structure.split_into_chunks(pandoc.Pandoc{})),
+        'pandoc.ChunkedDoc'
+      )
+    end),
+  },
+
+  group 'table_of_contents' {
+    test('is function', function ()
+      assert.are_equal(type(structure.table_of_contents), 'function')
+    end),
+    test('returns a bullet list', function ()
+      assert.are_equal(
+        pandoc.utils.type(structure.table_of_contents{}),
+        'Block'
+      )
+      assert.are_equal(
+        structure.table_of_contents{}.t,
+        'BulletList'
+      )
+    end),
+    test('returns a toc for a list of blocks', function ()
+      local body = pandoc.Blocks{
+        pandoc.Header(1, 'First'),
+        pandoc.Para('A sentence placed below the first structure.'),
+        pandoc.Header(2, 'Subsection'),
+        pandoc.Para('Mauris ac felis vel velit tristique imperdiet.'),
+        pandoc.Header(1, 'Second'),
+        pandoc.Para('Integer placerat tristique nisl.')
+      }
+      assert.are_equal(
+        structure.table_of_contents(body),
+        pandoc.BulletList{
+          {pandoc.Plain('First'),
+           pandoc.BulletList{{pandoc.Plain 'Subsection'}}
+          },
+          {pandoc.Plain('Second')}
+        }
+      )
+    end),
+    test('returns a toc for a chunked doc', function ()
+      local doc = pandoc.Pandoc {
+        pandoc.Header(1, 'First'),
+        pandoc.Para('A sentence placed below the first structure.'),
+        pandoc.Header(2, 'Subsection'),
+        pandoc.Para('Mauris ac felis vel velit tristique imperdiet.'),
+        pandoc.Header(1, 'Second'),
+        pandoc.Para('Integer placerat tristique nisl.')
+      }
+      local chunked = structure.split_into_chunks(doc, {chunk_level = 2})
+      assert.are_equal(
+        structure.table_of_contents(chunked),
+        pandoc.BulletList{
+          {pandoc.Plain('First'),
+           pandoc.BulletList{{pandoc.Plain 'Subsection'}}
+          },
+          {pandoc.Plain('Second')}
+        }
+      )
+    end),
+    test('respects toc-depth option', function ()
+      local doc = pandoc.Pandoc {
+        pandoc.Header(1, 'First'),
+        pandoc.Para('A sentence placed below the first structure.'),
+        pandoc.Header(2, 'Subsection'),
+        pandoc.Para('Mauris ac felis vel velit tristique imperdiet.'),
+        pandoc.Header(1, 'Second'),
+        pandoc.Para('Integer placerat tristique nisl.')
+      }
+      local chunked = structure.split_into_chunks(doc)
+      assert.are_equal(
+        pandoc.BulletList{
+          {pandoc.Plain('First')},
+          {pandoc.Plain('Second')}
+        },
+        structure.table_of_contents(chunked, {toc_depth = 1})
+      )
+    end),
+  },
+}