pandoc-lua-engine/test/lua/module/pandoc-utils.lua - main - githubmirror/pandoc

pandoc-lua-engine/test/lua/module/pandoc-utils.lua
393 строки12 KB
Albert Krewinkel
Lua: support more elements as input to `pandoc.utils.stringify`.
10 дек 2024, 13:45
10 дек 2024, 13:45a084731
local tasty = require 'tasty'
local pandoc = require 'pandoc'
local utils = require 'pandoc.utils'
local io = require 'io'

local assert = tasty.assert
local test = tasty.test_case
local group = tasty.test_group

return {
  group 'blocks_to_inlines' {
    test('default separator', function ()
      local blocks = {
        pandoc.Para { pandoc.Str 'Paragraph1' },
        pandoc.Para { pandoc.Emph { pandoc.Str 'Paragraph2' } }
      }
      local expected = {
        pandoc.Str 'Paragraph1',
        pandoc.LineBreak(),
        pandoc.Emph { pandoc.Str 'Paragraph2' }
      }
      assert.are_same(
        expected,
        utils.blocks_to_inlines(blocks)
      )
    end),
    test('custom separator', function ()
      local blocks = {
        pandoc.Para{ pandoc.Str 'Paragraph1' },
        pandoc.Para{ pandoc.Emph 'Paragraph2' }
      }
      local expected = {
        pandoc.Str 'Paragraph1',
        pandoc.LineBreak(),
        pandoc.Emph { pandoc.Str 'Paragraph2' }
      }
      assert.are_same(
        expected,
        utils.blocks_to_inlines(blocks, { pandoc.LineBreak() })
      )
    end)
  },

  group 'equals' {
    test('compares Pandoc elements', function ()
      assert.is_truthy(
        utils.equals(pandoc.Pandoc{'foo'}, pandoc.Pandoc{'foo'})
      )
    end),
    test('compares Block elements', function ()
      assert.is_truthy(
        utils.equals(pandoc.Plain{'foo'}, pandoc.Plain{'foo'})
      )
      assert.is_falsy(
        utils.equals(pandoc.Para{'foo'}, pandoc.Plain{'foo'})
      )
    end),
    test('compares Inline elements', function ()
      assert.is_truthy(
        utils.equals(pandoc.Emph{'foo'}, pandoc.Emph{'foo'})
      )
      assert.is_falsy(
        utils.equals(pandoc.Emph{'foo'}, pandoc.Strong{'foo'})
      )
    end),
    test('compares Inline with Block elements', function ()
      assert.is_falsy(
        utils.equals(pandoc.Emph{'foo'}, pandoc.Plain{'foo'})
      )
      assert.is_falsy(
        utils.equals(pandoc.Para{'foo'}, pandoc.Strong{'foo'})
      )
    end),
    test('compares Pandoc with Block elements', function ()
      assert.is_falsy(
        utils.equals(pandoc.Pandoc{'foo'}, pandoc.Plain{'foo'})
      )
      assert.is_falsy(
        utils.equals(pandoc.Para{'foo'}, pandoc.Pandoc{'foo'})
      )
    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 hblks = utils.make_sections(true, 1, blks)
      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)
  },

  group 'normalize_date' {
    test('09 Nov 1989', function ()
      assert.are_equal('1989-11-09', utils.normalize_date '09 Nov 1989')
    end),
    test('12/31/2017', function ()
      assert.are_equal('2017-12-31', utils.normalize_date '12/31/2017')
    end),
  },

  group 'references' {
    test('gets references from doc', function ()
      local ref = {
        ['author'] = {
          {given = 'Max', family = 'Mustermann'}
        },
        ['container-title'] = pandoc.Inlines('JOSS'),
        ['id']     = 'test',
        ['issued'] = {['date-parts'] = {{2021}}},
        ['title']  = pandoc.Inlines{
          pandoc.Quoted('DoubleQuote', 'Interesting'),
          pandoc.Space(),
          'work'
        },
        ['type']   = 'article-journal',
      }
      local nocite = pandoc.Cite(
        '@test',
        {pandoc.Citation('test', 'NormalCitation')}
      )
      local doc = pandoc.Pandoc({}, {nocite = nocite, references = {ref}})
      assert.are_same({ref}, pandoc.utils.references(doc))
    end)
  },

  group 'run_lua_filter' {
    test('runs a filter', function ()
      local doc = pandoc.Pandoc("indivisible words")
      pandoc.system.with_temporary_directory('lua-filter', function (dir)
        local filter_path = pandoc.path.join{dir, 'test.lua'}
        local filter = 'function Space() return " " end'
        local fh = io.open(filter_path, 'wb')
        fh:write(filter)
        fh:close()
        assert.are_equal(
          utils.run_lua_filter(doc, filter_path),
          pandoc.Pandoc(
            pandoc.Plain(pandoc.Inlines{"indivisible", " ", "words"})
          )
        )
      end)
    end),
    test("doesn't change the local environment by default", function ()
      pandoc.system.with_temporary_directory('lua-filter', function (dir)
        local filter_path = pandoc.path.join{dir, 'test.lua'}
        local foo
        local filter = 'foo = 42'
        local fh = io.open(filter_path, 'wb')
        fh:write(filter)
        fh:close()
        utils.run_lua_filter(pandoc.Pandoc{}, filter_path)
        assert.is_nil(foo)
      end)
    end),
    test("accepts an environment in which the filter is executed", function ()
      pandoc.system.with_temporary_directory('lua-filter', function (dir)
        local filter_path = pandoc.path.join{dir, 'test.lua'}
        local filter = 'foo = 42'
        local fh = io.open(filter_path, 'wb')
        fh:write(filter)
        fh:close()
        utils.run_lua_filter(pandoc.Pandoc{}, filter_path, _ENV)
        assert.are_equal(_ENV.foo, 42)
      end)
    end)
  },

  group 'sha1' {
    test('hashing', function ()
      local ref_hash = '0a0a9f2a6772942557ab5355d76af442f8f65e01'
      assert.are_equal(ref_hash, utils.sha1 'Hello, World!')
    end)
  },

  group 'stringify' {
    test('Inline', function ()
      local inline = pandoc.Emph{
        pandoc.Str 'Cogito',
        pandoc.Space(),
        pandoc.Str 'ergo',
        pandoc.Space(),
        pandoc.Str 'sum.',
      }
      assert.are_equal('Cogito ergo sum.', utils.stringify(inline))
    end),
    test('Block', function ()
      local block = pandoc.Para{
        pandoc.Str 'Make',
        pandoc.Space(),
        pandoc.Str 'it',
        pandoc.Space(),
        pandoc.Str 'so.',
      }
      assert.are_equal('Make it so.', utils.stringify(block))
    end),
    test('boolean', function ()
      assert.are_equal('true', utils.stringify(true))
      assert.are_equal('false', utils.stringify(false))
    end),
    test('number', function ()
      assert.are_equal('5', utils.stringify(5))
      assert.are_equal('23.23', utils.stringify(23.23))
    end),
    test('Attr', function ()
      local attr = pandoc.Attr('foo', {'bar'}, {a = 'b'})
      assert.are_equal('', utils.stringify(attr))
    end),
    test('List', function ()
      local list = pandoc.List{pandoc.Str 'a', pandoc.Blocks('b')}
      assert.are_equal('ab', utils.stringify(list))
    end),
    test('Blocks', function ()
      local blocks = pandoc.Blocks{pandoc.Para 'a', pandoc.Header(1, 'b')}
      assert.are_equal('ab', utils.stringify(blocks))
    end),
    test('Inlines', function ()
      local inlines = pandoc.Inlines{pandoc.Str 'a', pandoc.Subscript('b')}
      assert.are_equal('ab', utils.stringify(inlines))
    end),
    test('Caption', function ()
      local capt = pandoc.Caption(pandoc.Para{pandoc.Str 'a', pandoc.Emph('b')})
      assert.are_equal('ab', utils.stringify(capt))
    end),
    test('Cell', function ()
      local cell = pandoc.Cell(pandoc.Para{pandoc.Str 'a', pandoc.Emph('b')})
      assert.are_equal('ab', utils.stringify(cell))
    end),
    test('TableFoot', function ()
      local tf = pandoc.TableFoot{pandoc.Row{pandoc.Cell{pandoc.Plain "x y"}}}
      assert.are_equal('x y', utils.stringify(tf))
    end),
    test('TableHead', function ()
      local th = pandoc.TableHead{pandoc.Row{pandoc.Cell{pandoc.Plain "head1"}}}
      assert.are_equal('head1', utils.stringify(th))
    end),
    test('Meta', function ()
      local meta = pandoc.Meta{
        a = pandoc.Inlines 'funny and ',
        b = 'good movie',
        c = pandoc.List{pandoc.Inlines{pandoc.Str '!'}}
      }
      assert.are_equal('funny and good movie!', utils.stringify(meta))
    end),
  },

  group 'to_roman_numeral' {
    test('convertes number', function ()
      assert.are_equal('MDCCCLXXXVIII', utils.to_roman_numeral(1888))
    end),
    test('fails on non-convertible argument', function ()
      assert.is_falsy(pcall(utils.to_roman_numeral, 'not a number'))
    end)
  },

  group 'type' {
    test('nil', function ()
      assert.are_equal(utils.type(nil), 'nil')
    end),
    test('boolean', function ()
      assert.are_equal(utils.type(true), 'boolean')
      assert.are_equal(utils.type(false), 'boolean')
    end),
    test('number', function ()
      assert.are_equal(utils.type(5), 'number')
      assert.are_equal(utils.type(-3.02), 'number')
    end),
    test('string', function ()
      assert.are_equal(utils.type(''), 'string')
      assert.are_equal(utils.type('asdf'), 'string')
    end),
    test('plain table', function ()
      assert.are_equal(utils.type({}), 'table')
    end),
    test('List', function ()
      assert.are_equal(utils.type(pandoc.List{}), 'List')
    end),
    test('Inline', function ()
      assert.are_equal(utils.type(pandoc.Str 'a'), 'Inline')
      assert.are_equal(utils.type(pandoc.Emph 'emphasized'), 'Inline')
    end),
    test('Inlines', function ()
      assert.are_equal(utils.type(pandoc.Inlines{pandoc.Str 'a'}), 'Inlines')
      assert.are_equal(utils.type(pandoc.Inlines{pandoc.Emph 'b'}), 'Inlines')
    end),
    test('Blocks', function ()
      assert.are_equal(utils.type(pandoc.Para 'a'), 'Block')
      assert.are_equal(utils.type(pandoc.CodeBlock 'true'), 'Block')
    end),
    test('Inlines', function ()
      assert.are_equal(utils.type(pandoc.Blocks{'a'}), 'Blocks')
      assert.are_equal(utils.type(pandoc.Blocks{pandoc.CodeBlock 'b'}), 'Blocks')
    end),
  },

  group 'to_simple_table' {
    test('convertes Table', function ()
      function simple_cell (blocks)
        return {
          attr = pandoc.Attr(),
          alignment = "AlignDefault",
          contents = blocks,
          col_span = 1,
          row_span = 1,
        }
      end
      local tbl = pandoc.Table(
        {long = {pandoc.Plain {
                   pandoc.Str "the", pandoc.Space(), pandoc.Str "caption"}}},
        {{pandoc.AlignDefault, nil}},
        pandoc.TableHead{pandoc.Row{simple_cell{pandoc.Plain "head1"}}},
        {{
            attr = pandoc.Attr(),
            body = {pandoc.Row{simple_cell{pandoc.Plain "cell1"}}},
            head = {},
            row_head_columns = 0
        }},
        pandoc.TableFoot(),
        pandoc.Attr()
      )
      local stbl = utils.to_simple_table(tbl)
      assert.are_equal('SimpleTable', stbl.t)
      assert.are_equal('head1', utils.stringify(stbl.headers[1]))
      assert.are_equal('cell1', utils.stringify(stbl.rows[1][1]))
      assert.are_equal('the caption', utils.stringify(pandoc.Span(stbl.caption)))
    end),
    test('fails on para', function ()
      assert.is_falsy(pcall(utils.to_simple_table, pandoc.Para "nope"))
    end),
  },
  group 'from_simple_table' {
    test('converts SimpleTable to Table', function ()
      local caption = {pandoc.Str "Overview"}
      local aligns = {pandoc.AlignDefault, pandoc.AlignDefault}
      local widths = {0, 0} -- let pandoc determine col widths
      local headers = {
        {pandoc.Plain "Language"},
        {pandoc.Plain "Typing"}
      }
      local rows = {
        {{pandoc.Plain "Haskell"}, {pandoc.Plain "static"}},
        {{pandoc.Plain "Lua"}, {pandoc.Plain "Dynamic"}},
      }
      local simple_table = pandoc.SimpleTable(
        caption,
        aligns,
        widths,
        headers,
        rows
      )
      local tbl = utils.from_simple_table(simple_table)
      assert.are_equal("Table", tbl.t)
      assert.are_same(
        {pandoc.Plain(caption)},
        tbl.caption.long
      )
      -- reversible
      assert.are_same(simple_table, utils.to_simple_table(tbl))
    end),
    test('empty caption', function ()
      local simple_table = pandoc.SimpleTable(
        {},
        {pandoc.AlignDefault},
        {0},
        {{pandoc.Plain 'a'}},
        {{{pandoc.Plain 'b'}}}
      )
      local tbl = utils.from_simple_table(simple_table)
      assert.are_equal(
        pandoc.Blocks{},
        tbl.caption.long
      )
      assert.is_nil(tbl.caption.short)
    end),
    test('empty body', function ()
      local simple_table = pandoc.SimpleTable(
        pandoc.Inlines('a nice caption'),
        {pandoc.AlignDefault},
        {0},
        {{pandoc.Plain 'a'}},
        {}
      )
      local tbl = utils.from_simple_table(simple_table)
      tbl.bodies:map(print)
      assert.are_same(pandoc.List(), tbl.bodies)
    end),
  }
}