review 5.0.0 → 5.1.0

data/lib/review/exception.rb

@@ -10,10 +10,16 @@
 
 module ReVIEW
   class Error < ::StandardError; end
+
   class ApplicationError < Error; end
+
   class ConfigError < ApplicationError; end
+
   class CompileError < ApplicationError; end
+
   class SyntaxError < CompileError; end
+
   class FileNotFound < ApplicationError; end
+
   class KeyError < CompileError; end
 end

data/lib/review/htmlbuilder.rb

@@ -53,6 +53,7 @@ module ReVIEW
       @first_line_num = nil
       @body_ext = nil
       @toc = nil
+      @javascripts = []
     end
     private :builder_init_file
 
@@ -74,6 +75,7 @@ module ReVIEW
       if !File.exist?(layout_file) && File.exist?(File.join(@book.basedir, 'layouts', 'layout.erb'))
         raise ReVIEW::ConfigError, 'layout.erb is obsoleted. Please use layout.html.erb.'
       end
+
       if File.exist?(layout_file)
         if ENV['REVIEW_SAFE_MODE'].to_i & 4 > 0
           warn %Q(user's layout is prohibited in safe mode. ignored.)
@@ -100,6 +102,11 @@ module ReVIEW
         @toc = ReVIEW::WEBTOCPrinter.book_to_string(@book)
       end
 
+      if @book.config['math_format'] == 'mathjax'
+        @javascripts.push(%Q(<script>MathJax = { tex: { inlineMath: [['\\\\(', '\\\\)']] }, svg: { fontCache: 'global' } };</script>))
+        @javascripts.push(%Q(<script type="text/javascript" id="MathJax-script" async="true" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>))
+      end
+
       ReVIEW::Template.load(layoutfile).result(binding)
     end
 
@@ -149,6 +156,7 @@ module ReVIEW
       @nonum_counter += 1
       puts if level > 1
       return unless caption.present?
+
       if label
         puts %Q(<h#{level} id="#{normalize_id(label)}">#{compile_inline(caption)}</h#{level}>)
       else
@@ -164,6 +172,7 @@ module ReVIEW
       @nonum_counter += 1
       puts if level > 1
       return unless caption.present?
+
       if label
         puts %Q(<h#{level} id="#{normalize_id(label)}" notoc="true">#{compile_inline(caption)}</h#{level}>)
       else
@@ -179,6 +188,7 @@ module ReVIEW
       @nonum_counter += 1
       puts '' if level > 1
       return unless caption.present?
+
       if label
         puts %Q(<a id="#{normalize_id(label)}" /><h#{level} id="#{normalize_id(label)}" hidden="true">#{compile_inline(caption)}</h#{level}>)
       else
@@ -603,24 +613,27 @@ module ReVIEW
 
     def texequation_body(lines)
       puts %Q(<div class="equation">)
-      if @book.config['mathml']
-        require 'math_ml'
-        require 'math_ml/symbol/character_reference'
+      if @book.config['math_format'] == 'mathml'
+        begin
+          require 'math_ml'
+          require 'math_ml/symbol/character_reference'
+        rescue LoadError
+          error 'not found math_ml'
+        end
         p = MathML::LaTeX::Parser.new(symbol: MathML::Symbol::CharacterReference)
         print p.parse(lines.join("\n") + "\n", true)
-      elsif @book.config['imgmath']
+      elsif @book.config['math_format'] == 'mathjax'
+        puts "$$#{lines.join("\n")}$$"
+      elsif @book.config['math_format'] == 'imgmath'
         fontsize = @book.config['imgmath_options']['fontsize'].to_f
         lineheight = @book.config['imgmath_options']['lineheight'].to_f
         math_str = "\\begin{equation*}\n\\fontsize{#{fontsize}}{#{lineheight}}\\selectfont\n#{lines.join("\n")}\n\\end{equation*}\n"
         key = Digest::SHA256.hexdigest(math_str)
-        math_dir = File.join(@book.config['imagedir'], '_review_math')
-        Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
-        img_path = File.join(math_dir, "_gen_#{key}.#{@book.config['imgmath_options']['format']}")
         if @book.config.check_version('2', exception: false)
-          make_math_image(math_str, img_path)
+          img_path = @img_math.make_math_image(math_str, key)
           puts %Q(<img src="#{img_path}" />)
         else
-          defer_math_image(math_str, img_path, key)
+          img_path = @img_math.defer_math_image(math_str, key)
           puts %Q(<img src="#{img_path}" class="math_gen_#{key}" alt="#{escape(lines.join(' '))}" />)
         end
       else
@@ -761,6 +774,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       lines.unshift(escape(comment)) unless comment.blank?
       str = lines.join('<br />')
@@ -971,22 +985,25 @@ EOS
     end
 
     def inline_m(str)
-      if @book.config['mathml']
-        require 'math_ml'
-        require 'math_ml/symbol/character_reference'
+      if @book.config['math_format'] == 'mathml'
+        begin
+          require 'math_ml'
+          require 'math_ml/symbol/character_reference'
+        rescue LoadError
+          error 'not found math_ml'
+        end
         parser = MathML::LaTeX::Parser.new(symbol: MathML::Symbol::CharacterReference)
         %Q(<span class="equation">#{parser.parse(str, nil)}</span>)
-      elsif @book.config['imgmath']
+      elsif @book.config['math_format'] == 'mathjax'
+        %Q(<span class="equation">\\( #{str} \\)</span>)
+      elsif @book.config['math_format'] == 'imgmath'
         math_str = '$' + str + '$'
         key = Digest::SHA256.hexdigest(str)
-        math_dir = File.join(@book.config['imagedir'], '_review_math')
-        Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
-        img_path = File.join(math_dir, "_gen_#{key}.#{@book.config['imgmath_options']['format']}")
         if @book.config.check_version('2', exception: false)
-          make_math_image(math_str, img_path)
+          img_path = @img_math.make_math_image(math_str, key)
           %Q(<span class="equation"><img src="#{img_path}" /></span>)
         else
-          defer_math_image(math_str, img_path, key)
+          img_path = @img_math.defer_math_image(math_str, key)
           %Q(<span class="equation"><img src="#{img_path}" class="math_gen_#{key}" alt="#{escape(str)}" /></span>)
         end
       else
@@ -1030,7 +1047,7 @@ EOS
         str = I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
       if @book.config['chapterlink']
-        anchor = 'h' + n.gsub('.', '-')
+        anchor = 'h' + n.tr('.', '-')
         %Q(<a href="#{chap.id}#{extname}##{anchor}">#{str}</a>)
       else
         str
@@ -1240,35 +1257,5 @@ EOS
     def olnum(num)
       @ol_num = num.to_i
     end
-
-    def make_math_image(str, path, fontsize = 12)
-      # Re:VIEW 2 compatibility
-      fontsize2 = (fontsize * 1.2).round.to_i
-      texsrc = <<-EOB
-\\documentclass[12pt]{article}
-\\usepackage[utf8]{inputenc}
-\\usepackage{amsmath}
-\\usepackage{amsthm}
-\\usepackage{amssymb}
-\\usepackage{amsfonts}
-\\usepackage{anyfontsize}
-\\usepackage{bm}
-\\pagestyle{empty}
-
-\\begin{document}
-\\fontsize{#{fontsize}}{#{fontsize2}}\\selectfont #{str}
-\\end{document}
-      EOB
-      Dir.mktmpdir do |tmpdir|
-        tex_path = File.join(tmpdir, 'tmpmath.tex')
-        dvi_path = File.join(tmpdir, 'tmpmath.dvi')
-        File.write(tex_path, texsrc)
-        cmd = "latex --interaction=nonstopmode --output-directory=#{tmpdir} #{tex_path} && dvipng -T tight -z9 -o #{path} #{dvi_path}"
-        out, status = Open3.capture2e(cmd)
-        unless status.success?
-          error "latex compile error\n\nError log:\n" + out
-        end
-      end
-    end
   end
 end # module ReVIEW

data/lib/review/htmlutils.rb

@@ -134,7 +134,7 @@ module ReVIEW
       elsif id =~ /\A[0-9_.-][a-z0-9_.-]*\Z/i
         "id_#{id}" # dummy prefix
       else
-        "id_#{CGI.escape(id.gsub('_', '__')).gsub('%', '_').gsub('+', '-')}" # escape all
+        "id_#{CGI.escape(id.gsub('_', '__')).tr('%', '_').tr('+', '-')}" # escape all
       end
     end
   end

data/lib/review/i18n.rb

@@ -91,6 +91,7 @@ module ReVIEW
       else
         user_i18n.each do |key, values|
           raise KeyError, "Invalid locale file: #{path}" unless values.is_a?(Hash)
+
           @store[key].merge!(values)
         end
       end

data/lib/review/idgxmlbuilder.rb

@@ -103,15 +103,9 @@ module ReVIEW
     end
 
     def headline(level, label, caption)
+      output_close_sect_tags(level)
       case level
       when 1
-        if @secttags
-          print '</sect4>' if @subsubsubsection > 0
-          print '</sect3>' if @subsubsection > 0
-          print '</sect2>' if @subsection > 0
-          print '</sect>' if @section > 0
-        end
-
         print %Q(<chapter id="chap:#{@chapter.number}">) if @secttags
 
         @section = 0
@@ -119,12 +113,6 @@ module ReVIEW
         @subsubsection = 0
         @subsubsubsection = 0
       when 2
-        if @secttags
-          print '</sect4>' if @subsubsubsection > 0
-          print '</sect3>' if @subsubsection > 0
-          print '</sect2>' if @subsection > 0
-          print '</sect>' if @section > 0
-        end
         @section += 1
         print %Q(<sect id="sect:#{@chapter.number}.#{@section}">) if @secttags
 
@@ -132,30 +120,17 @@ module ReVIEW
         @subsubsection = 0
         @subsubsubsection = 0
       when 3
-        if @secttags
-          print '</sect4>' if @subsubsubsection > 0
-          print '</sect3>' if @subsubsection > 0
-          print '</sect2>' if @subsection > 0
-        end
-
         @subsection += 1
         print %Q(<sect2 id="sect:#{@chapter.number}.#{@section}.#{@subsection}">) if @secttags
 
         @subsubsection = 0
         @subsubsubsection = 0
       when 4
-        if @secttags
-          print '</sect4>' if @subsubsubsection > 0
-          print '</sect3>' if @subsubsection > 0
-        end
-
         @subsubsection += 1
         print %Q(<sect3 id="sect:#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}">) if @secttags
 
         @subsubsubsection = 0
       when 5
-        print '</sect4>' if @secttags && @subsubsubsection > 0
-
         @subsubsubsection += 1
         print %Q(<sect4 id="sect:#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}.#{@subsubsubsection}">) if @secttags
       when 6 # rubocop:disable Lint/EmptyWhen
@@ -170,6 +145,23 @@ module ReVIEW
       puts %Q(<title#{label} aid:pstyle="h#{level}">#{prefix}#{compile_inline(caption)}</title><?dtp level="#{level}" section="#{prefix}#{toccaption}"?>)
     end
 
+    def output_close_sect_tags(level)
+      if @secttags
+        if level <= 5 && @subsubsubsection > 0
+          print '</sect4>'
+        end
+        if level <= 4 && @subsubsection > 0
+          print '</sect3>'
+        end
+        if level <= 3 && @subsection > 0
+          print '</sect2>'
+        end
+        if level <= 2 && @section > 0
+          print '</sect>'
+        end
+      end
+    end
+
     def ul_begin
       level = block_given? ? yield : ''
       level = nil if level == 1
@@ -282,6 +274,7 @@ module ReVIEW
 
     def list_header(id, caption, _lang)
       return true unless caption.present?
+
       if get_chap.nil?
         puts %Q(<caption>#{I18n.t('list')}#{I18n.t('format_number_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
       else
@@ -448,6 +441,7 @@ module ReVIEW
 
     def image_header(id, caption)
       return true unless caption.present?
+
       if get_chap.nil?
         puts %Q(<caption>#{I18n.t('image')}#{I18n.t('format_number_without_chapter', [@chapter.image(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
       else
@@ -640,6 +634,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       lines.unshift(escape(comment)) unless comment.blank?
       str = lines.join("\n")
@@ -674,7 +669,7 @@ module ReVIEW
         then escape("#{word}（#{alt.strip}）")
         else escape(word)
         end +
-      '</keyword>' +
+        '</keyword>' +
         %Q(<index value="#{escape(word)}" />) +
         if alt
           alt.split(/\s*,\s*/).collect! { |e| %Q(<index value="#{escape(e.strip)}" />) }.join
@@ -773,6 +768,14 @@ module ReVIEW
       %Q(<underline>#{escape(str)}</underline>)
     end
 
+    def inline_ins(str)
+      %Q(<ins>#{escape(str)}</ins>)
+    end
+
+    def inline_del(str)
+      %Q(<del>#{escape(str)}</del>)
+    end
+
     def inline_icon(id)
       begin
         %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A\./}, '')}" type="inline" />)
@@ -1182,10 +1185,10 @@ module ReVIEW
         chs = ['', '「', '」']
         if @book.config['chapref']
           chs2 = @book.config['chapref'].split(',')
-          if chs2.size != 3
-            error '--chapsplitter must have exactly 3 parameters with comma.'
-          else
+          if chs2.size == 3
             chs = chs2
+          else
+            error '--chapsplitter must have exactly 3 parameters with comma.'
           end
         end
         s = "#{chs[0]}#{@book.chapter_index.number(id)}#{chs[1]}#{@book.chapter_index.title(id)}#{chs[2]}"

data/lib/review/idgxmlmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2019 Kenshi Muto
+# Copyright (c) 2019-2021 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -86,8 +86,10 @@ module ReVIEW
       I18n.setup(@config['language'])
       begin
         generate_idgxml_files(yamlfile)
+        @logger.success("built #{build_path}")
       rescue ApplicationError => e
         raise if @config['debug']
+
         error(e.message)
       end
     end

data/lib/review/img_math.rb

@@ -0,0 +1,245 @@
+require 'fileutils'
+require 'shellwords'
+
+module ReVIEW
+  class ImgMath
+    def initialize(config, path_name: '_review_math')
+      @config = config
+      @logger = ReVIEW.logger
+      @math_dir = File.join(@config['imagedir'], path_name)
+      @math_maps = {}
+    end
+
+    def cleanup_mathimg
+      if @config['math_format'] == 'imgmath' && Dir.exist?(@math_dir)
+        FileUtils.rm_rf(@math_dir)
+      end
+    end
+
+    def defer_math_image(str, key)
+      # for Re:VIEW >3
+      @math_maps[key] = str
+      File.join(@math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")
+    end
+
+    def make_math_image(str, key, fontsize = 12)
+      # Re:VIEW 2 compatibility
+
+      img_path = File.join(@math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")
+      Dir.mkdir(@math_dir) unless Dir.exist?(@math_dir)
+      fontsize2 = (fontsize * 1.2).round.to_i
+      texsrc = <<-EOB
+\\documentclass[12pt]{article}
+\\usepackage[utf8]{inputenc}
+\\usepackage{amsmath}
+\\usepackage{amsthm}
+\\usepackage{amssymb}
+\\usepackage{amsfonts}
+\\usepackage{anyfontsize}
+\\usepackage{bm}
+\\pagestyle{empty}
+
+\\begin{document}
+\\fontsize{#{fontsize}}{#{fontsize2}}\\selectfont #{str}
+\\end{document}
+      EOB
+      Dir.mktmpdir do |tmpdir|
+        tex_path = File.join(tmpdir, 'tmpmath.tex')
+        dvi_path = File.join(tmpdir, 'tmpmath.dvi')
+        File.write(tex_path, texsrc)
+        cmd = "latex --interaction=nonstopmode --output-directory=#{tmpdir} #{tex_path} && dvipng -T tight -z9 -o #{img_path} #{dvi_path}"
+        out, status = Open3.capture2e(cmd)
+        unless status.success?
+          raise ApplicationError, "latex compile error\n\nError log:\n" + out
+        end
+
+        img_path
+      end
+    end
+
+    def make_math_images
+      return if @math_maps.empty?
+
+      Dir.mkdir(@math_dir) unless Dir.exist?(@math_dir)
+      fontsize = @config['imgmath_options']['fontsize'].to_f
+      lineheight = @config['imgmath_options']['lineheight'].to_f
+
+      texsrc = default_imgmath_preamble
+      if @config['imgmath_options']['preamble_file'] && File.readable?(@config['imgmath_options']['preamble_file'])
+        texsrc = File.read(@config['imgmath_options']['preamble_file'])
+      end
+
+      texsrc << <<-EOB
+\\begin{document}
+\\fontsize{#{fontsize}}{#{lineheight}}\\selectfont
+\\input{__IMGMATH_BODY__}
+\\end{document}
+      EOB
+
+      math_real_dir = File.realpath(@math_dir)
+      Dir.mktmpdir do |tmpdir|
+        File.open(File.join(tmpdir, '__IMGMATH_BODY__.tex'), 'w') do |f|
+          @math_maps.keys.sort.each do |key|
+            f.puts "% #{key}"
+            f.puts @math_maps[key]
+            f.puts '\\clearpage'
+            f.puts
+          end
+        end
+
+        tex_path = File.join(tmpdir, '__IMGMATH__.tex')
+        File.write(tex_path, texsrc)
+
+        begin
+          case @config['imgmath_options']['converter']
+          when 'pdfcrop'
+            make_math_images_pdfcrop(tmpdir, tex_path, math_real_dir)
+          when 'dvipng'
+            make_math_images_dvipng(tmpdir, tex_path, math_real_dir)
+          else
+            error "unknown math converter error. imgmath_options/converter parameter should be 'pdfcrop' or 'dvipng'."
+            exit 1
+          end
+        rescue CompileError
+          FileUtils.cp([tex_path,
+                        File.join(File.dirname(tex_path), '__IMGMATH__.log')],
+                       math_real_dir)
+          error "LaTeX math compile error. See #{math_real_dir}/__IMGMATH__.log for details."
+          exit 1
+        end
+      end
+      @math_maps.clear
+    end
+
+    private
+
+    def error(msg)
+      @logger.error msg
+    end
+
+    def warn(msg)
+      @logger.warn msg
+    end
+
+    def default_imgmath_preamble
+      <<-EOB
+\\documentclass[uplatex,a3paper,landscape]{jsarticle}
+\\usepackage[deluxe,uplatex]{otf}
+\\usepackage[T1]{fontenc}
+\\usepackage{textcomp}
+\\usepackage{lmodern}
+\\usepackage[dvipdfmx]{graphicx}
+\\usepackage[dvipdfmx,table]{xcolor}
+\\usepackage[utf8]{inputenc}
+\\usepackage{ascmac}
+\\usepackage{float}
+\\usepackage{alltt}
+\\usepackage{amsmath}
+\\usepackage{amssymb}
+\\usepackage{amsfonts}
+\\usepackage{anyfontsize}
+\\usepackage{bm}
+\\pagestyle{empty}
+% \\setpaperwidth{1000mm}
+      EOB
+    end
+
+    def make_math_images_pdfcrop(dir, tex_path, math_real_dir)
+      Dir.chdir(dir) do
+        dvi_path = '__IMGMATH__.dvi'
+        pdf_path = '__IMGMATH__.pdf'
+        out, status = Open3.capture2e(*[@config['texcommand'], @config['texoptions'].shellsplit, tex_path].flatten.compact)
+        if !status.success? || (!File.exist?(dvi_path) && !File.exist?(pdf_path))
+          raise CompileError
+        end
+
+        if File.exist?(dvi_path)
+          out, status = Open3.capture2e(*[@config['dvicommand'], @config['dvioptions'].shellsplit, dvi_path].flatten.compact)
+          if !status.success? || !File.exist?(pdf_path)
+            warn "error in #{@config['dvicommand']}. Error log:\n#{out}"
+            raise CompileError
+          end
+        end
+        args = @config['imgmath_options']['pdfcrop_cmd'].shellsplit
+        args.map! do |m|
+          m.sub('%i', pdf_path).
+            sub('%o', '__IMGMATH__pdfcrop.pdf')
+        end
+        out, status = Open3.capture2e(*args)
+        unless status.success?
+          warn "error in pdfcrop. Error log:\n#{out}"
+          raise CompileError
+        end
+        pdf_path = '__IMGMATH__pdfcrop.pdf'
+        pdf_path2 = pdf_path
+
+        @math_maps.keys.sort.each_with_index do |key, idx|
+          page = idx + 1
+          if File.exist?(File.join(math_real_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}"))
+            # made already
+            next
+          end
+
+          if @config['imgmath_options']['extract_singlepage']
+            # if extract_singlepage = true, split each page
+            args = @config['imgmath_options']['pdfextract_cmd'].shellsplit
+
+            args.map! do |m|
+              m.sub('%i', pdf_path).
+                sub('%o', "__IMGMATH__pdfcrop_p#{page}.pdf").
+                sub('%O', "__IMGMATH__pdfcrop_p#{page}").
+                sub('%p', page.to_s)
+            end
+            out, status = Open3.capture2e(*args)
+            unless status.success?
+              warn "error in pdf extracting. Error log:\n#{out}"
+              raise CompileError
+            end
+
+            pdf_path2 = "__IMGMATH__pdfcrop_p#{page}.pdf"
+          end
+
+          args = @config['imgmath_options']['pdfcrop_pixelize_cmd'].shellsplit
+          args.map! do |m|
+            m.sub('%i', pdf_path2).
+              sub('%t', @config['imgmath_options']['format']).
+              sub('%o', File.join(math_real_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")).
+              sub('%O', File.join(math_real_dir, "_gen_#{key}")).
+              sub('%p', page.to_s)
+          end
+          out, status = Open3.capture2e(*args)
+          unless status.success?
+            warn "error in pdf pixelizing. Error log:\n#{out}"
+            raise CompileError
+          end
+        end
+      end
+    end
+
+    def make_math_images_dvipng(dir, tex_path, math_real_dir)
+      Dir.chdir(dir) do
+        dvi_path = '__IMGMATH__.dvi'
+        out, status = Open3.capture2e(*[@config['texcommand'], @config['texoptions'].shellsplit, tex_path].flatten.compact)
+        if !status.success? || !File.exist?(dvi_path)
+          raise CompileError
+        end
+
+        @math_maps.keys.sort.each_with_index do |key, idx|
+          page = idx + 1
+          args = @config['imgmath_options']['dvipng_cmd'].shellsplit
+          args.map! do |m|
+            m.sub('%i', dvi_path).
+              sub('%o', File.join(math_real_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")).
+              sub('%O', File.join(math_real_dir, "_gen_#{key}")).
+              sub('%p', page.to_s)
+          end
+          out, status = Open3.capture2e(*args)
+          unless status.success?
+            warn "error in dvipng. Error log:\n#{out}"
+            raise CompileError
+          end
+        end
+      end
+    end
+  end
+end