review 4.1.0 → 5.2.0

data/lib/review/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2002-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2002-2020 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -10,8 +10,9 @@ require 'review/exception'
 require 'review/textutils'
 require 'review/compiler'
 require 'review/sec_counter'
+require 'review/img_math'
+require 'review/loggable'
 require 'stringio'
-require 'cgi'
 require 'fileutils'
 require 'tempfile'
 require 'csv'
@@ -19,8 +20,9 @@ require 'csv'
 module ReVIEW
   class Builder
     include TextUtils
+    include Loggable
 
-    CAPTION_TITLES = %w[note memo tip info warning important caution notice].freeze
+    CAPTION_TITLES = Compiler.minicolumn_names
 
     def pre_paragraph
       nil
@@ -31,20 +33,17 @@ module ReVIEW
     end
 
     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 = {}
-      builder_init(*args)
+      @img_math = img_math
     end
 
-    def builder_init(*args)
-    end
-    private :builder_init
-
     def bind(compiler, chapter, location)
       @compiler = compiler
       @chapter = chapter
@@ -53,9 +52,14 @@ module ReVIEW
       if @chapter.present?
         @book = @chapter.book
       end
+      @chapter.generate_indexes
+      if @book
+        @book.generate_indexes
+      end
       @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]
@@ -74,7 +78,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
@@ -84,6 +88,7 @@ module ReVIEW
 
     def builder_init_file
       @sec_counter = SecCounter.new(5, @chapter)
+      @doc_status = {}
     end
     private :builder_init_file
 
@@ -91,8 +96,19 @@ module ReVIEW
       false
     end
 
+    def solve_nest(s)
+      check_nest
+      s.gsub(/\x01→.+?←\x01/, '')
+    end
+
+    def check_nest
+      if @children && !@children.empty?
+        app_error "//beginchild of #{@children.reverse.join(',')} misses //endchild"
+      end
+    end
+
     def result
-      @output.string
+      solve_nest(@output.string)
     end
 
     alias_method :raw_result, :result
@@ -134,6 +150,7 @@ module ReVIEW
 
     def line_num
       return 1 unless @first_line_num
+
       line_n = @first_line_num
       @first_line_num = nil
 
@@ -142,32 +159,35 @@ module ReVIEW
 
     def list(lines, id, caption, lang = nil)
       begin
-        list_header(id, caption, lang)
+        list_header(id, caption, lang) if caption_top?('list')
+        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
-      list_body(id, lines, lang)
     end
 
     def listnum(lines, id, caption, lang = nil)
       begin
-        list_header(id, caption, lang)
+        list_header(id, caption, lang) if caption_top?('list')
+        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
-      listnum_body(lines, lang)
     end
 
     def source(lines, caption = nil, lang = nil)
-      source_header(caption)
+      source_header(caption) if caption_top?('list')
       source_body(lines, lang)
+      source_header(caption) unless caption_top?('list')
     end
 
     def image(lines, id, caption, metric = nil)
       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
@@ -175,15 +195,18 @@ module ReVIEW
     def table(lines, id = nil, caption = nil)
       sepidx, rows = parse_table_rows(lines)
       begin
-        if caption.present?
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+        table_begin(rows.first.size)
+        table_rows(sepidx, rows)
+        table_end
+        if !caption_top?('table') && caption.present?
           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)
-      table_end
     end
 
     def table_row_separator_regexp
@@ -197,7 +220,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
 
@@ -205,14 +228,14 @@ module ReVIEW
       sepidx = nil
       rows = []
       lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line || /\A[\=\{\-\}]{12}/ =~ line
+        if /\A[=\-]{12}/ =~ line || /\A[={\-}]{12}/ =~ line
           sepidx ||= idx
           next
         end
         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
 
@@ -234,7 +257,7 @@ module ReVIEW
 
     def adjust_n_cols(rows)
       rows.each do |cols|
-        while cols.last and cols.last.strip.empty?
+        while cols.last && cols.last.strip.empty?
           cols.pop
         end
       end
@@ -273,19 +296,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)
@@ -296,7 +319,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)
@@ -307,7 +330,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)
@@ -328,7 +351,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)
@@ -339,13 +362,13 @@ 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_bou(str)
@@ -401,7 +424,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)
@@ -415,7 +438,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)
@@ -439,7 +462,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
@@ -475,18 +498,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
@@ -497,11 +508,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)
@@ -526,6 +539,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]
@@ -538,9 +552,36 @@ module ReVIEW
     CAPTION_TITLES.each do |name|
       class_eval %Q(
         def #{name}(lines, caption = nil)
+          check_nested_minicolumn
           captionblock("#{name}", lines, caption)
         end
-      )
+
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          if caption
+            puts compile_inline(caption)
+          end
+        end
+
+        def #{name}_end
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 17
+    end
+
+    def check_nested_minicolumn
+      if @doc_status[:minicolumn]
+        app_error "#{@location}: nested mini-column is not allowed"
+      end
+    end
+
+    def in_minicolumn?
+      @doc_status[:minicolumn]
+    end
+
+    def minicolumn_block_name?(name)
+      CAPTION_TITLES.include?(name)
     end
 
     def graph(lines, id, command, caption = '')
@@ -680,5 +721,33 @@ EOTGNUPLOT
     def escape(str)
       str
     end
+
+    def previous_list_type
+      @compiler.previous_list_type
+    end
+
+    def beginchild
+      @children ||= []
+      unless previous_list_type
+        app_error "//beginchild is shown, but previous element isn't ul, ol, or dl"
+      end
+      puts "\x01→#{previous_list_type}←\x01"
+      @children.push(previous_list_type)
+    end
+
+    def endchild
+      if @children.nil? || @children.empty?
+        app_error "//endchild is shown, but any opened //beginchild doesn't exist"
+      else
+        puts "\x01→/#{@children.pop}←\x01"
+      end
+    end
+
+    def caption_top?(type)
+      unless %w[top bottom].include?(@book.config['caption_position'][type])
+        warn "invalid caption_position/#{type} parameter. 'top' is assumed", location: @location
+      end
+      @book.config['caption_position'][type] != 'bottom'
+    end
   end
 end # module ReVIEW

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

@@ -41,7 +41,7 @@ module ReVIEW
 
     def replace_part(old_name, new_name)
       @yaml['CHAPS'].map! do |e|
-        if e.is_a?(Hash) and (e.keys.first == old_name)
+        if e.is_a?(Hash) && (e.keys.first == old_name)
           e = { new_name => e.values.first }
         end
         e
@@ -50,6 +50,7 @@ module ReVIEW
 
     def parts_with_chaps
       return [] unless @yaml['CHAPS']
+
       @yaml['CHAPS'].flatten.compact
     end
 
@@ -89,7 +90,7 @@ module ReVIEW
         filenames.concat(postdef)
       end
       filenames.each do |filename|
-        refile = File.join(basedir, config['contentdir'], filename)
+        refile = File.expand_path(File.join(config['contentdir'], filename), basedir)
         unless File.exist?(refile)
           raise FileNotFound, "file not found in catalog.yml: #{refile}"
         end