review 3.2.0 → 4.0.0

data/lib/review/htmlbuilder.rb

@@ -12,7 +12,6 @@ require 'review/htmlutils'
 require 'review/template'
 require 'review/textutils'
 require 'review/webtocprinter'
-require 'digest'
 require 'tmpdir'
 require 'open3'
 
@@ -308,7 +307,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      print "<li>#{lines.join}"
+      print "<li>#{join_lines_to_paragraph(lines)}"
     end
 
     def ul_item_end
@@ -329,7 +328,7 @@ module ReVIEW
     end
 
     def ol_item(lines, _num)
-      puts "<li>#{lines.join}</li>"
+      puts "<li>#{join_lines_to_paragraph(lines)}</li>"
     end
 
     def ol_end
@@ -345,7 +344,7 @@ module ReVIEW
     end
 
     def dd(lines)
-      puts "<dd>#{lines.join}</dd>"
+      puts "<dd>#{join_lines_to_paragraph(lines)}</dd>"
     end
 
     def dl_end
@@ -354,10 +353,10 @@ module ReVIEW
 
     def paragraph(lines)
       if @noindent
-        puts %Q(<p class="noindent">#{lines.join}</p>)
+        puts %Q(<p class="noindent">#{join_lines_to_paragraph(lines)}</p>)
         @noindent = nil
       else
-        puts "<p>#{lines.join}</p>"
+        puts "<p>#{join_lines_to_paragraph(lines)}</p>"
       end
     end
 
@@ -375,11 +374,11 @@ 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
+        list_header(id, caption, lang)
       rescue KeyError
         error "no such list: #{id}"
       end
-      list_body id, lines, lang
+      list_body(id, lines, lang)
       puts '</div>'
     end
 
@@ -404,8 +403,8 @@ module ReVIEW
 
     def source(lines, caption = nil, lang = nil)
       puts %Q(<div class="source-code">)
-      source_header caption
-      source_body caption, lines, lang
+      source_header(caption)
+      source_body(caption, lines, lang)
       puts '</div>'
     end
 
@@ -426,11 +425,11 @@ module ReVIEW
     def listnum(lines, id, caption, lang = nil)
       puts %Q(<div id="#{normalize_id(id)}" class="code">)
       begin
-        list_header id, caption, lang
+        list_header(id, caption, lang)
       rescue KeyError
         error "no such list: #{id}"
       end
-      listnum_body lines, lang
+      listnum_body(lines, lang)
       puts '</div>'
     end
 
@@ -541,7 +540,8 @@ module ReVIEW
 
     def texequation(lines, id = nil, caption = '')
       if id
-        texequation_header id, caption
+        puts %Q(<div id="#{normalize_id(id)}" class="caption-equation">)
+        texequation_header(id, caption)
       end
 
       texequation_body(lines)
@@ -552,7 +552,6 @@ module ReVIEW
     end
 
     def texequation_header(id, caption)
-      puts %Q(<div id="#{normalize_id(id)}" class="caption-equation">)
       if get_chap
         puts %Q(<p class="caption">#{I18n.t('equation')}#{I18n.t('format_number_header', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}</p>)
       else
@@ -566,11 +565,11 @@ module ReVIEW
         require 'math_ml'
         require 'math_ml/symbol/character_reference'
         p = MathML::LaTeX::Parser.new(symbol: MathML::Symbol::CharacterReference)
-        puts p.parse(unescape(lines.join("\n")), true)
+        print p.parse(lines.join("\n") + "\n", true)
       elsif @book.config['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#{unescape(lines.join("\n"))}\n\\end{equation*}\n"
+        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)
@@ -616,7 +615,7 @@ module ReVIEW
       metrics = parse_metric('html', metric)
       puts %Q(<div id="#{normalize_id(id)}" class="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)
       puts '</div>'
     end
 
@@ -628,7 +627,7 @@ module ReVIEW
         puts detab(line)
       end
       puts '</pre>'
-      image_header id, caption
+      image_header(id, caption)
       puts '</div>'
     end
 
@@ -643,47 +642,12 @@ module ReVIEW
     end
 
     def table(lines, id = nil, caption = nil)
-      rows = []
-      sepidx = nil
-      lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
-          # just ignore
-          # error "too many table separator" if sepidx
-          sepidx ||= idx
-          next
-        end
-        rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
-      end
-      rows = adjust_n_cols(rows)
-      error 'no rows in the table' if rows.empty?
-
       if id
         puts %Q(<div id="#{normalize_id(id)}" class="table">)
       else
         puts %Q(<div class="table">)
       end
-      begin
-        if caption.present?
-          table_header id, caption
-        end
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      table_begin rows.first.size
-      if sepidx
-        sepidx.times do
-          tr(rows.shift.map { |s| th(s) })
-        end
-        rows.each do |cols|
-          tr(cols.map { |s| td(s) })
-        end
-      else
-        rows.each do |cols|
-          h, *cs = *cols
-          tr([th(h)] + cs.map { |s| td(s) })
-        end
-      end
-      table_end
+      super(lines, id, caption)
       puts '</div>'
     end
 
@@ -718,16 +682,16 @@ module ReVIEW
     end
 
     def imgtable(lines, id, caption = nil, metric = nil)
-      unless @chapter.image(id).bound?
+      unless @chapter.image_bound?(id)
         warn "image not bound: #{id}"
-        image_dummy id, caption, lines
+        image_dummy(id, caption, lines)
         return
       end
 
       puts %Q(<div id="#{normalize_id(id)}" class="imgtable image">)
       begin
         if caption.present?
-          table_header id, caption
+          table_header(id, caption)
         end
       rescue KeyError
         error "no such table: #{id}"
@@ -750,7 +714,7 @@ module ReVIEW
     def comment(lines, comment = nil)
       return unless @book.config['draft']
       lines ||= []
-      lines.unshift escape(comment) unless comment.blank?
+      lines.unshift(escape(comment)) unless comment.blank?
       str = lines.join('<br />')
       puts %Q(<div class="draft-comment">#{str}</div>)
     end
@@ -978,8 +942,8 @@ module ReVIEW
 
     def bibpaper(lines, id, caption)
       puts %Q(<div class="bibpaper">)
-      bibpaper_header id, caption
-      bibpaper_bibpaper id, caption, lines unless lines.empty?
+      bibpaper_header(id, caption)
+      bibpaper_bibpaper(id, caption, lines) unless lines.empty?
       puts '</div>'
     end
 
@@ -1219,17 +1183,6 @@ module ReVIEW
       @ol_num = num.to_i
     end
 
-    def defer_math_image(str, path, key)
-      # for Re:VIEW >3
-      File.open(File.join(File.dirname(path), '__IMGMATH_BODY__.tex'), 'a+') do |f|
-        f.puts str
-        f.puts '\\clearpage'
-      end
-      File.open(File.join(File.dirname(path), '__IMGMATH_BODY__.map'), 'a+') do |f|
-        f.puts key
-      end
-    end
-
     def make_math_image(str, path, fontsize = 12)
       # Re:VIEW 2 compatibility
       fontsize2 = (fontsize * 1.2).round.to_i

data/lib/review/htmlutils.rb

@@ -82,7 +82,7 @@ module ReVIEW
       begin
         require 'pygments'
         begin
-          Pygments.highlight(unescape(body),
+          Pygments.highlight(body,
                              options: options,
                              formatter: format,
                              lexer: lexer)
@@ -128,8 +128,7 @@ module ReVIEW
         return body
       end
 
-      text = unescape(body)
-      formatter.format(lexer.lex(text))
+      formatter.format(lexer.lex(body))
     end
 
     def normalize_id(id)

data/lib/review/i18n.rb

@@ -90,7 +90,7 @@ module ReVIEW
         end
       else
         user_i18n.each do |key, values|
-          raise KeyError, "Invalid locale file: #{path}" unless values.is_a? Hash
+          raise KeyError, "Invalid locale file: #{path}" unless values.is_a?(Hash)
           @store[key].merge!(values)
         end
       end
@@ -165,7 +165,7 @@ module ReVIEW
         end
       end
       remove_args.reverse_each do |idx|
-        args.delete_at idx
+        args.delete_at(idx)
       end
       args_matched = (frmt.count('%') <= args.size)
       frmt.gsub!('##', '%%')

data/lib/review/idgxmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -16,7 +16,9 @@ module ReVIEW
     include TextUtils
     include HTMLUtils
 
-    %i[ttbold hint maru keytop labelref ref].each { |e| Compiler.definline(e) }
+    %i[ttbold hint maru keytop labelref ref strong em].each do |e|
+      Compiler.definline(e)
+    end
     Compiler.defsingle(:dtp, 1)
 
     Compiler.defblock(:insn, 0..1)
@@ -165,7 +167,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      print %Q(<li aid:pstyle="ul-item">#{lines.join.chomp})
+      print %Q(<li aid:pstyle="ul-item">#{join_lines_to_paragraph(lines).chomp})
     end
 
     def ul_item_end
@@ -200,7 +202,7 @@ module ReVIEW
     end
 
     def ol_item(lines, num)
-      puts %Q(<li aid:pstyle="ol-item" olnum="#{@ol_num}" num="#{num}">#{lines.join.chomp}</li>)
+      puts %Q(<li aid:pstyle="ol-item" olnum="#{@ol_num}" num="#{num}">#{join_lines_to_paragraph(lines).chomp}</li>)
       @ol_num += 1
     end
 
@@ -222,7 +224,7 @@ module ReVIEW
     end
 
     def dd(lines)
-      puts "<dd>#{lines.join.chomp}</dd>"
+      puts "<dd>#{join_lines_to_paragraph(lines).chomp}</dd>"
     end
 
     def dl_end
@@ -232,12 +234,12 @@ module ReVIEW
     def paragraph(lines)
       if @noindent.nil?
         if lines[0] =~ /\A(\t+)/
-          puts %Q(<p inlist="#{$1.size}">#{lines.join.sub(/\A\t+/, '')}</p>)
+          puts %Q(<p inlist="#{$1.size}">#{join_lines_to_paragraph(lines).sub(/\A\t+/, '')}</p>)
         else
-          puts "<p>#{lines.join}</p>"
+          puts "<p>#{join_lines_to_paragraph(lines)}</p>"
         end
       else
-        puts %Q(<p aid:pstyle="noindent" noindent='1'>#{lines.join}</p>)
+        puts %Q(<p aid:pstyle="noindent" noindent='1'>#{join_lines_to_paragraph(lines)}</p>)
         @noindent = nil
       end
     end
@@ -269,7 +271,6 @@ module ReVIEW
     end
 
     def list_header(id, caption, _lang)
-      puts '<codelist>'
       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>)
@@ -294,14 +295,25 @@ module ReVIEW
       end
     end
 
+    def list(lines, id, caption, lang = nil)
+      puts '<codelist>'
+      begin
+        list_header(id, caption, lang)
+      rescue KeyError
+        error "no such list: #{id}"
+      end
+      list_body(id, lines, lang)
+      puts '</codelist>'
+    end
+
     def list_body(_id, lines, _lang)
       print '<pre>'
       codelines_body(lines)
-      puts '</pre></codelist>'
+      print '</pre>'
     end
 
     def emlist(lines, caption = nil, _lang = nil)
-      quotedlist lines, 'emlist', caption
+      quotedlist(lines, 'emlist', caption)
     end
 
     def emlistnum(lines, caption = nil, _lang = nil)
@@ -310,7 +322,18 @@ module ReVIEW
       lines.each_with_index do |line, i|
         lines2 << detab(%Q(<span type='lineno'>) + (i + first_line_num).to_s.rjust(2) + ': </span>' + line)
       end
-      quotedlist lines2, 'emlistnum', caption
+      quotedlist(lines2, 'emlistnum', caption)
+    end
+
+    def listnum(lines, id, caption, lang = nil)
+      puts '<codelist>'
+      begin
+        list_header(id, caption, lang)
+      rescue KeyError
+        error "no such list: #{id}"
+      end
+      listnum_body(lines, lang)
+      puts '</codelist>'
     end
 
     def listnum_body(lines, _lang)
@@ -329,11 +352,11 @@ module ReVIEW
         print '</listinfo>' if @book.config['listinfo']
         no += 1
       end
-      puts '</pre></codelist>'
+      print '</pre>'
     end
 
     def cmd(lines, caption = nil)
-      quotedlist lines, 'cmd', caption
+      quotedlist(lines, 'cmd', caption)
     end
 
     def quotedlist(lines, css_class, caption)
@@ -398,7 +421,7 @@ module ReVIEW
       metrics = parse_metric('idgxml', metric)
       puts '<img>'
       puts %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A./}, '')}"#{metrics} />)
-      image_header id, caption
+      image_header(id, caption)
       puts '</img>'
     end
 
@@ -410,7 +433,7 @@ module ReVIEW
         print "\n"
       end
       print '</pre>'
-      image_header id, caption
+      image_header(id, caption)
       puts '</img>'
       warn "image not bound: #{id}"
     end
@@ -437,7 +460,7 @@ module ReVIEW
 
       puts %Q(<replace idref="texblock-#{@texblockequation}">)
       puts '<pre>'
-      puts lines.join("\n")
+      print lines.join("\n")
       puts '</pre>'
       puts '</replace>'
 
@@ -447,63 +470,75 @@ module ReVIEW
     end
 
     def table(lines, id = nil, caption = nil)
-      tablewidth = @book.config['tableopt'] ? @book.config['tableopt'].split(',')[0].to_f / @book.config['pt_to_mm_unit'].to_f : nil
-      col = 0
+      @tablewidth = nil
+      if @book.config['tableopt']
+        @tablewidth = @book.config['tableopt'].split(',')[0].to_f / @book.config['pt_to_mm_unit'].to_f
+      end
+      @col = 0
 
-      rows = []
+      sepidx, rows = parse_table_rows(lines)
+      puts '<table>'
+
+      begin
+        table_header(id, caption) if caption.present?
+      rescue KeyError
+        error "no such table: #{id}"
+      end
+
+      if @tablewidth.nil?
+        print '<tbody>'
+      else
+        print %Q(<tbody xmlns:aid5="http://ns.adobe.com/AdobeInDesign/5.0/" aid:table="table" aid:trows="#{rows.length}" aid:tcols="#{@col}">)
+      end
+      table_rows(sepidx, rows)
+      puts '</tbody></table>'
+      @tsize = nil
+    end
+
+    def parse_table_rows(lines)
       sepidx = nil
+      rows = []
       lines.each_with_index do |line, idx|
         if /\A[\=\-]{12}/ =~ line
           sepidx ||= idx
           next
         end
-        if tablewidth
+        if @tablewidth
           rows.push(line.gsub(/\t\.\t/, "\tDUMMYCELLSPLITTER\t").gsub(/\t\.\.\t/, "\t.\t").gsub(/\t\.\Z/, "\tDUMMYCELLSPLITTER").gsub(/\t\.\.\Z/, "\t.").gsub(/\A\./, ''))
         else
           rows.push(line.gsub(/\t\.\t/, "\t\t").gsub(/\t\.\.\t/, "\t.\t").gsub(/\t\.\Z/, "\t").gsub(/\t\.\.\Z/, "\t.").gsub(/\A\./, ''))
         end
         col2 = rows[rows.length - 1].split(/\t/).length
-        col = col2 if col2 > col
+        @col = col2 if col2 > @col
       end
       error 'no rows in the table' if rows.empty?
+      [sepidx, rows]
+    end
 
-      puts '<table>'
-
+    def table_rows(sepidx, rows)
       cellwidth = []
-      if tablewidth
+      if @tablewidth
         if @tsize.nil?
-          col.times { |n| cellwidth[n] = tablewidth / col }
+          @col.times { |n| cellwidth[n] = @tablewidth / @col }
         else
           cellwidth = @tsize.split(/\s*,\s*/)
           totallength = 0
           cellwidth.size.times do |n|
             cellwidth[n] = cellwidth[n].to_f / @book.config['pt_to_mm_unit'].to_f
             totallength += cellwidth[n]
-            warn "total length exceeds limit for table: #{id}" if totallength > tablewidth
+            warn "total length exceeds limit for table: #{id}" if totallength > @tablewidth
           end
-          if cellwidth.size < col
-            cw = (tablewidth - totallength) / (col - cellwidth.size)
+          if cellwidth.size < @col
+            cw = (@tablewidth - totallength) / (@col - cellwidth.size)
             warn "auto cell sizing exceeds limit for table: #{id}" if cw <= 0
-            (cellwidth.size..(col - 1)).each { |i| cellwidth[i] = cw }
+            (cellwidth.size..(@col - 1)).each { |i| cellwidth[i] = cw }
           end
         end
       end
 
-      begin
-        table_header id, caption if caption.present?
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-
-      if tablewidth.nil?
-        print '<tbody>'
-      else
-        print %Q(<tbody xmlns:aid5="http://ns.adobe.com/AdobeInDesign/5.0/" aid:table="table" aid:trows="#{rows.length}" aid:tcols="#{col}">)
-      end
-
       if sepidx
         sepidx.times do |y|
-          if tablewidth.nil?
+          if @tablewidth.nil?
             puts %Q(<tr type="header">#{rows.shift}</tr>)
           else
             i = 0
@@ -514,9 +549,7 @@ module ReVIEW
           end
         end
       end
-      trputs(tablewidth, rows, cellwidth, sepidx)
-      puts '</tbody></table>'
-      @tsize = nil
+      trputs(@tablewidth, rows, cellwidth, sepidx)
     end
 
     def trputs(tablewidth, rows, cellwidth, sepidx)
@@ -562,7 +595,6 @@ module ReVIEW
     end
 
     def table_end
-      print '<?dtp tablerow last?>'
     end
 
     def emtable(lines, caption = nil)
@@ -573,19 +605,19 @@ module ReVIEW
       if @chapter.image(id).bound?
         metrics = parse_metric('idgxml', metric)
         puts '<table>'
-        table_header id, caption if caption.present?
+        table_header(id, caption) if caption.present?
         puts %Q(<imgtable><Image href="file://#{@chapter.image(id).path.sub(%r{\A./}, '')}"#{metrics} /></imgtable>)
         puts '</table>'
       else
         warn "image not bound: #{id}" if @strict
-        image_dummy id, caption, lines
+        image_dummy(id, caption, lines)
       end
     end
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
       lines ||= []
-      lines.unshift escape(comment) unless comment.blank?
+      lines.unshift(escape(comment)) unless comment.blank?
       str = lines.join("\n")
       print "<msg>#{str}</msg>"
     end
@@ -691,6 +723,14 @@ module ReVIEW
       %Q(<b>#{escape(str)}</b>)
     end
 
+    def inline_em(str)
+      %Q(<em>#{escape(str)}</em>)
+    end
+
+    def inline_strong(str)
+      %Q(<strong>#{escape(str)}</strong>)
+    end
+
     def inline_tt(str)
       %Q(<tt>#{escape(str)}</tt>)
     end
@@ -1115,25 +1155,31 @@ module ReVIEW
       error "unknown chapter: #{id}"
     end
 
-    def source_header(caption)
+    def source(lines, caption, lang = nil)
       puts '<source>'
+      source_header(caption)
+      source_body(lines, lang)
+      puts '</source>'
+    end
+
+    def source_header(caption)
       puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
     end
 
     def source_body(lines, _lang)
       puts '<pre>'
       codelines_body(lines)
-      puts '</pre></source>'
+      print '</pre>'
     end
 
     def bibpaper(lines, id, caption)
-      bibpaper_header id, caption
-      bibpaper_bibpaper id, caption, lines unless lines.empty?
+      puts %Q(<bibitem id="bib-#{id}">)
+      bibpaper_header(id, caption)
+      bibpaper_bibpaper(id, caption, lines) unless lines.empty?
       puts '</bibitem>'
     end
 
     def bibpaper_header(id, caption)
-      puts %Q(<bibitem id="bib-#{id}">)
       puts "<caption><span type='bibno'>[#{@chapter.bibpaper(id).number}] </span>#{compile_inline(caption)}</caption>" if caption.present?
     end