review 5.1.1 → 5.2.0

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,13 @@ 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__.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 +114,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 +149,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 +160,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 +185,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 +202,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 +228,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

data/lib/review/index_builder.rb

@@ -24,9 +24,9 @@ module ReVIEW
     def check_id(id)
       if id
         if id =~ %r![#%\\{}\[\]~/$'"|*?&<>`\s]!
-          warn "deprecated ID: `#{$&}` in `#{id}`"
+          warn "deprecated ID: `#{$&}` in `#{id}`", location: location
         elsif id.start_with?('.')
-          warn "deprecated ID: `#{id}` begins from `.`"
+          warn "deprecated ID: `#{id}` begins from `.`", location: location
         end
       end
     end
@@ -51,8 +51,7 @@ module ReVIEW
     end
 
     def builder_init_file
-      @sec_counter = SecCounter.new(5, @chapter)
-
+      super
       @headline_stack = []
 
       @list_index = ReVIEW::Book::ListIndex.new
@@ -598,17 +597,9 @@ module ReVIEW
       ''
     end
 
-    def warn(msg)
-      @logger.warn "#{@location}: #{msg}"
-    end
-
-    def error(msg = '(no message)')
-      if msg =~ /builder does not support command/
-        # ignore
-        return
-      end
-
-      super
+    ## override
+    def error(msg = nil)
+      # ignore in indexing
     end
 
     def texequation(_lines, id = nil, _caption = '')

data/lib/review/latexbuilder.rb

@@ -28,6 +28,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @chapter.book.image_types = %w[.ai .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif]
       @blank_needed = false
       @latex_tsize = nil
@@ -35,7 +36,6 @@ module ReVIEW
       @cellwidth = nil
       @ol_num = nil
       @first_line_num = nil
-      @sec_counter = SecCounter.new(5, @chapter)
       @foottext = {}
       setup_index
       initialize_metachars(@book.config['texcommand'])
@@ -61,7 +61,7 @@ module ReVIEW
         require 'nkf'
         @index_mecab = MeCab::Tagger.new(@book.config['pdfmaker']['makeindex_mecab_opts'])
       rescue LoadError
-        warn 'not found MeCab'
+        warn 'not found MeCab', location: location
       end
     end
 
@@ -156,7 +156,7 @@ module ReVIEW
         puts macro('label', label) if label
       end
     rescue
-      error "unknown level: #{level}"
+      app_error "unknown level: #{level}"
     end
 
     def nonum_begin(level, _label, caption)
@@ -480,7 +480,7 @@ module ReVIEW
               captionstr = macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
             end
           rescue KeyError
-            error "no such list: #{id}"
+            app_error "no such list: #{id}"
           end
         end
       end
@@ -613,19 +613,19 @@ module ReVIEW
     end
 
     def image_dummy(id, caption, lines)
-      warn "image not bound: #{id}"
+      warn "image not bound: #{id}", location: location
       puts '\begin{reviewdummyimage}'
-      # path = @chapter.image(id).path
-      puts "--[[path = #{id} (#{existence(id)})]]--"
+      puts escape("--[[path = #{id} (#{existence(id)})]]--")
       lines.each do |line|
+        puts "\n"
         puts detab(line.rstrip)
       end
       puts macro('label', image_label(id))
       @doc_status[:caption] = true
       if @book.config.check_version('2', exception: false)
         puts macro('caption', compile_inline(caption)) if caption.present?
-      else
-        puts macro('reviewimagecaption', compile_inline(caption)) if caption.present?
+      elsif caption.present?
+        puts macro('reviewimagecaption', compile_inline(caption))
       end
       @doc_status[:caption] = nil
       puts '\end{reviewdummyimage}'
@@ -700,10 +700,11 @@ module ReVIEW
           puts "\\#{command}[width=\\maxwidth]{#{@chapter.image(id).path}}"
         end
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         puts '\begin{reviewdummyimage}'
-        puts "--[[path = #{escape(id)} (#{existence(id)})]]--"
+        puts escape("--[[path = #{escape(id)} (#{existence(id)})]]--")
         lines.each do |line|
+          puts "\n"
           puts detab(line.rstrip)
         end
       end
@@ -736,7 +737,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       table_begin(rows.first.size)
       table_rows(sepidx, rows)
@@ -821,7 +822,7 @@ module ReVIEW
       ret = []
       s = ''
       brace = nil
-      size.split('').each do |ch|
+      size.chars.each do |ch|
         case ch
         when '|'
           next
@@ -834,15 +835,11 @@ module ReVIEW
           ret << s
           s = ''
         else
-          if brace
+          if brace || s.empty?
             s << ch
           else
-            if s.empty?
-              s << ch
-            else
-              ret << s
-              s = ch
-            end
+            ret << s
+            s = ch
           end
         end
       end
@@ -902,7 +899,7 @@ module ReVIEW
 
     def imgtable(lines, id, caption = nil, metric = nil)
       unless @chapter.image_bound?(id)
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         image_dummy(id, caption, lines)
         return
       end
@@ -920,7 +917,7 @@ module ReVIEW
         end
         puts macro('label', table_label(id))
       rescue ReVIEW::KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       imgtable_image(id, caption, metric)
 
@@ -1056,7 +1053,7 @@ module ReVIEW
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
@@ -1067,7 +1064,7 @@ module ReVIEW
         @book.chapter_index.number(id)
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
@@ -1079,7 +1076,7 @@ module ReVIEW
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
@@ -1096,7 +1093,7 @@ module ReVIEW
         macro('reviewlistref', I18n.t('format_number', [get_chap(chapter), chapter.list(id).number]))
       end
     rescue KeyError
-      error "unknown list: #{id}"
+      app_error "unknown list: #{id}"
     end
 
     def inline_table(id)
@@ -1107,7 +1104,7 @@ module ReVIEW
         macro('reviewtableref', I18n.t('format_number', [get_chap(chapter), chapter.table(id).number]), table_label(id, chapter))
       end
     rescue KeyError
-      error "unknown table: #{id}"
+      app_error "unknown table: #{id}"
     end
 
     def inline_img(id)
@@ -1118,7 +1115,7 @@ module ReVIEW
         macro('reviewimageref', I18n.t('format_number', [get_chap(chapter), chapter.image(id).number]), image_label(id, chapter))
       end
     rescue KeyError
-      error "unknown image: #{id}"
+      app_error "unknown image: #{id}"
     end
 
     def inline_eq(id)
@@ -1129,13 +1126,13 @@ module ReVIEW
         macro('reviewequationref', I18n.t('format_number', [get_chap(chapter), chapter.equation(id).number]))
       end
     rescue KeyError
-      error "unknown equation: #{id}"
+      app_error "unknown equation: #{id}"
     end
 
     def footnote(id, content)
       if @book.config['footnotetext'] || @foottext[id]
         if @doc_status[:column]
-          warn "//footnote[#{id}] is in the column block. It is recommended to move out of the column block."
+          warn "//footnote[#{id}] is in the column block. It is recommended to move out of the column block.", location: location
         end
         puts macro("footnotetext[#{@chapter.footnote(id).number}]", compile_inline(content.strip))
       end
@@ -1151,7 +1148,7 @@ module ReVIEW
         macro('footnote', compile_inline(@chapter.footnote(id).content.strip))
       end
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
     end
 
     BOUTEN = '・'.freeze
@@ -1285,7 +1282,7 @@ module ReVIEW
             I18n.t('column', compile_inline(chapter.column(id).caption)),
             column_label(id, chapter))
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_raw(str) # rubocop:disable Lint/UselessMethodDefinition
@@ -1324,7 +1321,7 @@ module ReVIEW
         end
         macro(command, @chapter.image(id).path)
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         "\\verb|--[[path = #{id} (#{existence(id)})]]--|"
       end
     end
@@ -1377,18 +1374,16 @@ module ReVIEW
       sa.map! do |item|
         if @index_db[item]
           escape_mendex_key(escape_index(@index_db[item])) + '@' + escape_mendex_display(escape_index(escape(item)))
-        else
-          if item =~ /\A[[:ascii:]]+\Z/ || @index_mecab.nil?
-            esc_item = escape_mendex_display(escape_index(escape(item)))
-            if esc_item == item
-              esc_item
-            else
-              "#{escape_mendex_key(escape_index(item))}@#{esc_item}"
-            end
+        elsif item =~ /\A[[:ascii:]]+\Z/ || @index_mecab.nil?
+          esc_item = escape_mendex_display(escape_index(escape(item)))
+          if esc_item == item
+            esc_item
           else
-            yomi = NKF.nkf('-w --hiragana', @index_mecab.parse(item).force_encoding('UTF-8').chomp)
-            escape_mendex_key(escape_index(yomi)) + '@' + escape_mendex_display(escape_index(escape(item)))
+            "#{escape_mendex_key(escape_index(item))}@#{esc_item}"
           end
+        else
+          yomi = NKF.nkf('-w --hiragana', @index_mecab.parse(item).force_encoding('UTF-8').chomp)
+          escape_mendex_key(escape_index(yomi)) + '@' + escape_mendex_display(escape_index(escape(item)))
         end
       end
 

data/lib/review/loggable.rb

@@ -0,0 +1,27 @@
+module ReVIEW
+  module Loggable
+    attr_reader :logger
+
+    def error(msg, location: nil)
+      logger.error(msg, location: location)
+    end
+
+    def app_error(msg)
+      raise ApplicationError, msg
+    end
+
+    def error!(msg, location: nil)
+      logger.error(msg, location: location)
+
+      exit 1
+    end
+
+    def warn(msg, location: nil)
+      logger.warn(msg, location: location)
+    end
+
+    def debug(msg, location: nil)
+      logger.debug(msg, location: location)
+    end
+  end
+end

data/lib/review/logger.rb

@@ -7,6 +7,30 @@ module ReVIEW
       self.formatter = ->(severity, _datetime, name, msg) { "#{severity} #{name}: #{msg}\n" }
     end
 
+    def warn(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
+    def error(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
+    def debug(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
     def ttylogger?
       nil
     end
@@ -19,6 +43,30 @@ module ReVIEW
   begin
     require 'tty-logger'
     class TTYLogger < ::TTY::Logger
+      def warn(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
+      def error(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
+      def debug(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
       def ttylogger?
         true
       end