review 4.0.0 → 5.1.1

data/lib/review/epubmaker/reviewheaderlistener.rb

@@ -7,6 +7,15 @@
 #
 module ReVIEW
   class EPUBMaker
+    # Listener class to scan HTML and get heading information
+    #
+    # The heading information this listener will retrieve is as follows:
+    #
+    # * level: Heading level (1..6)
+    # * id: HTMl ID attribute. Basically the `id` attribute of the h(1-6) element, but if there is an `a` element within the h(1-6) element, it will be its `id` attribute.
+    # * title: The title string of the headline. Usually, it is the text within the h(1-6) element, but if there is an `img` element, it will be the text with its `alt` attribute.
+    # * notoc: The `notoc` attribute of the headline element.
+    #
     class ReVIEWHeaderListener
       include REXML::StreamListener
       def initialize(headlines)
@@ -18,10 +27,11 @@ module ReVIEW
       def tag_start(name, attrs)
         if name =~ /\Ah(\d+)/
           raise "#{name}, #{attrs}" if @level.present?
+
           @level = $1.to_i
           @id = attrs['id'] if attrs['id'].present?
           @notoc = attrs['notoc'] if attrs['notoc'].present?
-        elsif !@level.nil?
+        elsif @level.present? # if in <hN> tag
           if name == 'img' && attrs['alt'].present?
             @content << attrs['alt']
           elsif name == 'a' && attrs['id'].present?
@@ -49,7 +59,7 @@ module ReVIEW
 
       def text(text)
         if @level.present?
-          @content << text.gsub("\t", '　')
+          @content << text.tr("\t", '　')
         end
       end
     end

data/lib/review/epubmaker/zip_exporter.rb

@@ -0,0 +1,84 @@
+# Copyright (c) 2010-2017 Kenshi Muto and Masayoshi Takahashi
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+
+require 'pathname'
+begin
+  require 'zip'
+rescue LoadError
+  ## I cannot find rubyzip library, so I use external zip command.
+  warn 'rubyzip not found, so use external zip command'
+end
+
+module ReVIEW
+  class EPUBMaker
+    ##
+    # Export into zip file for EPUB producer.
+    #
+    class ZipExporter
+      attr_reader :tmpdir
+
+      def initialize(tmpdir, config)
+        @tmpdir = tmpdir
+        @config = config
+      end
+
+      def export_zip(epubfile)
+        if defined?(Zip)
+          export_zip_rubyzip(epubfile)
+        else
+          export_zip_extcmd(epubfile)
+        end
+      end
+
+      def export_zip_extcmd(epubfile)
+        stage1 = @config['epubmaker']['zip_stage1'].to_s.split
+        path1 = stage1[0] || 'zip'
+        opt1 = stage1[1] || '-0Xq'
+        stage2 = @config['epubmaker']['zip_stage2'].to_s.split
+        path2 = stage2[0] || 'zip'
+        opt2 = stage2[1] || '-Xr9Dq'
+
+        Dir.chdir(tmpdir) do
+          system(path1, opt1, epubfile, 'mimetype')
+          addpath = @config['epubmaker']['zip_addpath']
+          if addpath
+            system(path2, opt2, epubfile, 'META-INF', 'OEBPS', addpath)
+          else
+            system(path2, opt2, epubfile, 'META-INF', 'OEBPS')
+          end
+        end
+      end
+
+      def export_zip_rubyzip(epubfile)
+        Dir.chdir(tmpdir) do
+          Zip::OutputStream.open(epubfile) do |epub|
+            root_pathname = Pathname.new(tmpdir)
+            epub.put_next_entry('mimetype', nil, nil, Zip::Entry::STORED)
+            epub << 'application/epub+zip'
+
+            export_zip_rubyzip_addpath(epub, File.join(tmpdir, 'META-INF'), root_pathname)
+            export_zip_rubyzip_addpath(epub, File.join(tmpdir, 'OEBPS'), root_pathname)
+            if @config['zip_addpath'].present?
+              export_zip_rubyzip_addpath(epub, File.join(tmpdir, @config['zip_addpath']), root_pathname)
+            end
+          end
+        end
+      end
+
+      def export_zip_rubyzip_addpath(epub, dirname, rootdir)
+        Dir[File.join(dirname, '**', '**')].each do |path|
+          next if File.directory?(path)
+
+          relpath = Pathname.new(path).relative_path_from(rootdir)
+          epub.put_next_entry(relpath)
+          epub << File.binread(path)
+        end
+      end
+    end
+  end
+end

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/extentions/string.rb

@@ -2,7 +2,3 @@ if defined?(Encoding) && Encoding.respond_to?('default_external') &&
    Encoding.default_external != Encoding::UTF_8
   Encoding.default_external = 'UTF-8'
 end
-
-class String
-  alias_method :each, :each_line
-end

data/lib/review/htmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #               2002-2007 Minero Aoki
 #
@@ -41,10 +41,6 @@ module ReVIEW
       ".#{@book.config['htmlext']}"
     end
 
-    def builder_init
-    end
-    private :builder_init
-
     def builder_init_file
       @noindent = nil
       @ol_num = nil
@@ -57,6 +53,7 @@ module ReVIEW
       @first_line_num = nil
       @body_ext = nil
       @toc = nil
+      @javascripts = []
     end
     private :builder_init_file
 
@@ -78,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.)
@@ -92,7 +90,7 @@ module ReVIEW
     def result
       # default XHTML header/footer
       @title = strip_html(compile_inline(@chapter.title))
-      @body = @output.string
+      @body = solve_nest(@output.string)
       @language = @book.config['language']
       @stylesheets = @book.config['stylesheet']
       @next = @chapter.next_chapter
@@ -104,9 +102,28 @@ 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
 
+    def solve_nest(s)
+      check_nest
+      s.gsub("</dd>\n</dl>\n\x01→dl←\x01", '').
+        gsub("\x01→/dl←\x01", "</dd>\n</dl>←END\x01").
+        gsub("</li>\n</ul>\n\x01→ul←\x01", '').
+        gsub("\x01→/ul←\x01", "</li>\n</ul>←END\x01").
+        gsub("</li>\n</ol>\n\x01→ol←\x01", '').
+        gsub("\x01→/ol←\x01", "</li>\n</ol>←END\x01").
+        gsub("</dl>←END\x01\n<dl>", '').
+        gsub("</ul>←END\x01\n<ul>", '').
+        gsub("</ol>←END\x01\n<ol>", '').
+        gsub("←END\x01", '')
+    end
+
     def xmlns_ops_prefix
       if @book.config['epubversion'].to_i == 3
         'epub'
@@ -139,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
@@ -154,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
@@ -169,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
@@ -228,6 +248,7 @@ module ReVIEW
     end
 
     def captionblock(type, lines, caption)
+      check_nested_minicolumn
       puts %Q(<div class="#{type}">)
       if caption.present?
         puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
@@ -286,15 +307,25 @@ module ReVIEW
     end
 
     def box(lines, caption = nil)
-      puts %Q(<div class="syntax">)
+      captionstr = nil
       if caption.present?
-        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+        captionstr = %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
+      puts %Q(<div class="syntax">)
+
+      if caption_top?('list') && caption.present?
+        puts captionstr
       end
+
       print %Q(<pre class="syntax">)
       lines.each do |line|
         puts detab(line)
       end
       puts '</pre>'
+
+      if !caption_top?('list') && caption.present?
+        puts captionstr
+      end
       puts '</div>'
     end
 
@@ -302,6 +333,24 @@ module ReVIEW
       captionblock('note', lines, caption)
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          puts %Q(<div class="#{name}">)
+          if caption.present?
+            puts %Q(<p class="caption">\#{compile_inline(caption)}</p>)
+          end
+        end
+
+        def #{name}_end
+          puts '</div>'
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def ul_begin
       puts '<ul>'
     end
@@ -373,12 +422,7 @@ module ReVIEW
 
     def list(lines, id, caption, lang = nil)
       puts %Q(<div id="#{normalize_id(id)}" class="caption-code">)
-      begin
-        list_header(id, caption, lang)
-      rescue KeyError
-        error "no such list: #{id}"
-      end
-      list_body(id, lines, lang)
+      super(lines, id, caption, lang)
       puts '</div>'
     end
 
@@ -403,8 +447,7 @@ module ReVIEW
 
     def source(lines, caption = nil, lang = nil)
       puts %Q(<div class="source-code">)
-      source_header(caption)
-      source_body(caption, lines, lang)
+      super(lines, caption, lang)
       puts '</div>'
     end
 
@@ -414,7 +457,7 @@ module ReVIEW
       end
     end
 
-    def source_body(_id, lines, lang)
+    def source_body(lines, lang)
       print %Q(<pre class="source">)
       body = lines.inject('') { |i, j| i + detab(j) + "\n" }
       lexer = lang
@@ -424,12 +467,7 @@ module ReVIEW
 
     def listnum(lines, id, caption, lang = nil)
       puts %Q(<div id="#{normalize_id(id)}" class="code">)
-      begin
-        list_header(id, caption, lang)
-      rescue KeyError
-        error "no such list: #{id}"
-      end
-      listnum_body(lines, lang)
+      super(lines, id, caption, lang)
       puts '</div>'
     end
 
@@ -455,7 +493,7 @@ module ReVIEW
 
     def emlist(lines, caption = nil, lang = nil)
       puts %Q(<div class="emlist-code">)
-      if caption.present?
+      if caption_top?('list') && caption.present?
         puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
       end
       class_names = ['emlist']
@@ -466,12 +504,15 @@ module ReVIEW
       lexer = lang
       puts highlight(body: body, lexer: lexer, format: 'html')
       puts '</pre>'
+      if !caption_top?('list') && caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
       puts '</div>'
     end
 
     def emlistnum(lines, caption = nil, lang = nil)
       puts %Q(<div class="emlistnum-code">)
-      if caption.present?
+      if caption_top?('list') && caption.present?
         puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
       end
 
@@ -493,19 +534,29 @@ module ReVIEW
         puts '</pre>'
       end
 
+      if !caption_top?('list') && caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
+
       puts '</div>'
     end
 
     def cmd(lines, caption = nil)
       puts %Q(<div class="cmd-code">)
-      if caption.present?
+      if caption_top?('list') && caption.present?
         puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
       end
+
       print %Q(<pre class="cmd">)
       body = lines.inject('') { |i, j| i + detab(j) + "\n" }
       lexer = 'shell-session'
       puts highlight(body: body, lexer: lexer, format: 'html')
       puts '</pre>'
+
+      if !caption_top?('list') && caption.present?
+        puts %Q(<p class="caption">#{compile_inline(caption)}</p>)
+      end
+
       puts '</div>'
     end
 
@@ -541,12 +592,13 @@ module ReVIEW
     def texequation(lines, id = nil, caption = '')
       if id
         puts %Q(<div id="#{normalize_id(id)}" class="caption-equation">)
-        texequation_header(id, caption)
+        texequation_header(id, caption) if caption_top?('equation')
       end
 
       texequation_body(lines)
 
       if id
+        texequation_header(id, caption) unless caption_top?('equation')
         puts '</div>'
       end
     end
@@ -561,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
@@ -614,20 +669,22 @@ module ReVIEW
     def image_image(id, caption, metric)
       metrics = parse_metric('html', metric)
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
+      image_header(id, caption) if caption_top?('image')
       puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
-      image_header(id, caption)
+      image_header(id, caption) unless caption_top?('image')
       puts '</div>'
     end
 
     def image_dummy(id, caption, lines)
       warn "image not bound: #{id}"
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
+      image_header(id, caption) if caption_top?('image')
       puts %Q(<pre class="dummyimage">)
       lines.each do |line|
         puts detab(line)
       end
       puts '</pre>'
-      image_header(id, caption)
+      image_header(id, caption) unless caption_top?('image')
       puts '</div>'
     end
 
@@ -690,15 +747,19 @@ module ReVIEW
 
       puts %Q(<div id="#{normalize_id(id)}" class="imgtable image">)
       begin
-        if caption.present?
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+
+        imgtable_image(id, caption, metric)
+
+        if !caption_top?('table') && caption.present?
           table_header(id, caption)
         end
       rescue KeyError
         error "no such table: #{id}"
       end
 
-      imgtable_image(id, caption, metric)
-
       puts '</div>'
     end
 
@@ -713,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 />')
@@ -735,7 +797,19 @@ module ReVIEW
     def indepimage(lines, id, caption = '', metric = nil)
       metrics = parse_metric('html', metric)
       caption = '' unless caption.present?
+      caption_str = nil
+      if caption.present?
+        caption_str = <<-EOS
+<p class="caption">
+#{I18n.t('numberless_image')}#{I18n.t('caption_prefix')}#{compile_inline(caption)}
+</p>
+EOS
+      end
+
       puts %Q(<div id="#{normalize_id(id)}" class="image">)
+      if caption_top?('image') && caption.present?
+        puts caption_str
+      end
       begin
         puts %Q(<img src="#{@chapter.image(id).path.sub(%r{\A\./}, '')}" alt="#{escape(compile_inline(caption))}"#{metrics} />)
       rescue
@@ -749,10 +823,8 @@ module ReVIEW
         end
       end
 
-      if caption.present?
-        puts %Q(<p class="caption">)
-        puts %Q(#{I18n.t('numberless_image')}#{I18n.t('caption_prefix')}#{compile_inline(caption)})
-        puts '</p>'
+      if !caption_top?('image') && caption.present?
+        puts caption_str
       end
       puts '</div>'
     end
@@ -913,22 +985,25 @@ module ReVIEW
     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
@@ -972,7 +1047,7 @@ module ReVIEW
         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
@@ -989,7 +1064,7 @@ module ReVIEW
 
     def inline_column_chap(chapter, id)
       if @book.config['chapterlink']
-        %Q(<a href="\##{column_label(id, chapter)}" class="columnref">#{I18n.t('column', compile_inline(chapter.column(id).caption))}</a>)
+        %Q(<a href="#{chapter.id}#{extname}##{column_label(id, chapter)}" class="columnref">#{I18n.t('column', compile_inline(chapter.column(id).caption))}</a>)
       else
         I18n.t('column', compile_inline(chapter.column(id).caption))
       end
@@ -1151,7 +1226,7 @@ module ReVIEW
       %Q(<span class="balloon">#{escape_html(str)}</span>)
     end
 
-    def inline_raw(str)
+    def inline_raw(str) # rubocop:disable Lint/UselessMethodDefinition
       super(str)
     end
 
@@ -1182,35 +1257,5 @@ module ReVIEW
     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