review 3.2.0 → 4.0.0

data/lib/review/book/chapter.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -18,6 +18,21 @@ module ReVIEW
 
       attr_reader :number, :book
 
+      def self.mkchap(book, name, number = nil)
+        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
+
+      def self.mkchap_ifexist(book, name, number = nil)
+        name += book.ext if File.extname(name).empty?
+        path = File.join(book.contentdir, name)
+        if File.file?(path)
+          Chapter.new(book, number, name, path)
+        end
+      end
+
       def initialize(book, number, name, path, io = nil)
         @book = book
         @number = number
@@ -35,7 +50,7 @@ module ReVIEW
           @content = nil
         end
         if !@content && @path && File.exist?(@path)
-          @content = File.read(@path, mode: 'r:BOM|utf-8')
+          @content = File.read(@path, mode: 'rt:BOM|utf-8')
           @number = nil if %w[nonum nodisp notoc].include?(find_first_header_option)
         end
         @list_index = nil
@@ -125,7 +140,7 @@ module ReVIEW
       private
 
       def on_file?(contents)
-        contents.lines.map(&:strip).include?("#{id}#{@book.ext}")
+        contents.map(&:strip).include?("#{id}#{@book.ext}")
       end
 
       # backward compatibility

data/lib/review/book/compilable.rb

@@ -168,6 +168,11 @@ module ReVIEW
       def prev_chapter
         book.prev_chapter(self)
       end
+
+      def image_bound?(item_id)
+        item = self.image(item_id)
+        item.path
+      end
     end
   end
 end

data/lib/review/book/index.rb

@@ -12,6 +12,7 @@ require 'review/exception'
 require 'review/book/image_finder'
 require 'review/i18n'
 require 'review/logger'
+require 'review/book/index/item'
 
 module ReVIEW
   module Book
@@ -21,7 +22,7 @@ module ReVIEW
         seq = 1
         src.grep(%r{\A//#{item_type}}) do |line|
           if id = line.slice(/\[(.*?)\]/, 1)
-            items.push item_class.new(id, seq)
+            items.push(ReVIEW::Book::Index::Item.new(id, seq))
             seq += 1
             if id.empty?
               ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}"
@@ -31,12 +32,6 @@ module ReVIEW
         new(items, *args)
       end
 
-      Item = Struct.new(:id, :number)
-
-      def self.item_class
-        self::Item
-      end
-
       include Enumerable
 
       def item_type
@@ -47,11 +42,11 @@ module ReVIEW
         @items = items
         @index = {}
         @logger = ReVIEW.logger
-        items.each do |i|
-          if @index[i.id]
-            @logger.warn "warning: duplicate ID: #{i.id} (#{i})"
+        items.each do |item|
+          if @index[item.id]
+            @logger.warn "warning: duplicate ID: #{item.id} (#{item})"
           end
-          @index[i.id] = i
+          @index[item.id] = item
         end
         @image_finder = nil
       end
@@ -65,9 +60,9 @@ module ReVIEW
           raise KeyError, "key '#{id}' is ambiguous for #{self.class}"
         end
 
-        @items.each do |i|
-          if i.id.split('|').include?(id)
-            return i
+        @items.each do |item|
+          if item.id.split('|').include?(id)
+            return item
           end
         end
         raise KeyError, "not found key '#{id}' for #{self.class}"
@@ -135,8 +130,6 @@ module ReVIEW
     end
 
     class FootnoteIndex < Index
-      Item = Struct.new(:id, :number, :content)
-
       def self.parse(src)
         items = []
         seq = 1
@@ -144,7 +137,7 @@ module ReVIEW
           if m = /\[(.*?)\]\[(.*)\]/.match(line)
             m1 = m[1].gsub(/\\(\])/) { $1 }
             m2 = m[2].gsub(/\\(\])/) { $1 }
-            items.push Item.new(m1, seq, m2)
+            items.push(Item.new(m1, seq, m2))
           end
           seq += 1
         end
@@ -161,9 +154,9 @@ module ReVIEW
           elements = line.split(/\[(.*?)\]/)
           if elements[1].present?
             if line =~ %r{\A//imgtable}
-              items.push item_class.new(elements[1], 0, elements[3])
+              items.push(ReVIEW::Book::Index::Item.new(elements[1], 0, elements[3]))
             else ## %r<\A//(image|graph)>
-              items.push item_class.new(elements[1], seq, elements[3])
+              items.push(ReVIEW::Book::Index::Item.new(elements[1], seq, elements[3]))
               seq += 1
             end
             if elements[1] == ''
@@ -178,34 +171,12 @@ module ReVIEW
         '(image|graph|imgtable)'
       end
 
-      class Item
-        def initialize(id, number, caption = nil)
-          @id = id
-          @number = number
-          @caption = caption
-          @path = nil
-        end
-
-        attr_reader :id
-        attr_reader :number
-        attr_reader :caption
-        attr_writer :index # internal use only
-
-        def bound?
-          path
-        end
-
-        def path
-          @path ||= @index.find_path(id)
-        end
-      end
-
       attr_reader :image_finder
 
       def initialize(items, chapid, basedir, types, builder)
-        super items
-        items.each do |i|
-          i.index = self
+        super(items)
+        items.each do |item|
+          item.index = self
         end
         @chapid = chapid
         @basedir = basedir
@@ -223,8 +194,8 @@ module ReVIEW
       def initialize(items, chapid, basedir, types, builder)
         @items = items
         @index = {}
-        items.each { |i| @index[i.id] = i }
-        items.each { |i| i.index = self }
+        items.each { |item| @index[item.id] = item }
+        items.each { |item| item.index = self }
         @chapid = chapid
         @basedir = basedir
         @types = types
@@ -237,7 +208,7 @@ module ReVIEW
         seq = 1
         src.grep(/@<icon>/) do |line|
           line.gsub(/@<icon>\{(.+?)\}/) do
-            items.push item_class.new($1, seq)
+            items.push(ReVIEW::Book::Index::Item.new($1, seq))
             seq += 1
           end
         end
@@ -246,8 +217,6 @@ module ReVIEW
     end
 
     class BibpaperIndex < Index
-      Item = Struct.new(:id, :number, :caption)
-
       def self.parse(src)
         items = []
         seq = 1
@@ -255,7 +224,7 @@ module ReVIEW
           if m = /\[(.*?)\]\[(.*)\]/.match(line)
             m1 = m[1].gsub(/\\(.)/) { $1 }
             m2 = m[2].gsub(/\\(.)/) { $1 }
-            items.push Item.new(m1, seq, m2)
+            items.push(Item.new(m1, seq, m2))
           end
           seq += 1
         end
@@ -268,18 +237,12 @@ module ReVIEW
         'numberlessimage'
       end
 
-      class Item < ImageIndex::Item
-      end
-
       def number(_id)
         ''
       end
     end
 
     class IndepImageIndex < ImageIndex
-      class Item < ImageIndex::Item
-      end
-
       def self.item_type
         '(indepimage|imgtable)'
       end
@@ -291,7 +254,6 @@ module ReVIEW
 
     class HeadlineIndex < Index
       HEADLINE_PATTERN = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/
-      Item = Struct.new(:id, :number, :caption)
       attr_reader :items
 
       def self.parse(src, chap)
@@ -349,11 +311,11 @@ 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)
+            items.push(Item.new(headlines.join('|'), 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)
+            items.push(Item.new(headlines.join('|'), indexs.dup, m[4].strip))
           end
         end
         new(items, chap)
@@ -364,11 +326,11 @@ module ReVIEW
         @chap = chap
         @index = {}
         @logger = ReVIEW.logger
-        items.each do |i|
-          if @index[i.id]
-            @logger.warn "warning: duplicate ID: #{i.id}"
+        items.each do |item|
+          if @index[item.id]
+            @logger.warn "warning: duplicate ID: #{item.id}"
           end
-          @index[i.id] = i
+          @index[item.id] = item
         end
       end
 
@@ -388,7 +350,6 @@ module ReVIEW
 
     class ColumnIndex < Index
       COLUMN_PATTERN = /\A(=+)\[column\](?:\{(.+?)\})?(.*)/
-      Item = Struct.new(:id, :number, :caption)
 
       def self.parse(src, *_args)
         items = []
@@ -401,7 +362,7 @@ module ReVIEW
           caption = m[3].strip
           id = caption if id.nil? || id.empty?
 
-          items.push item_class.new(id, seq, caption)
+          items.push(ReVIEW::Book::Index::Item.new(id, seq, caption))
           seq += 1
         end
         new(items)

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

@@ -0,0 +1,40 @@
+# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of LGPL, see the file "COPYING".
+#
+
+require 'review/extentions'
+require 'review/exception'
+require 'review/book/image_finder'
+require 'review/i18n'
+require 'review/logger'
+
+module ReVIEW
+  module Book
+    class Index
+      class Item
+        def initialize(id, number, caption = nil)
+          @id = id
+          @number = number
+          @caption = caption
+          @path = nil
+          @index = nil
+        end
+
+        attr_reader :id
+        attr_reader :number
+        attr_reader :caption
+        attr_writer :index # internal use only
+
+        alias_method :content, :caption
+
+        def path
+          @path ||= @index.find_path(id)
+        end
+      end
+    end
+  end
+end

data/lib/review/book/part.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -13,6 +13,26 @@ module ReVIEW
     class Part
       include Compilable
 
+      def self.mkpart_from_namelistfile(book, path)
+        chaps = []
+        File.read(path, mode: 'rt:BOM|utf-8').split.each_with_index do |name, number|
+          if path =~ /PREDEF/
+            chaps << Chapter.mkchap(book, name)
+          else
+            chaps << Chapter.mkchap(book, name, number + 1)
+          end
+        end
+        Part.mkpart(chaps)
+      end
+
+      def self.mkpart_from_namelist(book, names)
+        Part.mkpart(names.map { |name| Chapter.mkchap_ifexist(book, name) }.compact)
+      end
+
+      def self.mkpart(chaps)
+        chaps.empty? ? nil : Part.new(self, nil, chaps)
+      end
+
       # if Part is dummy, `number` is nil.
       #
       def initialize(book, number, chapters, name = '', io = nil)
@@ -25,7 +45,7 @@ module ReVIEW
         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: 'r:BOM|utf-8')
+          @content = File.read(File.join(@book.config['contentdir'], @path), mode: 'rt:BOM|utf-8')
           @name = File.basename(@name, '.re')
         end
         if file?

data/lib/review/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2002-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2002-2019 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -62,6 +62,15 @@ module ReVIEW
         if @book.config['tabwidth']
           @tabwidth = @book.config['tabwidth']
         end
+
+        if @book.config['join_lines_by_lang']
+          begin
+            require 'unicode/eaw'
+          rescue LoadError
+            warn 'not found unicode/eaw. disabled join_lines_by_lang feature.'
+            @book.config['join_lines_by_lang'] = nil
+          end
+        end
       end
       builder_init_file
     end
@@ -71,6 +80,10 @@ module ReVIEW
     end
     private :builder_init_file
 
+    def highlight?
+      false
+    end
+
     def result
       @output.string
     end
@@ -122,43 +135,55 @@ module ReVIEW
 
     def list(lines, id, caption, lang = nil)
       begin
-        list_header id, caption, lang
+        list_header(id, caption, lang)
       rescue KeyError
         error "no such list: #{id}"
       end
-      list_body id, lines, lang
+      list_body(id, lines, lang)
     end
 
     def listnum(lines, id, caption, lang = nil)
       begin
-        list_header id, caption, lang
+        list_header(id, caption, lang)
       rescue KeyError
         error "no such list: #{id}"
       end
-      listnum_body lines, lang
+      listnum_body(lines, lang)
     end
 
     def source(lines, caption, lang = nil)
-      source_header caption
-      source_body lines, lang
+      source_header(caption)
+      source_body(lines, lang)
     end
 
     def image(lines, id, caption, metric = nil)
-      if @chapter.image(id).bound?
-        image_image id, caption, metric
+      if @chapter.image_bound?(id)
+        image_image(id, caption, metric)
       else
         warn "image not bound: #{id}" if @strict
-        image_dummy id, caption, lines
+        image_dummy(id, caption, lines)
       end
     end
 
     def table(lines, id = nil, caption = nil)
-      rows = []
+      sepidx, rows = parse_table_rows(lines)
+      begin
+        if 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 parse_table_rows(lines)
       sepidx = nil
+      rows = []
       lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
-          # just ignore
-          # error "too many table separator" if sepidx
+        if /\A[\=\-]{12}/ =~ line || /\A[\=\{\-\}]{12}/ =~ line
           sepidx ||= idx
           next
         end
@@ -166,15 +191,10 @@ module ReVIEW
       end
       rows = adjust_n_cols(rows)
       error 'no rows in the table' if rows.empty?
+      [sepidx, rows]
+    end
 
-      begin
-        if caption.present?
-          table_header id, caption
-        end
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      table_begin rows.first.size
+    def table_rows(sepidx, rows)
       if sepidx
         sepidx.times do
           tr(rows.shift.map { |s| th(s) })
@@ -188,7 +208,6 @@ module ReVIEW
           tr([th(h)] + cs.map { |s| td(s) })
         end
       end
-      table_end
     end
 
     def adjust_n_cols(rows)
@@ -199,7 +218,7 @@ module ReVIEW
       end
       n_maxcols = rows.map(&:size).max
       rows.each do |cols|
-        cols.concat [''] * (n_maxcols - cols.size)
+        cols.concat([''] * (n_maxcols - cols.size))
       end
       rows
     end
@@ -230,7 +249,7 @@ module ReVIEW
     end
 
     def inline_chapref(id)
-      compile_inline @book.chapter_index.display_string(id)
+      compile_inline(@book.chapter_index.display_string(id))
     rescue KeyError
       error "unknown chapter: #{id}"
     end
@@ -242,7 +261,7 @@ module ReVIEW
     end
 
     def inline_title(id)
-      compile_inline @book.chapter_index.title(id)
+      compile_inline(@book.chapter_index.title(id))
     rescue KeyError
       error "unknown chapter: #{id}"
     end
@@ -341,10 +360,10 @@ module ReVIEW
     end
 
     def bibpaper(lines, id, caption)
-      bibpaper_header id, caption
+      bibpaper_header(id, caption)
       unless lines.empty?
         puts
-        bibpaper_bibpaper id, caption, lines
+        bibpaper_bibpaper(id, caption, lines)
       end
       puts
     end
@@ -404,7 +423,12 @@ module ReVIEW
     end
 
     def inline_wb(s)
-      inline_b(unescape(inline_w(s)))
+      translated = @dictionary[s]
+      if translated
+        inline_b(translated)
+      else
+        inline_b("[missing word: #{s}]")
+      end
     end
 
     def raw(str)
@@ -423,9 +447,9 @@ module ReVIEW
       if arg
         builders = arg.gsub(/^\s*\|/, '').gsub(/\|\s*$/, '').gsub(/\s/, '').split(',')
         c = target_name
-        print lines.join if builders.include?(c)
+        print lines.join("\n") + "\n" if builders.include?(c)
       else
-        print lines.join
+        print lines.join("\n") + "\n"
       end
     end
 
@@ -504,13 +528,13 @@ module ReVIEW
       file = "#{id}.#{image_ext}"
       file_path = File.join(dir, file)
 
-      line = self.unescape(lines.join("\n"))
+      content = lines.join("\n") + "\n"
 
       tf = Tempfile.new('review_graph')
-      tf.puts line
+      tf.puts content
       tf.close
       begin
-        file_path = send("graph_#{command}".to_sym, id, file_path, line, tf.path)
+        file_path = send("graph_#{command}".to_sym, id, file_path, content, tf.path)
       ensure
         tf.unlink
       end
@@ -558,7 +582,7 @@ EOTGNUPLOT
         file_path.sub!(/\.pdf\Z/, '.eps')
       end
       system_graph(id, 'java', '-jar', 'plantuml.jar', "-t#{ext}", '-charset', 'UTF-8', tf_path)
-      FileUtils.mv "#{tf_path}.#{ext}", file_path
+      FileUtils.mv("#{tf_path}.#{ext}", file_path)
       file_path
     end
 
@@ -567,7 +591,7 @@ EOTGNUPLOT
     end
 
     def inline_include(file_name)
-      compile_inline File.read(file_name, mode: 'rt:BOM|utf-8').chomp
+      compile_inline(File.read(file_name, mode: 'rt:BOM|utf-8').chomp)
     end
 
     def ul_item_begin(lines)
@@ -634,9 +658,5 @@ EOTGNUPLOT
     def escape(str)
       str
     end
-
-    def unescape(str)
-      str
-    end
   end
 end # module ReVIEW