review 4.0.0 → 4.1.0

data/lib/review/book/index.rb

@@ -18,18 +18,18 @@ module ReVIEW
   module Book
     class Index
       def self.parse(src, *args)
-        items = []
+        index = self.new(*args)
         seq = 1
         src.grep(%r{\A//#{item_type}}) do |line|
           if id = line.slice(/\[(.*?)\]/, 1)
-            items.push(ReVIEW::Book::Index::Item.new(id, seq))
+            index.add_item(ReVIEW::Book::Index::Item.new(id, seq))
             seq += 1
             if id.empty?
               ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}"
             end
           end
         end
-        new(items, *args)
+        index
       end
 
       include Enumerable
@@ -38,19 +38,22 @@ module ReVIEW
         self.class.item_type
       end
 
-      def initialize(items)
-        @items = items
+      def initialize
         @index = {}
         @logger = ReVIEW.logger
-        items.each do |item|
-          if @index[item.id]
-            @logger.warn "warning: duplicate ID: #{item.id} (#{item})"
-          end
-          @index[item.id] = item
-        end
         @image_finder = nil
       end
 
+      def add_item(item)
+        if @index[item.id]
+          @logger.warn "warning: duplicate ID: #{item.id} (#{item})"
+        end
+        @index[item.id] = item
+        if item.class != ReVIEW::Book::Chapter
+          item.index = self
+        end
+      end
+
       def [](id)
         @index.fetch(id)
       rescue
@@ -60,7 +63,7 @@ module ReVIEW
           raise KeyError, "key '#{id}' is ambiguous for #{self.class}"
         end
 
-        @items.each do |item|
+        @index.values.each do |item|
           if item.id.split('|').include?(id)
             return item
           end
@@ -73,7 +76,7 @@ module ReVIEW
       end
 
       def each(&block)
-        @items.each(&block)
+        @index.values.each(&block)
       end
 
       def key?(id)
@@ -88,8 +91,9 @@ module ReVIEW
       end
 
       def number(id)
-        chapter = @index.fetch(id)
+        chapter_item = @index.fetch(id)
         begin
+          chapter = chapter_item.content
           chapter.format_number
         rescue # part
           I18n.t('part', chapter.number)
@@ -97,9 +101,9 @@ module ReVIEW
       end
 
       def title(id)
-        @index.fetch(id).title
+        @index.fetch(id).content.title
       rescue # non-file part
-        @index.fetch(id).name
+        @index.fetch(id).content.name
       end
 
       def display_string(id)
@@ -131,32 +135,32 @@ module ReVIEW
 
     class FootnoteIndex < Index
       def self.parse(src)
-        items = []
+        index = self.new
         seq = 1
         src.grep(%r{\A//footnote}) do |line|
           if m = /\[(.*?)\]\[(.*)\]/.match(line)
             m1 = m[1].gsub(/\\(\])/) { $1 }
             m2 = m[2].gsub(/\\(\])/) { $1 }
-            items.push(Item.new(m1, seq, m2))
+            index.add_item(Item.new(m1, seq, m2))
           end
           seq += 1
         end
-        new(items)
+        index
       end
     end
 
     class ImageIndex < Index
       def self.parse(src, *args)
-        items = []
+        index = self.new(*args)
         seq = 1
         src.grep(%r{\A//#{item_type}}) do |line|
           # ex. ["//image", "id", "", "caption"]
           elements = line.split(/\[(.*?)\]/)
           if elements[1].present?
-            if line =~ %r{\A//imgtable}
-              items.push(ReVIEW::Book::Index::Item.new(elements[1], 0, elements[3]))
+            if line.start_with?('//imgtable')
+              index.add_item(ReVIEW::Book::Index::Item.new(elements[1], 0, elements[3]))
             else ## %r<\A//(image|graph)>
-              items.push(ReVIEW::Book::Index::Item.new(elements[1], seq, elements[3]))
+              index.add_item(ReVIEW::Book::Index::Item.new(elements[1], seq, elements[3]))
               seq += 1
             end
             if elements[1] == ''
@@ -164,7 +168,7 @@ module ReVIEW
             end
           end
         end
-        new(items, *args)
+        index
       end
 
       def self.item_type
@@ -173,14 +177,12 @@ module ReVIEW
 
       attr_reader :image_finder
 
-      def initialize(items, chapid, basedir, types, builder)
-        super(items)
-        items.each do |item|
-          item.index = self
-        end
+      def initialize(chapid, basedir, types, builder)
+        super()
         @chapid = chapid
         @basedir = basedir
         @types = types
+        @logger = ReVIEW.logger
 
         @image_finder = ReVIEW::Book::ImageFinder.new(basedir, chapid, builder, types)
       end
@@ -191,44 +193,42 @@ module ReVIEW
     end
 
     class IconIndex < ImageIndex
-      def initialize(items, chapid, basedir, types, builder)
-        @items = items
+      def initialize(chapid, basedir, types, builder)
         @index = {}
-        items.each { |item| @index[item.id] = item }
-        items.each { |item| item.index = self }
         @chapid = chapid
         @basedir = basedir
         @types = types
+        @logger = ReVIEW.logger
 
         @image_finder = ImageFinder.new(basedir, chapid, builder, types)
       end
 
       def self.parse(src, *args)
-        items = []
+        index = self.new(*args)
         seq = 1
         src.grep(/@<icon>/) do |line|
           line.gsub(/@<icon>\{(.+?)\}/) do
-            items.push(ReVIEW::Book::Index::Item.new($1, seq))
+            index.add_item(ReVIEW::Book::Index::Item.new($1, seq))
             seq += 1
           end
         end
-        new(items, *args)
+        index
       end
     end
 
     class BibpaperIndex < Index
       def self.parse(src)
-        items = []
+        index = self.new
         seq = 1
         src.grep(%r{\A//bibpaper}) do |line|
           if m = /\[(.*?)\]\[(.*)\]/.match(line)
             m1 = m[1].gsub(/\\(.)/) { $1 }
             m2 = m[2].gsub(/\\(.)/) { $1 }
-            items.push(Item.new(m1, seq, m2))
+            index.add_item(Item.new(m1, seq, m2))
           end
           seq += 1
         end
-        new(items)
+        index
       end
     end
 
@@ -254,10 +254,9 @@ module ReVIEW
 
     class HeadlineIndex < Index
       HEADLINE_PATTERN = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/
-      attr_reader :items
 
       def self.parse(src, chap)
-        items = []
+        headline_index = self.new(chap)
         indexs = []
         headlines = []
         inside_column = false
@@ -267,7 +266,7 @@ module ReVIEW
           if line =~ %r{\A//[a-z]+.*\{\Z}
             inside_block = true
             next
-          elsif line =~ %r{\A//\}}
+          elsif line.start_with?('//}')
             inside_block = nil
             next
           elsif inside_block
@@ -311,27 +310,22 @@ module ReVIEW
 
           if %w[nonum notoc nodisp].include?(m[2])
             headlines[index] = m[3].present? ? m[3].strip : m[4].strip
-            items.push(Item.new(headlines.join('|'), nil, m[4].strip))
+            item_id = headlines.join('|')
+            headline_index.add_item(Item.new(item_id, nil, m[4].strip))
           else
             indexs[index] += 1
             headlines[index] = m[3].present? ? m[3].strip : m[4].strip
-            items.push(Item.new(headlines.join('|'), indexs.dup, m[4].strip))
+            item_id = headlines.join('|')
+            headline_index.add_item(Item.new(item_id, indexs.dup, m[4].strip))
           end
         end
-        new(items, chap)
+        headline_index
       end
 
-      def initialize(items, chap)
-        @items = items
+      def initialize(chap)
         @chap = chap
         @index = {}
         @logger = ReVIEW.logger
-        items.each do |item|
-          if @index[item.id]
-            @logger.warn "warning: duplicate ID: #{item.id}"
-          end
-          @index[item.id] = item
-        end
       end
 
       def number(id)
@@ -352,7 +346,7 @@ module ReVIEW
       COLUMN_PATTERN = /\A(=+)\[column\](?:\{(.+?)\})?(.*)/
 
       def self.parse(src, *_args)
-        items = []
+        index = self.new
         seq = 1
         src.each do |line|
           m = COLUMN_PATTERN.match(line)
@@ -362,10 +356,10 @@ module ReVIEW
           caption = m[3].strip
           id = caption if id.nil? || id.empty?
 
-          items.push(ReVIEW::Book::Index::Item.new(id, seq, caption))
+          index.add_item(ReVIEW::Book::Index::Item.new(id, seq, caption))
           seq += 1
         end
-        new(items)
+        index
       end
     end
   end

data/lib/review/book/index/item.rb

@@ -27,7 +27,7 @@ module ReVIEW
         attr_reader :id
         attr_reader :number
         attr_reader :caption
-        attr_writer :index # internal use only
+        attr_accessor :index # internal use only
 
         alias_method :content, :caption
 

data/lib/review/builder.rb

@@ -56,8 +56,15 @@ module ReVIEW
       @tabwidth = nil
       @tsize = nil
       if @book && @book.config
-        if @book.config['words_file']
-          load_words(@book.config['words_file'])
+        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']
@@ -151,7 +158,7 @@ module ReVIEW
       listnum_body(lines, lang)
     end
 
-    def source(lines, caption, lang = nil)
+    def source(lines, caption = nil, lang = nil)
       source_header(caption)
       source_body(lines, lang)
     end
@@ -179,6 +186,21 @@ module ReVIEW
       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 = []
@@ -187,7 +209,7 @@ module ReVIEW
           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?

data/lib/review/compiler.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto
 # Copyright (c) 2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -115,7 +115,7 @@ module ReVIEW
     defblock :emlist, 0..2
     defblock :cmd, 0..1
     defblock :table, 0..2
-    defblock :imgtable, 0..2
+    defblock :imgtable, 0..3
     defblock :emtable, 0..1
     defblock :quote, 0
     defblock :image, 2..3, true
@@ -422,7 +422,10 @@ module ReVIEW
     def compile_dlist(f)
       @strategy.dl_begin
       while /\A\s*:/ =~ f.peek
+        # defer compile_inline to handle footnotes
+        @strategy.doc_status[:dt] = true
         @strategy.dt(text(f.gets.sub(/\A\s*:/, '').strip))
+        @strategy.doc_status[:dt] = nil
         desc = f.break(/\A(\S|\s*:|\s+\d+\.\s|\s+\*\s)/).map { |line| text(line.strip) }
         @strategy.dd(desc)
         f.skip_blank_lines
@@ -466,7 +469,7 @@ module ReVIEW
           buf.push(text(line.rstrip, true))
         end
       end
-      unless %r{\A//\}} =~ f.peek
+      unless f.peek.to_s.start_with?('//}')
         error "unexpected EOF (block begins at: #{head})"
         return buf
       end

data/lib/review/configure.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2012-2019 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2012-2020 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -66,6 +66,7 @@ module ReVIEW
         'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt],
         'externallink' => true,
         'join_lines_by_lang' => nil, # experimental. default should be nil
+        'table_row_separator' => 'tabs',
         # for IDGXML
         'tableopt' => nil,
         'listinfo' => nil,
@@ -74,7 +75,6 @@ module ReVIEW
         'structuredxml' => nil,
         'pt_to_mm_unit' => 0.3528, # DTP: 1pt = 0.3528mm, JIS: 1pt = 0.3514mm
         # for LaTeX
-        'image_scale2width' => true,
         'footnotetext' => nil,
         'texcommand' => 'uplatex',
         'texoptions' => '-interaction=nonstopmode -file-line-error -halt-on-error',
@@ -84,6 +84,7 @@ module ReVIEW
         'dvioptions' => '-d 5 -z 9',
         # for PDFMaker
         'pdfmaker' => {
+          'image_scale2width' => true,
           'makeindex' => nil, # Make index page
           'makeindex_command' => 'mendex', # works only when makeindex is true
           'makeindex_options' => '-f -r -I utf8',
@@ -91,7 +92,8 @@ module ReVIEW
           'makeindex_dic' => nil,
           'makeindex_mecab' => true,
           'makeindex_mecab_opts' => '-Oyomi',
-          'use_cover_nombre' => true
+          'use_cover_nombre' => true,
+          'use_original_image_size' => nil
         },
         'imgmath_options' => {
           'format' => 'png',

data/lib/review/epubmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2019 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2020 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -73,6 +73,7 @@ module ReVIEW
     def parse_opts(args)
       cmd_config = {}
       opts = OptionParser.new
+      @buildonly = nil
 
       opts.banner = 'Usage: review-epubmaker [options] configfile [export_filename]'
       opts.version = ReVIEW::VERSION
@@ -81,6 +82,7 @@ module ReVIEW
         exit 0
       end
       opts.on('--[no-]debug', 'Keep temporary files.') { |debug| cmd_config['debug'] = debug }
+      opts.on('-y', '--only file1,file2,...', 'Build only specified files.') { |v| @buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') } }
 
       opts.parse!(args)
       if args.size < 1 || args.size > 2
@@ -394,6 +396,11 @@ module ReVIEW
         end
       end
 
+      if @buildonly && !@buildonly.include?(id)
+        warn "skip #{id}.re"
+        return
+      end
+
       htmlfile = "#{id}.#{@config['htmlext']}"
       write_buildlogtxt(basetmpdir, htmlfile, filename)
       log("Create #{htmlfile} from #{filename}.")
@@ -445,6 +452,13 @@ module ReVIEW
       path = File.join(basetmpdir, filename)
       htmlio = File.new(path)
       Document.parse_stream(htmlio, ReVIEWHeaderListener.new(headlines))
+      htmlio.close
+
+      if headlines.empty?
+        warn "#{filename} is discarded because there is no heading. Use `=[notoc]' or `=[nodisp]' to exclude headlines from the table of contents."
+        return
+      end
+
       properties = detect_properties(path)
       if properties.present?
         prop_str = ',properties=' + properties.join(' ')
@@ -472,7 +486,6 @@ module ReVIEW
           first = nil
         end
       end
-      htmlio.close
     end
 
     def push_contents(_basetmpdir)