review 5.1.1 → 5.4.0

data/lib/review/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2002-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2002-2021 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -11,6 +11,7 @@ require 'review/textutils'
 require 'review/compiler'
 require 'review/sec_counter'
 require 'review/img_math'
+require 'review/loggable'
 require 'stringio'
 require 'fileutils'
 require 'tempfile'
@@ -19,6 +20,7 @@ require 'csv'
 module ReVIEW
   class Builder
     include TextUtils
+    include Loggable
 
     CAPTION_TITLES = Compiler.minicolumn_names
 
@@ -30,7 +32,8 @@ module ReVIEW
       nil
     end
 
-    attr_accessor :doc_status, :previous_list_type
+    attr_accessor :doc_status
+    attr_reader :location
 
     def initialize(strict = false, *_args, img_math: nil)
       @strict = strict
@@ -38,8 +41,8 @@ module ReVIEW
       @logger = ReVIEW.logger
       @doc_status = {}
       @dictionary = {}
-      @previous_list_type = nil
       @img_math = img_math
+      @shown_endnotes = true
     end
 
     def bind(compiler, chapter, location)
@@ -59,11 +62,11 @@ module ReVIEW
       if @book && @book.config
         @img_math ||= ReVIEW::ImgMath.new(@book.config)
         if words_file_path = @book.config['words_file']
-          if words_file_path.is_a?(String)
-            words_files = [words_file_path]
-          else
-            words_files = words_file_path
-          end
+          words_files = if words_file_path.is_a?(String)
+                          [words_file_path]
+                        else
+                          words_file_path
+                        end
           words_files.each do |f|
             load_words(f)
           end
@@ -76,7 +79,7 @@ module ReVIEW
           begin
             require 'unicode/eaw'
           rescue LoadError
-            warn 'not found unicode/eaw. disabled join_lines_by_lang feature.'
+            warn 'not found unicode/eaw. disabled join_lines_by_lang feature.', location: @location
             @book.config['join_lines_by_lang'] = nil
           end
         end
@@ -101,11 +104,18 @@ module ReVIEW
 
     def check_nest
       if @children && !@children.empty?
-        error "//beginchild of #{@children.reverse.join(',')} misses //endchild"
+        app_error "#{@location}: //beginchild of #{@children.reverse.join(',')} misses //endchild"
+      end
+    end
+
+    def check_printendnotes
+      if @shown_endnotes.nil?
+        app_error "#{@location}: //endnote is found but //printendnotes is not found."
       end
     end
 
     def result
+      check_printendnotes
       solve_nest(@output.string)
     end
 
@@ -124,11 +134,9 @@ module ReVIEW
     end
 
     def load_words(file)
-      if File.exist?(file)
-        if file =~ /\.csv\Z/i
-          CSV.foreach(file) do |row|
-            @dictionary[row[0]] = row[1]
-          end
+      if File.exist?(file) && /\.csv\Z/i.match?(file)
+        CSV.foreach(file) do |row|
+          @dictionary[row[0]] = row[1]
         end
       end
     end
@@ -161,7 +169,7 @@ module ReVIEW
         list_body(id, lines, lang)
         list_header(id, caption, lang) unless caption_top?('list')
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
     end
 
@@ -171,7 +179,7 @@ module ReVIEW
         listnum_body(lines, lang)
         list_header(id, caption, lang) unless caption_top?('list')
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
     end
 
@@ -185,7 +193,7 @@ module ReVIEW
       if @chapter.image_bound?(id)
         image_image(id, caption, metric)
       else
-        warn "image not bound: #{id}" if @strict
+        warn "image not bound: #{id}", location: @location if @strict
         image_dummy(id, caption, lines)
       end
     end
@@ -203,7 +211,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
     end
 
@@ -218,7 +226,7 @@ module ReVIEW
       when 'verticalbar'
         Regexp.new('\s*\\' + escape('|') + '\s*')
       else
-        error "Unknown value for 'table_row_separator', shold be: tabs, singletab, spaces, verticalbar"
+        app_error "Unknown value for 'table_row_separator', shold be: tabs, singletab, spaces, verticalbar"
       end
     end
 
@@ -233,7 +241,7 @@ module ReVIEW
         rows.push(line.strip.split(table_row_separator_regexp).map { |s| s.sub(/\A\./, '') })
       end
       rows = adjust_n_cols(rows)
-      error 'no rows in the table' if rows.empty?
+      app_error 'no rows in the table' if rows.empty?
       [sepidx, rows]
     end
 
@@ -271,17 +279,28 @@ module ReVIEW
       table(lines, nil, caption)
     end
 
-    # def footnote(id, str)
-    #   @footnotes.push [id, str]
-    # end
-    #
-    # def flush_footnote
-    #   footnote_begin
-    #   @footnotes.each do |id, str|
-    #     footnote_item(id, str)
-    #   end
-    #   footnote_end
-    # end
+    def printendnotes
+      @shown_endnotes = true
+      endnote_begin
+      @chapter.endnotes.each do |en|
+        endnote_item(en.id)
+      end
+      endnote_end
+    end
+
+    def endnote(_id, _str)
+      @shown_endnotes = nil
+    end
+
+    def endnote_begin
+    end
+
+    def endnote_end
+    end
+
+    def endnote_item(id)
+      puts "(#{@chapter.endnote(id).number}) #{compile_inline(@chapter.endnote(id).content)}"
+    end
 
     def blankline
       puts ''
@@ -294,19 +313,19 @@ module ReVIEW
     def inline_chapref(id)
       compile_inline(@book.chapter_index.display_string(id))
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_chap(id)
       @book.chapter_index.number(id)
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_title(id)
       compile_inline(@book.chapter_index.title(id))
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_list(id)
@@ -317,7 +336,7 @@ module ReVIEW
         %Q(#{I18n.t('list')}#{I18n.t('format_number_without_chapter', [chapter.list(id).number])})
       end
     rescue KeyError
-      error "unknown list: #{id}"
+      app_error "unknown list: #{id}"
     end
 
     def inline_img(id)
@@ -328,7 +347,7 @@ module ReVIEW
         %Q(#{I18n.t('image')}#{I18n.t('format_number_without_chapter', [chapter.image(id).number])})
       end
     rescue KeyError
-      error "unknown image: #{id}"
+      app_error "unknown image: #{id}"
     end
 
     def inline_imgref(id)
@@ -349,7 +368,7 @@ module ReVIEW
         %Q(#{I18n.t('table')}#{I18n.t('format_number_without_chapter', [chapter.table(id).number])})
       end
     rescue KeyError
-      error "unknown table: #{id}"
+      app_error "unknown table: #{id}"
     end
 
     def inline_eq(id)
@@ -360,13 +379,19 @@ module ReVIEW
         %Q(#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [chapter.equation(id).number])})
       end
     rescue KeyError
-      error "unknown equation: #{id}"
+      app_error "unknown equation: #{id}"
     end
 
     def inline_fn(id)
       @chapter.footnote(id).content
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
+    end
+
+    def inline_endnote(id)
+      "(#{@chapter.endnote(id).number})"
+    rescue KeyError
+      app_error "unknown endnote: #{id}"
     end
 
     def inline_bou(str)
@@ -422,7 +447,7 @@ module ReVIEW
         inline_hd_chap(@chapter, id)
       end
     rescue KeyError
-      error "unknown headline: #{id}"
+      app_error "unknown headline: #{id}"
     end
 
     def inline_column(id)
@@ -436,7 +461,7 @@ module ReVIEW
         inline_column_chap(@chapter, id)
       end
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_column_chap(chapter, id)
@@ -460,7 +485,7 @@ module ReVIEW
       if translated
         escape(translated)
       else
-        warn "word not bound: #{s}"
+        warn "word not bound: #{s}", location: @location
         escape("[missing word: #{s}]")
       end
     end
@@ -496,18 +521,6 @@ module ReVIEW
       end
     end
 
-    def warn(msg)
-      @logger.warn "#{@location}: #{msg}"
-    end
-
-    def error(msg)
-      if msg =~ /:\d+: error: /
-        raise ApplicationError, msg
-      else
-        raise ApplicationError, "#{@location}: error: #{msg}"
-      end
-    end
-
     def handle_metric(str)
       str
     end
@@ -522,8 +535,8 @@ module ReVIEW
       params = metric.split(/,\s*/)
       results = []
       params.each do |param|
-        if param =~ /\A.+?::/
-          next unless param =~ /\A#{type}::/
+        if /\A.+?::/.match?(param)
+          next unless /\A#{type}::/.match?(param)
 
           param.sub!(/\A#{type}::/, '')
         end
@@ -582,7 +595,7 @@ module ReVIEW
 
     def check_nested_minicolumn
       if @doc_status[:minicolumn]
-        error "#{@location}: nested mini-column is not allowed"
+        app_error "#{@location}: nested mini-column is not allowed"
       end
     end
 
@@ -654,7 +667,17 @@ EOTGNUPLOT
         ext = 'eps'
         file_path.sub!(/\.pdf\Z/, '.eps')
       end
-      system_graph(id, 'java', '-jar', 'plantuml.jar', "-t#{ext}", '-charset', 'UTF-8', tf_path)
+      plant_path = nil
+      if File.exist?('plantuml.jar')
+        plant_path = 'plantuml.jar'
+      elsif File.exist?('/usr/share/plantuml/plantuml.jar')
+        plant_path = '/usr/share/plantuml/plantuml.jar'
+      elsif File.exist?('/usr/share/java/plantuml.jar')
+        plant_path = '/usr/share/java/plantuml.jar'
+      else
+        error!('missing plantuml.jar. Please put plantuml.jar at the working folder.')
+      end
+      system_graph(id, 'java', '-jar', plant_path, "-t#{ext}", '-charset', 'UTF-8', tf_path)
       FileUtils.mv("#{tf_path}.#{ext}", file_path)
       file_path
     end
@@ -732,18 +755,22 @@ EOTGNUPLOT
       str
     end
 
+    def previous_list_type
+      @compiler.previous_list_type
+    end
+
     def beginchild
       @children ||= []
-      unless @previous_list_type
-        error "//beginchild is shown, but previous element isn't ul, ol, or dl"
+      unless previous_list_type
+        app_error "#{@location}: //beginchild is shown, but previous element isn't ul, ol, or dl"
       end
-      puts "\x01→#{@previous_list_type}←\x01"
-      @children.push(@previous_list_type)
+      puts "\x01→#{previous_list_type}←\x01"
+      @children.push(previous_list_type)
     end
 
     def endchild
       if @children.nil? || @children.empty?
-        error "//endchild is shown, but any opened //beginchild doesn't exist"
+        app_error "#{@location}: //endchild is shown, but any opened //beginchild doesn't exist"
       else
         puts "\x01→/#{@children.pop}←\x01"
       end
@@ -751,7 +778,7 @@ EOTGNUPLOT
 
     def caption_top?(type)
       unless %w[top bottom].include?(@book.config['caption_position'][type])
-        warn("invalid caption_position/#{type} parameter. 'top' is assumed")
+        warn "invalid caption_position/#{type} parameter. 'top' is assumed", location: @location
       end
       @book.config['caption_position'][type] != 'bottom'
     end

data/lib/review/catalog.rb

@@ -1,13 +1,14 @@
 require 'yaml'
+require 'date'
 
 module ReVIEW
   class Catalog
     def initialize(file)
-      if file.respond_to?(:read)
-        @yaml = YAML.safe_load(file.read, [Date])
-      else ## as Object
-        @yaml = file
-      end
+      @yaml = if file.respond_to?(:read)
+                YAMLLoader.safe_load(file.read)
+              else ## as Object
+                file
+              end
       @yaml ||= {}
     end