pandoc2review 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cfd0215db986170226f60ea72af5f323ca588196b0622cfaddd14fe16dbbd0e
-  data.tar.gz: b14fcc9ad8b5146dcbb13fe6e5f3bea7eb66d991596bef2f20fd6c649af4e1b8
+  metadata.gz: 5920e240b004f5ddbbdad1773109673183325ea838daf3a96dc140156c1995fa
+  data.tar.gz: c13ded6150f3a5f64fec9845cc3195c33b7601dd4326245195e66ff754959866
 SHA512:
-  metadata.gz: 1c441ec53f24068da40cbb31c83a0adce2a80c38c6dcb705227d4a147f019be367bd79b7d9afa7482ecd06d976e2503f5f4ca33cda6af85d63a14994875248fa
-  data.tar.gz: 68f1bfaece899793dc563c423387da38d73574122d90cb98fca45d807f0e35e855eb3d2d67f898965f38f337c6c59dbe219cf37ff41c2f52362e4989dc28e663
+  metadata.gz: 40d92ef8d7e3cf1534c579a1bfd783d4971af5ecc570644da20515a0117e1ae2ba1dd46cde9bf07e56adf30a512561fe9b888b47756f68babb3b13ecacc6ba87
+  data.tar.gz: 210316797f1fa487b619f42da293cda5a57129a04dacfee1d2b8b0d7695fa6818823f3fa481a1745b834bfaa78609e8cdb0b8129a8758f300b9881954138be14

data/.github/workflows/lint.yml

@@ -0,0 +1,14 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  stylua:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: JohnnyMorganz/stylua-action@v3
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        version: latest
+        args: --check .

data/.github/workflows/pandoc.yml

@@ -21,4 +21,4 @@ jobs:
     - run: |
         gem install bundler --no-document
         bundle install --retry 3
-        bundle exec ruby test/run_test.rb
+        bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,305 @@
+AllCops:
+  Exclude:
+    - samples/**/*
+  DisplayCopNames: true
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+
+#### Lint
+
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'test/*'
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/ErbNewArguments:
+  Enabled: false
+
+# make it enable when supporting only Ruby 3.0 and higher.
+Lint/RedundantDirGlobSort:
+  Enabled: false
+
+#### Performance
+
+Performance/DeletePrefix:
+  Enabled: false
+
+Performance/StringInclude:
+  Enabled: false
+
+Performance/CollectionLiteralInLoop:
+  Enabled: false
+
+Performance/MapCompact:
+  Enabled: false
+
+#### Style
+
+Style/AsciiComments:
+  Enabled: false
+
+# Use alias_method instead of alias.
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+  Enabled: true
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+  Enabled: true
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+  Enabled: true
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+  Enabled: true
+
+Style/TernaryParentheses:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+  Enabled: true
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+  Enabled: true
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+  Enabled: true
+
+Style/LineEndConcatenation:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  AllowedPatterns:
+    - 'require'
+    - 'include'
+    - 'file'
+    - 'task'
+    - 'desc'
+    - 'info'
+    - 'gem'
+    - 'exit'
+    - 'print'
+    - 'puts'
+    - 'write'
+    - 'warn'
+    - 'error'
+    - 'error!'
+    - 'app_error'
+    - 'raise'
+    - 'yield'
+    - 'source'
+    - 'assert'
+    - 'assert_equal'
+    - 'assert_raise'
+    - 'assert_raises'
+    - 'assert_nothing_raised'
+    - 'sh'
+    - 'mv'
+    - 'rm_rf'
+  Enabled: true
+
+Style/MixinUsage:
+  Enabled: false
+
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/PercentQLiterals:
+  EnforcedStyle: upper_case_q
+  Enabled: true
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: exploded
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/StderrPuts:
+  Enabled: false
+
+Style/WordArray:
+  MinSize: 10
+
+Style/RedundantPercentQ:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/CombinableLoops:
+  Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
+### Layout
+
+Layout/BlockAlignment:
+  Enabled: false
+
+Layout/ClosingHeredocIndentation:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Layout/SpaceAroundBlockParameters:
+  EnforcedStyleInsidePipes: no_space
+  Enabled: true
+
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+  AllowInHeredoc: true
+
+Layout/LineLength:
+  Max: 256
+  Exclude:
+    - "test/**/*"
+
+#### Metrics
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ModuleLength:
+  Max: 300
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 28
+
+Metrics/ClassLength:
+  Max: 1500
+  Exclude:
+    - 'test/*.rb'
+
+### should be < 50
+Metrics/MethodLength:
+  Max: 100
+  Exclude:
+    - "bin/review-*"
+    - "bin/review2*"
+    - "test/**/*"
+
+### should be < 20
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+### should be < 60
+Metrics/AbcSize:
+  Max: 120
+  Exclude:
+    - "bin/review-*"
+    - "test/**/*"
+
+### shoud be < 25
+Metrics/BlockLength:
+  CountComments: false  # count full line comments?
+  Max: 62
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'test/**/*.rb'
+
+## Naming
+
+Naming/FileName:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: normalcase
+  Enabled: true
+  Exclude:
+    - test/*
+
+#### Security
+
+#### Gemspec
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pandoc2review.gemspec
 gemspec
-
-gem "rake", "~> 12.0"

data/README.md

@@ -57,6 +57,10 @@ GNU General Public License Version 2
 - [@takahashim](https://github.com/takahashim)
 
 ## Changelog
+### 2.0.0
+- Full refactoring for Pandoc 3 model. Thanks atusy for your hard work!
+- Introduce rubocop and regression tests.
+
 ### 1.6.0
 - Fix inline raw.
 - Refactoring.
@@ -123,6 +127,7 @@ pandoc2review ファイル名 > ファイル名.re
 - `--shiftheading <数>`: 見出しレベルに <数> だけ加えます (pandoc >= 2.8)
 - `--disable-eaw`: Ruby の EAW ライブラリを使った段落構築を使いません
 - `--hideraw`: raw 判定されたインライン・ブロックを出力に含めません
+- `--classic-writer`: Pandoc 3 で Pando 2 互換のクラシックカスタム Writer モードを使います
 
 ## 仕様など
 - [pandoc2review における Markdown 形式処理の注意事項](markdown-format.ja.md)

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 desc 'Run tests'
 task :test, :target do |_, argv|
@@ -10,4 +10,14 @@ task :test, :target do |_, argv|
   end
 end
 
-task :default => :test
+desc 'Check with rubocop'
+task :rubocop do
+  begin
+    require 'rubocop/rake_task'
+    RuboCop::RakeTask.new
+  rescue LoadError
+    $stderr.puts 'rubocop not found'
+  end
+end
+
+task default: %i[rubocop test]

data/exe/pandoc2review

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
-# -*- coding: utf-8 -*-
-# Copyright 2020-2021 Kenshi Muto
+# Copyright 2020-2023 Kenshi Muto
 
 require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname

data/lib/pandoc2review.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright 2020-2023 Kenshi Muto
 require 'optparse'
 require 'unicode/eaw'
@@ -7,7 +6,7 @@ require 'open3'
 
 class Pandoc2ReVIEW
   def main
-    luadir = ((Pathname.new(__FILE__)).realpath.dirname + '../lua').realpath
+    luadir = (Pathname.new(__FILE__).realpath.dirname + '../lua').realpath
     parse_args
 
     ARGV.each do |file|
@@ -17,20 +16,24 @@ class Pandoc2ReVIEW
       end
       args = ['pandoc', '-t', File.join(luadir, 'review.lua'), '--lua-filter', File.join(luadir, 'filters.lua')]
 
-      if file =~ /\.md$/i
+      if file.match?(/\.md$/i)
         args += ['-f', 'markdown-auto_identifiers-smart+east_asian_line_breaks']
 
         if @disableeaw
-          args += ['-M', "softbreak:true"]
+          args += ['-M', 'softbreak:true']
         end
 
         if @hideraw
-          args += ['-M', "hideraw:true"]
+          args += ['-M', 'hideraw:true']
         end
       end
 
       if @stripemptydev
-        args += ['-M', "stripemptydev:true"]
+        args += ['-M', 'stripemptydev:true']
+      end
+
+      if @classicwriter
+        args += ['-M', 'classicwriter:true']
       end
 
       if @heading
@@ -41,7 +44,7 @@ class Pandoc2ReVIEW
 
       stdout, stderr, status = Open3.capture3(*args)
       unless status.success?
-        STDERR.puts stderr
+        $stderr.puts stderr
         exit 1
       end
       print modify_result(stdout)
@@ -53,9 +56,10 @@ class Pandoc2ReVIEW
     @disableeaw = nil
     @hideraw = nil
     @stripemptydev = nil
+    @classicwriter = nil
     opts = OptionParser.new
     opts.banner = 'Usage: pandoc2review [option] file [file ...]'
-    opts.version = '1.6'
+    opts.version = '2.0'
 
     opts.on('--help', 'Prints this message and quit.') do
       puts opts.help
@@ -67,12 +71,15 @@ class Pandoc2ReVIEW
     opts.on('--disable-eaw', "Disable compositing a paragraph with Ruby's EAW library.") do
       @disableeaw = true
     end
-    opts.on('--hideraw', "Hide raw inline/block with no review format specified.") do
+    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
+    opts.on('--strip-emptydev', 'Strip <div> without any id or class') do
       @stripemptydev = true
     end
+    opts.on('--classic-writer', 'Prefer classic custom writer on Pandoc 3.x to be compatible with Pandoc 2.x') do
+      @classicwriter = true
+    end
 
     begin
       opts.parse!(ARGV)

data/lua/filters.lua

@@ -1,18 +1,14 @@
 -- Copyright 2020-2023 atusy and Kenshi Muto
 
 local function review_inline(x)
-    return pandoc.RawInline("review", x)
+  return pandoc.RawInline("review", x)
 end
 
-local beginchild = {pandoc.Plain(review_inline("//beginchild"))}
-local endchild = {pandoc.Plain(review_inline("//endchild"))}
+local beginchild = { pandoc.Plain(review_inline("//beginchild")) }
+local endchild = { pandoc.Plain(review_inline("//endchild")) }
 
 local function markdown(text)
-  return pandoc.read(
-    text,
-    "markdown-auto_identifiers-smart+east_asian_line_breaks",
-    PANDOC_READER_OPTIONS
-  ).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)
@@ -24,7 +20,7 @@ local function support_blankline(constructor)
   ]]
   local construct = constructor or pandoc.Para
   return function(x)
-    local blocks = {construct({})}
+    local blocks = { construct({}) }
     local i = 1
     local n_break = 0
     local content = blocks[i].content
@@ -40,8 +36,8 @@ local function support_blankline(constructor)
         n_break = 0
       elseif n_break > 1 then
         -- Convert LineBreak's into //blankline commands
-        table.insert(blocks, pandoc.Div({}, {blankline = n_break - 1}))
-        table.insert(blocks, construct({elem}))
+        table.insert(blocks, pandoc.Div({}, { blankline = n_break - 1 }))
+        table.insert(blocks, construct({ elem }))
         i = i + 2
         content = blocks[i].content
         n_break = 0
@@ -68,7 +64,7 @@ local function nestablelist(elem)
       elseif second.tag then
         table.insert(block, 2, pandoc.BulletList(beginchild))
       else
-        for _,definition in ipairs(second) do
+        for _, definition in ipairs(second) do
           if definition[2] then
             table.insert(definition, 2, pandoc.BulletList(beginchild))
             table.insert(definition, pandoc.BulletList(endchild))
@@ -98,7 +94,7 @@ local function support_strong(child)
   ]]
   return function(elem)
     if (#elem.content == 1) and (elem.content[1].tag == child) then
-      return pandoc.Span(elem.content[1].content, {class = 'strong'})
+      return pandoc.Span(elem.content[1].content, { class = "strong" })
     end
   end
 end
@@ -107,23 +103,21 @@ local function caption_div(div)
   local class = div.classes[1]
   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
+  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
     class = "texequation[" .. div.identifier .. "]"
-    local math_text = (div.content[1].content[1].text
-      ):gsub("^\n+", ""):gsub("\n+$", "")
+    local math_text = (div.content[1].content[1].text):gsub("^\n+", ""):gsub("\n+$", "")
 
     if caption == nil then
-      return pandoc.RawBlock(
-        "review",
-        "//" .. class .. "{\n" .. math_text .. "\n//}"
-      )
+      return pandoc.RawBlock("review", "//" .. class .. "{\n" .. math_text .. "\n//}")
     end
 
-    div.content = {pandoc.RawBlock("review", math_text)}
+    div.content = { pandoc.RawBlock("review", math_text) }
   end
 
   if class == nil then
@@ -136,7 +130,7 @@ local function caption_div(div)
     table.insert(begin.content, review_inline("]{<P2RREMOVEBELOW/>"))
     table.insert(div.content, 1, begin)
     table.insert(div.content, pandoc.RawBlock("review", "<P2RREMOVEABOVE/>//}"))
-    div.classes = {"review-internal"}
+    div.classes = { "review-internal" }
     return div
   end
 end
@@ -144,9 +138,7 @@ end
 local function noindent(para)
   local first = para.content[1]
 
-  if (first and (first.tag == "RawInline") and
-      (first.format == "tex") and
-      (first.text:match("^\\noindent%s*"))) then
+  if first and (first.tag == "RawInline") and (first.format == "tex") and (first.text:match("^\\noindent%s*")) then
     para.content[1] = review_inline("//noindent\n")
     if para.content[2].tag == "SoftBreak" then
       table.remove(para.content, 2)
@@ -156,44 +148,15 @@ 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")},
-  {Plain = support_blankline(pandoc.Plain)},
-  {Para = support_blankline(pandoc.Para)},
-  {Para = noindent},
+  { Emph = support_strong("Strong") },
+  { Strong = support_strong("Emph") },
+  { Plain = support_blankline(pandoc.Plain) },
+  { Para = support_blankline(pandoc.Para) },
+  { Para = noindent },
   -- blankline must be processed before lists
-  {BulletList = nestablelist},
-  {OrderedList = nestablelist},
-  {DefinitionList = nestablelist},
-  {Div = caption_div},
-  {Figure = figure},
+  { BulletList = nestablelist },
+  { OrderedList = nestablelist },
+  { DefinitionList = nestablelist },
+  { Div = caption_div },
 }