review 3.2.0 → 5.1.0

data/lib/review.rb

@@ -1,3 +1,3 @@
-Dir["#{File.dirname(__FILE__)}/review/*.rb"].sort.each do |path|
+Dir["#{__dir__}/review/*.rb"].sort.each do |path|
   require "review/#{File.basename(path, '.rb')}"
 end

data/lib/review/book.rb

@@ -18,8 +18,8 @@ require 'review/book/index'
 
 module ReVIEW
   module Book
-    def self.load(dir)
-      Base.load dir
+    def self.load(_dir)
+      raise NotImplementedError, 'ReVIEW::Book.load is obsoleted. Please use ReVIEW::Book::Base.new.'
     end
   end
 end

data/lib/review/book/base.rb

@@ -9,27 +9,34 @@
 #
 require 'review/configure'
 require 'review/catalog'
+require 'review/book/bib'
 
 module ReVIEW
   module Book
     class Base
       attr_accessor :config
       attr_writer :parts
-      attr_writer :catalog
+      attr_accessor :catalog
       attr_reader :basedir
+      attr_accessor :bibpaper_index
 
-      def self.load(dir = '.')
-        new(dir)
+      def self.load(basedir = '.', config: nil)
+        new(basedir, config: config)
       end
 
-      def initialize(basedir = '.')
+      def initialize(basedir = '.', config: nil)
         @basedir = basedir
         @logger = ReVIEW.logger
         @parts = nil
         @chapter_index = nil
-        @config = ReVIEW::Configure.values
+        @config = config || ReVIEW::Configure.values
         @catalog = nil
-        @read_part = nil
+        @bibpaper_index = nil
+        catalog_path = filename_join(@basedir, @config['catalogfile'])
+        if catalog_path && File.file?(catalog_path)
+          parse_catalog_file(catalog_path)
+        end
+
         @warn_old_files = {} # XXX for checking CHAPS, PREDEF, POSTDEF
         @basedir_seen = {}
         update_rubyenv
@@ -45,6 +52,14 @@ module ReVIEW
         end
       end
 
+      def execute_indexer
+        return unless @catalog
+
+        parts.each do |part|
+          part.chapters.each(&:execute_indexer)
+        end
+      end
+
       def bib_file
         config['bib_file']
       end
@@ -80,7 +95,7 @@ module ReVIEW
       def page_metric
         if config['page_metric'].respond_to?(:downcase) && config['page_metric'].upcase =~ /\A[A-Z0-9_]+\Z/
           ReVIEW::Book::PageMetric.const_get(config['page_metric'].upcase)
-        elsif config['page_metric'].is_a?(Array) && config['page_metric'].size == 5
+        elsif config['page_metric'].is_a?(Array) && (config['page_metric'].size == 5 || config['page_metric'].size == 4)
           ReVIEW::Book::PageMetric.new(*config['page_metric'])
         else
           config['page_metric']
@@ -95,6 +110,30 @@ module ReVIEW
         end
       end
 
+      def create_chapter_index
+        chapter_index = ChapterIndex.new
+        each_chapter do |chap|
+          chapter_index.add_item(Index::Item.new(chap.id, chap.number, chap))
+        end
+        parts.each do |prt|
+          if prt.id.present?
+            chapter_index.add_item(Index::Item.new(prt.id, prt.number, prt))
+          end
+        end
+        chapter_index
+      end
+
+      def generate_indexes
+        if bib_exist?
+          bib = ReVIEW::Book::Bib.new(file_content: bib_content, book: self)
+          bib.generate_indexes(use_bib: true)
+          @bibpaper_index = bib.bibpaper_index
+        end
+        self.each_chapter(&:generate_indexes)
+        self.parts.map(&:generate_indexes)
+        @chapter_index = create_chapter_index
+      end
+
       def parts
         @parts ||= read_parts
       end
@@ -102,7 +141,7 @@ module ReVIEW
       def parts_in_file
         # TODO: should be `parts.find_all{|part| part.present? and part.file?}` ?
         parts.find_all do |part|
-          part if part.present? and part.file?
+          part if part.present? && part.file?
         end
       end
 
@@ -138,24 +177,19 @@ module ReVIEW
       def chapter_index
         return @chapter_index if @chapter_index
 
-        contents = chapters
-        # TODO: contents += parts.find_all { |prt| prt.id.present? }
-        parts.each do |prt|
-          if prt.id.present?
-            contents << prt
-          end
-        end
-        @chapter_index = ChapterIndex.new(contents)
+        @chapter_index = create_chapter_index
+        @chapter_index
       end
 
       def chapter(id)
-        chapter_index[id]
+        chapter_index[id].content
       end
 
       def next_chapter(chapter)
         finded = false
         each_chapter do |c|
           return c if finded
+
           if c == chapter
             finded = true
           end
@@ -167,6 +201,7 @@ module ReVIEW
         finded = false
         each_chapter_r do |c|
           return c if finded
+
           if c == chapter
             finded = true
           end
@@ -175,9 +210,7 @@ module ReVIEW
       end
 
       def volume
-        vol = Volume.sum(chapters.map(&:volume))
-        vol.page_per_kbyte = page_metric.page_per_kbyte
-        vol
+        Volume.sum(parts.map(&:volume) + chapters.map(&:volume))
       end
 
       def load_config(filename)
@@ -185,24 +218,22 @@ module ReVIEW
         @config.merge!(new_conf)
       end
 
-      def catalog
-        return @catalog if @catalog.present?
-
-        catalogfile_path = filename_join(@basedir, config['catalogfile'])
-        if File.file? catalogfile_path
-          @catalog = File.open(catalogfile_path, 'r:BOM|utf-8') { |f| Catalog.new(f) }
+      def parse_catalog_file(path)
+        unless File.file?(path)
+          raise FileNotFound, "catalog.yml is not found #{path}"
         end
-        if @catalog
+
+        File.open(path, 'rt:BOM|utf-8') do |f|
+          @catalog = Catalog.new(f)
           @catalog.validate!(@config, basedir)
         end
-        @catalog
       end
 
       def read_chaps
         if catalog
           catalog.chaps
         else
-          read_file(config['chapter_file'])
+          read_file(config['chapter_file']).split("\n")
         end
       end
 
@@ -210,7 +241,7 @@ module ReVIEW
         if catalog
           catalog.predef
         else
-          read_file(config['predef_file'])
+          read_file(config['predef_file']).split("\n")
         end
       end
 
@@ -218,7 +249,7 @@ module ReVIEW
         if catalog
           catalog.appendix
         else
-          read_file(config['postdef_file']) # for backward compatibility
+          read_file(config['postdef_file']).split("\n") # for backward compatibility
         end
       end
 
@@ -226,17 +257,15 @@ module ReVIEW
         if catalog
           catalog.postdef
         else
-          ''
+          []
         end
       end
 
       def read_part
-        return @read_part if @read_part
-
         if catalog
-          @read_part = catalog.parts
+          catalog.parts
         else
-          @read_part = File.read(File.join(@basedir, config['part_file']))
+          File.read(File.join(@basedir, config['part_file'])).split("\n")
         end
       end
 
@@ -256,15 +285,19 @@ module ReVIEW
         File.exist?(File.join(contentdir, bib_file))
       end
 
+      def bib_content
+        File.read(File.join(contentdir, bib_file))
+      end
+
       def prefaces
         if catalog
-          return mkpart_from_namelist(catalog.predef.split("\n"))
+          return Part.mkpart_from_namelist(self, catalog.predef)
         end
 
         begin
           predef_file = filename_join(@basedir, config['predef_file'])
           if File.file?(predef_file)
-            mkpart_from_namelistfile(predef_file)
+            Part.mkpart_from_namelistfile(self, predef_file)
           end
         rescue FileNotFound => e
           raise FileNotFound, "preface #{e.message}"
@@ -273,15 +306,15 @@ module ReVIEW
 
       def appendix
         if catalog
-          names = catalog.appendix.split("\n")
-          chaps = names.each_with_index.map { |n, idx| mkchap_ifexist(n, idx) }.compact
-          return mkpart(chaps)
+          names = catalog.appendix
+          chaps = names.each_with_index.map { |name, number| Chapter.mkchap_ifexist(self, name, number + 1) }.compact
+          return Part.mkpart(chaps)
         end
 
         begin
           postdef_file = filename_join(@basedir, config['postdef_file'])
           if File.file?(postdef_file)
-            mkpart_from_namelistfile(postdef_file)
+            Part.mkpart_from_namelistfile(self, postdef_file)
           end
         rescue FileNotFound => e
           raise FileNotFound, "postscript #{e.message}"
@@ -290,7 +323,7 @@ module ReVIEW
 
       def postscripts
         if catalog
-          mkpart_from_namelist(catalog.postdef.split("\n"))
+          Part.mkpart_from_namelist(self, catalog.postdef)
         end
       end
 
@@ -300,13 +333,13 @@ module ReVIEW
         list = parse_chapters
         # NOTE: keep this = style to work this logic.
         if pre = prefaces
-          list.unshift pre
+          list.unshift(pre)
         end
         if app = appendix
-          list.push app
+          list.push(app)
         end
         if post = postscripts
-          list.push post
+          list.push(post)
         end
         list
       end
@@ -324,7 +357,7 @@ module ReVIEW
                 chap = Chapter.new(self, num += 1, chap, File.join(contentdir, chap))
                 chap
               end
-              Part.new(self, part += 1, chaps, read_part.split("\n")[part - 1])
+              Part.new(self, part += 1, chaps, read_part[part - 1])
             else
               chap = Chapter.new(self, num += 1, entry, File.join(contentdir, entry))
               if chap.number
@@ -337,53 +370,18 @@ module ReVIEW
           end
         end
 
-        chap = read_chaps.
-               strip.lines.map(&:strip).join("\n").split(/\n{2,}/).
-               map do |part_chunk|
+        # rubocop:disable Style/RedundantAssignment
+        chap = read_chaps.map(&:strip).join("\n").split(/\n{2,}/).map do |part_chunk|
           chaps = part_chunk.split.map { |chapid| Chapter.new(self, num += 1, chapid, File.join(contentdir, chapid)) }
-          if part_exist? && read_part.split("\n").size > part
-            Part.new(self, part += 1, chaps, read_part.split("\n")[part - 1])
+          if part_exist? && read_part.size > part
+            Part.new(self, part += 1, chaps, read_part[part - 1])
           else
             Part.new(self, nil, chaps)
           end
         end
-        chap
-      end
-
-      def mkpart_from_namelistfile(path)
-        chaps = []
-        File.read(path, mode: 'r:BOM|utf-8').split.each_with_index do |name, idx|
-          if path =~ /PREDEF/
-            chaps << mkchap(name)
-          else
-            chaps << mkchap(name, idx + 1)
-          end
-        end
-        mkpart(chaps)
-      end
-
-      def mkpart_from_namelist(names)
-        mkpart(names.map { |n| mkchap_ifexist(n) }.compact)
-      end
-
-      def mkpart(chaps)
-        chaps.empty? ? nil : Part.new(self, nil, chaps)
-      end
+        # rubocop:enable Style/RedundantAssignment
 
-      def mkchap(name, number = nil)
-        name += ext if File.extname(name).empty?
-        path = File.join(contentdir, name)
-        raise FileNotFound, "file not exist: #{path}" unless File.file?(path)
-        Chapter.new(self, number, name, path)
-      end
-
-      def mkchap_ifexist(name, idx = nil)
-        name += ext if File.extname(name).empty?
-        path = File.join(contentdir, name)
-        if File.file?(path)
-          idx += 1 if idx
-          Chapter.new(self, idx, name, path)
-        end
+        chap
       end
 
       def read_file(filename)
@@ -394,9 +392,10 @@ module ReVIEW
           end
         end
         res = ''
-        File.open(filename_join(@basedir, filename), 'r:BOM|utf-8') do |f|
+        File.open(filename_join(@basedir, filename), 'rt:BOM|utf-8') do |f|
           f.each_line do |line|
-            next if /\A#/ =~ line
+            next if line.start_with?('#')
+
             line.gsub!(/#.*\Z/, '')
             res << line
           end

data/lib/review/book/bib.rb

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2009-2020 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 the GNU LGPL, see the file "COPYING".
+#
+require 'review/book/book_unit'
+require 'review/lineinput'
+require 'review/preprocessor'
+
+module ReVIEW
+  module Book
+    class Bib < BookUnit
+      def number
+        nil
+      end
+    end
+  end
+end

data/lib/review/book/book_unit.rb

@@ -0,0 +1,158 @@
+# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+#               2002-2008 Minero Aoki
+#
+# 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 the GNU LGPL, see the file "COPYING".
+#
+require 'review/textutils'
+require 'review/index_builder'
+
+module ReVIEW
+  module Book
+    class BookUnit
+      include TextUtils
+      attr_reader :book
+      attr_reader :path
+      attr_reader :lines
+      attr_accessor :content
+
+      attr_reader :list_index, :table_index, :equation_index, :footnote_index,
+                  :numberless_image_index, :image_index, :icon_index, :indepimage_index,
+                  :headline_index, :column_index
+
+      def initialize(file_content: nil, book: nil)
+        if book
+          @book = book
+        end
+        if file_content
+          @content = file_content
+        end
+        if @content
+          @lines = @content.lines
+        end
+      end
+
+      def execute_indexer(force: false)
+        if @index_builder && !force
+          return @index_builder
+        end
+
+        @index_builder = ReVIEW::IndexBuilder.new
+        compiler = ReVIEW::Compiler.new(@index_builder)
+        compiler.compile(self)
+        @index_builder
+      end
+
+      def generate_indexes(use_bib: false)
+        return unless content
+
+        @lines = content.lines
+
+        @indexes = execute_indexer
+
+        @list_index = @indexes.list_index
+        @table_index = @indexes.table_index
+        @equation_index = @indexes.equation_index
+        @footnote_index = @indexes.footnote_index
+        @headline_index = @indexes.headline_index
+        @column_index = @indexes.column_index
+        if use_bib
+          @book.bibpaper_index = @indexes.bibpaper_index
+        end
+      end
+
+      def dirname
+        @path && File.dirname(@path)
+      end
+
+      def basename
+        @path && File.basename(@path)
+      end
+
+      def name
+        @name && File.basename(@name, '.*')
+      end
+
+      alias_method :id, :name
+
+      def title
+        return @title if @title
+
+        @title = ''
+        return @title unless content
+
+        content.each_line do |line|
+          if line =~ /\A=+/
+            @title = line.sub(/\A=+(\[.+?\])?(\{.+?\})?/, '').strip
+            break
+          end
+        end
+        @title
+      end
+
+      def size
+        content.size
+      end
+
+      def volume
+        @volume ||= Volume.count_file(path)
+      end
+
+      def list(id)
+        list_index[id]
+      end
+
+      def table(id)
+        table_index[id]
+      end
+
+      def equation(id)
+        equation_index[id]
+      end
+
+      def footnote(id)
+        footnote_index[id]
+      end
+
+      def image(id)
+        return image_index[id] if image_index.key?(id)
+        return icon_index[id] if icon_index.key?(id)
+        return numberless_image_index[id] if numberless_image_index.key?(id)
+
+        indepimage_index[id]
+      end
+
+      def bibpaper(id)
+        bibpaper_index[id]
+      end
+
+      def bibpaper_index
+        raise FileNotFound, "no such bib file: #{@book.bib_file}" unless @book.bib_exist?
+
+        @book.bibpaper_index
+      end
+
+      def headline(caption)
+        headline_index[caption]
+      end
+
+      def column(id)
+        column_index[id]
+      end
+
+      def next_chapter
+        book.next_chapter(self)
+      end
+
+      def prev_chapter
+        book.prev_chapter(self)
+      end
+
+      def image_bound?(item_id)
+        image(item_id).path
+      end
+    end
+  end
+end