review-retrovert 0.3.3 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4018ff4ea97d4ea7a151e769c871e9d1f91d6c1ce2b18a500ae68a569987d1d0
-  data.tar.gz: 862bc4e9be33d25e15a2b1b3bfac1b3f231af1568e35d320ee5458740629ac50
+  metadata.gz: a9311aa0fa85bd42652cbbe163b02383bb3e3ce8b82d5c10f1d85af48ecda098
+  data.tar.gz: cac37e6eae36803b96a0f009695ffe480a7fafe4642a1bb45a44a4bcc1eb948b
 SHA512:
-  metadata.gz: 4423300d41d6ba1ad911c99145fa830c8c36a9dd4a54273dda177b27bca65ae8d86bb5300382f28b5bc05abe27ce8fb12c6313fb4967f2244d0583a4c32c1bed
-  data.tar.gz: 68d804e35464032a32bc6d4b0cd45f919128fecced2bf4e8692db0e0e9e62212e64c1e4539b943f076e32ea10baf5fdb631d146eb0afaaa465375f4a67b58886
+  metadata.gz: 506fd1726a38d677b12c6641ba1f77330c332c9ec75d9d18427cedc8647ec319762df7025b8bcc65458e7bac9921fd62b6c3e7f3d6faf0447c5ad15a486ed2a9
+  data.tar.gz: 21dabf3b90b0d6f93183d7e48aa7a3b32614b37edc078f6c538c6e8b810fc5c5f4ae7577ca10d9f6a45cc8732867d2e12f558f7ff5d1fb4fb97ddefe547c80fa

data/.github/workflows/retrovert.yml

@@ -0,0 +1,39 @@
+on: 
+  pull_request:
+  push:
+    branches:
+      - master
+
+name: Retrovert
+jobs:
+  review:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: bundle install
+      # spec
+      - name: spec
+        run: bundle exec rake spec
+      # convert
+      - name: convert
+        run: bundle exec review-retrovert convert testdata/mybook/config.yml tmp -f
+      # build
+      - name: review build
+        uses: docker://srzzumix/review-retrovert
+        with:
+          entrypoint: bash
+          args: -c "cd tmp; rake preproc all"
+      # artifacts
+      - name: artifacts
+        uses: actions/upload-artifact@v1
+        with:
+          name: mybook
+          path: tmp/mybook.pdf
+      - name: artifacts
+        uses: actions/upload-artifact@v1
+        with:
+          name: mybook
+          path: tmp/mybook.epub

data/.gitignore

@@ -5,11 +5,11 @@
 /doc/
 /pkg/
 /spec/reports/
-/tmp/
+tmp/
 
 # rspec failure tracking
 .rspec_status
 .rakeTasks
 .idea
 
-*.gem
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem 'aruba', '~> 1.0.2'

data/Gemfile.lock

@@ -1,15 +1,74 @@
 PATH
   remote: .
   specs:
-    review-retrovert (0.3.3)
+    review-retrovert (0.3.4)
       review (>= 3.2.0, < 4.0)
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    aruba (1.0.2)
+      childprocess (>= 2.0, < 5.0)
+      contracts (~> 0.16.0)
+      cucumber (>= 2.4, < 5.0)
+      ffi (~> 1.9)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    builder (3.2.4)
+    childprocess (4.0.0)
+    concurrent-ruby (1.1.6)
+    contracts (0.16.0)
+    cucumber (4.1.0)
+      builder (~> 3.2, >= 3.2.3)
+      cucumber-core (~> 7.1, >= 7.1.0)
+      cucumber-create-meta (~> 1.0.0, >= 1.0.0)
+      cucumber-cucumber-expressions (~> 10.1, >= 10.1.0)
+      cucumber-gherkin (~> 14.0, >= 14.0.1)
+      cucumber-html-formatter (~> 7.0, >= 7.0.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      cucumber-wire (~> 3.1, >= 3.1.0)
+      diff-lcs (~> 1.3, >= 1.3, < 1.4)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.0, >= 1.0.2)
+    cucumber-core (7.1.0)
+      cucumber-gherkin (~> 14.0, >= 14.0.1)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
+    cucumber-create-meta (1.0.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-cucumber-expressions (10.2.2)
+    cucumber-gherkin (14.2.0)
+      cucumber-messages (~> 12.4, >= 12.4.0)
+    cucumber-html-formatter (7.2.0)
+      cucumber-messages (~> 12.4, >= 12.4.0)
+    cucumber-messages (12.4.0)
+      protobuf-cucumber (~> 3.10, >= 3.10.8)
+    cucumber-tag-expressions (2.0.4)
+    cucumber-wire (3.1.0)
+      cucumber-core (~> 7.1, >= 7.1.0)
+      cucumber-cucumber-expressions (~> 10.1, >= 10.1.0)
+      cucumber-messages (~> 12.2, >= 12.2.0)
     diff-lcs (1.3)
+    ffi (1.13.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
     image_size (2.0.2)
+    middleware (0.1.0)
+    minitest (5.14.1)
+    multi_test (0.1.2)
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
     rake (12.3.3)
     review (3.2.0)
       image_size
@@ -30,12 +89,19 @@ GEM
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
     rubyzip (2.3.0)
+    sys-uname (1.2.1)
+      ffi (>= 1.0.0)
     thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  aruba (~> 1.0.2)
   rake (~> 12.0)
   review-retrovert!
   rspec (~> 3.0)

data/README.md

@@ -4,6 +4,8 @@
 
 # ReVIEW::Retrovert
 
+[Re:VIEW Starter](https://kauplan.org/reviewstarter/) Project convert to [Re:VIEW](https://reviewml.org/ja/) 3.X
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +24,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```sh
+review-retrovert convert /path/to/dir/review-starter/config.yml <output directory>
+```
 
 ## Development
 
@@ -34,10 +38,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/srz-zumix/review-retrovert.
 
-
 ## Develop
 
-docker run -it --rm -v $(pwd)/../:/github vvakame/review:3.2 bash
+docker run -it --rm -v $(pwd)/:/work -w /work vvakame/review:3.2 bash
 
 ## License
 

data/lib/review/retrovert/converter.rb

@@ -69,8 +69,31 @@ module ReVIEW
         @configs.rewrite_yml('texstyle', '["reviewmacro"]')
       end
 
-      def replace_inline_command(content, command, sub)
+      def replace_compatible_block_command_outline(content, command, new_command, option_count)
+        content.gsub!(/^\/\/#{command}(?<option>(\[[^\r\n]*?\]){0,#{option_count}})(\[[^\r\n]*\])*{(?<inner>.*?)\/\/}/m, "//#{new_command}\\k<option>{\\k<inner>//}")
+      end
+
+      def replace_compatible_block_command_to_outside(content, command, new_command, option_count, add_options="", new_body="")
+        body = new_body
+        body += '\n' unless body.empty?
+        content.gsub!(/^\/\/#{command}(?<option>(\[[^\r\n]*?\]){0,#{option_count}})(\[[^\r\n]*\])*{(?<inner>.*?)\/\/}/m, "//#{new_command}\\k<option>#{add_options}{\n#{new_body}//}\\k<inner>")
+      end
+
+      def replace_block_command_outline(content, command, new_command, use_option)
+        if use_option
+          content.gsub!(/^\/\/#{command}(?<option>\[[^\r\n]*\])*{(?<inner>.*?)\/\/}/m, "//#{new_command}\\k<option>{\\k<inner>//}")
+        else
+          content.gsub!(/^\/\/#{command}(?<option>\[[^\r\n]*?\])*{(?<inner>.*?)\/\/}/m, "//#{new_command}{\\k<inner>//}")
+        end
+      end
 
+      def delete_block_command_outer(content, command)
+        content.gsub!(/^\/\/#{command}(\[[^\r\n]*?\])*{(?<inner>.*?)\/\/}\R/m, '\k<inner>')
+      end
+
+      def delete_block_command(content, command)
+        content.gsub!(/^\/\/#{command}(\[[^\r\n]*?\])*{.*?\/\/}\R/m, '')
+        content.gsub!(/^\/\/#{command}(\[.*?\])*\s*\R/, '')
       end
 
       def delete_inline_command(content, command)
@@ -78,6 +101,156 @@ module ReVIEW
         content.gsub!(/@<#{command}>(?:(\$)|(?:({)|(\|)))((?:.*@<\w*>[\|${].*?[\|$}].*?|.*?)*)(?(1)(\$)|(?(2)(})|(\|)))/){"#{$4}"}
       end
 
+      def replace_inline_command(content, command, new_command)
+        content.gsub!(/@<#{command}>/, "@<#{new_command}>")
+      end
+
+      def replace_block_command_nested_boxed_article(content, box)
+        found = false
+        content.dup.scan(/(^\/\/#{box})(\[[^\r\n]*?\])*(?:(\$)|(?:({)|(\|)))(.*?)(^\/\/)(?(3)(\$)|(?(4)(})|(\|)).*?[\r\n]+)/m) { |m|
+          matched = m[0..-1].join
+          inner = m[5]
+          im = inner.match(/^\/\/(\w+)((\[.*?\])*)([$|{])/)
+          unless im.nil?
+            inner_cmd = im[1]
+            inner_open = im[4]
+            inner_opts = im[2]
+            first_opt = inner_opts.match(/^\[(.*?)\]/)[1]
+
+            is_commentout = true
+            unless first_opt.empty?
+              if inner.match(/@<.*?>[$|{]#{first_opt}/)
+                is_commentout = false
+              end
+            end
+            cmd_begin = m[0..4].join
+            cmd_end = m[6..-1].join
+            # check other fence inner block (block command has fence??)
+            if inner_open == m[2..4].join
+              # if same fence then cmd_end == inner_end
+              if is_commentout
+                inner.gsub!(/(^\/\/(\w+\[.*?\])*#{inner_open})/, '#@#\1')
+                content.gsub!(/#{Regexp.escape(matched)}/m, "#{cmd_begin}#{inner}#@##{cmd_end}")
+              else
+                imb = inner.match(/(\R((^\/\/\w+(\[.*?\])*)\s*)*^\/\/\w+\[#{first_opt}\](\[.*?\])*#{inner_open}.*)\R/m)
+                to_out_block = imb[1]
+                inner.gsub!(/#{Regexp.escape(to_out_block)}/m, '')
+                content.gsub!(/#{Regexp.escape(matched)}/m, "#{cmd_begin}#{inner}#{cmd_end}#{to_out_block}")
+              end
+            else
+              close = inner_open == '{' ? '}' : inner_open
+              if is_commentout
+                inner.gsub!(/(^\/\/(\w+\[.*?\])*#{inner_open})(.*?)(^\/\/#{close})/m, '#@#\1\2#@#\3')
+                content.gsub!(/#{Regexp.escape(matched)}/m, "#{cmd_begin}#{inner}#{cmd_end}")
+              else
+                imb = inner.match(/\R((^\/\/\w+(\[.*?\])*)\s*)*^\/\/(\w+)\[#{first_opt}\](\[[^\r\n]*?\])*(?:(\$)|(?:({)|(\|)))(.*?)(^\/\/)(?(3)(\$)|(?(4)(})|(\|)))/m)
+                to_out_block = imb[0]
+                inner.gsub!(/#{Regexp.escape(to_out_block)}/m, '')
+                content.gsub!(/#{Regexp.escape(matched)}/m, "#{cmd_begin}#{inner}#{cmd_end}#{to_out_block}")
+              end
+            end
+            found = true
+          end
+        }
+        if found
+          replace_block_command_nested_boxed_article(content, box)
+        end
+      end
+
+      def replace_block_command_nested_boxed_articles(content)
+        replace_block_command_nested_boxed_article(content, 'note')
+        replace_block_command_nested_boxed_article(content, 'memo')
+        replace_block_command_nested_boxed_article(content, 'tip')
+        replace_block_command_nested_boxed_article(content, 'info')
+        replace_block_command_nested_boxed_article(content, 'warning')
+        replace_block_command_nested_boxed_article(content, 'important')
+        replace_block_command_nested_boxed_article(content, 'caution')
+        replace_block_command_nested_boxed_article(content, 'notice')
+      end
+
+      def replace_block_commentout(content)
+        d = content.dup
+        d.gsub!(/(^\/\/sampleoutputbegin\[)(.*?)(\])(.*?)(^\/\/sampleoutputend)/m, '')
+        d.scan(/(^#@)(\++)(.*?)(^#@)(-+)/m) { |m|
+          matched = m[0..-1].join
+          inner = m[2]
+          inner.gsub!(/(^.)/, '#@#\1')
+          content.gsub!(/#{Regexp.escape(matched)}/m, "#@##{m[1]}#{inner}#@##{m[4]}")
+        }
+      end
+
+      def replace_sampleoutput(content)
+        replace_block_commentout(content)
+        content.dup.scan(/(^\/\/sampleoutputbegin\[)(.*?)(\].*?\R)(.*?)(^\/\/sampleoutputend)/m) { |m|
+          matched = m[0..-1].join
+          sampleoutputbegin = m[0..2].join
+          sampleoutputend = m[4]
+          option = m[1]
+          inner = m[3]
+          # inner.gsub!(/^\/\//, '//@<nop>{}')
+          content.gsub!(/#{Regexp.escape(matched)}/m, "#{option}\n#@##{sampleoutputbegin}#{inner}#@##{sampleoutputend}")
+        }
+      end
+
+      def replace_auto_ids(content, command, require_option_count)
+        index = -1
+        content.gsub!(/^\/\/#{command}\[(|\?)\]/) { |s| index += 1; "//#{command}[starter_auto_id_#{command}_#{index}]" }
+        if require_option_count > 0
+          while !content.gsub!(/(^\/\/#{command}(\[[^\[\]]*?\]){0,#{require_option_count-1}})($|{)/, '\1[]\3').nil?
+          end
+        end
+      end
+
+      def remove_starter_refid(content)
+        # note - noteref
+        content.dup.scan(/(@<noteref>)(?:(\$)|(?:({)|(\|)))(.*?)(?(2)(\$)|(?(3)(})|(\|)))/) { |m|
+          matched = m[0..-1].join
+          ref = m[4]
+          n = content.match(/^\/\/note\[#{ref}\](\[.*?\])/)
+          unless n.nil?
+            content.gsub!(/#{Regexp.escape(matched)}/, n[1])
+            content.gsub!(/^\/\/note\[#{ref}\](\[.*?\])/, '//note\1')
+          else
+            # content.gsub!(/#{Regexp.escape(matched)}/, "noteref<#{ref}>")
+          end
+        }
+      end
+
+      def remove_starter_options(content)
+        # image border
+        content.gsub!(/(^\/\/image\[.*?\]\[.*?\]\[.*?)((,|)border=[^,\]]*)(.*?\])/, '\1\4')
+        # list lineno
+        content.gsub!(/(^\/\/list\[.*?\]\[.*?\]\[.*?)((,|)lineno=[^,\]]*)(.*?\])/, '\1\4')
+      end
+
+      def expand_nested_inline_command(content)
+        found = false
+        content.dup.scan(/(@<.*?>)(?:(\$)|(?:({)|(\|)))(.*?)(?(2)(\$)|(?(3)(})|(\|)))/) { |m|
+          matched = m.join
+          body = m[4]
+          im = body.match(/(.*)(@<.*?>)(?:(\$)|(?:({)|(\|)))(.*?)(?(3)(\$)|(?(4)(})|(\|)))(.*)/)
+          if im.nil?
+            im = body.match(/(.*)(@<.*?>)#{m[1..3].join}/)
+            unless im.nil?
+              outcmd_begin = m[0] + "$|{".gsub(m[1..3].join, '')
+              outcmd_end = "$|}".gsub(m[5..7].join, '')
+              rep = "#{outcmd_begin}#{body}#{outcmd_end}"
+              content.gsub!(matched, rep)
+              found = true
+            end
+          else
+            outcmd_begin = m[0..3].join
+            outcmd_end = m[5..7].join
+            rep = "#{outcmd_begin}#{im[1]}#{outcmd_end}#{im[2..9].join}#{outcmd_begin}#{im[-1]}#{outcmd_end}"
+            content.gsub!(matched, rep)
+            found = true
+          end
+        }
+        if found
+          expand_nested_inline_command(content)
+        end
+      end
+
       def copy_embedded_contents(outdir, content)
         content.scan(/\#@mapfile\((.*?)\)/).each do |filepath|
           srcpath = File.join(@basedir, filepath)
@@ -93,8 +266,6 @@ module ReVIEW
       def update_content(outdir, contentfile)
         info contentfile
         content = File.read(contentfile)
-        content.gsub!(/(\/\/sideimage\[.*?\]\[.*?\])\[.*?\]/, '\1')
-        content.gsub!(/\/\/sideimage/, '//image')
         content.gsub!(/@<href>{(.*?)#.*?,(.*?)}/, '@<href>{\1,\2}')
         content.gsub!(/@<href>{(.*?)#.*?}/, '@<href>{\1}')
         # table 内の @ コマンドは不安定らしい
@@ -103,8 +274,62 @@ module ReVIEW
         # 空セルが2行になることがあるらしい
         while !content.gsub!(/(\/\/table.*\s)\.(\s.*?\/\/})/m, "\\1#{@table_empty_replace}\\2").nil? do
         end
-        delete_inline_command(content , 'xsmall')
-        delete_inline_command(content , 'weak')
+        # Re:VIEW Starter commands
+        replace_compatible_block_command_outline(content, 'terminal', 'cmd', 1)
+        replace_compatible_block_command_to_outside(content, 'sideimage', 'image', 1, '[]')
+        replace_block_command_outline(content, 'abstract', 'lead', true)
+        delete_block_command(content, 'needvspace')
+        delete_block_command(content, 'clearpage')
+        delete_block_command(content, 'flushright')
+        delete_block_command(content, 'centering')
+        delete_block_command(content, 'noindent')
+        delete_block_command(content, 'paragraphend')
+
+        replace_inline_command(content, 'secref', 'hd')
+        replace_inline_command(content, 'file', 'kw')
+        replace_inline_command(content, 'hlink', 'href')
+        replace_inline_command(content, 'B', 'strong')
+        delete_inline_command(content, 'userinput')
+        delete_inline_command(content, 'weak')
+        delete_inline_command(content, 'cursor')
+        # font size
+        delete_inline_command(content, 'small')
+        delete_inline_command(content, 'xsmall')
+        delete_inline_command(content, 'xxsmall')
+        delete_inline_command(content, 'large')
+        delete_inline_command(content, 'xlarge')
+        delete_inline_command(content, 'xxlarge')
+
+        # fixed lack of options
+        content.gsub!(/^\/\/list{/, '//list[][]{')
+
+        # special command
+        replace_sampleoutput(content)
+
+        # nested command
+        replace_block_command_nested_boxed_articles(content)
+
+        # empty ids
+        replace_auto_ids(content, 'list', 2)
+        replace_auto_ids(content, 'listnum', 2)
+
+        # remove starter extension
+        remove_starter_refid(content)
+        remove_starter_options(content)
+
+        # special charactor
+        content.gsub!('@<LaTeX>{}', 'LaTeX')
+        content.gsub!('@<TeX>{}', 'TeX')
+        content.gsub!('@<hearts>{}', '!HEART!')
+
+        # nop replace must be last step
+        content.gsub!('@<nop>$$', '@<b>$$')
+        content.gsub!('@<nop>||', '@<b>||')
+        content.gsub!('@<nop>{}', '@<b>{}')
+
+        # expand nested inline command
+        expand_nested_inline_command(content)
+
         File.write(contentfile, content)
         copy_embedded_contents(outdir, content)
       end
@@ -128,7 +353,7 @@ module ReVIEW
         yamlfile = @config['catalogfile']
         abspath = File.absolute_path(outdir)
         contentdir = abspath
-        info 'replace //sideimage to //image'
+        info 'replace starter block command'
         info 'replace starter inline command'
         if options['strict']
           catalog = ReVIEW::Catalog.new(File.open(File.join(abspath, yamlfile)))