review 3.2.0 → 5.1.0

data/lib/review/topbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -65,11 +65,11 @@ module ReVIEW
     end
 
     def ul_item(lines)
-      puts "●\t#{lines.join}"
+      puts "●\t#{join_lines_to_paragraph(lines)}"
     end
 
     def ol_item(lines, num)
-      puts "#{num}\t#{lines.join}"
+      puts "#{num}\t#{join_lines_to_paragraph(lines)}"
     end
 
     def dt(line)
@@ -78,7 +78,7 @@ module ReVIEW
 
     def dd(lines)
       split_paragraph(lines).each do |paragraph|
-        puts "\t#{paragraph.gsub(/\n/, '')}"
+        puts "\t#{paragraph.delete("\n")}"
       end
     end
 
@@ -91,30 +91,50 @@ module ReVIEW
 
     alias_method :lead, :read
 
-    def list_header(id, caption, _lang)
+    def list(lines, id, caption, lang = nil)
       blank
       puts "◆→開始:#{@titles['list']}←◆"
+      begin
+        if caption_top?('list')
+          list_header(id, caption, lang)
+          blank
+        end
+        list_body(id, lines, lang)
+        unless caption_top?('list')
+          blank
+          list_header(id, caption, lang)
+        end
+      rescue KeyError
+        error "no such list: #{id}"
+      end
+      puts "◆→終了:#{@titles['list']}←◆"
+      blank
+    end
+
+    def list_header(id, caption, _lang)
       if get_chap
         puts %Q(#{I18n.t('list')}#{I18n.t('format_number', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)})
       else
         puts %Q(#{I18n.t('list')}#{I18n.t('format_number_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)})
       end
-      blank
     end
 
     def list_body(_id, lines, _lang)
       lines.each do |line|
         puts detab(line)
       end
-      puts "◆→終了:#{@titles['list']}←◆"
-      blank
     end
 
     def base_block(type, lines, caption = nil)
       blank
       puts "◆→開始:#{@titles[type]}←◆"
-      puts "■#{compile_inline(caption)}" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts lines.join("\n")
+      if !caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts "◆→終了:#{@titles[type]}←◆"
       blank
     end
@@ -131,20 +151,43 @@ module ReVIEW
     def emlistnum(lines, caption = nil, _lang = nil)
       blank
       puts "◆→開始:#{@titles['emlist']}←◆"
-      puts "■#{compile_inline(caption)}" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
+      if !caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts "◆→終了:#{@titles['emlist']}←◆"
       blank
     end
 
+    def listnum(lines, id, caption, lang = nil)
+      blank
+      puts "◆→開始:#{@titles['list']}←◆"
+      begin
+        if caption_top?('list') && caption.present?
+          list_header(id, caption, lang)
+          blank
+        end
+        listnum_body(lines, lang)
+        if !caption_top?('list') && caption.present?
+          blank
+          list_header(id, caption, lang)
+        end
+      rescue KeyError
+        error "no such list: #{id}"
+      end
+      puts "◆→終了:#{@titles['list']}←◆"
+      blank
+    end
+
     def listnum_body(lines, _lang)
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
-      puts "◆→終了:#{@titles['list']}←◆"
-      blank
     end
 
     def image(lines, id, caption, metric = nil)
@@ -152,13 +195,11 @@ module ReVIEW
       metrics = " #{metrics}" if metrics.present?
       blank
       puts "◆→開始:#{@titles['image']}←◆"
-      if get_chap
-        puts "#{I18n.t('image')}#{I18n.t('format_number', [get_chap, @chapter.image(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
-      else
-        puts "#{I18n.t('image')}#{I18n.t('format_number_without_chapter', [@chapter.image(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
+      if caption_top?('image')
+        image_header(id, caption)
+        blank
       end
-      blank
-      if @chapter.image(id).bound?
+      if @chapter.image_bound?(id)
         puts "◆→#{@chapter.image(id).path}#{metrics}←◆"
       else
         warn "image not bound: #{id}"
@@ -166,13 +207,44 @@ module ReVIEW
           puts line
         end
       end
+      unless caption_top?('image')
+        blank
+        image_header(id, caption)
+      end
       puts "◆→終了:#{@titles['image']}←◆"
       blank
     end
 
+    def image_header(id, caption)
+      if get_chap
+        puts "#{I18n.t('image')}#{I18n.t('format_number', [get_chap, @chapter.image(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
+      else
+        puts "#{I18n.t('image')}#{I18n.t('format_number_without_chapter', [@chapter.image(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
+      end
+    end
+
     def texequation(lines, id = nil, caption = '')
       blank
       puts "◆→開始:#{@titles['texequation']}←◆"
+      texequation_header(id, caption) if caption_top?('equation')
+
+      if @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)
+        img_path = @img_math.defer_math_image(math_str, key)
+        puts "◆→math:#{File.basename(img_path)}←◆"
+      else
+        puts lines.join("\n")
+      end
+
+      texequation_header(id, caption) unless caption_top?('equation')
+      puts "◆→終了:#{@titles['texequation']}←◆"
+      blank
+    end
+
+    def texequation_header(id, caption)
       if id
         if get_chap
           puts "#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
@@ -180,49 +252,14 @@ module ReVIEW
           puts "#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
         end
       end
-      puts lines.join("\n")
-      puts "◆→終了:#{@titles['texequation']}←◆"
-      blank
     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?
-
       blank
       puts "◆→開始:#{@titles['table']}←◆"
-
-      begin
-        table_header id, caption if caption.present?
-      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, true)
+      puts "◆→終了:#{@titles['table']}←◆"
+      blank
     end
 
     def th(str)
@@ -230,15 +267,14 @@ module ReVIEW
     end
 
     def table_end
-      puts "◆→終了:#{@titles['table']}←◆"
-      blank
     end
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
-        lines.unshift comment
+        lines.unshift(comment)
       end
       str = lines.join("\n")
       puts "◆→#{str}←◆"
@@ -329,6 +365,18 @@ module ReVIEW
       "＠#{str}＠◆→＠〜＠部分に下線←◆"
     end
 
+    def inline_ins(str)
+      "◆→開始:挿入表現←◆#{str}◆→終了:挿入表現←◆"
+    end
+
+    def inline_del(str)
+      "◆→開始:削除表現←◆#{str}◆→終了:削除表現←◆"
+    end
+
+    def inline_tcy(str)
+      "◆→開始:回転←◆#{str}◆→終了:縦回転←◆"
+    end
+
     def inline_icon(id)
       begin
         "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}←◆"
@@ -359,7 +407,14 @@ module ReVIEW
     end
 
     def inline_m(str)
-      %Q(◆→TeX式ここから←◆#{str}◆→TeX式ここまで←◆)
+      if @book.config['math_format'] == 'imgmath'
+        math_str = '$' + str + '$'
+        key = Digest::SHA256.hexdigest(str)
+        img_path = @img_math.defer_math_image(math_str, key)
+        %Q(◆→TeX式ここから←◆◆→math:#{File.basename(img_path)}←◆◆→TeX式ここまで←◆)
+      else
+        %Q(◆→TeX式ここから←◆#{str}◆→TeX式ここまで←◆)
+      end
     end
 
     def bibpaper_header(id, caption)
@@ -396,17 +451,48 @@ module ReVIEW
       blank
     end
 
+    def common_block_begin(type, _level, _label, caption = nil)
+      blank
+      puts "◆→開始:#{@titles[type]}←◆"
+      puts '■' + compile_inline(caption) if caption.present?
+    end
+
+    def common_block_end(type, _level)
+      puts "◆→終了:#{@titles[type]}←◆"
+      blank
+    end
+
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          common_block_begin('#{name}', nil, nil, caption)
+        end
+
+        def #{name}_end
+          common_block_end('#{name}', nil)
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 11
+    end
+
     def indepimage(_lines, id, caption = nil, metric = nil)
       metrics = parse_metric('top', metric)
       metrics = " #{metrics}" if metrics.present?
       blank
+      if caption_top?('image') && caption.present?
+        puts "図　#{compile_inline(caption)}"
+      end
       begin
         puts "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}#{metrics}←◆"
       rescue
         warn "image not bound: #{id}"
         puts "◆→画像 #{id}←◆"
       end
-      puts "図　#{compile_inline(caption)}" if caption.present?
+      if !caption_top?('image') && caption.present?
+        puts "図　#{compile_inline(caption)}"
+      end
       blank
     end
 

data/lib/review/update.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2018-2019 Kenshi Muto
+# Copyright (c) 2018-2020 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -20,14 +20,14 @@ module ReVIEW
     end
 
     # should be
-    TARGET_VERSION = '3.0'
+    TARGET_VERSION = '5.0'
     EPUB_VERSION = '3'
     HTML_VERSION = '5'
     TEX_DOCUMENTCLASS = ['review-jsbook', 'review-jlreq']
     TEX_DOCUMENTCLASS_BAD = ['jsbook', nil]
     TEX_DOCUMENTCLASS_OPTS = 'media=print,paper=a5'
     TEX_COMMAND = 'uplatex'
-    TEX_OPTIONS = '-interaction=nonstopmode -file-line-error'
+    TEX_OPTIONS = '-interaction=nonstopmode -file-line-error -halt-on-error'
     DVI_COMMAND = 'dvipdfmx'
     DVI_OPTIONS = '-d 5 -z 9'
 
@@ -126,7 +126,7 @@ module ReVIEW
       content = File.read(yml)
       content.gsub!(/^(\s*)#{key}:.*$/, '\1' + "#{key}: #{val}")
       if @backup
-        FileUtils.mv yml, "#{yml}-old"
+        FileUtils.mv(yml, "#{yml}-old")
       end
       File.write(yml, content)
     end
@@ -239,7 +239,7 @@ module ReVIEW
     def update_version
       @config_ymls.each do |yml|
         config = YAML.load_file(yml)
-        if config['review_version'].to_f == TARGET_VERSION.to_f
+        if config['review_version'].to_f.round(1) == TARGET_VERSION.to_f.round(1)
           next
         end
 
@@ -257,7 +257,7 @@ module ReVIEW
     def update_rakefile(dir)
       taskdir = File.join(dir, 'lib/tasks')
       unless File.exist?(taskdir)
-        FileUtils.mkdir_p taskdir
+        FileUtils.mkdir_p(taskdir)
       end
 
       master_rakefile = File.join(@review_dir, 'samples/sample-book/src/Rakefile')
@@ -266,13 +266,13 @@ module ReVIEW
       if File.exist?(target_rakefile)
         if Digest::SHA256.hexdigest(File.read(target_rakefile)) != Digest::SHA256.hexdigest(File.read(master_rakefile))
           if confirm('%s will be overridden with Re:VIEW version (%s). Do you really proceed?', ['Rakefile', master_rakefile])
-            FileUtils.mv target_rakefile, "#{target_rakefile}-old"
-            FileUtils.cp master_rakefile, target_rakefile
+            FileUtils.mv(target_rakefile, "#{target_rakefile}-old")
+            FileUtils.cp(master_rakefile, target_rakefile)
           end
         end
       else
         @logger.info t('new file %s is created.', [target_rakefile]) unless @force
-        FileUtils.cp master_rakefile, target_rakefile
+        FileUtils.cp(master_rakefile, target_rakefile)
       end
 
       master_rakefile = File.join(@review_dir, 'samples/sample-book/src/lib/tasks/review.rake')
@@ -280,13 +280,13 @@ module ReVIEW
       if File.exist?(target_rakefile)
         if Digest::SHA256.hexdigest(File.read(target_rakefile)) != Digest::SHA256.hexdigest(File.read(master_rakefile))
           if confirm('%s will be overridden with Re:VIEW version (%s). Do you really proceed?', ['lib/tasks/review.rake', master_rakefile])
-            FileUtils.mv target_rakefile, "#{target_rakefile}-old"
-            FileUtils.cp master_rakefile, target_rakefile
+            FileUtils.mv(target_rakefile, "#{target_rakefile}-old")
+            FileUtils.cp(master_rakefile, target_rakefile)
           end
         end
       else
         @logger.info t('new file %s is created.', [target_rakefile]) unless @force
-        FileUtils.cp master_rakefile, target_rakefile
+        FileUtils.cp(master_rakefile, target_rakefile)
       end
     end
 
@@ -301,6 +301,7 @@ module ReVIEW
         if !config['htmlversion'].present? || config['htmlversion'].to_f >= HTML_VERSION.to_f
           next
         end
+
         if confirm("%s: Update '%s' to '%s' from '%s'?", [File.basename(yml), 'htmlversion', HTML_VERSION, config['htmlversion']])
           rewrite_yml(yml, 'htmlversion', HTML_VERSION)
         end
@@ -313,6 +314,7 @@ module ReVIEW
         if !config['chapter_quote'].present? || config['chapter_quote'].scan('%s').size != 1
           next
         end
+
         v = config['chapter_quote'].sub('%s', '%s %s')
         if confirm("%s: 'chapter_quote' now takes 2 values. Update '%s' to '%s'?", [File.basename(yml), config['chapter_quote'], v])
           rewrite_yml(yml, 'chapter_quote', v)
@@ -414,9 +416,7 @@ module ReVIEW
             opts << "paper=#{v.sub('j', '').sub('paper', '')}"
           when /[\d.]+ptj/ # not cared...
             opts << "fontsize=#{v.sub('j', '')}"
-          when /[\d.]+pt/
-            opts << "fontsize=#{v}"
-          when /[\d.]+Q/
+          when /[\d.]+pt/, /[\d.]+Q/
             opts << "fontsize=#{v}"
           when 'landscape', 'oneside', 'twoside', 'vartwoside', 'onecolumn',
                'twocolumn', 'titlepage', 'notitlepage', 'openright',
@@ -442,9 +442,7 @@ module ReVIEW
             opts << "paper=#{v.sub('j', '').sub('paper', '')}"
           when /[\d.]+ptj/ # not cared...
             opts << "fontsize=#{v.sub('j', '')}"
-          when /[\d.]+pt/
-            opts << "fontsize=#{v}"
-          when /[\d.]+Q/
+          when /[\d.]+pt/, /[\d.]+Q/
             opts << "fontsize=#{v}"
           when 'landscape', 'oneside', 'twoside', 'onecolumn', 'twocolumn', 'titlepage', 'notitlepage', 'openright', 'openany', 'leqno', 'fleqn', 'draft', 'final', 'report'
             # pass-through
@@ -469,7 +467,7 @@ module ReVIEW
     def update_tex_stys(template, dir)
       texmacrodir = File.join(dir, 'sty')
       unless File.exist?(texmacrodir)
-        FileUtils.mkdir texmacrodir
+        FileUtils.mkdir(texmacrodir)
       end
 
       tdir = File.join(@review_dir, 'templates/latex', template)
@@ -479,7 +477,7 @@ module ReVIEW
         unless File.exist?(target_styfile)
           # just copy
           @logger.info t('new file %s is created.', [target_styfile]) unless @force
-          FileUtils.cp master_styfile, target_styfile
+          FileUtils.cp(master_styfile, target_styfile)
           next
         end
         if File.basename(target_styfile) == 'review-custom.sty'
@@ -492,20 +490,20 @@ module ReVIEW
         end
 
         if confirm('%s will be overridden with Re:VIEW version (%s). Do you really proceed?', [target_styfile, master_styfile])
-          FileUtils.mv target_styfile, "#{target_styfile}-old"
-          FileUtils.cp master_styfile, target_styfile
+          FileUtils.mv(target_styfile, "#{target_styfile}-old")
+          FileUtils.cp(master_styfile, target_styfile)
         end
       end
 
       if template == 'review-jsbook'
         unless File.exist?(File.join(texmacrodir, 'jsbook.cls'))
           @logger.info t('new file %s is created.', [File.join(texmacrodir, 'jsbook.cls')]) unless @force
-          FileUtils.cp File.join(@review_dir, 'vendor/jsclasses/jsbook.cls'), File.join(texmacrodir, 'jsbook.cls')
+          FileUtils.cp(File.join(@review_dir, 'vendor/jsclasses/jsbook.cls'), File.join(texmacrodir, 'jsbook.cls'))
         end
 
         unless File.exist?(File.join(texmacrodir, 'gentombow.sty'))
           @logger.info t('new file %s is created.', [File.join(texmacrodir, 'gentombow.sty')]) unless @force
-          FileUtils.cp File.join(@review_dir, 'vendor/gentombow/gentombow.sty'), File.join(texmacrodir, 'gentombow.sty')
+          FileUtils.cp(File.join(@review_dir, 'vendor/gentombow/gentombow.sty'), File.join(texmacrodir, 'gentombow.sty'))
         end
       end
     end
@@ -513,11 +511,12 @@ module ReVIEW
     def update_tex_command
       @tex_ymls.each do |yml|
         config = YAML.load_file(yml)
-        if !config['texcommand'] || config['texcommand'] !~ /\s+\-/
+        if !config['texcommand'] || config['texcommand'] !~ /\s+-/
           next
         end
+
         # option should be moved to texoptions
-        cmd, opts = config['texcommand'].split(/\s+\-/, 2)
+        cmd, opts = config['texcommand'].split(/\s+-/, 2)
         opts = "-#{opts}"
 
         unless confirm("%s: 'texcommand' has options ('%s'). Move it to 'texoptions'?", [File.basename(yml), opts])
@@ -537,12 +536,12 @@ module ReVIEW
     def update_dvi_command
       @tex_ymls.each do |yml|
         config = YAML.load_file(yml)
-        if !config['dvicommand'] || config['dvicommand'] !~ /\s+\-/
+        if !config['dvicommand'] || config['dvicommand'] !~ /\s+-/
           next
         end
 
         # option should be moved to dvioptions
-        cmd, opts = config['dvicommand'].split(/\s+\-/, 2)
+        cmd, opts = config['dvicommand'].split(/\s+-/, 2)
         opts = "-#{opts}"
 
         unless confirm("%s: 'dvicommand' has options ('%s'). Move it to 'dvioptions'?", [File.basename(yml), opts])