review 5.1.1 → 5.4.0

data/lib/review/htmlutils.rb

@@ -9,7 +9,7 @@
 
 begin
   require 'cgi/escape'
-rescue
+rescue StandardError
   require 'cgi/util'
 end
 
@@ -60,13 +60,13 @@ module ReVIEW
     def highlight_pygments(ops)
       body = ops[:body] || ''
       format = ops[:format] || ''
-      if ops[:lexer].present?
-        lexer = ops[:lexer]
-      elsif @book.config['highlight'] && @book.config['highlight']['lang']
-        lexer = @book.config['highlight']['lang'] # default setting
-      else
-        lexer = 'text'
-      end
+      lexer = if ops[:lexer].present?
+                ops[:lexer]
+              elsif @book.config['highlight'] && @book.config['highlight']['lang']
+                @book.config['highlight']['lang'] # default setting
+              else
+                'text'
+              end
       options = { nowrap: true, noclasses: true }
       if ops[:linenum]
         options[:nowrap] = false
@@ -93,13 +93,13 @@ module ReVIEW
 
     def highlight_rouge(ops)
       body = ops[:body] || ''
-      if ops[:lexer].present?
-        lexer = ops[:lexer]
-      elsif @book.config['highlight'] && @book.config['highlight']['lang']
-        lexer = @book.config['highlight']['lang'] # default setting
-      else
-        lexer = 'text'
-      end
+      lexer = if ops[:lexer].present?
+                ops[:lexer]
+              elsif @book.config['highlight'] && @book.config['highlight']['lang']
+                @book.config['highlight']['lang'] # default setting
+              else
+                'text'
+              end
       # format = ops[:format] || ''
 
       first_line_num = 1 ## default
@@ -129,9 +129,9 @@ module ReVIEW
     end
 
     def normalize_id(id)
-      if id =~ /\A[a-z][a-z0-9_.-]*\Z/i
+      if /\A[a-z][a-z0-9_.-]*\Z/i.match?(id)
         id
-      elsif id =~ /\A[0-9_.-][a-z0-9_.-]*\Z/i
+      elsif /\A[0-9_.-][a-z0-9_.-]*\Z/i.match?(id)
         "id_#{id}" # dummy prefix
       else
         "id_#{CGI.escape(id.gsub('_', '__')).tr('%', '_').tr('+', '-')}" # escape all

data/lib/review/i18n.rb

@@ -75,11 +75,11 @@ module ReVIEW
     end
 
     def load_file(path)
-      @store = YAML.load_file(path)
+      @store = YAMLLoader.safe_load_file(path)
     end
 
     def update_localefile(path)
-      user_i18n = YAML.load_file(path)
+      user_i18n = YAMLLoader.safe_load_file(path)
       locale = user_i18n['locale']
       if locale
         user_i18n.delete('locale')
@@ -171,7 +171,7 @@ module ReVIEW
       args_matched = (frmt.count('%') <= args.size)
       frmt.gsub!('##', '%%')
       args_matched ? (frmt % args) : frmt
-    rescue
+    rescue StandardError
       str
     end
   end

data/lib/review/i18n.yml

@@ -32,6 +32,8 @@ ja:
   html_footnote_refmark: "*%s"
   html_footnote_textmark: "[*%s] "
   html_footnote_backmark: "⏎"
+  html_endnote_refmark: "(%s)"
+  html_endnote_textmark: "(%s) "
   aut: "著　者"
   csl: "監　修"
   dsr: "デザイン"
@@ -120,6 +122,8 @@ en:
   html_footnote_refmark: "*%s"
   html_footnote_textmark: "[*%s] "
   html_footnote_backmark: "⏎"
+  html_endnote_refmark: "(%s)"
+  html_endnote_textmark: "(%s) "
   aut: "Author"
   csl: "Consultant"
   dsr: "Design"
@@ -188,6 +192,8 @@ zh-TW:
   html_footnote_refmark: "*%s"
   html_footnote_textmark: "[*%s] "
   html_footnote_backmark: "⏎"
+  html_endnote_refmark: "(%s)"
+  html_endnote_textmark: "(%s) "
   aut: "著作人"
   csl: "監　修"
   dsr: "美術編輯"

data/lib/review/idgxmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2022 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -47,6 +47,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @warns = []
       @errors = []
       @section = 0
@@ -77,13 +78,15 @@ module ReVIEW
     end
 
     def result
+      check_printendnotes
+
       s = ''
       if @secttags
         s += '</sect4>' if @subsubsubsection > 0
         s += '</sect3>' if @subsubsection > 0
         s += '</sect2>' if @subsection > 0
         s += '</sect>' if @section > 0
-        s += '</chapter>' if @chapter.number > 0
+        s += '</chapter>'
       end
       solve_nest(@output.string) + s + "</#{@rootelement}>\n"
     end
@@ -200,7 +203,7 @@ module ReVIEW
 
     def ol_begin
       puts '<ol>'
-      @ol_num ||= 1
+      @ol_num ||= 1 # rubocop:disable Naming/MemoizedInstanceVariableName
     end
 
     def ol_item(lines, num)
@@ -265,7 +268,7 @@ module ReVIEW
         I18n.t('column', compile_inline(chapter.column(id).caption))
       end
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_list(id)
@@ -436,7 +439,7 @@ module ReVIEW
       print '</pre>'
       image_header(id, caption) unless caption_top?('image')
       puts '</img>'
-      warn "image not bound: #{id}"
+      warn "image not bound: #{id}", location: location
     end
 
     def image_header(id, caption)
@@ -454,11 +457,11 @@ module ReVIEW
       caption_str = nil
       if id
         puts '<equationblock>'
-        if get_chap.nil?
-          caption_str = %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
-        else
-          caption_str = %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
-        end
+        caption_str = if get_chap.nil?
+                        %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
+                      else
+                        %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
+                      end
         puts caption_str if caption_top?('equation')
       end
 
@@ -477,7 +480,7 @@ module ReVIEW
     def table(lines, id = nil, caption = nil)
       @tablewidth = nil
       if @book.config['tableopt']
-        @tablewidth = @book.config['tableopt'].split(',')[0].to_f / @book.config['pt_to_mm_unit'].to_f
+        @tablewidth = @book.config['tableopt'].split(',')[0].to_f / @book.config['pt_to_mm_unit'].to_f # rubocop:disable Style/FloatDivision
       end
       @col = 0
 
@@ -502,7 +505,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       puts '</table>'
       @tsize = nil
@@ -512,7 +515,7 @@ module ReVIEW
       sepidx = nil
       rows = []
       lines.each_with_index do |line, idx|
-        if /\A[=\-]{12}/ =~ line
+        if /\A[=\-]{12}/.match?(line)
           sepidx ||= idx
           next
         end
@@ -524,7 +527,7 @@ module ReVIEW
         col2 = rows[rows.length - 1].split(table_row_separator_regexp).length
         @col = col2 if col2 > @col
       end
-      error 'no rows in the table' if rows.empty?
+      app_error 'no rows in the table' if rows.empty?
       [sepidx, rows]
     end
 
@@ -537,13 +540,13 @@ module ReVIEW
           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
+            cellwidth[n] = cellwidth[n].to_f / @book.config['pt_to_mm_unit'].to_f # rubocop:disable Style/FloatDivision
             totallength += cellwidth[n]
-            warn "total length exceeds limit for table: #{@table_id}" if totallength > @tablewidth
+            warn "total length exceeds limit for table: #{@table_id}", location: location if totallength > @tablewidth
           end
           if cellwidth.size < @col
             cw = (@tablewidth - totallength) / (@col - cellwidth.size)
-            warn "auto cell sizing exceeds limit for table: #{@table_id}" if cw <= 0
+            warn "auto cell sizing exceeds limit for table: #{@table_id}", location: location if cw <= 0
             (cellwidth.size..(@col - 1)).each { |i| cellwidth[i] = cw }
           end
         end
@@ -627,7 +630,7 @@ module ReVIEW
         end
         puts '</table>'
       else
-        warn "image not bound: #{id}" if @strict
+        warn "image not bound: #{id}", location: location if @strict
         image_dummy(id, caption, lines)
       end
     end
@@ -656,7 +659,25 @@ module ReVIEW
     def inline_fn(id)
       %Q(<footnote>#{compile_inline(@chapter.footnote(id).content.strip)}</footnote>)
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
+    end
+
+    def inline_endnote(id)
+      %Q(<span type='endnoteref' idref='endnoteb-#{normalize_id(id)}'>(#{@chapter.endnote(id).number})</span>)
+    rescue KeyError
+      app_error "unknown endnote: #{id}"
+    end
+
+    def endnote_begin
+      puts '<endnotes>'
+    end
+
+    def endnote_end
+      puts '</endnotes>'
+    end
+
+    def endnote_item(id)
+      puts %Q(<endnote id='endnoteb-#{normalize_id(id)}'><span type='endnotenumber'>(#{@chapter.endnote(id).number})</span>\t#{compile_inline(@chapter.endnote(id).content)}</endnote>)
     end
 
     def compile_ruby(base, ruby)
@@ -666,8 +687,9 @@ module ReVIEW
     def compile_kw(word, alt)
       '<keyword>' +
         if alt
-        then escape("#{word}（#{alt.strip}）")
-        else escape(word)
+          escape("#{word}（#{alt.strip}）")
+        else
+          escape(word)
         end +
         '</keyword>' +
         %Q(<index value="#{escape(word)}" />) +
@@ -703,22 +725,22 @@ module ReVIEW
     end
 
     def inline_maru(str)
-      if str =~ /\A\d+\Z/
+      if /\A\d+\Z/.match?(str)
         sprintf('&#x%x;', 9311 + str.to_i)
-      elsif str =~ /\A[A-Z]\Z/
+      elsif /\A[A-Z]\Z/.match?(str)
         begin
           sprintf('&#x%x;', 9398 + str.codepoints.to_a[0] - 65)
         rescue NoMethodError
           sprintf('&#x%x;', 9398 + str[0] - 65)
         end
-      elsif str =~ /\A[a-z]\Z/
+      elsif /\A[a-z]\Z/.match?(str)
         begin
           sprintf('&#x%x;', 9392 + str.codepoints.to_a[0] - 65)
         rescue NoMethodError
           sprintf('&#x%x;', 9392 + str[0] - 65)
         end
       else
-        error "can't parse maru: #{str}"
+        app_error "can't parse maru: #{str}"
       end
     end
 
@@ -779,8 +801,8 @@ module ReVIEW
     def inline_icon(id)
       begin
         %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A\./}, '')}" type="inline" />)
-      rescue
-        warn "image not bound: #{id}"
+      rescue StandardError
+        warn "image not bound: #{id}", location: location
         ''
       end
     end
@@ -1121,16 +1143,16 @@ module ReVIEW
     def indepimage(_lines, id, caption = nil, metric = nil)
       metrics = parse_metric('idgxml', metric)
       puts '<img>'
-      if caption_top?('image')
-        puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
+      if caption_top?('image') && caption.present?
+        puts %Q(<caption>#{compile_inline(caption)}</caption>)
       end
       begin
         puts %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A\./}, '')}"#{metrics} />)
-      rescue
-        warn %Q(image not bound: #{id})
+      rescue StandardError
+        warn %Q(image not bound: #{id}), location: location
       end
-      unless caption_top?('image')
-        puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
+      if !caption_top?('image') && caption.present?
+        puts %Q(<caption>#{compile_inline(caption)}</caption>)
       end
       puts '</img>'
     end
@@ -1188,7 +1210,7 @@ module ReVIEW
           if chs2.size == 3
             chs = chs2
           else
-            error '--chapsplitter must have exactly 3 parameters with comma.'
+            app_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]}"
@@ -1206,7 +1228,7 @@ module ReVIEW
         end
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_chap(id)
@@ -1216,7 +1238,7 @@ module ReVIEW
         @book.chapter_index.number(id)
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_title(id)
@@ -1227,7 +1249,7 @@ module ReVIEW
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def source(lines, caption = nil, lang = nil)
@@ -1270,7 +1292,7 @@ module ReVIEW
     def inline_bib(id)
       %Q(<span type='bibref' idref='#{id}'>[#{@chapter.bibpaper(id).number}]</span>)
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def inline_hd_chap(chap, id)
@@ -1281,7 +1303,7 @@ module ReVIEW
         I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
     rescue KeyError
-      error "unknown headline: #{id}"
+      app_error "unknown headline: #{id}"
     end
 
     def inline_recipe(id)

data/lib/review/idgxmlmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2021 Kenshi Muto
+# Copyright (c) 2019-2022 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -16,10 +16,12 @@ require 'review/yamlloader'
 require 'review/idgxmlbuilder'
 require 'review/version'
 require 'review/makerhelper'
+require 'review/loggable'
 
 module ReVIEW
   class IDGXMLMaker
     include MakerHelper
+    include Loggable
 
     attr_accessor :config, :basedir
 
@@ -27,15 +29,7 @@ module ReVIEW
       @basedir = nil
       @logger = ReVIEW.logger
       @plaintext = nil
-    end
-
-    def error(msg)
-      @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -78,11 +72,15 @@ module ReVIEW
 
     def execute(*args)
       cmd_config, yamlfile = parse_opts(args)
-      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      @config = ReVIEW::Configure.create(maker: 'idgxmlmaker',
-                                         yamlfile: yamlfile,
-                                         config: cmd_config)
+      begin
+        @config = ReVIEW::Configure.create(maker: 'idgxmlmaker',
+                                           yamlfile: yamlfile,
+                                           config: cmd_config)
+      rescue ReVIEW::ConfigError => e
+        error! e.message
+      end
       I18n.setup(@config['language'])
       begin
         generate_idgxml_files(yamlfile)
@@ -90,7 +88,7 @@ module ReVIEW
       rescue ApplicationError => e
         raise if @config['debug']
 
-        error(e.message)
+        error! e.message
       end
     end
 
@@ -106,6 +104,10 @@ module ReVIEW
       end
 
       build_body(@path, yamlfile)
+
+      if @compile_errors
+        app_error 'compile error, No IDGXML file output.'
+      end
     end
 
     def apply_filter(xmlfile)
@@ -121,7 +123,7 @@ module ReVIEW
         if s.success?
           File.write(xmlfile, o) # override
         end
-      rescue => e
+      rescue StandardError => e
         warn("filter error for #{xmlfile}: #{e.message}")
       end
     end
@@ -161,13 +163,11 @@ module ReVIEW
     end
 
     def build_chap(chap, base_path, basetmpdir, ispart)
-      filename = ''
-
-      if ispart.present?
-        filename = chap.path
-      else
-        filename = Pathname.new(chap.path).relative_path_from(base_path).to_s
-      end
+      filename = if ispart.present?
+                   chap.path
+                 else
+                   Pathname.new(chap.path).relative_path_from(base_path).to_s
+                 end
       id = File.basename(filename).sub(/\.re\Z/, '')
       if @buildonly && !@buildonly.include?(id)
         warn "skip #{id}.re"
@@ -179,9 +179,10 @@ module ReVIEW
       begin
         @converter.convert(filename, File.join(basetmpdir, xmlfile))
         apply_filter(File.join(basetmpdir, xmlfile))
-      rescue => e
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+      rescue StandardError => e
+        @compile_errors = true
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end
   end

data/lib/review/img_math.rb

@@ -1,8 +1,11 @@
 require 'fileutils'
 require 'shellwords'
+require 'review/loggable'
 
 module ReVIEW
   class ImgMath
+    include Loggable
+
     def initialize(config, path_name: '_review_math')
       @config = config
       @logger = ReVIEW.logger
@@ -50,7 +53,7 @@ module ReVIEW
         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
+          raise ApplicationError, "latex compile error\n\nError log:\n#{out}"
         end
 
         img_path
@@ -97,15 +100,14 @@ module ReVIEW
           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
+            error! "unknown math converter error. imgmath_options/converter parameter should be 'pdfcrop' or 'dvipng'."
           end
         rescue CompileError
           FileUtils.cp([tex_path,
+                        File.join(File.dirname(tex_path), '__IMGMATH_BODY__.tex'),
                         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
+          error! "LaTeX math compile error. See #{math_real_dir}/__IMGMATH__.log for details."
         end
       end
       @math_maps.clear
@@ -113,14 +115,6 @@ module ReVIEW
 
     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}
@@ -156,7 +150,7 @@ module ReVIEW
         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}"
+            @logger.error "error in #{@config['dvicommand']}. Error log:\n#{out}"
             raise CompileError
           end
         end
@@ -167,7 +161,7 @@ module ReVIEW
         end
         out, status = Open3.capture2e(*args)
         unless status.success?
-          warn "error in pdfcrop. Error log:\n#{out}"
+          @logger.error "error in pdfcrop. Error log:\n#{out}"
           raise CompileError
         end
         pdf_path = '__IMGMATH__pdfcrop.pdf'
@@ -192,7 +186,7 @@ module ReVIEW
             end
             out, status = Open3.capture2e(*args)
             unless status.success?
-              warn "error in pdf extracting. Error log:\n#{out}"
+              @logger.error "error in pdf extracting. Error log:\n#{out}"
               raise CompileError
             end
 
@@ -209,7 +203,7 @@ module ReVIEW
           end
           out, status = Open3.capture2e(*args)
           unless status.success?
-            warn "error in pdf pixelizing. Error log:\n#{out}"
+            @logger.error "error in pdf pixelizing. Error log:\n#{out}"
             raise CompileError
           end
         end
@@ -235,7 +229,7 @@ module ReVIEW
           end
           out, status = Open3.capture2e(*args)
           unless status.success?
-            warn "error in dvipng. Error log:\n#{out}"
+            @logger.error "error in dvipng. Error log:\n#{out}"
             raise CompileError
           end
         end