pandoc2review 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5671aaebdb1909371f608bb0812d18f101827b5ccc06ee80532b48928d0f158
-  data.tar.gz: 568f9cee83013a84b9a11691c4420e62b174fec7a88e5898b0a3ba565e0b2e52
+  metadata.gz: a11aa7a678f2ccee527f68b25d2617c4b25dbe44fb675316593b4638ccf82252
+  data.tar.gz: afe9e95dde61125f788c438128014721cc5825f67f834048a2240d455929e90b
 SHA512:
-  metadata.gz: 15129e6dffb240ca58c4da70834d4f16488da5b752c3302f313c9d0ff74eb614ec7d9e9d2615f688085b089035a9c8b3b32e8822470c6b0635c9bdb2427ea8c3
-  data.tar.gz: 60a7d8451a10be4a98f21f9a5c0b934f5fe95cc7637aad9e1951dca092a3ab21d78b3838815ca0de95584b932085cdede8c8f0cfa86bcf5c135bef44d6514fd8
+  metadata.gz: 267a8c27385b13c00f835fc73b01dd9f5c27e8c3e85b5d298c185580f1f048aef2537dbde3eb5c39a0d87893ef98c9572f9c53eb152fddf79166e5c7a4744301
+  data.tar.gz: 4665b011334f35a3c1444a2aacfcec7bf96771ccd8181c3f14b116f499cd936355b587d1b804e37ed7c99b6b99568e8b27a3855c9e3f50c48edeb96700a832b4

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
 
 GNU General Public License Version 2
 
@@ -57,6 +57,13 @@ GNU General Public License Version 2
 - [@takahashim](https://github.com/takahashim)
 
 ## Changelog
+### 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.
+
 ### 1.3.0
 - Fix "attempt to index global 'first' (a nil value)" error in a docx 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'
@@ -29,6 +29,10 @@ class Pandoc2ReVIEW
         end
       end
 
+      if @stripemptydev
+        args += ['-M', "stripemptydev:true"]
+      end
+
       if @heading
         args += ["--shift-heading-level-by=#{@heading}"]
       end
@@ -48,9 +52,10 @@ class Pandoc2ReVIEW
     @heading = nil
     @disableeaw = nil
     @hideraw = nil
+    @stripemptydev = nil
     opts = OptionParser.new
     opts.banner = 'Usage: pandoc2review [option] file [file ...]'
-    opts.version = '1.3'
+    opts.version = '1.5'
 
     opts.on('--help', 'Prints this message and quit.') do
       puts opts.help
@@ -65,8 +70,16 @@ class Pandoc2ReVIEW
     opts.on('--hideraw', "Hide raw inline/block with no review format specified.") do
       @hideraw = true
     end
+    opts.on('--strip-emptydev', "Strip <div> without any id or class") do
+      @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)
@@ -102,6 +108,7 @@ local function caption_div(div)
   local caption = div.attributes.caption
 
   if ((#div.content == 1) and
+      (div.content[1].content) and
       (#div.content[1].content == 1) and
       (div.content[1].content[1].tag == "Math") and
       (div.identifier)) then
@@ -149,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")},
@@ -159,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 = {
@@ -477,6 +477,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 .. "]")
@@ -522,7 +532,11 @@ function Div(s, attr)
   local classes = attr_classes(attr)
 
   if next(classes) == nil then
-    return "//{\n" .. s .. "\n//}"
+    if metadata.stripemptydev then
+      return s
+    else
+      return "//{\n" .. s .. "\n//}"
+    end
   end
 
   if classes["review-internal"] then
@@ -592,24 +606,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,v 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.3.0"
+  spec.version       = "1.5.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.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Kenshi Muto
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2023-07-03 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: []