pandoc2review 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8adcffddd4264746fd310194473ea979a7f884edda769a164fbbf9caa4a40fb0
-  data.tar.gz: b42b6d77e327254cd472a356736885735984742d16acabf360d337b1fdf09611
+  metadata.gz: 4cfd0215db986170226f60ea72af5f323ca588196b0622cfaddd14fe16dbbd0e
+  data.tar.gz: b14fcc9ad8b5146dcbb13fe6e5f3bea7eb66d991596bef2f20fd6c649af4e1b8
 SHA512:
-  metadata.gz: 2b45bf183261d07b0970b8afdfe6f24a68f63aca8505bb082237140b6d377982697f1fecc5463d255cabb5ac38920ebf838b76cfc9feca8d61f9359ff121f32a
-  data.tar.gz: bea497ce7dba3bba8eaaefd41975bb820840803cf71260ce02901bfa5f30bc572d8c1706bbb68aa38f1d984fb980988fa9aba4c684e095c97d18daeffadce54e
+  metadata.gz: 1c441ec53f24068da40cbb31c83a0adce2a80c38c6dcb705227d4a147f019be367bd79b7d9afa7482ecd06d976e2503f5f4ca33cda6af85d63a14994875248fa
+  data.tar.gz: 68f1bfaece899793dc563c423387da38d73574122d90cb98fca45d807f0e35e855eb3d2d67f898965f38f337c6c59dbe219cf37ff41c2f52362e4989dc28e663

data/.github/workflows/pandoc.yml

@@ -4,14 +4,20 @@ on: [push, pull_request]
 jobs:
   Pandoc:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.1']
+        pandoc: ['2.11.3', '3.1.4']
     steps:
     - uses: actions/checkout@master
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '2.7'
+        ruby-version: ${{ matrix.ruby }}
     - uses: r-lib/actions/setup-pandoc@v1
       with:
-        pandoc-version: '2.11.3'
+        pandoc-version: ${{ matrix.pandoc }}
     - run: |
         gem install bundler --no-document
         bundle install --retry 3

data/README.md

@@ -47,7 +47,7 @@ pandoc2review file > file.re
 
 ## Copyright
 
-Copyright 2020-2021 Kenshi Muto
+Copyright 2020-2023 Kenshi Muto and atusy
 
 GNU General Public License Version 2
 
@@ -57,6 +57,13 @@ GNU General Public License Version 2
 - [@takahashim](https://github.com/takahashim)
 
 ## Changelog
+### 1.6.0
+- Fix inline raw.
+- Refactoring.
+
+### 1.5.0
+- Support Pandoc 3.
+
 ### 1.4.0
 - Fix an error when empty div block is received.
 - Introduce '--strip-emptydev' to strip empty block `//{-//}`, produced by TeX file.

data/lib/pandoc2review.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2020-2021 Kenshi Muto
+# Copyright 2020-2023 Kenshi Muto
 require 'optparse'
 require 'unicode/eaw'
 require 'pathname'
@@ -55,7 +55,7 @@ class Pandoc2ReVIEW
     @stripemptydev = nil
     opts = OptionParser.new
     opts.banner = 'Usage: pandoc2review [option] file [file ...]'
-    opts.version = '1.4'
+    opts.version = '1.6'
 
     opts.on('--help', 'Prints this message and quit.') do
       puts opts.help
@@ -74,7 +74,12 @@ class Pandoc2ReVIEW
       @stripemptydev = true
     end
 
-    opts.parse!(ARGV)
+    begin
+      opts.parse!(ARGV)
+    rescue OptionParser::ParseError
+      puts opts.help
+      exit 1
+    end
     if ARGV.size != 1
       puts opts.help
       exit 0

data/lua/filters.lua

@@ -1,3 +1,5 @@
+-- Copyright 2020-2023 atusy and Kenshi Muto
+
 local function review_inline(x)
     return pandoc.RawInline("review", x)
 end
@@ -6,7 +8,11 @@ local beginchild = {pandoc.Plain(review_inline("//beginchild"))}
 local endchild = {pandoc.Plain(review_inline("//endchild"))}
 
 local function markdown(text)
-  return(pandoc.read(text, "markdown").blocks[1].content)
+  return pandoc.read(
+    text,
+    "markdown-auto_identifiers-smart+east_asian_line_breaks",
+    PANDOC_READER_OPTIONS
+  ).blocks[1].content
 end
 
 local function support_blankline(constructor)
@@ -23,7 +29,7 @@ local function support_blankline(constructor)
     local n_break = 0
     local content = blocks[i].content
 
-    for j, elem in ipairs(x.content) do
+    for _, elem in ipairs(x.content) do
       if elem.tag == "LineBreak" then
         -- Count the repeated number of LineBreak
         n_break = n_break + 1
@@ -136,7 +142,7 @@ local function caption_div(div)
 end
 
 local function noindent(para)
-  first = para.content[1]
+  local first = para.content[1]
 
   if (first and (first.tag == "RawInline") and
       (first.format == "tex") and
@@ -150,6 +156,34 @@ local function noindent(para)
   return para
 end
 
+local function figure(fig)
+  -- Pandoc 3.x adds pandoc.Figure
+  if #fig.content > 1 or #fig.content[1].content > 1 then
+    error("NotImplemented")
+  end
+
+  local base = fig.content[1].content[1]
+
+  local attr = {}
+  for k, v in pairs(base.attributes) do
+    attr[k] = v
+  end
+  local classes = {}
+  for _, v in pairs(base.classes) do
+    table.insert(classes, "." .. v)
+  end
+  attr.classes = table.concat(classes, " ")
+  attr.identifier = base.attr.identifier
+  attr.is_figure = "true"
+
+  return pandoc.Image(
+    base.title,
+    base.src,
+    pandoc.utils.stringify(fig.caption),
+    attr
+  )
+end
+
 return {
   {Emph = support_strong("Strong")},
   {Strong = support_strong("Emph")},
@@ -160,5 +194,6 @@ return {
   {BulletList = nestablelist},
   {OrderedList = nestablelist},
   {DefinitionList = nestablelist},
-  {Div = caption_div}
+  {Div = caption_div},
+  {Figure = figure},
 }

data/lua/review.lua

@@ -1,6 +1,6 @@
 -- -*- coding: utf-8 -*-
 -- Re:VIEW Writer for Pandoc
--- Copyright 2020 Kenshi Muto
+-- Copyright 2020-2023 atusy and Kenshi Muto
 
 -- config
 local config = {
@@ -161,13 +161,7 @@ function Para(s)
 end
 
 local function attr_val(attr, key)
-  local attr_table = {}
-  for k, v in pairs(attr) do
-    if (k == key and v and v ~= "") then
-      return v
-    end
-  end
-  return ""
+  return attr[key] or ""
 end
 
 local function attr_classes(attr)
@@ -180,7 +174,7 @@ local function attr_classes(attr)
 end
 
 local function attr_scale(attr, key) -- a helper for CaptionedImage
-  scale = attr_val(attr, key)
+  local scale, count = attr_val(attr, key), 0
   if (scale == "") or (key == "scale") then
     return scale
   end
@@ -195,10 +189,7 @@ local function attr_scale(attr, key) -- a helper for CaptionedImage
 end
 
 function Header(level, s, attr)
-  local headmark = ""
-  for i = 1, level do
-    headmark = headmark .. "="
-  end
+  local headmark = string.rep("=", level)
 
   local classes = attr_classes(attr)
 
@@ -288,7 +279,7 @@ function CodeBlock(s, attr)
   end
   command = command or "list"
 
-  is_list = command == "list"
+  local is_list = command == "list"
 
 
   local num = (is_list == false) and "" or (
@@ -411,7 +402,7 @@ function Table(caption, aligns, widths, headers, rows)
   end
   local tmp = {}
   for i, h in pairs(headers) do
-    align = html_align(aligns[i])
+    local align = html_align(aligns[i])
     if (config.use_table_align == "true") and (align ~= "") then
       h = format_inline("dtp", "table align=" .. align) .. h
     end
@@ -422,7 +413,7 @@ function Table(caption, aligns, widths, headers, rows)
   for _, row in pairs(rows) do
     tmp = {}
       for i, c in pairs(row) do
-      align = html_align(aligns[i])
+      local align = html_align(aligns[i])
       if (config.use_table_align == "true") and (align ~= "") then
         c = format_inline("dtp", "table align=" .. align) .. c
       end
@@ -477,6 +468,16 @@ function CaptionedImage(s, src, tit, attr)
   )
 end
 
+function Image(s, src, tit, attr)
+  -- Re:VIEW @<icon> ignores caption and title
+  if attr.is_figure then
+    return CaptionedImage(src, s, tit, attr)
+  end
+  local id = string.gsub(src, "%.%w+$", "")
+  id = string.gsub(id, "^images/", "")
+  return format_inline("icon", id)
+end
+
 function Note(s)
   note_num = note_num + 1
   table.insert(footnotes, "//footnote[fn" .. note_num .. "][" .. s .. "]")
@@ -513,7 +514,7 @@ function Div(s, attr)
   local blankline = attr_val(attr, "blankline")
   if blankline ~= "" then
     local buffer = {}
-    for i = 1, tonumber(blankline) do
+    for _ = 1, tonumber(blankline) do
       table.insert(buffer, "//blankline")
     end
     return table.concat(buffer, "\n")
@@ -576,7 +577,7 @@ function RawInline(format, text)
   if (format == "tex") then
     return format_inline("embed", "|latex|" .. text)
   else
-    return format_inline("embed", "|" .. format .. "|", text)
+    return format_inline("embed", "|" .. format .. "|" .. text)
   end
 end
 
@@ -596,24 +597,38 @@ function RawBlock(format, text)
   end
 end
 
-try_catch {
-  try = function()
-    metadata = PANDOC_DOCUMENT.meta
-  end,
-  catch = function(error)
-    log("Due to your pandoc version is too old, config.yml loader is disabled.\n")
-  end
-}
+local function configure()
+  try_catch {
+    try = function()
+      metadata = PANDOC_DOCUMENT.meta
+    end,
+    catch = function(error)
+      log("Due to your pandoc version is too old, config.yml loader is disabled.\n")
+    end
+  }
 
-if (metadata) then
-  -- Load config from YAML
-  for k,v in pairs(config) do
-    if metadata[k] ~= nil then
-      config[k] = stringify(metadata[k])
+  if (metadata) then
+    -- Load config from YAML
+    for k, _ in pairs(config) do
+      if metadata[k] ~= nil then
+        config[k] = stringify(metadata[k])
+      end
     end
   end
 end
 
+if PANDOC_VERSION >= "3.0.0" then
+  -- NOTE: A wrapper to support Pandoc >= 3.0 https://pandoc.org/custom-writers.html#changes-in-pandoc-3.0
+  function Writer (doc, opts)
+    PANDOC_DOCUMENT = doc
+    PANDOC_WRITER_OPTIONS = opts
+    configure()
+    return pandoc.write_classic(doc, opts)
+  end
+else
+  configure()
+end
+
 local meta = {}
 meta.__index =
   function(_, key)

data/pandoc2review.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "pandoc2review"
-  spec.version       = "1.4.0"
+  spec.version       = "1.6.0"
   spec.authors       = ["Kenshi Muto"]
   spec.email         = ["kmuto@kmuto.jp"]
   spec.license       = "GPL-2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandoc2review
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Kenshi Muto
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode-eaw
@@ -104,7 +104,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/kmuto/pandoc2review
   source_code_uri: https://github.com/kmuto/pandoc2review
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,9 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Pandoc2review is a converter from any document to Re:VIEW format (using Pandoc)
 test_files: []