review 1.2.0 → 1.3.0

data/lib/review/book/chapter.rb

@@ -15,6 +15,9 @@ module ReVIEW
     class Chapter
       include Compilable
 
+      ROMAN = %w[0 I II III IV V VI VII VIII IX X XI XII XIII XIV XV XVI XVII XVIII XIX XX XXI XXII XXIII XXIV XXV XXVI XXVII]
+      ALPHA = %w[0 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z]
+
       def Chapter.intern_pathes(pathes)
         books = {}
         pathes.map {|path|
@@ -54,12 +57,51 @@ module ReVIEW
         @numberless_image_index = nil
         @indepimage_index = nil
         @headline_index = nil
+        @column_index = nil
       end
 
       def inspect
         "\#<#{self.class} #{@number} #{@path}>"
       end
 
+      def format_number(heading = true)
+        if on_PREDEF?
+          return "#{@number}"
+        end
+
+        if on_POSTDEF?
+          return "#{@number}" if @number < 1 || @number > 27
+
+          if @book.config["appendix_format"].blank?
+            type = "arabic"
+          else
+            type = @book.config["appendix_format"].downcase.strip
+          end
+
+          appendix = case type
+                       when "roman"
+                         ROMAN[@number]
+                       when "alphabet", "alpha"
+                         ALPHA[@number]
+                       else
+                         # nil, "arabic", etc...
+                         "#{@number}"
+                     end
+
+          if heading
+            return "#{I18n.t("appendix", appendix)}"
+          else
+            return "#{appendix}"
+          end
+        end
+
+        if heading
+          "#{I18n.t("chapter", @number)}"
+        else
+          "#{@number}"
+        end
+      end
+
       def on_CHAPS?
         on_FILE?(@book.read_CHAPS())
       end

data/lib/review/book/compilable.rb

@@ -32,16 +32,19 @@ module ReVIEW
       end
 
       def name
+        return nil unless @name
         File.basename(@name, '.*')
       end
 
-      alias id name
+      alias_method :id, :name
 
       def title
-        @title = ""
+        return @title if @title
+
+        @title = ''
         open {|f|
           f.each_line {|l|
-            l = convert_inencoding(l, ReVIEW.book.param["inencoding"])
+            l = convert_inencoding(l, book.config["inencoding"])
             if l =~ /\A=+/
               @title = l.sub(/\A=+(\[.+?\])?(\{.+?\})?/, '').strip
               break
@@ -68,7 +71,7 @@ module ReVIEW
 
       def content
         @content = convert_inencoding(File.read(path()),
-                                      ReVIEW.book.param["inencoding"])
+                                      book.config["inencoding"])
       rescue
         @content
       end
@@ -157,6 +160,22 @@ module ReVIEW
       def headline_index
         @headline_index ||= HeadlineIndex.parse(lines(), self)
       end
+
+      def column(id)
+        column_index()[id]
+      end
+
+      def column_index
+        @column_index ||= ColumnIndex.parse(lines())
+      end
+
+      def next_chapter
+        book.next_chapter(self)
+      end
+
+      def prev_chapter
+        book.prev_chapter(self)
+      end
     end
   end
 end

data/lib/review/book/image_finder.rb

@@ -0,0 +1,64 @@
+#
+# Copyright (c) 2014 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
+#
+# 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'
+
+module ReVIEW
+  module Book
+    class ImageFinder
+      def initialize(basedir, chapid, builder, exts)
+        @basedir = basedir
+        @chapid = chapid
+        @builder = builder
+        @exts = exts
+        @entries = get_entries()
+      end
+
+      def get_entries
+        Dir.glob(File.join(@basedir, "**/*.*"))
+      end
+
+      def find_path(id)
+        targets = target_list(id)
+        targets.each do |target|
+          @exts.each do |ext|
+            if @entries.include?("#{target}#{ext}")
+              return "#{target}#{ext}"
+            end
+          end
+        end
+        nil
+      end
+
+      def target_list(id)
+        [
+         # 1. <basedir>/<builder>/<chapid>/<id>.<ext>
+         "#{@basedir}/#{@builder}/#{@chapid}/#{id}",
+
+         # 2. <basedir>/<builder>/<chapid>-<id>.<ext>
+         "#{@basedir}/#{@builder}/#{@chapid}-#{id}",
+
+         # 3. <basedir>/<builder>/<id>.<ext>
+         "#{@basedir}/#{@builder}/#{id}",
+
+         # 4. <basedir>/<chapid>/<id>.<ext>
+         "#{@basedir}/#{@chapid}/#{id}",
+
+         # 5. <basedir>/<chapid>-<id>.<ext>
+         "#{@basedir}/#{@chapid}-#{id}",
+
+         # 6. <basedir>/<id>.<ext>
+         "#{@basedir}/#{id}"
+        ]
+      end
+
+    end
+  end
+end

data/lib/review/book/index.rb

@@ -11,6 +11,7 @@
 
 require 'review/extentions'
 require 'review/exception'
+require 'review/book/image_finder'
 
 module ReVIEW
   module Book
@@ -49,12 +50,13 @@ module ReVIEW
           warn "warning: duplicate ID: #{i.id} (#{i})" unless @index[i.id].nil?
           @index[i.id] = i
         end
+        @image_finder = nil
       end
 
       def [](id)
         @index.fetch(id)
       rescue
-        raise KeyError
+        raise KeyError, "not found key '#{id}' for #{self.class}"
       end
 
       def number(id)
@@ -78,17 +80,15 @@ module ReVIEW
 
       def number(id)
         chapter = @index.fetch(id)
-        if chapter.on_CHAPS?
-          "#{I18n.t("chapter", chapter.number)}"
-        elsif chapter.on_PREDEF?
-          "#{chapter.number}"
-        elsif chapter.on_POSTDEF?
-          "#{I18n.t("appendix", chapter.number)}"
-        end
+        chapter.format_number
+      rescue # part
+        "#{I18n.t("part", chapter.number)}"
       end
 
       def title(id)
         @index.fetch(id).title
+      rescue # non-file part
+        @index.fetch(id).name
       end
 
       def display_string(id)
@@ -132,12 +132,11 @@ module ReVIEW
 
     class ImageIndex < Index
       class Item
-        @@entries = nil
 
         def initialize(id, number)
           @id = id
           @number = number
-          @pathes = nil
+          @path = nil
         end
 
         attr_reader :id
@@ -145,22 +144,21 @@ module ReVIEW
         attr_writer :index    # internal use only
 
         def bound?
-          not pathes().empty?
+          path
         end
 
         def path
-          pathes().first
+          @path ||= @index.find_path(id)
         end
 
-        def pathes
-          @pathes ||= @index.find_pathes(id)
-        end
       end
 
       def ImageIndex.item_type
         '(image|graph)'
       end
 
+      attr_reader :image_finder
+
       def initialize(items, chapid, basedir, types)
         super items
         items.each do |i|
@@ -170,46 +168,34 @@ module ReVIEW
         @basedir = basedir
         @types = types
 
-        @@entries ||= get_entries
+        @image_finder = ReVIEW::Book::ImageFinder.new(basedir, chapid,
+                                                      ReVIEW.book.config['builder'], types)
       end
 
-      def get_entries
-        Dir.glob(File.join(@basedir, "**/*.*"))
+      def find_path(id)
+        @image_finder.find_path(id)
       end
 
-      # internal use only
-      def find_pathes(id)
-        pathes = []
-
-        # 1. <basedir>/<builder>/<chapid>/<id>.<ext>
-        target = "#{@basedir}/#{ReVIEW.book.param['builder']}/#{@chapid}/#{id}"
-        @types.each {|ext| pathes.push("#{target}#{ext}") if @@entries.include?("#{target}#{ext}")}
-
-        # 2. <basedir>/<builder>/<chapid>-<id>.<ext>
-        target = "#{@basedir}/#{ReVIEW.book.param['builder']}/#{@chapid}-#{id}"
-        @types.each {|ext| pathes.push("#{target}#{ext}") if @@entries.include?("#{target}#{ext}")}
-
-        # 3. <basedir>/<builder>/<id>.<ext>
-        target = "#{@basedir}/#{ReVIEW.book.param['builder']}/#{id}"
-        @types.each {|ext| pathes.push("#{target}#{ext}") if @@entries.include?("#{target}#{ext}")}
-
-        # 4. <basedir>/<chapid>/<id>.<ext>
-        target = "#{@basedir}/#{@chapid}/#{id}"
-        @types.each {|ext| pathes.push("#{target}#{ext}") if @@entries.include?("#{target}#{ext}")}
-
-        # 5. <basedir>/<chapid>-<id>.<ext>
-        target = "#{@basedir}/#{@chapid}-#{id}"
-        @types.each {|ext| pathes.push("#{target}#{ext}") if @@entries.include?("#{target}#{ext}")}
+    end
 
-        # 6. <basedir>/<id>.<ext>
-        target = "#{@basedir}/#{id}"
-        @types.each {|ext| pathes.push("#{target}#{ext}") if @@entries.include?("#{target}#{ext}")}
+    class IconIndex < ImageIndex
+      def initialize(items, chapid, basedir, types)
+        @items = items
+        @index = {}
+        items.each do |i|
+          ## warn "warning: duplicate ID: #{i.id} (#{i})" unless @index[i.id].nil?
+          @index[i.id] = i
+        end
+        items.each do |i|
+          i.index = self
+        end
+        @chapid = chapid
+        @basedir = basedir
+        @types = types
 
-        return pathes
+        @image_finder = ImageFinder.new(basedir, chapid, ReVIEW.book.config['builder'], types)
       end
-    end
 
-    class IconIndex < ImageIndex
       def IconIndex.parse(src, *args)
         items = []
         seq = 1
@@ -268,7 +254,7 @@ module ReVIEW
         def initialize(id, number)
           @id = id
           @number = ""
-          @pathes = nil
+          @path = nil
         end
       end
 
@@ -286,7 +272,7 @@ module ReVIEW
         def initialize(id, number)
           @id = id
           @number = ""
-          @pathes = nil
+          @path = nil
         end
       end
 
@@ -300,14 +286,16 @@ module ReVIEW
     end
 
     class HeadlineIndex < Index
+      HEADLINE_PATTERN = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/
       Item = Struct.new(:id, :number, :caption)
+      attr_reader :items
 
       def HeadlineIndex.parse(src, chap)
         items = []
         indexs = []
         headlines = []
         src.each do |line|
-          if m = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/.match(line)
+          if m = HEADLINE_PATTERN.match(line)
             next if m[2] == 'column'
             index = m[1].size - 2
             if index >= 0
@@ -341,5 +329,31 @@ module ReVIEW
         return ([@chap.number] + @index.fetch(id).number).join(".")
       end
     end
+
+    class ColumnIndex < Index
+      COLUMN_PATTERN = /\A(=+)\[column\](?:\{(.+?)\})?(.*)/
+      Item = Struct.new(:id, :number, :caption)
+
+      def ColumnIndex.parse(src, *args)
+        items = []
+        seq = 1
+        src.each do |line|
+          if m = COLUMN_PATTERN.match(line)
+            level = m[1] ## not use it yet
+            id = m[2]
+            caption = m[3].strip
+            if !id || id == ""
+              id = caption
+            end
+
+            items.push item_class().new(id, seq, caption)
+            seq += 1
+          end
+        end
+        new(items)
+      end
+
+    end
+
   end
 end

data/lib/review/book/page_metric.rb

@@ -22,7 +22,7 @@ module ReVIEW
       def PageMetric.b5
         new(46, 80, 30, 74, 2)
       end
-      
+
       def initialize(list_lines, list_columns, text_lines, text_columns, page_per_kbyte)
         @list = MetricData.new(list_lines, list_columns)
         @text = MetricData.new(text_lines, text_columns)

data/lib/review/builder.rb

@@ -30,10 +30,6 @@ module ReVIEW
 
     def initialize(strict = false, *args)
       @strict = strict
-      @tabwidth = nil
-      if ReVIEW.book.param && ReVIEW.book.param["tabwidth"]
-        @tabwidth = ReVIEW.book.param["tabwidth"]
-      end
       builder_init(*args)
     end
 
@@ -47,6 +43,10 @@ module ReVIEW
       @location = location
       @output = StringIO.new
       @book = ReVIEW.book
+      @tabwidth = nil
+      if @book.config && @book.config["tabwidth"]
+        @tabwidth = @book.config["tabwidth"]
+      end
       builder_init_file
     end
 
@@ -58,17 +58,17 @@ module ReVIEW
       @output.string
     end
 
-    alias :raw_result result
+    alias_method :raw_result, :result
 
     def print(*s)
       @output.print(*s.map{|i|
-        convert_outencoding(i, ReVIEW.book.param["outencoding"])
+        convert_outencoding(i, @book.config["outencoding"])
       })
     end
 
     def puts(*s)
       @output.puts *s.map{|i|
-        convert_outencoding(i, ReVIEW.book.param["outencoding"])
+        convert_outencoding(i, @book.config["outencoding"])
       }
     end
 
@@ -257,12 +257,19 @@ module ReVIEW
     end
 
     def inline_hd(id)
-      m = /\A(\w+)\|(.+)/.match(id)
+      m = /\A([^|]+)\|(.+)/.match(id)
       chapter = @book.chapters.detect{|chap| chap.id == m[1]} if m && m[1]
       return inline_hd_chap(chapter, m[2]) if chapter
       return inline_hd_chap(@chapter, id)
     end
 
+    def inline_column(id)
+      @chapter.column(id).caption
+    rescue
+      error "unknown column: #{id}"
+      nofunc_text("[UnknownColumn:#{id}]")
+    end
+
     def raw(str)
       if matched = str.match(/\|(.*?)\|(.*)/)
         builders = matched[1].split(/,/).map{|i| i.gsub(/\s/, '') }
@@ -312,7 +319,7 @@ module ReVIEW
     end
 
     def get_chap(chapter = @chapter)
-      if ReVIEW.book.param["secnolevel"] > 0 && !chapter.number.nil? && !chapter.number.to_s.empty?
+      if @book.config["secnolevel"] > 0 && !chapter.number.nil? && !chapter.number.to_s.empty?
         return "#{chapter.number}"
       end
       return nil
@@ -346,7 +353,7 @@ module ReVIEW
       file = "#{id}.#{image_ext}"
       file_path = File.join(dir, file)
 
-      line = CGI.unescapeHTML(lines.join("\n"))
+      line = self.unescape(lines.join("\n"))
       cmds = {
         :graphviz => "echo '#{line}' | dot -T#{image_ext} -o#{file_path}",
         :gnuplot  => "echo 'set terminal " +
@@ -369,12 +376,12 @@ module ReVIEW
 
     def inline_include(file_name)
       compile_inline convert_inencoding(File.open(file_name).read,
-                                        ReVIEW.book.param["inencoding"])
+                                        @book.config["inencoding"])
     end
 
     def include(file_name)
       File.foreach(file_name) do |line|
-        paragraph([convert_inencoding(line, ReVIEW.book.param["inencoding"])])
+        paragraph([convert_inencoding(line, @book.config["inencoding"])])
       end
     end