review 4.0.0 → 5.1.1

data/lib/review/book/part.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -6,13 +6,11 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 # For details of the GNU LGPL, see the file "COPYING".
 #
-require 'review/book/compilable'
+require 'review/book/book_unit'
 
 module ReVIEW
   module Book
-    class Part
-      include Compilable
-
+    class Part < BookUnit
       def self.mkpart_from_namelistfile(book, path)
         chaps = []
         File.read(path, mode: 'rt:BOM|utf-8').split.each_with_index do |name, number|
@@ -30,7 +28,7 @@ module ReVIEW
       end
 
       def self.mkpart(chaps)
-        chaps.empty? ? nil : Part.new(self, nil, chaps)
+        chaps.empty? ? nil : Part.new(chaps[0].book, nil, chaps)
       end
 
       # if Part is dummy, `number` is nil.
@@ -38,15 +36,16 @@ module ReVIEW
       def initialize(book, number, chapters, name = '', io = nil)
         @book = book
         @number = number
-        @chapters = chapters
         @name = name
+        @chapters = chapters
         @path = name
-        @content = nil
         if io
           @content = io.read
         elsif @path.present? && File.exist?(File.join(@book.config['contentdir'], @path))
           @content = File.read(File.join(@book.config['contentdir'], @path), mode: 'rt:BOM|utf-8')
-          @name = File.basename(@name, '.re')
+          @name = File.basename(name, '.re')
+        else
+          @content = ''
         end
         if file?
           @title = nil
@@ -54,6 +53,19 @@ module ReVIEW
           @title = name
         end
         @volume = nil
+
+        super()
+      end
+
+      def generate_indexes
+        super
+
+        return unless content
+
+        @numberless_image_index = @indexes.numberless_image_index
+        @image_index = @indexes.image_index
+        @icon_index = @indexes.icon_index
+        @indepimage_index = @indexes.indepimage_index
       end
 
       attr_reader :number
@@ -65,8 +77,11 @@ module ReVIEW
       end
 
       def volume
-        vol = Volume.sum(@chapters.map(&:volume))
-        vol.page_per_kbyte = @book.page_metric.page_per_kbyte
+        if @number && file?
+          vol = Volume.count_file(File.join(@book.config['contentdir'], @path))
+        else
+          vol = Volume.new(0, 0, 0)
+        end
         vol
       end
 

data/lib/review/book/volume.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2007-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2007-2020 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -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
@@ -22,7 +23,7 @@ module ReVIEW
       end
 
       def self.sum(vols)
-        vols.inject(new) { |sum, i| sum + i }
+        vols.inject(new) { |sum, i| sum + i } # rubocop:disable Performance/Sum
       end
 
       def self.dummy
@@ -33,20 +34,19 @@ module ReVIEW
         @bytes = bytes
         @chars = chars
         @lines = lines
-        @page_per_kbyte = nil
       end
 
       attr_reader :bytes
       attr_reader :chars
       attr_accessor :lines
-      attr_accessor :page_per_kbyte
 
       def kbytes
         (@bytes.to_f / 1024).ceil
       end
 
       def page
-        (kbytes.to_f / @page_per_kbyte).ceil
+        # XXX:unrelibable
+        kbytes.to_f.ceil
       end
 
       def to_s

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,8 @@ require 'review/exception'
 require 'review/textutils'
 require 'review/compiler'
 require 'review/sec_counter'
+require 'review/img_math'
 require 'stringio'
-require 'cgi'
 require 'fileutils'
 require 'tempfile'
 require 'csv'
@@ -20,7 +20,7 @@ module ReVIEW
   class Builder
     include TextUtils
 
-    CAPTION_TITLES = %w[note memo tip info warning important caution notice].freeze
+    CAPTION_TITLES = Compiler.minicolumn_names
 
     def pre_paragraph
       nil
@@ -30,21 +30,18 @@ module ReVIEW
       nil
     end
 
-    attr_accessor :doc_status
+    attr_accessor :doc_status, :previous_list_type
 
-    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)
+      @previous_list_type = nil
+      @img_math = img_math
     end
 
-    def builder_init(*args)
-    end
-    private :builder_init
-
     def bind(compiler, chapter, location)
       @compiler = compiler
       @chapter = chapter
@@ -53,11 +50,23 @@ 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
-        if @book.config['words_file']
-          load_words(@book.config['words_file'])
+        @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.each do |f|
+            load_words(f)
+          end
         end
         if @book.config['tabwidth']
           @tabwidth = @book.config['tabwidth']
@@ -77,6 +86,7 @@ module ReVIEW
 
     def builder_init_file
       @sec_counter = SecCounter.new(5, @chapter)
+      @doc_status = {}
     end
     private :builder_init_file
 
@@ -84,8 +94,19 @@ module ReVIEW
       false
     end
 
+    def solve_nest(s)
+      check_nest
+      s.gsub(/\x01→.+?←\x01/, '')
+    end
+
+    def check_nest
+      if @children && !@children.empty?
+        error "//beginchild of #{@children.reverse.join(',')} misses //endchild"
+      end
+    end
+
     def result
-      @output.string
+      solve_nest(@output.string)
     end
 
     alias_method :raw_result, :result
@@ -127,6 +148,7 @@ module ReVIEW
 
     def line_num
       return 1 unless @first_line_num
+
       line_n = @first_line_num
       @first_line_num = nil
 
@@ -135,25 +157,28 @@ 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}"
       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}"
       end
-      listnum_body(lines, lang)
     end
 
-    def source(lines, caption, lang = nil)
-      source_header(caption)
+    def source(lines, caption = nil, lang = nil)
+      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)
@@ -168,26 +193,44 @@ 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}"
       end
-      table_begin(rows.first.size)
-      table_rows(sepidx, rows)
-      table_end
+    end
+
+    def table_row_separator_regexp
+      case @book.config['table_row_separator']
+      when 'tabs'
+        Regexp.new('\t+')
+      when 'singletab'
+        Regexp.new('\t')
+      when 'spaces'
+        Regexp.new('\s+')
+      when 'verticalbar'
+        Regexp.new('\s*\\' + escape('|') + '\s*')
+      else
+        error "Unknown value for 'table_row_separator', shold be: tabs, singletab, spaces, verticalbar"
+      end
     end
 
     def parse_table_rows(lines)
       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(/\t+/).map { |s| s.sub(/\A\./, '') })
+        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?
@@ -212,7 +255,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
@@ -475,11 +518,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)
@@ -504,6 +549,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]
@@ -516,9 +562,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]
+        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 = '')
@@ -658,5 +731,29 @@ EOTGNUPLOT
     def escape(str)
       str
     end
+
+    def beginchild
+      @children ||= []
+      unless @previous_list_type
+        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?
+        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")
+      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