review 3.0.0 → 4.2.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

@@ -52,11 +52,7 @@ module ReVIEW
       end
 
       def volume
-        unless @volume
-          @volume = Volume.count_file(path)
-          @volume.page_per_kbyte = @book.page_metric.page_per_kbyte
-        end
-        @volume
+        @volume ||= Volume.count_file(path)
       end
 
       def lines
@@ -168,6 +164,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

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -12,29 +12,24 @@ require 'review/exception'
 require 'review/book/image_finder'
 require 'review/i18n'
 require 'review/logger'
+require 'review/book/index/item'
 
 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 item_class.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)
-      end
-
-      Item = Struct.new(:id, :number)
-
-      def self.item_class
-        self::Item
+        index
       end
 
       include Enumerable
@@ -43,19 +38,22 @@ module ReVIEW
         self.class.item_type
       end
 
-      def initialize(items)
-        @items = items
+      def initialize
         @index = {}
         @logger = ReVIEW.logger
-        items.each do |i|
-          if @index[i.id]
-            @logger.warn "warning: duplicate ID: #{i.id} (#{i})"
-          end
-          @index[i.id] = i
-        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
@@ -65,9 +63,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
+        @index.values.each do |item|
+          if item.id.split('|').include?(id)
+            return item
           end
         end
         raise KeyError, "not found key '#{id}' for #{self.class}"
@@ -78,7 +76,7 @@ module ReVIEW
       end
 
       def each(&block)
-        @items.each(&block)
+        @index.values.each(&block)
       end
 
       def key?(id)
@@ -93,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)
@@ -102,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)
@@ -135,35 +134,33 @@ module ReVIEW
     end
 
     class FootnoteIndex < Index
-      Item = Struct.new(:id, :number, :content)
-
       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 item_class.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 item_class.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] == ''
@@ -171,45 +168,21 @@ module ReVIEW
             end
           end
         end
-        new(items, *args)
+        index
       end
 
       def self.item_type
         '(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
-        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
@@ -220,46 +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 { |i| @index[i.id] = i }
-        items.each { |i| i.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 item_class.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
-      Item = Struct.new(:id, :number, :caption)
-
       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
 
@@ -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,11 +254,9 @@ module ReVIEW
 
     class HeadlineIndex < Index
       HEADLINE_PATTERN = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/
-      Item = Struct.new(:id, :number, :caption)
-      attr_reader :items
 
       def self.parse(src, chap)
-        items = []
+        headline_index = self.new(chap)
         indexs = []
         headlines = []
         inside_column = false
@@ -305,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
@@ -316,6 +277,7 @@ module ReVIEW
           if m.nil? || m[1].size > 10 # Ignore too deep index
             next
           end
+
           index = m[1].size - 2
 
           # column
@@ -335,7 +297,9 @@ module ReVIEW
 
           next unless index >= 0
           if indexs.size > (index + 1)
-            indexs = indexs.take(index + 1)
+            unless %w[nonum notoc nodisp].include?(m[2])
+              indexs = indexs.take(index + 1)
+            end
             headlines = headlines.take(index + 1)
           end
           if indexs[index].nil?
@@ -343,27 +307,32 @@ module ReVIEW
               indexs[i] ||= 0
             end
           end
-          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)
+
+          if %w[nonum notoc nodisp].include?(m[2])
+            headlines[index] = m[3].present? ? m[3].strip : 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
+            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 |i|
-          if @index[i.id]
-            @logger.warn "warning: duplicate ID: #{i.id}"
-          end
-          @index[i.id] = i
-        end
       end
 
       def number(id)
+        unless self[id].number
+          # when notoc
+          return ''
+        end
         n = @chap.number
         # XXX: remove magic number (move to lib/review/book/chapter.rb)
         if @chap.on_appendix? && @chap.number > 0 && @chap.number < 28
@@ -375,10 +344,9 @@ module ReVIEW
 
     class ColumnIndex < Index
       COLUMN_PATTERN = /\A(=+)\[column\](?:\{(.+?)\})?(.*)/
-      Item = Struct.new(:id, :number, :caption)
 
       def self.parse(src, *_args)
-        items = []
+        index = self.new
         seq = 1
         src.each do |line|
           m = COLUMN_PATTERN.match(line)
@@ -388,10 +356,10 @@ module ReVIEW
           caption = m[3].strip
           id = caption if id.nil? || id.empty?
 
-          items.push item_class.new(id, seq, caption)
+          index.add_item(ReVIEW::Book::Index::Item.new(id, seq, caption))
           seq += 1
         end
-        new(items)
+        index
       end
     end
   end