review 5.0.0 → 5.3.0

data/lib/review/book/base.rb

@@ -176,6 +176,7 @@ module ReVIEW
 
       def chapter_index
         return @chapter_index if @chapter_index
+
         @chapter_index = create_chapter_index
         @chapter_index
       end
@@ -188,6 +189,7 @@ module ReVIEW
         finded = false
         each_chapter do |c|
           return c if finded
+
           if c == chapter
             finded = true
           end
@@ -199,6 +201,7 @@ module ReVIEW
         finded = false
         each_chapter_r do |c|
           return c if finded
+
           if c == chapter
             finded = true
           end
@@ -392,6 +395,7 @@ module ReVIEW
         File.open(filename_join(@basedir, filename), 'rt:BOM|utf-8') do |f|
           f.each_line do |line|
             next if line.start_with?('#')
+
             line.gsub!(/#.*\Z/, '')
             res << line
           end

data/lib/review/book/book_unit.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2021 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -18,7 +18,8 @@ module ReVIEW
       attr_reader :lines
       attr_accessor :content
 
-      attr_reader :list_index, :table_index, :equation_index, :footnote_index,
+      attr_reader :list_index, :table_index, :equation_index,
+                  :footnote_index, :endnote_index,
                   :numberless_image_index, :image_index, :icon_index, :indepimage_index,
                   :headline_index, :column_index
 
@@ -56,6 +57,7 @@ module ReVIEW
         @table_index = @indexes.table_index
         @equation_index = @indexes.equation_index
         @footnote_index = @indexes.footnote_index
+        @endnote_index = @indexes.endnote_index
         @headline_index = @indexes.headline_index
         @column_index = @indexes.column_index
         if use_bib
@@ -82,6 +84,7 @@ module ReVIEW
 
         @title = ''
         return @title unless content
+
         content.each_line do |line|
           if line =~ /\A=+/
             @title = line.sub(/\A=+(\[.+?\])?(\{.+?\})?/, '').strip
@@ -115,10 +118,19 @@ module ReVIEW
         footnote_index[id]
       end
 
+      def endnote(id)
+        endnote_index[id]
+      end
+
+      def endnotes
+        endnote_index
+      end
+
       def image(id)
         return image_index[id] if image_index.key?(id)
         return icon_index[id] if icon_index.key?(id)
         return numberless_image_index[id] if numberless_image_index.key?(id)
+
         indepimage_index[id]
       end
 
@@ -128,6 +140,7 @@ module ReVIEW
 
       def bibpaper_index
         raise FileNotFound, "no such bib file: #{@book.bib_file}" unless @book.bib_exist?
+
         @book.bibpaper_index
       end
 

data/lib/review/book/chapter.rb

@@ -20,6 +20,7 @@ module ReVIEW
         name += book.ext if File.extname(name).empty?
         path = File.join(book.contentdir, name)
         raise FileNotFound, "file not exist: #{path}" unless File.file?(path)
+
         Chapter.new(book, number, name, path)
       end
 
@@ -85,6 +86,8 @@ module ReVIEW
           nil
         rescue ArgumentError => e
           raise ReVIEW::CompileError, "#{@name}: #{e}"
+        rescue SyntaxError => e
+          raise ReVIEW::SyntaxError, "#{@name}:#{f.lineno}: #{e}"
         end
       end
 

data/lib/review/book/index.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -125,6 +125,9 @@ module ReVIEW
     class FootnoteIndex < Index
     end
 
+    class EndnoteIndex < Index
+    end
+
     class ImageIndex < Index
       def self.item_type
         '(image|graph|imgtable)'
@@ -189,6 +192,7 @@ module ReVIEW
           # when notoc
           return ''
         end
+
         n = @chapter.number
         # XXX: remove magic number (move to lib/review/book/chapter.rb)
         if @chapter.on_appendix? && @chapter.number > 0 && @chapter.number < 28

data/lib/review/book/volume.rb

@@ -13,6 +13,7 @@ module ReVIEW
         b = c = l = 0
         File.foreach(path) do |line|
           next if /\A\#@/ =~ line
+
           text = line.gsub(/\s+/, '')
           b += text.bytesize
           c += text.size

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
@@ -10,6 +10,8 @@ require 'review/exception'
 require 'review/textutils'
 require 'review/compiler'
 require 'review/sec_counter'
+require 'review/img_math'
+require 'review/loggable'
 require 'stringio'
 require 'fileutils'
 require 'tempfile'
@@ -18,6 +20,7 @@ require 'csv'
 module ReVIEW
   class Builder
     include TextUtils
+    include Loggable
 
     CAPTION_TITLES = Compiler.minicolumn_names
 
@@ -29,15 +32,17 @@ module ReVIEW
       nil
     end
 
-    attr_accessor :doc_status, :previous_list_type
+    attr_accessor :doc_status
+    attr_reader :location
 
-    def initialize(strict = false, *_args)
+    def initialize(strict = false, *_args, img_math: nil)
       @strict = strict
       @output = nil
       @logger = ReVIEW.logger
       @doc_status = {}
       @dictionary = {}
-      @previous_list_type = nil
+      @img_math = img_math
+      @shown_endnotes = true
     end
 
     def bind(compiler, chapter, location)
@@ -55,6 +60,7 @@ module ReVIEW
       @tabwidth = nil
       @tsize = nil
       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]
@@ -73,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
@@ -98,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
 
@@ -145,6 +158,7 @@ module ReVIEW
 
     def line_num
       return 1 unless @first_line_num
+
       line_n = @first_line_num
       @first_line_num = nil
 
@@ -157,7 +171,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
 
@@ -167,7 +181,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
 
@@ -181,7 +195,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
@@ -199,7 +213,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
     end
 
@@ -214,7 +228,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
 
@@ -229,7 +243,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
 
@@ -267,17 +281,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 ''
@@ -290,19 +315,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)
@@ -313,7 +338,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)
@@ -324,7 +349,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)
@@ -345,7 +370,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)
@@ -356,13 +381,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)
@@ -418,7 +449,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)
@@ -432,7 +463,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)
@@ -456,7 +487,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
@@ -492,18 +523,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
@@ -514,11 +533,13 @@ module ReVIEW
 
     def parse_metric(type, metric)
       return '' if metric.blank?
+
       params = metric.split(/,\s*/)
       results = []
       params.each do |param|
         if param =~ /\A.+?::/
           next unless param =~ /\A#{type}::/
+
           param.sub!(/\A#{type}::/, '')
         end
         param2 = handle_metric(param)
@@ -543,6 +564,7 @@ module ReVIEW
       if m
         ch = @book.contents.detect { |chap| chap.id == m[1] }
         raise KeyError unless ch
+
         return [ch, m[2]]
       end
       [@chapter, chap_ref]
@@ -575,7 +597,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
 
@@ -647,7 +669,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
@@ -725,18 +757,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
@@ -744,7 +780,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/call_hook.rb

@@ -0,0 +1,20 @@
+module ReVIEW
+  module CallHook
+    def call_hook(hook_name, *params, base_dir: nil)
+      maker = @config.maker
+      filename = @config.dig(maker, hook_name)
+      return unless filename
+
+      hook = File.absolute_path(filename, base_dir)
+      @logger.debug("Call #{hook_name}. (#{hook})")
+
+      return if !File.exist?(hook) || !FileTest.executable?(hook)
+
+      if ENV['REVIEW_SAFE_MODE'].to_i & 1 > 0
+        warn 'hook configuration is prohibited in safe mode. ignored.'
+      else
+        system(hook, *params)
+      end
+    end
+  end
+end

data/lib/review/catalog.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'date'
 
 module ReVIEW
   class Catalog
@@ -50,6 +51,7 @@ module ReVIEW
 
     def parts_with_chaps
       return [] unless @yaml['CHAPS']
+
       @yaml['CHAPS'].flatten.compact
     end