review 1.0.0 → 1.1.0

data/lib/review/book/base.rb

@@ -0,0 +1,247 @@
+#
+# $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
+#
+# Copyright (c) 2002-2008 Minero Aoki
+#               2009 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".
+#
+module ReVIEW
+  module Book
+    class Base
+
+      attr_accessor :param
+
+      def self.load_default
+        %w( . .. ../.. ).each do |basedir|
+          if File.file?("#{basedir}/CHAPS")
+            book = load(basedir)
+            if File.file?("#{basedir}/config.rb")
+              book.instance_variable_set("@parameters", Parameters.load("#{basedir}/config.rb"))
+            end
+            return book
+          end
+        end
+        new('.')
+      end
+
+      def self.load(dir)
+        update_rubyenv dir
+        new(dir)
+      end
+
+      @basedir_seen = {}
+
+      def self.update_rubyenv(dir)
+        return if @basedir_seen.key?(dir)
+        if File.directory?("#{dir}/lib/review")
+          $LOAD_PATH.unshift "#{dir}/lib"
+        end
+        if File.file?("#{dir}/review-ext.rb")
+          Kernel.load File.expand_path("#{dir}/review-ext.rb")
+        end
+        @basedir_seen[dir] = true
+      end
+
+      def initialize(basedir, parameters = Parameters.default)
+        @basedir = basedir
+        @parameters = parameters
+        @parts = nil
+        @chapter_index = nil
+      end
+
+      extend Forwardable
+      def_delegators '@parameters',
+      :chapter_file,
+      :part_file,
+      :bib_file,
+      :reject_file,
+      :predef_file,
+      :postdef_file,
+      :ext,
+      :image_dir,
+      :image_types,
+      :page_metric
+
+      def parts
+        @parts ||= read_parts()
+      end
+
+      def parts_in_file
+        parts.find_all{|part|
+          part if part.present? and part.file?
+        }
+      end
+
+      def part(n)
+        parts.detect {|part| part.number == n }
+      end
+
+      def each_part(&block)
+        parts.each(&block)
+      end
+
+      def chapters
+        parts().map {|p| p.chapters }.flatten
+      end
+
+      def each_chapter(&block)
+        chapters.each(&block)
+      end
+
+      def chapter_index
+        @chapter_index ||= ChapterIndex.new(chapters())
+        @chapter_index
+      end
+
+      def chapter(id)
+        chapter_index()[id]
+      end
+
+      def volume
+        Volume.sum(chapters.map {|chap| chap.volume })
+      end
+
+      def read_CHAPS
+        read_FILE("chapter_file")
+      end
+
+      def read_PREDEF
+        read_FILE("predef_file")
+      end
+
+      def read_POSTDEF
+        read_FILE("postdef_file")
+      end
+
+      def read_PART
+        @read_PART ||= File.read("#{@basedir}/#{part_file}")
+      end
+
+      def part_exist?
+        File.exist?("#{@basedir}/#{part_file}")
+      end
+
+      def read_bib
+        File.read("#{@basedir}/#{bib_file}")
+      end
+
+      def bib_exist?
+        File.exist?("#{@basedir}/#{bib_file}")
+      end
+
+      def prefaces
+        if File.file?("#{@basedir}/#{predef_file}")
+          begin
+            return mkpart_from_namelistfile("#{@basedir}/#{predef_file}")
+          rescue FileNotFound => err
+            raise FileNotFound, "preface #{err.message}"
+          end
+        else
+          mkpart_from_namelist(%w(preface))
+        end
+      end
+
+      def postscripts
+        if File.file?("#{@basedir}/#{postdef_file}")
+          begin
+            return mkpart_from_namelistfile("#{@basedir}/#{postdef_file}")
+          rescue FileNotFound => err
+            raise FileNotFound, "postscript #{err.message}"
+          end
+        else
+          mkpart_from_namelist(%w(appendix postscript))
+        end
+      end
+
+      def basedir
+        @basedir
+      end
+
+      private
+
+      def read_parts
+        list = parse_chapters
+        if pre = prefaces
+          list.unshift pre
+        end
+        if post = postscripts
+          list.push post
+        end
+        list
+      end
+
+      def parse_chapters
+        part = 0
+        num = 0
+        chap = read_CHAPS()\
+          .strip.lines.map {|line| line.strip }.join("\n").split(/\n{2,}/)\
+          .map {|part_chunk|
+          chaps = part_chunk.split.map {|chapid|
+            Chapter.new(self, (num += 1), chapid, "#{@basedir}/#{chapid}")
+          }
+          if part_exist? && read_PART.split("\n").size >= part
+            Part.new(self, (part += 1), chaps, read_PART.split("\n")[part-1])
+          else
+            Part.new(self, (part += 1), chaps)
+          end
+        }
+        return chap
+      end
+
+      def mkpart_from_namelistfile(path)
+        chaps = []
+        File.read(path).split.each_with_index do |name, idx|
+          name.sub!(/\A\xEF\xBB\xBF/u, '') # remove BOM
+          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
+
+      def mkchap(name, number = nil)
+        name += ext if File.extname(name) == ""
+        path = "#{@basedir}/#{name}"
+        raise FileNotFound, "file not exist: #{path}" unless File.file?(path)
+        Chapter.new(self, number, name, path)
+      end
+
+      def mkchap_ifexist(id)
+        name = "#{id}#{ext()}"
+        path = "#{@basedir}/#{name}"
+        File.file?(path) ? Chapter.new(self, nil, name, path) : nil
+      end
+
+      def read_FILE(filename)
+        res = ""
+        File.open("#{@basedir}/#{eval(filename)}") do |f|
+          while line = f.gets
+            line.sub!(/\A\xEF\xBB\xBF/u, '') # remove BOM
+            if /\A#/ =~ line
+              next
+            end
+            line.gsub!(/#.*$/, "")
+            res << line
+          end
+        end
+        res
+      rescue Errno::ENOENT
+        Dir.glob("#{@basedir}/*#{ext()}").sort.join("\n")
+      end
+    end
+  end
+end

data/lib/review/book/chapter.rb

@@ -0,0 +1,81 @@
+#
+# $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
+#
+# Copyright (c) 2002-2008 Minero Aoki
+#               2009 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/compilable'
+module ReVIEW
+  module Book
+    class Chapter
+      include Compilable
+
+      def Chapter.intern_pathes(pathes)
+        books = {}
+        pathes.map {|path|
+          basedir = File.dirname(path)
+          book = (books[File.expand_path(basedir)] ||= Book.load(basedir))
+          begin
+            book.chapter(File.basename(path, '.*'))
+          rescue KeyError => err
+            raise FileNotFound, "no such file: #{path}"
+          end
+        }
+      end
+
+      def Chapter.for_stdin
+        new(nil, nil, '-', nil, $stdin)
+      end
+
+      def Chapter.for_path(number, path)
+        new(nil, number, File.basename(path), path)
+      end
+
+      attr_reader :number
+
+      def initialize(book, number, name, path, io = nil)
+        @book = book
+        @number = number
+        @name = name
+        @path = path
+        @io = io
+        @title = nil
+        @content = nil
+        @list_index = nil
+        @table_index = nil
+        @footnote_index = nil
+        @image_index = nil
+        @icon_index = nil
+        @numberless_image_index = nil
+        @indepimage_index = nil
+        @headline_index = nil
+      end
+
+      def inspect
+        "\#<#{self.class} #{@number} #{@path}>"
+      end
+
+      def on_CHAPS?
+        on_FILE?(@book.read_CHAPS())
+      end
+
+      def on_PREDEF?
+        on_FILE?(@book.read_PREDEF())
+      end
+
+      def on_POSTDEF?
+        on_FILE?(@book.read_POSTDEF())
+      end
+
+      private
+      def on_FILE?(contents)
+        contents.lines.map(&:strip).include?(id() + @book.ext())
+      end
+    end
+  end
+end

data/lib/review/book/compilable.rb

@@ -0,0 +1,163 @@
+#
+# $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
+#
+# Copyright (c) 2002-2008 Minero Aoki
+#               2009 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/textutils'
+module ReVIEW
+  module Book
+    module Compilable
+      include TextUtils
+      attr_reader :book
+      attr_reader :path
+
+      def env
+        @book
+      end
+
+      def dirname
+        return nil unless @path
+        File.dirname(@path)
+      end
+
+      def basename
+        return nil unless @path
+        File.basename(@path)
+      end
+
+      def name
+        File.basename(@name, '.*')
+      end
+
+      alias id name
+
+      def title
+        @title = ""
+        open {|f|
+          f.each_line {|l|
+            l = convert_inencoding(l, ReVIEW.book.param["inencoding"])
+            if l =~ /\A=+/
+              @title = l.sub(/\A=+/, '').strip
+              break
+            end
+          }
+        }
+        @title
+      end
+
+      def size
+        File.size(path())
+      end
+
+      def volume
+        @volume ||= Volume.count_file(path())
+      end
+
+      def open(&block)
+        return (block_given?() ? yield(@io) : @io) if @io
+        File.open(path(), &block)
+      end
+
+      attr_writer :content
+
+      def content
+        @content = convert_inencoding(File.read(path()),
+                                      ReVIEW.book.param["inencoding"])
+      rescue
+        @content
+      end
+
+      def lines
+        # FIXME: we cannot duplicate Enumerator on ruby 1.9 HEAD
+        (@lines ||= content().lines.to_a).dup
+      end
+
+      def list(id)
+        list_index()[id]
+      end
+
+      def list_index
+        @list_index ||= ListIndex.parse(lines())
+        @list_index
+      end
+
+      def table(id)
+        table_index()[id]
+      end
+
+      def table_index
+        @table_index ||= TableIndex.parse(lines())
+        @table_index
+      end
+
+      def footnote(id)
+        footnote_index()[id]
+      end
+
+      def footnote_index
+        @footnote_index ||= FootnoteIndex.parse(lines())
+        @footnote_index
+      end
+
+      def image(id)
+        return image_index()[id] if image_index().has_key?(id)
+        return icon_index()[id] if icon_index().has_key?(id)
+        return numberless_image_index()[id] if numberless_image_index().has_key?(id)
+        indepimage_index()[id]
+      end
+
+      def numberless_image_index
+        @numberless_image_index ||=
+          NumberlessImageIndex.parse(lines(), id(),
+          "#{book.basedir}#{@book.image_dir}",
+          @book.image_types)
+      end
+
+      def image_index
+        @image_index ||= ImageIndex.parse(lines(), id(),
+          "#{book.basedir}#{@book.image_dir}",
+          @book.image_types)
+        @image_index
+      end
+
+      def icon_index
+        @icon_index ||= IconIndex.parse(lines(), id(),
+          "#{book.basedir}#{@book.image_dir}",
+          @book.image_types)
+        @icon_index
+      end
+
+      def indepimage_index
+        @indepimage_index ||=
+          IndepImageIndex.parse(lines(), id(),
+          "#{book.basedir}#{@book.image_dir}",
+          @book.image_types)
+      end
+
+      def bibpaper(id)
+        bibpaper_index()[id]
+      end
+
+      def bibpaper_index
+        raise FileNotFound, "no such bib file: #{@book.bib_file}" unless @book.bib_exist?
+        @bibpaper_index ||= BibpaperIndex.parse(@book.read_bib.lines.to_a)
+        @bibpaper_index
+      end
+
+      def headline(caption)
+        headline_index()[caption]
+      end
+
+      def headline_index
+        @headline_index ||= HeadlineIndex.parse(lines(), self)
+      end
+    end
+  end
+end
+